@pablo2410/shared-ui 0.23.0 → 0.24.0

package/dist/reporting/index.d.ts

@@ -14,9 +14,9 @@ interface ReportingToolbarProps extends Omit<ReportingToolbarConfig, "moduleName
     /** Show the "attach screenshot" control (default: true). */
     enableScreenshot?: boolean;
     /**
-     * While true (the DEFAULT), the Report items are disabled with a "Coming
-     * soon" badge and `onReportSubmit` is never called. A later release wires the
-     * per-type forms and passes `false`.
+     * While true, the Report items are disabled with a "Coming soon" badge and
+     * `onReportSubmit` is never called. Defaults to `false` — pass `true` only
+     * if this host's `onReportSubmit` doesn't actually persist the report yet.
      */
     reportsComingSoon?: boolean;
     /**
@@ -34,16 +34,19 @@ declare function ReportingToolbar({ moduleName, showIncidentReporting, showFeedb
  * Reporting and feedback toolbar types + configuration for all Oplytics
  * subdomains — the header "User Actions" dropdown (ReportingToolbar).
  *
- * Feedback (Report Problem / Suggestion) is fully wired: the dialog collects a
- * service, an "is this blocking you?" signal, a short summary, the detail, and
- * an optional screenshot, then calls `onFeedbackSubmit` with the canonical
- * `FeedbackReport` shape. The host owns the transport (it POSTs to Portal's
- * `/api/service/feedback`).
+ * Both groups are fully wired. Feedback collects a service, an "is this
+ * blocking you?" signal, a short summary, the detail, and an optional
+ * screenshot, then calls `onFeedbackSubmit` with the canonical
+ * `FeedbackReport` shape. Report (Safety / Environmental / Stop Work) is
+ * three bespoke forms, one per category, each collecting the fields needed
+ * to conform to the external standard it's built against (see each
+ * category's comment below), then calls `onReportSubmit` with the
+ * discriminated `IncidentReport` union. Either way the host owns the
+ * transport (Feedback POSTs to Portal's `/api/service/feedback`; Report
+ * POSTs to Portal's `/api/service/reports`).
  *
- * Report (Safety / Environmental / Stop Work) is not wired yet — while
- * `reportsComingSoon` is true (the default), those items render disabled with a
- * "Coming soon" badge. A later release adds the per-type forms and flips the
- * default.
+ * `reportsComingSoon` defaults to `false` as of this version — pass `true`
+ * per-host only if that host's `onReportSubmit` doesn't actually persist yet.
  */
 type ReportCategory = "safety" | "environmental" | "stop-work";
 type FeedbackCategory = "problem" | "suggestion";
@@ -67,11 +70,27 @@ interface ReportScreenshot {
     dataBase64: string;
     mime: string;
 }
-interface IncidentReport {
-    category: ReportCategory;
+type IncidentSeverity = "low" | "medium" | "high" | "critical";
+/**
+ * OSHA 29 CFR 1904's own injury-and-illness recordkeeping classification —
+ * the standard the Safety form's injury fields conform to, alongside
+ * ISO 45001 (the international OH&S management-system standard it sits
+ * under). Shown to the user on the form, not just used internally.
+ */
+type OshaInjuryClassification = "none" | "first_aid_only" | "recordable" | "days_away_restricted_transfer" | "fatality";
+/** ISO 14001's "environmental aspect" concept — which element of the
+ *  environment an incident affects. The standard the Environmental form's
+ *  classification field conforms to. */
+type EnvironmentalAspect = "air_emission" | "water_discharge" | "soil_contamination" | "waste" | "spill" | "noise" | "other";
+/** ISO 45001's hierarchy-of-controls hazard classification. Stop Work
+ *  authority isn't itself a numbered standard — it's a control mechanism
+ *  exercised under an ISO 45001 OH&S management system, which this
+ *  classification maps to. */
+type HazardCategory = "mechanical" | "electrical" | "chemical" | "working_at_height" | "confined_space" | "vehicle_traffic" | "other";
+interface IncidentReportBase {
     description: string;
     location?: string;
-    severity?: "low" | "medium" | "high" | "critical";
+    severity?: IncidentSeverity;
     /** Optional — what was done at the scene to make the area safe. */
     immediateAction?: string;
     moduleName: string;
@@ -80,6 +99,44 @@ interface IncidentReport {
     submittedBy?: ReportSubmitter;
     hierarchyContext?: ReportHierarchyContext;
 }
+interface SafetyIncidentReport extends IncidentReportBase {
+    category: "safety";
+    injuryOccurred: boolean;
+    /** OSHA 1904 classification — see `OshaInjuryClassification`. */
+    injuryClassification?: OshaInjuryClassification;
+    /** OSHA DART-rate inputs — only meaningful when injuryClassification is
+     *  "days_away_restricted_transfer". */
+    daysAwayFromWork?: number;
+    daysRestrictedOrTransferred?: number;
+    firstAiderAttended?: boolean;
+    witnessName?: string;
+    bodyPart?: string;
+    treatmentType?: string;
+}
+interface EnvironmentalIncidentReport extends IncidentReportBase {
+    category: "environmental";
+    /** ISO 14001 environmental aspect — see `EnvironmentalAspect`. */
+    environmentalAspect?: EnvironmentalAspect;
+    /** Does this trigger a duty to notify an external regulator? */
+    regulatoryReportable?: boolean;
+    substance?: string;
+    estimatedQuantity?: string;
+    contained?: boolean;
+    reachedWatercourse?: boolean;
+}
+interface StopWorkIncidentReport extends IncidentReportBase {
+    category: "stop-work";
+    /** ISO 45001 hazard classification — see `HazardCategory`. */
+    hazardCategory?: HazardCategory;
+    hazardDescription?: string;
+    areaMadeSafe?: boolean;
+    workResumed?: boolean;
+}
+/** Discriminated on `category` — narrow on it to get the right per-type
+ *  fields (`report.category === "safety"` narrows to `SafetyIncidentReport`,
+ *  etc.). Each variant maps 1:1 onto its own bespoke form; see
+ *  ReportingToolbar.tsx's SafetyForm/EnvironmentalForm/StopWorkForm. */
+type IncidentReport = SafetyIncidentReport | EnvironmentalIncidentReport | StopWorkIncidentReport;
 interface FeedbackReport {
     category: FeedbackCategory;
     /** Canonical service slug the feedback is about (from the picker). */
@@ -120,7 +177,8 @@ interface ReportingToolbarConfig {
     reportCategories?: ReportCategory[];
     /** Feedback categories to show (default: both). */
     feedbackCategories?: FeedbackCategory[];
-    /** Called when an incident report is submitted (not wired yet). */
+    /** Called when an incident report is submitted. The host is responsible
+     * for actually persisting it — see `reportsComingSoon` above. */
     onReportSubmit: (report: IncidentReport) => Promise<void> | void;
     /** Called when feedback is submitted — the host POSTs it to Portal. */
     onFeedbackSubmit: (feedback: FeedbackReport) => Promise<void> | void;
@@ -141,6 +199,14 @@ interface FeedbackButtonDef {
 }
 declare const REPORT_BUTTONS: ReportButtonDef[];
 declare const FEEDBACK_BUTTONS: FeedbackButtonDef[];
+interface ReportStandardReference {
+    category: ReportCategory;
+    /** Short label shown on the form, e.g. "OSHA 1904 · ISO 45001". */
+    label: string;
+    /** One sentence explaining what the standard governs here. */
+    description: string;
+}
+declare const REPORT_STANDARD_REFERENCES: Record<ReportCategory, ReportStandardReference>;
 /** Create a default ReportingToolbarConfig with sensible defaults. */
 declare function createReportingConfig(moduleName: string, handlers: {
     onReportSubmit: (report: IncidentReport) => Promise<void> | void;
@@ -163,4 +229,4 @@ declare function isAcceptableScreenshot(file: {
 };
 declare function readFileAsScreenshot(file: File): Promise<ReportScreenshot>;
 
-export { FEEDBACK_BUTTONS, FEEDBACK_SCREENSHOT_MAX_BYTES, type FeedbackButtonDef, type FeedbackCategory, type FeedbackReport, type IncidentReport, OPLYTICS_SERVICES, type OplyticsService, REPORT_BUTTONS, type ReportButtonDef, type ReportCategory, type ReportHierarchyContext, type ReportScreenshot, type ReportSubmitter, ReportingToolbar, type ReportingToolbarConfig, type ReportingToolbarProps, createReportingConfig, isAcceptableScreenshot, readFileAsScreenshot };
+export { type EnvironmentalAspect, type EnvironmentalIncidentReport, FEEDBACK_BUTTONS, FEEDBACK_SCREENSHOT_MAX_BYTES, type FeedbackButtonDef, type FeedbackCategory, type FeedbackReport, type HazardCategory, type IncidentReport, type IncidentSeverity, OPLYTICS_SERVICES, type OplyticsService, type OshaInjuryClassification, REPORT_BUTTONS, REPORT_STANDARD_REFERENCES, type ReportButtonDef, type ReportCategory, type ReportHierarchyContext, type ReportScreenshot, type ReportStandardReference, type ReportSubmitter, ReportingToolbar, type ReportingToolbarConfig, type ReportingToolbarProps, type SafetyIncidentReport, type StopWorkIncidentReport, createReportingConfig, isAcceptableScreenshot, readFileAsScreenshot };