@eintrek/erp-shell 0.1.52 → 0.1.54

package/README.md

@@ -100,7 +100,10 @@ the data in as props:
 
 - `NavUser` — accepts `organization?`, `profileHref?`,
   `selectOrganizationHref?`, `signInRedirectHref?`. Reads `useSession`
-  + `useTheme` internally.
+  + `useTheme` internally. From 0.1.53 the card shows the person's roles
+  in the current organisation (platform-api `GET /organizations/:id/my-roles`,
+  via `useMyRoles`); `showRoles?` (default: `showSelectOrganization`) and
+  `organizationId?` (default: the X-Organization-ID the API client sends).
 - `NavMain` — accepts `items`, `orgCode?`, `closeOnNavigation?`,
   `approvalCounts?` (HR uses the last one for queue badges).
 - `OrganizationSwitcher` — accepts `activeOrganization`, `organizations`,

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

@@ -1,5 +1,11 @@
 import type { HelpAppId } from "./help-store";
 import type { HelpContext } from "./help-context";
+import { type HelpUploader } from "./help-attach";
+/**
+ * The help channel lives on platform-api (POST /support/messages). The shared
+ * axios instance carries the user's token and the organisation header, and
+ * refreshes a stale token.
+ */
 export declare function helpApiBase(app: HelpAppId | "other"): string;
 export type HelpKind = "help" | "problem" | "feedback";
 export interface HelpSent {
@@ -8,6 +14,22 @@ export interface HelpSent {
     status: string;
     created_at: string;
 }
+/** An image on a message or a follow-up; url works for a few minutes. */
+export interface HelpImage {
+    id: string;
+    file_name: string;
+    content_type: string;
+    size: number;
+    url?: string;
+}
+/** One step of a thread after the message: a staff answer or the author's follow-up. */
+export interface HelpThreadEntry {
+    id: string;
+    author: "customer" | "staff";
+    body: string;
+    created_at: string;
+    images: HelpImage[];
+}
 export interface MyHelpMessage {
     id: string;
     ref: string;
@@ -16,20 +38,48 @@ export interface MyHelpMessage {
     message: string;
     status: "new" | "answered" | "closed";
     created_at: string;
+    /** The message's own images (platform-api before images: absent). */
+    images?: HelpImage[];
+    /** Staff answers only. */
     replies: Array<{
         body: string;
         created_at: string;
     }>;
+    /** Answers and follow-ups in order (platform-api before follow-ups: absent). */
+    thread?: HelpThreadEntry[];
 }
-/** A failure the dialog shows as is. */
+/** The thread of m, oldest first, from whichever shape platform-api sent. */
+export declare function helpThread(m: MyHelpMessage): HelpThreadEntry[];
+/** A failure the dialog shows as is; attachmentId names the image it is about. */
 export declare class HelpSendError extends Error {
-    readonly status?: number | undefined;
-    constructor(message: string, status?: number | undefined);
+    readonly status?: number;
+    readonly attachmentId?: string;
+    constructor(message: string, status?: number, attachmentId?: string);
 }
 export declare function sendHelpMessage(input: {
     app: HelpAppId | "other";
     kind: HelpKind;
     message: string;
     context: HelpContext;
+    attachmentIds?: string[];
 }): Promise<HelpSent>;
+/** One of the caller's messages by id or reference number ("H1004"). */
+export declare function getMyHelpMessage(app: HelpAppId | "other", key: string): Promise<MyHelpMessage>;
+/** The author writes again on their own message. */
+export declare function sendHelpFollowUp(input: {
+    app: HelpAppId | "other";
+    key: string;
+    message: string;
+    attachmentIds?: string[];
+}): Promise<{
+    id: string;
+    ref: string;
+    status: string;
+}>;
+/**
+ * The uploader the dialog uses: an upload URL from platform-api, the bytes
+ * straight to the bucket, then platform-api reads them to say whether they
+ * are an image it will take.
+ */
+export declare function helpUploader(app: HelpAppId | "other"): HelpUploader;
 export declare function listMyHelpMessages(app: HelpAppId | "other"): Promise<MyHelpMessage[]>;

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

@@ -0,0 +1,145 @@
+/**
+ * The images on a help message (and on a follow-up): what was added, what is
+ * uploading, what is ready to send, and what was refused and why.
+ *
+ * Plain state with no React and no network of its own — the uploader is
+ * handed in — so the rules are tested on their own (help-attach.test.ts):
+ * PNG, JPEG, WebP or GIF; at most 5 MB each; at most three; a paste or a drop
+ * adds the same way the file picker does; ส่ง waits for what is uploading.
+ *
+ * Kept free of imports: the tests load it straight from source.
+ */
+export declare const HELP_IMAGE_TYPES: readonly ["image/png", "image/jpeg", "image/webp", "image/gif"];
+export declare const HELP_IMAGE_ACCEPT: string;
+export declare const HELP_IMAGE_MAX_BYTES: number;
+export declare const HELP_IMAGE_MAX_COUNT = 3;
+/** The words for each refusal, per file. */
+export declare const HELP_IMAGE_ERRORS: {
+    readonly tooLarge: "ใหญ่เกิน 5 MB";
+    readonly notImage: "ไม่ใช่ไฟล์รูปภาพ (PNG, JPEG, WebP หรือ GIF)";
+    readonly tooMany: "แนบได้ไม่เกิน 3 รูป";
+    readonly failed: "อัปโหลดไม่สำเร็จ";
+};
+/** What the rules need to know about a file (a File is one). */
+export interface FileLike {
+    readonly name: string;
+    readonly size: number;
+    readonly type: string;
+}
+export type AttachStatus = "uploading" | "ready" | "failed";
+export interface AttachItem {
+    /** This dialog's own key for the item. */
+    key: string;
+    name: string;
+    size: number;
+    /** A URL the thumbnail shows (an object URL of the file). */
+    preview: string;
+    status: AttachStatus;
+    /** 0…1 while uploading. */
+    progress: number;
+    /** platform-api's upload id, once it has given one. */
+    id: string | null;
+    error: string | null;
+}
+/** A file that was not added, and why. */
+export interface AttachRejection {
+    name: string;
+    message: string;
+}
+export interface UploadHooks {
+    onProgress(fraction: number): void;
+    /** Called as soon as platform-api has named the upload. */
+    onId(id: string): void;
+    signal: AbortSignal;
+}
+/** Puts one file where platform-api can claim it; resolves when it was checked. */
+export interface HelpUploader {
+    upload(file: FileLike, hooks: UploadHooks): Promise<{
+        id: string;
+    }>;
+    /** Forget an upload that will not be sent (best effort). */
+    discard?(id: string): void;
+}
+export interface AttachOptions {
+    preview?(file: FileLike): string;
+    revoke?(url: string): void;
+    max?: number;
+}
+/** The declared type, as one of the four, or "". */
+export declare function helpImageType(type: string): string;
+/** Why a file cannot be attached, or null when it can. */
+export declare function checkHelpImage(file: FileLike): string | null;
+interface ClipboardLike {
+    readonly files?: ArrayLike<FileLike> | null;
+    readonly items?: ArrayLike<{
+        kind: string;
+        type: string;
+        getAsFile(): FileLike | null;
+    }> | null;
+    getData?(format: string): string;
+}
+/**
+ * The files a paste carries, when it is a paste of a picture: a screenshot
+ * or a copied image. A paste that carries text is text — copying a cell from
+ * a spreadsheet also puts a picture of it on the clipboard, and that is not
+ * an attachment.
+ */
+export declare function filesFromPaste(data: ClipboardLike | null | undefined): FileLike[];
+interface DataTransferLike {
+    readonly files?: ArrayLike<FileLike> | null;
+    readonly types?: ArrayLike<string> | null;
+}
+/** True while what is dragged over the dialog includes files. */
+export declare function dragHasFiles(dt: DataTransferLike | null | undefined): boolean;
+/** The files a drop carries. */
+export declare function filesFromDrop(dt: DataTransferLike | null | undefined): FileLike[];
+/**
+ * The images being attached to one message. Subscribe to redraw; every
+ * change replaces items and rejections with new arrays.
+ */
+export declare class HelpAttachments {
+    private list;
+    private refused;
+    private readonly listeners;
+    private readonly running;
+    private readonly uploader;
+    private readonly opts;
+    constructor(uploader: HelpUploader, opts?: AttachOptions);
+    get items(): readonly AttachItem[];
+    /** The files the last add, paste or drop refused, each with its reason. */
+    get rejections(): readonly AttachRejection[];
+    get max(): number;
+    /** True while any image is still uploading. */
+    get uploading(): boolean;
+    /** How many more can be added. */
+    get room(): number;
+    subscribe(fn: () => void): () => void;
+    private emit;
+    private patch;
+    /**
+     * Adds files: each is checked, the first ones that fit are uploaded at
+     * once, and every one refused is named with its reason.
+     */
+    add(files: Iterable<FileLike>): void;
+    private start;
+    /** Takes an image off: stops its upload and forgets it on the server. */
+    remove(key: string): void;
+    /** Marks the image platform-api refused on sending (it names it by id). */
+    refuse(id: string, message: string): void;
+    dismissRejections(): void;
+    /**
+     * Waits until nothing is uploading, then says what can be sent: the ids
+     * of the ready images in the order they are shown, and the ones that
+     * failed. ส่ง calls this, so a send never leaves without its images.
+     */
+    settled(): Promise<{
+        ids: string[];
+        failed: AttachItem[];
+    }>;
+    /**
+     * Empties the list. sent: the images went with a message — nothing to
+     * forget on the server. Otherwise every upload made is discarded.
+     */
+    clear(sent?: boolean): void;
+}
+export {};

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

@@ -7,7 +7,9 @@ export interface HelpDialogHostProps {
 }
 /**
  * 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.
+ * the user menu open it with openHelp(), and a page address with
+ * ?help=H1004 (the ตอบกลับ button in a staff answer) opens it on that
+ * message. 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-images.d.ts

@@ -0,0 +1,42 @@
+import * as React from "react";
+import { HelpAttachments, type AttachItem, type AttachRejection } from "./help-attach";
+import { type HelpImage } from "./help-api";
+import type { HelpAppId } from "./help-store";
+export interface HelpAttachState {
+    attach: HelpAttachments;
+    items: readonly AttachItem[];
+    rejections: readonly AttachRejection[];
+}
+/** One message's images, uploading as they are added. */
+export declare function useHelpAttachments(app: HelpAppId | "other"): HelpAttachState;
+/**
+ * Paste and drop for a form that takes images: spread onto the form. A
+ * pasted screenshot or a dropped file is added like a picked one.
+ */
+export declare function useHelpImageDrop(attach: HelpAttachments, enabled: boolean): {
+    over: boolean;
+    props: {
+        onPaste: (e: React.ClipboardEvent) => void;
+        onDragEnter: (e: React.DragEvent) => void;
+        onDragOver: (e: React.DragEvent) => void;
+        onDragLeave: (e: React.DragEvent) => void;
+        onDrop: (e: React.DragEvent) => void;
+    };
+};
+export interface HelpAttachFieldProps {
+    state: HelpAttachState;
+    disabled?: boolean;
+    /** Ties the hidden file input to the button, for tests and labels. */
+    id: string;
+}
+/**
+ * แนบรูป: the button that opens the file picker (on a phone, the photo
+ * library or the camera), the thumbnails with their progress and a remove
+ * button each, and a line per file that was refused.
+ */
+export declare function HelpAttachField({ state, disabled, id }: HelpAttachFieldProps): import("react/jsx-runtime").JSX.Element;
+/** Images already sent: thumbnails that open the full image. */
+export declare function HelpImageStrip({ images, size }: {
+    images?: HelpImage[];
+    size?: "sm" | "md";
+}): import("react/jsx-runtime").JSX.Element | null;

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

@@ -0,0 +1,15 @@
+/**
+ * The ตอบกลับ link in a staff answer e-mail opens the app with ?help=H1004:
+ * the shell's ช่วยเหลือ dialog then opens on that message. Any app page
+ * with the shell's layout works; the e-mail uses Platform.
+ *
+ * Kept free of imports: the tests load it straight from source.
+ */
+export declare const HELP_LINK_PARAM = "help";
+/** The message a page address asks the dialog to open, or null. */
+export declare function helpRefFromSearch(search: string | null | undefined): string | null;
+/**
+ * The same address without ?help=, so a reload or a shared link does not
+ * open the dialog again. Everything else in it is kept.
+ */
+export declare function withoutHelpParam(href: string): string;

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

@@ -8,8 +8,20 @@ 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. */
+/** Opens the dialog on one of the person's messages, by id or "H1004". */
+export declare function openHelpOn(ref: string): void;
+/** The message the dialog was asked to open on, if it has not been left. */
+export declare function pendingHelpRef(): string | null;
+/** The dialog moved on from the message it was opened on. */
+export declare function clearPendingHelpRef(): void;
+/**
+ * Called by the dialog host on mount; returns its unmount. A host that
+ * mounts while a message is waiting to be shown (a page that mounted its
+ * layout twice) opens the dialog again.
+ */
 export declare function registerHelpHost(): () => void;
+/** Whether the dialog is open now (outside React). */
+export declare function isHelpOpen(): boolean;
 export declare function useHelpOpen(): boolean;
 /** True while a dialog host is mounted, i.e. the ช่วยเหลือ entry works. */
 export declare function useHelpAvailable(): boolean;

package/dist/http/platform-api.d.ts

@@ -0,0 +1,2 @@
+import type { HelpAppId } from "../help/help-store";
+export declare function platformApiBase(app: HelpAppId | "other"): string;

package/dist/index.d.ts

@@ -14,6 +14,8 @@ export { TapMenu } from "./navigation/tap-menu";
 export { NavTools } from "./navigation/nav-tools";
 export { AppBreadcrumb } from "./navigation/app-breadcrumb";
 export { NavUser, type NavUserProps, type NavUserSystemLink } from "./navigation/nav-user";
+export { useMyRoles, myRolesQueryKey } from "./navigation/use-my-roles";
+export { parseMyRoles, roleSummary, OWNER_CHIP, type MyRole, type MyRoles, } from "./navigation/my-roles";
 export { buildSystemLinks, type BuildSystemLinksOptions, type ErpAppId, } from "./navigation/app-registry";
 export { PLAN_FEATURES, hasPlanFeature, type PlanFeatureKey, } from "./lib/plan-features";
 export { NavMain, type NavMainProps } from "./navigation/nav-main";