@actschurch/ccms-sdk 0.0.26 → 0.0.28
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.
- package/dist/models/accounselling/ModelView/CareSessionModelView.d.ts +31 -0
- package/dist/models/accounselling/ModelView/CareSessionModelView.d.ts.map +1 -1
- package/dist/models/analytics/KnowledgeSearch.d.ts +10 -0
- package/dist/models/analytics/KnowledgeSearch.d.ts.map +1 -1
- package/dist/models/dashboard/index.d.ts +282 -3
- package/dist/models/dashboard/index.d.ts.map +1 -1
- package/dist/models/dashboard/index.js +315 -3
- package/dist/models/dashboard/index.js.map +1 -1
- package/dist/models/resources/ModelView/CourseModelView.d.ts +17 -0
- package/dist/models/resources/ModelView/CourseModelView.d.ts.map +1 -1
- package/dist/models/resources/ResourceSettings.d.ts +31 -0
- package/dist/models/resources/ResourceSettings.d.ts.map +1 -0
- package/dist/models/resources/ResourceSettings.js +2 -0
- package/dist/models/resources/ResourceSettings.js.map +1 -0
- package/dist/models/resources/SessionNote.d.ts +30 -0
- package/dist/models/resources/SessionNote.d.ts.map +1 -0
- package/dist/models/resources/SessionNote.js +2 -0
- package/dist/models/resources/SessionNote.js.map +1 -0
- package/dist/models/resources/index.d.ts +2 -0
- package/dist/models/resources/index.d.ts.map +1 -1
- package/dist/models/resources/index.js +3 -0
- package/dist/models/resources/index.js.map +1 -1
- package/dist/react/hooks/services/useResourcesServices.d.ts +5 -1
- package/dist/react/hooks/services/useResourcesServices.d.ts.map +1 -1
- package/dist/react/hooks/services/useResourcesServices.js +6 -0
- package/dist/react/hooks/services/useResourcesServices.js.map +1 -1
- package/dist/realtime/dashboards/DashboardAggregatorClient.d.ts +48 -0
- package/dist/realtime/dashboards/DashboardAggregatorClient.d.ts.map +1 -0
- package/dist/realtime/dashboards/DashboardAggregatorClient.js +65 -0
- package/dist/realtime/dashboards/DashboardAggregatorClient.js.map +1 -0
- package/dist/realtime/dashboards/index.d.ts +1 -0
- package/dist/realtime/dashboards/index.d.ts.map +1 -1
- package/dist/realtime/dashboards/index.js +3 -0
- package/dist/realtime/dashboards/index.js.map +1 -1
- package/dist/services/accounselling/CareCaseService.d.ts +115 -1
- package/dist/services/accounselling/CareCaseService.d.ts.map +1 -1
- package/dist/services/accounselling/CareCaseService.js +171 -0
- package/dist/services/accounselling/CareCaseService.js.map +1 -1
- package/dist/services/dashboard/DashboardAggregatorService.d.ts +73 -0
- package/dist/services/dashboard/DashboardAggregatorService.d.ts.map +1 -0
- package/dist/services/dashboard/DashboardAggregatorService.js +145 -0
- package/dist/services/dashboard/DashboardAggregatorService.js.map +1 -0
- package/dist/services/dashboard/DashboardLayoutService.d.ts +46 -0
- package/dist/services/dashboard/DashboardLayoutService.d.ts.map +1 -0
- package/dist/services/dashboard/DashboardLayoutService.js +75 -0
- package/dist/services/dashboard/DashboardLayoutService.js.map +1 -0
- package/dist/services/dashboard/DashboardServices.d.ts +38 -0
- package/dist/services/dashboard/DashboardServices.d.ts.map +1 -0
- package/dist/services/dashboard/DashboardServices.js +28 -0
- package/dist/services/dashboard/DashboardServices.js.map +1 -0
- package/dist/services/dashboard/index.d.ts +11 -0
- package/dist/services/dashboard/index.d.ts.map +1 -0
- package/dist/services/dashboard/index.js +10 -0
- package/dist/services/dashboard/index.js.map +1 -0
- package/dist/services/index.d.ts +1 -0
- package/dist/services/index.d.ts.map +1 -1
- package/dist/services/index.js +2 -0
- package/dist/services/index.js.map +1 -1
- package/dist/services/knowledgebase/KnowledgeBaseQAService.d.ts +7 -1
- package/dist/services/knowledgebase/KnowledgeBaseQAService.d.ts.map +1 -1
- package/dist/services/knowledgebase/KnowledgeBaseQAService.js +11 -0
- package/dist/services/knowledgebase/KnowledgeBaseQAService.js.map +1 -1
- package/dist/services/members/MemberService.d.ts +17 -0
- package/dist/services/members/MemberService.d.ts.map +1 -1
- package/dist/services/members/MemberService.js +27 -0
- package/dist/services/members/MemberService.js.map +1 -1
- package/dist/services/resources/PublicCoursesService.d.ts +7 -0
- package/dist/services/resources/PublicCoursesService.d.ts.map +1 -1
- package/dist/services/resources/PublicCoursesService.js +12 -0
- package/dist/services/resources/PublicCoursesService.js.map +1 -1
- package/dist/services/resources/ResourceSettingsService.d.ts +26 -0
- package/dist/services/resources/ResourceSettingsService.d.ts.map +1 -0
- package/dist/services/resources/ResourceSettingsService.js +43 -0
- package/dist/services/resources/ResourceSettingsService.js.map +1 -0
- package/dist/services/resources/SessionNoteService.d.ts +27 -0
- package/dist/services/resources/SessionNoteService.d.ts.map +1 -0
- package/dist/services/resources/SessionNoteService.js +44 -0
- package/dist/services/resources/SessionNoteService.js.map +1 -0
- package/dist/services/resources/UserCourseProgressService.d.ts +9 -0
- package/dist/services/resources/UserCourseProgressService.d.ts.map +1 -1
- package/dist/services/resources/UserCourseProgressService.js +13 -0
- package/dist/services/resources/UserCourseProgressService.js.map +1 -1
- package/dist/services/resources/index.d.ts +6 -0
- package/dist/services/resources/index.d.ts.map +1 -1
- package/dist/services/resources/index.js +6 -0
- package/dist/services/resources/index.js.map +1 -1
- package/package.json +1 -1
|
@@ -200,4 +200,35 @@ export interface CreateCareCaseNote {
|
|
|
200
200
|
/** Admin-only note (hidden from the assigned leader) */
|
|
201
201
|
hideFromLeader?: boolean;
|
|
202
202
|
}
|
|
203
|
+
/** Partial update of a case note — only supplied fields are applied. */
|
|
204
|
+
export interface UpdateCareCaseNoteRequest {
|
|
205
|
+
/** Note HTML content */
|
|
206
|
+
note?: string | null;
|
|
207
|
+
/** Admin-only note (hidden from the assigned leader) */
|
|
208
|
+
hideFromLeader?: boolean | null;
|
|
209
|
+
}
|
|
210
|
+
/** Partial update of a case file — only supplied fields are applied. */
|
|
211
|
+
export interface UpdateCareCaseFileRequest {
|
|
212
|
+
/** File name */
|
|
213
|
+
name?: string | null;
|
|
214
|
+
/** Description */
|
|
215
|
+
description?: string | null;
|
|
216
|
+
/** MIME type / file extension */
|
|
217
|
+
type?: string | null;
|
|
218
|
+
/** Storage URL */
|
|
219
|
+
url?: string | null;
|
|
220
|
+
/** Upload timestamp (yyyyMMddHHmmss) */
|
|
221
|
+
uploadedDateTime?: number | null;
|
|
222
|
+
/** Whether the file is active */
|
|
223
|
+
isActive?: boolean | null;
|
|
224
|
+
}
|
|
225
|
+
/** Partial update of a case counselee link — only supplied fields are applied. */
|
|
226
|
+
export interface UpdateCareCaseMemberRequest {
|
|
227
|
+
/** Whether the member is the primary counselee */
|
|
228
|
+
isMain?: boolean | null;
|
|
229
|
+
/** POPIA / data-use consent given */
|
|
230
|
+
hasConsent?: boolean | null;
|
|
231
|
+
/** Whether the link is active */
|
|
232
|
+
isActive?: boolean | null;
|
|
233
|
+
}
|
|
203
234
|
//# sourceMappingURL=CareSessionModelView.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CareSessionModelView.d.ts","sourceRoot":"","sources":["../../../../src/models/accounselling/ModelView/CareSessionModelView.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,yBAAyB;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,mBAAmB;IACnB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,iCAAiC;IACjC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,sBAAsB;IACtB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAGxB,yDAAyD;IACzD,MAAM,EAAE,MAAM,CAAC;IACf,wBAAwB;IACxB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,qBAAqB;IACrB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAG1B,6DAA6D;IAC7D,QAAQ,EAAE,MAAM,CAAC;IACjB,0BAA0B;IAC1B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,uBAAuB;IACvB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAG5B,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,2DAA2D;IAC3D,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,6DAA6D;IAC7D,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,2BAA2B;IAC3B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,uEAAuE;IACvE,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,iEAAiE;IACjE,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,yCAAyC;IACzC,eAAe,EAAE,MAAM,CAAC;IACxB,oCAAoC;IACpC,QAAQ,EAAE,OAAO,CAAC;IAClB,0CAA0C;IAC1C,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,mDAAmD;IACnD,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,wDAAwD;IACxD,KAAK,CAAC,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC;IAGpC,4DAA4D;IAC5D,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,gEAAgE;IAChE,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,gEAAgE;IAChE,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,mFAAmF;IACnF,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,+CAA+C;AAC/C,MAAM,WAAW,kBAAkB;IACjC,sBAAsB;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,gBAAgB;IAChB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,iDAAiD;AACjD,MAAM,WAAW,sBAAsB;IACrC,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,qCAAqC;IACrC,QAAQ,EAAE,MAAM,CAAC;IACjB,0CAA0C;IAC1C,YAAY,EAAE,MAAM,CAAC;IACrB,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,uBAAuB;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,mCAAmC;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,sCAAsC;IACtC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,sCAAsC;IACtC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,yDAAyD;AACzD,MAAM,WAAW,2BAA2B;IAC1C,2BAA2B;IAC3B,KAAK,EAAE,oBAAoB,EAAE,CAAC;IAC9B,oCAAoC;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,sCAAsC;IACtC,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,yCAAyC;AACzC,MAAM,WAAW,iBAAiB;IAChC,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,iCAAiC;IACjC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,sBAAsB;IACtB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,cAAc;IACd,MAAM,EAAE,MAAM,CAAC;IACf,iCAAiC;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,2BAA2B;IAC3B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,kBAAkB;IAClB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,yCAAyC;IACzC,eAAe,EAAE,MAAM,CAAC;IACxB,oBAAoB;IACpB,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,yCAAyC;AACzC,MAAM,WAAW,wBAAwB;IACvC,mBAAmB;IACnB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,iCAAiC;IACjC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,sBAAsB;IACtB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,cAAc;IACd,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,qBAAqB;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,2BAA2B;IAC3B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,kBAAkB;IAClB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,yCAAyC;IACzC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,oCAAoC;IACpC,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,sBAAsB;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,yBAAyB;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,0BAA0B;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,wBAAwB;IACxB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAGrB,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,2DAA2D;IAC3D,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,6DAA6D;IAC7D,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,kCAAkC;IAClC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,2DAA2D;IAC3D,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,+CAA+C;IAC/C,cAAc,EAAE,OAAO,CAAC;IACxB,gCAAgC;IAChC,eAAe,EAAE,OAAO,CAAC;IACzB,uCAAuC;IACvC,aAAa,EAAE,MAAM,CAAC;IAGtB,mEAAmE;IACnE,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,yCAAyC;AACzC,MAAM,WAAW,qBAAqB;IACpC,yBAAyB;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,0BAA0B;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,kCAAkC;IAClC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,+CAA+C;IAC/C,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,+CAA+C;IAC/C,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,sCAAsC;AACtC,MAAM,WAAW,kBAAkB;IACjC,sBAAsB;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B"}
|
|
1
|
+
{"version":3,"file":"CareSessionModelView.d.ts","sourceRoot":"","sources":["../../../../src/models/accounselling/ModelView/CareSessionModelView.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,yBAAyB;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,mBAAmB;IACnB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,iCAAiC;IACjC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,sBAAsB;IACtB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAGxB,yDAAyD;IACzD,MAAM,EAAE,MAAM,CAAC;IACf,wBAAwB;IACxB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,qBAAqB;IACrB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAG1B,6DAA6D;IAC7D,QAAQ,EAAE,MAAM,CAAC;IACjB,0BAA0B;IAC1B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,uBAAuB;IACvB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAG5B,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,2DAA2D;IAC3D,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,6DAA6D;IAC7D,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,2BAA2B;IAC3B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,uEAAuE;IACvE,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,iEAAiE;IACjE,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,yCAAyC;IACzC,eAAe,EAAE,MAAM,CAAC;IACxB,oCAAoC;IACpC,QAAQ,EAAE,OAAO,CAAC;IAClB,0CAA0C;IAC1C,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,mDAAmD;IACnD,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,wDAAwD;IACxD,KAAK,CAAC,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC;IAGpC,4DAA4D;IAC5D,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,gEAAgE;IAChE,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,gEAAgE;IAChE,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,mFAAmF;IACnF,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,+CAA+C;AAC/C,MAAM,WAAW,kBAAkB;IACjC,sBAAsB;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,gBAAgB;IAChB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,iDAAiD;AACjD,MAAM,WAAW,sBAAsB;IACrC,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,qCAAqC;IACrC,QAAQ,EAAE,MAAM,CAAC;IACjB,0CAA0C;IAC1C,YAAY,EAAE,MAAM,CAAC;IACrB,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,uBAAuB;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,mCAAmC;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,sCAAsC;IACtC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,sCAAsC;IACtC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,yDAAyD;AACzD,MAAM,WAAW,2BAA2B;IAC1C,2BAA2B;IAC3B,KAAK,EAAE,oBAAoB,EAAE,CAAC;IAC9B,oCAAoC;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,sCAAsC;IACtC,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,yCAAyC;AACzC,MAAM,WAAW,iBAAiB;IAChC,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,iCAAiC;IACjC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,sBAAsB;IACtB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,cAAc;IACd,MAAM,EAAE,MAAM,CAAC;IACf,iCAAiC;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,2BAA2B;IAC3B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,kBAAkB;IAClB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,yCAAyC;IACzC,eAAe,EAAE,MAAM,CAAC;IACxB,oBAAoB;IACpB,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,yCAAyC;AACzC,MAAM,WAAW,wBAAwB;IACvC,mBAAmB;IACnB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,iCAAiC;IACjC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,sBAAsB;IACtB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,cAAc;IACd,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,qBAAqB;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,2BAA2B;IAC3B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,kBAAkB;IAClB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,yCAAyC;IACzC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,oCAAoC;IACpC,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,sBAAsB;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,yBAAyB;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,0BAA0B;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,wBAAwB;IACxB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAGrB,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,2DAA2D;IAC3D,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,6DAA6D;IAC7D,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,kCAAkC;IAClC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,2DAA2D;IAC3D,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,+CAA+C;IAC/C,cAAc,EAAE,OAAO,CAAC;IACxB,gCAAgC;IAChC,eAAe,EAAE,OAAO,CAAC;IACzB,uCAAuC;IACvC,aAAa,EAAE,MAAM,CAAC;IAGtB,mEAAmE;IACnE,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,yCAAyC;AACzC,MAAM,WAAW,qBAAqB;IACpC,yBAAyB;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,0BAA0B;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,kCAAkC;IAClC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,+CAA+C;IAC/C,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,+CAA+C;IAC/C,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,sCAAsC;AACtC,MAAM,WAAW,kBAAkB;IACjC,sBAAsB;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,wEAAwE;AACxE,MAAM,WAAW,yBAAyB;IACxC,wBAAwB;IACxB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,wDAAwD;IACxD,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACjC;AAED,wEAAwE;AACxE,MAAM,WAAW,yBAAyB;IACxC,gBAAgB;IAChB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,kBAAkB;IAClB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,iCAAiC;IACjC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,kBAAkB;IAClB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,wCAAwC;IACxC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,iCAAiC;IACjC,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC3B;AAED,kFAAkF;AAClF,MAAM,WAAW,2BAA2B;IAC1C,kDAAkD;IAClD,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACxB,qCAAqC;IACrC,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC5B,iCAAiC;IACjC,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC3B"}
|
|
@@ -46,6 +46,16 @@ export interface KnowledgeChatRequest {
|
|
|
46
46
|
includeCourses?: boolean | null;
|
|
47
47
|
anonymousId?: string | null;
|
|
48
48
|
}
|
|
49
|
+
/**
|
|
50
|
+
* Effective on/off state of the Resource Centre AI features, from
|
|
51
|
+
* <c>GET /api/ai/knowledge/availability</c> (anonymous-capable). The public
|
|
52
|
+
* site uses this to show/hide the Ask AI / Chat tabs.
|
|
53
|
+
*/
|
|
54
|
+
export interface KnowledgeAvailability {
|
|
55
|
+
searchEnabled: boolean;
|
|
56
|
+
chatEnabled: boolean;
|
|
57
|
+
allowAnonymous: boolean;
|
|
58
|
+
}
|
|
49
59
|
export interface KnowledgeChatResponse {
|
|
50
60
|
/**
|
|
51
61
|
* - "answer": concrete reply, citations populated.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"KnowledgeSearch.d.ts","sourceRoot":"","sources":["../../../src/models/analytics/KnowledgeSearch.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAChC,yEAAyE;IACzE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,uBAAuB;IACtC,+CAA+C;IAC/C,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,kDAAkD;IAClD,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,6DAA6D;IAC7D,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACtC,sEAAsE;IACtE,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,uBAAuB,EAAE,CAAC;IACrC,2EAA2E;IAC3E,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,2FAA2F;IAC3F,MAAM,EAAE,MAAM,CAAC;CAChB;AAOD,uDAAuD;AACvD,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,QAAQ,CAAC;IACtC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,oBAAoB,EAAE,CAAC;IACjC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAChC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,IAAI,EAAE,QAAQ,GAAG,eAAe,GAAG,cAAc,GAAG,aAAa,CAAC;IAClE,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,uBAAuB,EAAE,CAAC;IACrC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;CAChB"}
|
|
1
|
+
{"version":3,"file":"KnowledgeSearch.d.ts","sourceRoot":"","sources":["../../../src/models/analytics/KnowledgeSearch.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAChC,yEAAyE;IACzE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,uBAAuB;IACtC,+CAA+C;IAC/C,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,kDAAkD;IAClD,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,6DAA6D;IAC7D,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACtC,sEAAsE;IACtE,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,uBAAuB,EAAE,CAAC;IACrC,2EAA2E;IAC3E,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,2FAA2F;IAC3F,MAAM,EAAE,MAAM,CAAC;CAChB;AAOD,uDAAuD;AACvD,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,QAAQ,CAAC;IACtC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,oBAAoB,EAAE,CAAC;IACjC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAChC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,aAAa,EAAE,OAAO,CAAC;IACvB,WAAW,EAAE,OAAO,CAAC;IACrB,cAAc,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,IAAI,EAAE,QAAQ,GAAG,eAAe,GAAG,cAAc,GAAG,aAAa,CAAC;IAClE,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,uBAAuB,EAAE,CAAC;IACrC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;CAChB"}
|
|
@@ -1,8 +1,287 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Dashboard models
|
|
3
3
|
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
4
|
+
* TypeScript-SDK mirror of the cross-domain "my day at CCMS" dashboard
|
|
5
|
+
* contract — kept byte-for-byte in step with the iOS (`CCMSSDK`) and Android
|
|
6
|
+
* (`com.ccms.sdk`) SDKs and the backend
|
|
7
|
+
* `CCMS.Api.DashboardAggregator` / `CCMSLib.Dashboard` types.
|
|
8
|
+
*
|
|
9
|
+
* The Hub renders a dashboard widget purely from its JSON payload — it never
|
|
10
|
+
* links the owning domain's binary — so these shapes are the locked
|
|
11
|
+
* cross-platform contract (`05_DASHBOARD_EXPERIENCE.md`). Unknown renderer /
|
|
12
|
+
* container kinds (a newer server talking to an older client) must degrade
|
|
13
|
+
* gracefully rather than blank-out or crash.
|
|
14
|
+
*
|
|
15
|
+
* Wire form is camelCase, matching Swift/Kotlin exactly.
|
|
16
|
+
*/
|
|
17
|
+
/**
|
|
18
|
+
* The renderer kind a dashboard widget is drawn with — the SDK mirror of the
|
|
19
|
+
* backend `CCMSLib.Dashboard.WidgetRendererKind`.
|
|
20
|
+
*
|
|
21
|
+
* Wire form is the lower / kebab-case string. `'custom'` is the
|
|
22
|
+
* graceful-degradation fallback for unknown values.
|
|
23
|
+
*/
|
|
24
|
+
export type WidgetRendererKind = 'stat' | 'list' | 'progress' | 'calendar-strip' | 'custom';
|
|
25
|
+
/** Every known renderer kind, in declaration order. */
|
|
26
|
+
export declare const WIDGET_RENDERER_KINDS: readonly WidgetRendererKind[];
|
|
27
|
+
/**
|
|
28
|
+
* Parse a wire value to a {@link WidgetRendererKind}. Unknown / undefined
|
|
29
|
+
* values fall back to `'custom'` — the graceful-degradation contract (a widget
|
|
30
|
+
* always renders something, never blank, never a crash).
|
|
31
|
+
*/
|
|
32
|
+
export declare function parseWidgetRendererKind(value?: string | null): WidgetRendererKind;
|
|
33
|
+
/**
|
|
34
|
+
* The layout kind of a dashboard container section — the SDK mirror of the
|
|
35
|
+
* backend `CCMSLib.Dashboard.WidgetContainerType`.
|
|
36
|
+
*
|
|
37
|
+
* Wire form is the kebab-case string. `'stack'` is the graceful-degradation
|
|
38
|
+
* fallback for unknown values.
|
|
39
|
+
*/
|
|
40
|
+
export type WidgetContainerType = 'kpi-grid' | 'kpi-two-col' | 'kpi-single' | 'horizontal-cards' | 'stack';
|
|
41
|
+
/** Every known container type, in declaration order. */
|
|
42
|
+
export declare const WIDGET_CONTAINER_TYPES: readonly WidgetContainerType[];
|
|
43
|
+
/**
|
|
44
|
+
* Parse a wire value to a {@link WidgetContainerType}. Unknown / undefined
|
|
45
|
+
* values fall back to `'stack'`.
|
|
46
|
+
*/
|
|
47
|
+
export declare function parseWidgetContainerType(value?: string | null): WidgetContainerType;
|
|
48
|
+
/**
|
|
49
|
+
* A single self-contained dashboard widget — the SDK mirror of the backend
|
|
50
|
+
* `CCMSLib.Dashboard.DashboardWidget`. The Hub renders one of these from JSON
|
|
51
|
+
* alone, without linking the owning domain's binary.
|
|
52
|
+
*/
|
|
53
|
+
export interface DashboardWidget {
|
|
54
|
+
/** Stable, catalogue-registered widget id (e.g. `task.my-open-count`). */
|
|
55
|
+
widgetId: string;
|
|
56
|
+
/** Payload schema version, bumped when `payload`'s shape changes. */
|
|
57
|
+
version: number;
|
|
58
|
+
/**
|
|
59
|
+
* The wire string the Hub maps to a native renderer. Parse with
|
|
60
|
+
* {@link parseWidgetRendererKind} for the unknown-tolerant value.
|
|
61
|
+
*/
|
|
62
|
+
rendererKind: string;
|
|
63
|
+
/**
|
|
64
|
+
* The renderer-specific free-form JSON bag (title, subtitle, primary value,
|
|
65
|
+
* rows, actions, …). Kept untyped so a domain can evolve its payload without
|
|
66
|
+
* a shared-model change.
|
|
67
|
+
*/
|
|
68
|
+
payload: Record<string, unknown>;
|
|
69
|
+
/** UTC ISO-8601 timestamp the underlying data was computed. */
|
|
70
|
+
lastUpdated?: string;
|
|
71
|
+
/** Freshness window in seconds; the client refreshes after it elapses. */
|
|
72
|
+
ttl: number;
|
|
73
|
+
/**
|
|
74
|
+
* Set when the widget could not be produced; the Hub renders an error state
|
|
75
|
+
* for this widget only — the rest of the dashboard still renders.
|
|
76
|
+
*/
|
|
77
|
+
error?: string;
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* The composed dashboard returned by `GET /api/dashboard/me` — the SDK mirror
|
|
81
|
+
* of the backend `CCMS.Api.DashboardAggregator.Models.DashboardResponse`.
|
|
82
|
+
*/
|
|
83
|
+
export interface DashboardResponse {
|
|
84
|
+
/**
|
|
85
|
+
* Every requested widget, in request order. Failed widgets carry a non-empty
|
|
86
|
+
* {@link DashboardWidget.error} — the dashboard still renders.
|
|
87
|
+
*/
|
|
88
|
+
widgets: DashboardWidget[];
|
|
89
|
+
/** UTC ISO-8601 time the dashboard was composed. */
|
|
90
|
+
generatedAt: string;
|
|
91
|
+
}
|
|
92
|
+
/**
|
|
93
|
+
* One label/value field in a widget's enriched detail view — the SDK mirror of
|
|
94
|
+
* the backend `WidgetDetailField`. **Locked cross-platform contract** (matches
|
|
95
|
+
* the iOS `WidgetDetailFieldResult` and Android `WidgetDetailFieldResult`).
|
|
96
|
+
*/
|
|
97
|
+
export interface WidgetDetailField {
|
|
98
|
+
/** The field's display label. */
|
|
99
|
+
label: string;
|
|
100
|
+
/** The field's display value. */
|
|
101
|
+
value: string;
|
|
102
|
+
/** Optional hex colour for the value (e.g. a status colour). */
|
|
103
|
+
color?: string;
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* The enriched detail a domain returns for a tapped widget row — fetched on
|
|
107
|
+
* demand via `GET /api/dashboard/detail?widget=&item=`. The SDK mirror of the
|
|
108
|
+
* backend `WidgetDetailResult` and the iOS/Android SDKs. **Locked
|
|
109
|
+
* cross-platform contract.**
|
|
110
|
+
*/
|
|
111
|
+
export interface WidgetDetailResult {
|
|
112
|
+
/** The detail view's title. */
|
|
113
|
+
title: string;
|
|
114
|
+
/** Optional secondary line under the title. */
|
|
115
|
+
subtitle?: string;
|
|
116
|
+
/** The label/value fields rendered in the detail view. */
|
|
117
|
+
fields: WidgetDetailField[];
|
|
118
|
+
/** Deep link the "Open App" button routes to (e.g. `/app/tasks/123`). */
|
|
119
|
+
deepLink?: string;
|
|
120
|
+
/** Optional header image (e.g. an avatar) URL. */
|
|
121
|
+
imageUrl?: string;
|
|
122
|
+
}
|
|
123
|
+
/**
|
|
124
|
+
* One widget's placement in a {@link DashboardLayout}.
|
|
125
|
+
*/
|
|
126
|
+
export interface WidgetLayoutEntry {
|
|
127
|
+
/** Stable, catalogue-registered widget id (e.g. `task.my-open-count`). */
|
|
128
|
+
widgetId: string;
|
|
129
|
+
/** Whether the widget is shown on the dashboard. */
|
|
130
|
+
enabled: boolean;
|
|
131
|
+
/** Zero-based sort position among the layout's widgets. */
|
|
132
|
+
order: number;
|
|
133
|
+
/**
|
|
134
|
+
* Free-form per-widget settings bag — kept untyped so a widget can evolve
|
|
135
|
+
* its settings shape without a shared-model change.
|
|
136
|
+
*/
|
|
137
|
+
settings: Record<string, unknown>;
|
|
138
|
+
}
|
|
139
|
+
/**
|
|
140
|
+
* A container section grouping one or more widgets for the Hub to render — the
|
|
141
|
+
* SDK mirror of the backend `LayoutSection`.
|
|
142
|
+
*/
|
|
143
|
+
export interface LayoutSection {
|
|
144
|
+
/** Stable section id. */
|
|
145
|
+
id: string;
|
|
146
|
+
/** Optional section heading. */
|
|
147
|
+
title?: string;
|
|
148
|
+
/**
|
|
149
|
+
* Wire string (`kpi-grid` | `kpi-two-col` | `kpi-single` |
|
|
150
|
+
* `horizontal-cards` | `stack`). Parse with {@link parseWidgetContainerType}
|
|
151
|
+
* (unknown → `stack`).
|
|
152
|
+
*/
|
|
153
|
+
containerType: string;
|
|
154
|
+
/** Zero-based sort position among the layout's sections. */
|
|
155
|
+
order: number;
|
|
156
|
+
/** Whether the section is rendered. */
|
|
157
|
+
enabled: boolean;
|
|
158
|
+
/** The ids of the widgets placed in this section, in order. */
|
|
159
|
+
widgetIds: string[];
|
|
160
|
+
/**
|
|
161
|
+
* Free-form section settings the client reads (e.g. `{ background, cardRows,
|
|
162
|
+
* showWidgetTitles }`) — kept untyped so a section can evolve its settings
|
|
163
|
+
* shape without a shared-model change. Absent on pre-settings layouts.
|
|
164
|
+
*/
|
|
165
|
+
settings?: Record<string, unknown>;
|
|
166
|
+
}
|
|
167
|
+
/**
|
|
168
|
+
* A swipeable dashboard page — the top layout level. The SDK mirror of the
|
|
169
|
+
* backend `DashboardPage`. **Locked cross-platform contract** (matches the iOS
|
|
170
|
+
* `DashboardPage` and Android `DashboardPage`).
|
|
171
|
+
*/
|
|
172
|
+
export interface DashboardPage {
|
|
173
|
+
/** Stable page id (e.g. `"home"`). Unique within a layout. */
|
|
174
|
+
id: string;
|
|
175
|
+
/** Optional page title shown in the page indicator / tab. */
|
|
176
|
+
title?: string;
|
|
177
|
+
/** Zero-based sort position among the layout's pages. */
|
|
178
|
+
order: number;
|
|
179
|
+
/** The container sections rendered on this page, in order. */
|
|
180
|
+
sections: LayoutSection[];
|
|
181
|
+
}
|
|
182
|
+
/**
|
|
183
|
+
* The user's personalised dashboard layout — the SDK mirror of the backend
|
|
184
|
+
* `CCMS.Api.DashboardAggregator.Models.DashboardLayout`.
|
|
185
|
+
*
|
|
186
|
+
* This is the locked cross-platform contract: the iOS / Android SDKs define an
|
|
187
|
+
* identically-shaped type and the backend serialises the identical shape. It is
|
|
188
|
+
* read/written via `GET/PUT /api/dashboard/me/layout`.
|
|
189
|
+
*/
|
|
190
|
+
export interface DashboardLayout {
|
|
191
|
+
/**
|
|
192
|
+
* Every widget the user has placed on their dashboard, with its enabled flag,
|
|
193
|
+
* sort order, and per-widget settings bag.
|
|
194
|
+
*/
|
|
195
|
+
widgets: WidgetLayoutEntry[];
|
|
196
|
+
/**
|
|
197
|
+
* Optional swipeable pages — the top layout level. Absent/empty ⇒ the client
|
|
198
|
+
* wraps {@link DashboardLayout.sections} (or a flat stack) as a single page.
|
|
199
|
+
* Superseded by `pages` when present.
|
|
200
|
+
*/
|
|
201
|
+
pages?: DashboardPage[];
|
|
202
|
+
/**
|
|
203
|
+
* Optional saved container sections (legacy / single-page); absent on
|
|
204
|
+
* pre-container layouts. Superseded by {@link DashboardLayout.pages}.
|
|
205
|
+
*/
|
|
206
|
+
sections?: LayoutSection[];
|
|
207
|
+
/**
|
|
208
|
+
* UTC ISO-8601 time the layout was last saved. The server stamps this on a
|
|
209
|
+
* successful `PUT`; clients send it back unchanged.
|
|
210
|
+
*/
|
|
211
|
+
updatedAt?: string;
|
|
212
|
+
}
|
|
213
|
+
/**
|
|
214
|
+
* The widgets the user has switched on, in their chosen `order`.
|
|
215
|
+
*/
|
|
216
|
+
export declare function enabledWidgetsInOrder(layout: DashboardLayout): WidgetLayoutEntry[];
|
|
217
|
+
/**
|
|
218
|
+
* The sections to render: the saved {@link DashboardLayout.sections} (enabled,
|
|
219
|
+
* ordered, each trimmed to its enabled widgets and dropped when empty) when
|
|
220
|
+
* present, else a single synthesized `stack` section over
|
|
221
|
+
* {@link enabledWidgetsInOrder} — back-compat with pre-container layouts.
|
|
222
|
+
*
|
|
223
|
+
* Mirrors the Swift `resolvedSections` / Kotlin `resolvedSections()` logic.
|
|
224
|
+
*/
|
|
225
|
+
export declare function resolvedSections(layout: DashboardLayout): LayoutSection[];
|
|
226
|
+
/**
|
|
227
|
+
* The pages to render: the saved {@link DashboardLayout.pages} (sorted by
|
|
228
|
+
* order, each page's sections filtered to enabled and trimmed to the layout's
|
|
229
|
+
* enabled widget ids, then dropped when empty) when present, else a single
|
|
230
|
+
* `home` page wrapping {@link resolvedSections} — back-compat with pre-page
|
|
231
|
+
* layouts.
|
|
232
|
+
*
|
|
233
|
+
* Mirrors the Swift `resolvedPages` / Kotlin `resolvedPages()` logic.
|
|
234
|
+
*/
|
|
235
|
+
export declare function resolvedPages(layout: DashboardLayout): DashboardPage[];
|
|
236
|
+
/**
|
|
237
|
+
* One per-widget setting the editor renders a control for — the SDK mirror of
|
|
238
|
+
* the backend `WidgetSettingSchema`. **Locked cross-platform contract** (matches
|
|
239
|
+
* the iOS `WidgetSettingSchema` and Android `WidgetSettingSchema`).
|
|
240
|
+
*/
|
|
241
|
+
export interface WidgetSettingSchema {
|
|
242
|
+
/** The setting's stable key (e.g. `"showOverdueOnly"`). */
|
|
243
|
+
key: string;
|
|
244
|
+
/** The control type — `int` | `string` | `bool` | `enum`. */
|
|
245
|
+
type: string;
|
|
246
|
+
/** The setting's display label. */
|
|
247
|
+
label: string;
|
|
248
|
+
/** The default value (number / string / bool). Wire key is `default`. */
|
|
249
|
+
default?: unknown;
|
|
250
|
+
/** Minimum value for a numeric setting. */
|
|
251
|
+
min?: number;
|
|
252
|
+
/** Maximum value for a numeric setting. */
|
|
253
|
+
max?: number;
|
|
254
|
+
/** Allowed choices for an `enum` setting. */
|
|
255
|
+
options?: string[];
|
|
256
|
+
}
|
|
257
|
+
/**
|
|
258
|
+
* Catalog metadata for one widget — drives the Hub's add-picker + settings
|
|
259
|
+
* sheet. The SDK mirror of the backend `WidgetCatalogItem` and the iOS/Android
|
|
260
|
+
* SDKs. **Locked cross-platform contract.** Returned by `GET /api/dashboard/widgets`.
|
|
261
|
+
*/
|
|
262
|
+
export interface WidgetCatalogItem {
|
|
263
|
+
/** Stable, catalogue-registered widget id (e.g. `task.my-open-count`). */
|
|
264
|
+
id: string;
|
|
265
|
+
/** The widget's display title. */
|
|
266
|
+
title: string;
|
|
267
|
+
/** A short description shown in the add-picker. */
|
|
268
|
+
description: string;
|
|
269
|
+
/** Renderer kind: `stat` | `list` | `progress` | `calendar-strip` | `custom`. */
|
|
270
|
+
kind: string;
|
|
271
|
+
/** The widget's grouping category in the add-picker. */
|
|
272
|
+
category: string;
|
|
273
|
+
/** The container type the widget defaults into when added. */
|
|
274
|
+
defaultContainer: string;
|
|
275
|
+
/** The container types the widget can be placed in. */
|
|
276
|
+
supportedContainers: string[];
|
|
277
|
+
/** Optional default accent colour (hex) for the widget. */
|
|
278
|
+
defaultAccentColor?: string;
|
|
279
|
+
/** The per-widget settings the editor renders controls for. */
|
|
280
|
+
settings: WidgetSettingSchema[];
|
|
281
|
+
}
|
|
282
|
+
/**
|
|
283
|
+
* The bundled catalog — same set + order as the backend `WidgetCatalogMeta.All`,
|
|
284
|
+
* the iOS `WidgetCatalogItem.bundled`, and the Kotlin `BUNDLED_WIDGET_CATALOG`.
|
|
6
285
|
*/
|
|
7
|
-
export
|
|
286
|
+
export declare const BUNDLED_WIDGET_CATALOG: WidgetCatalogItem[];
|
|
8
287
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/models/dashboard/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/models/dashboard/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAMH;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,GAC1B,MAAM,GACN,MAAM,GACN,UAAU,GACV,gBAAgB,GAChB,QAAQ,CAAC;AAEb,uDAAuD;AACvD,eAAO,MAAM,qBAAqB,EAAE,SAAS,kBAAkB,EAMrD,CAAC;AAEX;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,kBAAkB,CAejF;AAMD;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAC3B,UAAU,GACV,aAAa,GACb,YAAY,GACZ,kBAAkB,GAClB,OAAO,CAAC;AAEZ,wDAAwD;AACxD,eAAO,MAAM,sBAAsB,EAAE,SAAS,mBAAmB,EAMvD,CAAC;AAEX;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,mBAAmB,CAenF;AAMD;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,0EAA0E;IAC1E,QAAQ,EAAE,MAAM,CAAC;IACjB,qEAAqE;IACrE,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,+DAA+D;IAC/D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0EAA0E;IAC1E,GAAG,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,OAAO,EAAE,eAAe,EAAE,CAAC;IAC3B,oDAAoD;IACpD,WAAW,EAAE,MAAM,CAAC;CACrB;AAMD;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,iCAAiC;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,iCAAiC;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,gEAAgE;IAChE,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0DAA0D;IAC1D,MAAM,EAAE,iBAAiB,EAAE,CAAC;IAC5B,yEAAyE;IACzE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kDAAkD;IAClD,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAMD;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,0EAA0E;IAC1E,QAAQ,EAAE,MAAM,CAAC;IACjB,oDAAoD;IACpD,OAAO,EAAE,OAAO,CAAC;IACjB,2DAA2D;IAC3D,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,yBAAyB;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,gCAAgC;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB,4DAA4D;IAC5D,KAAK,EAAE,MAAM,CAAC;IACd,uCAAuC;IACvC,OAAO,EAAE,OAAO,CAAC;IACjB,+DAA+D;IAC/D,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,8DAA8D;IAC9D,EAAE,EAAE,MAAM,CAAC;IACX,6DAA6D;IAC7D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yDAAyD;IACzD,KAAK,EAAE,MAAM,CAAC;IACd,8DAA8D;IAC9D,QAAQ,EAAE,aAAa,EAAE,CAAC;CAC3B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,OAAO,EAAE,iBAAiB,EAAE,CAAC;IAC7B;;;;OAIG;IACH,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB;;;OAGG;IACH,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAC;IAC3B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,eAAe,GAAG,iBAAiB,EAAE,CAKlF;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,eAAe,GAAG,aAAa,EAAE,CA2BzE;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,eAAe,GAAG,aAAa,EAAE,CA+BtE;AAMD;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,2DAA2D;IAC3D,GAAG,EAAE,MAAM,CAAC;IACZ,6DAA6D;IAC7D,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,yEAAyE;IACzE,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,2CAA2C;IAC3C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,2CAA2C;IAC3C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,6CAA6C;IAC7C,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,0EAA0E;IAC1E,EAAE,EAAE,MAAM,CAAC;IACX,kCAAkC;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,mDAAmD;IACnD,WAAW,EAAE,MAAM,CAAC;IACpB,iFAAiF;IACjF,IAAI,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,QAAQ,EAAE,MAAM,CAAC;IACjB,8DAA8D;IAC9D,gBAAgB,EAAE,MAAM,CAAC;IACzB,uDAAuD;IACvD,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,2DAA2D;IAC3D,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,+DAA+D;IAC/D,QAAQ,EAAE,mBAAmB,EAAE,CAAC;CACjC;AA0ID;;;GAGG;AACH,eAAO,MAAM,sBAAsB,EAAE,iBAAiB,EAqErD,CAAC"}
|