@eintrek/erp-shell 0.1.50 → 0.1.52

package/dist/help/help-api.d.ts

@@ -0,0 +1,35 @@
+import type { HelpAppId } from "./help-store";
+import type { HelpContext } from "./help-context";
+export declare function helpApiBase(app: HelpAppId | "other"): string;
+export type HelpKind = "help" | "problem" | "feedback";
+export interface HelpSent {
+    id: string;
+    ref: string;
+    status: string;
+    created_at: string;
+}
+export interface MyHelpMessage {
+    id: string;
+    ref: string;
+    app: string;
+    kind: HelpKind;
+    message: string;
+    status: "new" | "answered" | "closed";
+    created_at: string;
+    replies: Array<{
+        body: string;
+        created_at: string;
+    }>;
+}
+/** A failure the dialog shows as is. */
+export declare class HelpSendError extends Error {
+    readonly status?: number | undefined;
+    constructor(message: string, status?: number | undefined);
+}
+export declare function sendHelpMessage(input: {
+    app: HelpAppId | "other";
+    kind: HelpKind;
+    message: string;
+    context: HelpContext;
+}): Promise<HelpSent>;
+export declare function listMyHelpMessages(app: HelpAppId | "other"): Promise<MyHelpMessage[]>;

package/dist/help/help-button.d.ts

@@ -0,0 +1,8 @@
+export interface HelpButtonProps {
+    className?: string;
+}
+/**
+ * The ช่วยเหลือ button in the top bar. Drawn in the header's ink (the
+ * --header-* variables of the workspace chrome, white on the brand chrome).
+ */
+export declare function HelpButton({ className }: HelpButtonProps): import("react/jsx-runtime").JSX.Element;

package/dist/help/help-context.d.ts

@@ -0,0 +1,37 @@
+import { type HelpAppId } from "./help-store";
+/** What the dialog attaches to a message, as platform-api keeps it. */
+export interface HelpContext {
+    page_url?: string;
+    page_title?: string;
+    org_code?: string;
+    app_version?: string;
+    shell_version?: string;
+    browser?: string;
+    platform?: string;
+    screen?: string;
+    viewport?: string;
+    language?: string;
+    time_zone?: string;
+}
+export declare const HELP_APP_LABEL: Record<HelpAppId | "other", string>;
+/**
+ * Which app this page is: what the host said, what the app declared to the
+ * app switcher, then the production sub-domain, then the app URLs the build
+ * was given (local development). "other" when none of them tells.
+ */
+export declare function detectHelpApp(explicit?: HelpAppId | null): HelpAppId | "other";
+/** "Chrome 141" and "macOS" from a user agent — enough to reproduce. */
+export declare function describeBrowser(ua: string): {
+    browser: string;
+    platform: string;
+};
+/**
+ * The deployed build: NEXT_PUBLIC_APP_VERSION when the app sets one, else
+ * the Next build id in the page's own script paths (the build time, as every
+ * app's generateBuildId writes it).
+ */
+export declare function readAppVersion(): string;
+/** Everything attached to a message, read at the moment it is sent. */
+export declare function collectHelpContext(orgCode?: string | null): HelpContext;
+/** The short line under the form, "ข้อมูลที่แนบ: …". */
+export declare function describeAttached(app: HelpAppId | "other", ctx: HelpContext, email?: string | null): string;

package/dist/help/help-dialog.d.ts

@@ -0,0 +1,13 @@
+import { type HelpAppId } from "./help-store";
+export interface HelpDialogHostProps {
+    /** Which app this is; detected when omitted (see detectHelpApp). */
+    app?: HelpAppId | null;
+    /** Organisation code from the route, attached to the message. */
+    orgCode?: string | null;
+}
+/**
+ * The ช่วยเหลือ dialog. AppLayoutShell mounts one; the top-bar button and
+ * the user menu open it with openHelp(). It sends to platform-api, which
+ * puts the message in the back office's queue on admin.antniti.com.
+ */
+export declare function HelpDialogHost({ app, orgCode }: HelpDialogHostProps): import("react/jsx-runtime").JSX.Element;

package/dist/help/help-store.d.ts

@@ -0,0 +1,22 @@
+/**
+ * The ช่วยเหลือ dialog's open state, shared by everything that can open it:
+ * the top-bar button (AppLayoutShell) and the user menu (NavUser), which
+ * live in different subtrees. A tiny external store rather than a context so
+ * NavUser works the same whether or not it sits under the layout.
+ */
+export type HelpAppId = "platform" | "accounx" | "invenx" | "plannex" | "peoplx";
+/** Opens the dialog — a no-op when no layout has mounted one. */
+export declare function openHelp(): void;
+export declare function closeHelp(): void;
+/** Called by the dialog host on mount; returns its unmount. */
+export declare function registerHelpHost(): () => void;
+export declare function useHelpOpen(): boolean;
+/** True while a dialog host is mounted, i.e. the ช่วยเหลือ entry works. */
+export declare function useHelpAvailable(): boolean;
+/**
+ * Every app names itself when it builds its app-switcher links
+ * (buildSystemLinks({ activeApp })); the dialog reads that to say which app
+ * a message came from without each app passing it again.
+ */
+export declare function declareHelpApp(app: HelpAppId): void;
+export declare function declaredHelpApp(): HelpAppId | null;

package/dist/index.d.ts

@@ -24,6 +24,11 @@ export { AppLayoutShell, type AppLayoutShellProps, type AppLayoutShellOrganizati
 export { type ShellChrome, type WorkspaceHeaderTone, WORKSPACE_HEADER_VARS, WORKSPACE_LIGHT_HEADER_VARS, } from "./navigation/chrome";
 export { WorkspaceBrand, type WorkspaceBrandProps } from "./navigation/workspace-brand";
 export { SidebarHelpCard, SidebarHelpLink, type SidebarHelpCardProps, type SidebarHelpLinkProps, } from "./navigation/sidebar-help-card";
+export { HelpButton, type HelpButtonProps } from "./help/help-button";
+export { HelpDialogHost, type HelpDialogHostProps } from "./help/help-dialog";
+export { openHelp, closeHelp, type HelpAppId } from "./help/help-store";
+export { describeBrowser, describeAttached, detectHelpApp, type HelpContext, } from "./help/help-context";
+export { SHELL_VERSION } from "./version";
 export { AccessDenied, type AccessDeniedProps } from "./auth/access-denied";
 export { EmployeeRequiredGate, EMPLOYEE_RECORD_REQUIRED, EMPLOYEE_RECORD_REQUIRED_EVENT, EMPLOYEE_RECORD_OK_EVENT, } from "./auth/employee-required-gate";
 export { PermissionGateShell, type PermissionGateShellProps, type PermissionGateSkeletonVariant, } from "./auth/permission-gate-shell";