@webority/mobile-support 0.0.9

package/lib/typescript/module/types.d.ts

@@ -0,0 +1,152 @@
+/**
+ * Wire shapes of the Webority Support HTTP contract. Field names are the camelCase
+ * of the backend's view records and enums travel as their member names, so these
+ * mirror `Webority.Support/SupportViews.cs` and `SupportEnums.cs` exactly.
+ */
+export type SupportTicketStatus = 'Open' | 'InProgress' | 'Resolved' | 'Closed';
+export type SupportTicketPriority = 'Low' | 'Normal' | 'High' | 'Urgent';
+export type SupportMessageAuthorKind = 'Customer' | 'Agent' | 'System';
+export type SupportAttachmentKind = 'Screenshot' | 'File';
+export type SupportSatisfaction = 'Satisfied' | 'Unsatisfied';
+export interface SupportContactInfo {
+    productName: string;
+    supportEmail: string;
+    supportName: string;
+    supportPhone: string | null;
+    supportHours: string | null;
+    categories: string[];
+    maxAttachmentBytes: number;
+    maxAttachmentsPerMessage: number;
+    allowedContentTypes: string[];
+    subjectMaxLength: number;
+    bodyMaxLength: number;
+    satisfactionCommentMaxLength: number;
+}
+export interface SupportTicketSummary {
+    id: string;
+    number: string;
+    category: string;
+    subject: string;
+    status: SupportTicketStatus;
+    statusLabel: string;
+    messageCount: number;
+    awaitingCustomer: boolean;
+    createdDateTimeUtc: string;
+    updatedDateTimeUtc: string;
+}
+/** The fleet pagination shape `GET {base}/tickets` returns. */
+export interface SupportPage<T> {
+    items: T[];
+    page: number;
+    pageSize: number;
+    totalCount: number;
+    totalPages: number;
+}
+/** `GET {base}/tickets`. Empty or missing fields are left off the request. */
+export interface SupportTicketQuery {
+    status?: SupportTicketStatus;
+    /** Matches the subject or the ticket number. */
+    search?: string;
+    /** 1-based. The server defaults to 1. */
+    page?: number;
+    /** The server defaults to 20 and caps at 100. */
+    pageSize?: number;
+}
+/** `GET {base}/tickets/counts`: the caller's tickets by status. */
+export interface SupportTicketCounts {
+    open: number;
+    inProgress: number;
+    resolved: number;
+    closed: number;
+    total: number;
+}
+export interface SupportAttachmentView {
+    id: string;
+    fileName: string;
+    contentType: string;
+    sizeBytes: number;
+    kind: SupportAttachmentKind;
+}
+export interface SupportMessageView {
+    id: string;
+    authorKind: SupportMessageAuthorKind;
+    authorName: string | null;
+    body: string;
+    isInternal: boolean;
+    createdDateTimeUtc: string;
+    attachments: SupportAttachmentView[];
+}
+export interface SupportTicketDetail {
+    id: string;
+    number: string;
+    /** Null on the customer view: internal ids never leave the platform. */
+    accountId: number | null;
+    /** Null on the customer view. */
+    realm: string | null;
+    category: string;
+    subject: string;
+    status: SupportTicketStatus;
+    statusLabel: string;
+    priority: SupportTicketPriority | null;
+    reporterName: string;
+    reporterEmail: string;
+    assignedAgentUserId: number | null;
+    assignedAgentName: string | null;
+    dueDateTimeUtc: string | null;
+    isOverdue: boolean;
+    pageUrl: string | null;
+    userAgent: string | null;
+    appVersion: string | null;
+    satisfaction: SupportSatisfaction | null;
+    satisfactionComment: string | null;
+    canReopen: boolean;
+    canRate: boolean;
+    createdDateTimeUtc: string;
+    updatedDateTimeUtc: string;
+    resolvedDateTimeUtc: string | null;
+    closedDateTimeUtc: string | null;
+    messages: SupportMessageView[];
+    /** Opaque. Changes whenever the ticket changes. */
+    version: string;
+}
+/** A local file as React Native's FormData takes it. */
+export interface SupportFilePart {
+    uri: string;
+    name: string;
+    type: string;
+    /** Bytes, when the picker knew it. Used for the size check only; never sent. */
+    size?: number;
+}
+export interface NewSupportTicketInput {
+    category: string;
+    subject: string;
+    body: string;
+    pageUrl?: string;
+    userAgent?: string;
+    appVersion?: string;
+    files?: SupportFilePart[];
+    screenshots?: SupportFilePart[];
+}
+export interface SupportReplyInput {
+    body: string;
+    files?: SupportFilePart[];
+    screenshots?: SupportFilePart[];
+}
+export interface SupportRatingInput {
+    satisfaction: SupportSatisfaction;
+    comment?: string;
+}
+/**
+ * What the report-an-issue flow hands to the new ticket screen: the captured
+ * screenshot and where it was taken.
+ */
+export interface SupportTicketDraft {
+    category?: string;
+    subject?: string;
+    body?: string;
+    pageUrl?: string;
+    userAgent?: string;
+    appVersion?: string;
+    screenshots?: SupportFilePart[];
+}
+//# sourceMappingURL=types.d.ts.map

package/lib/typescript/module/validation.d.ts

@@ -0,0 +1,10 @@
+import type { SupportContactInfo, SupportFilePart } from './types.js';
+export declare const validateCategory: (category: string, config: SupportContactInfo) => string | undefined;
+/** Limits come from GET /settings, so the product's own values are the only copy. */
+type Limits = Pick<SupportContactInfo, 'subjectMaxLength' | 'bodyMaxLength'>;
+export declare const validateSubject: (subject: string, limits: Limits) => string | undefined;
+export declare const validateBody: (body: string, limits: Limits) => string | undefined;
+/** Checks every file on one message against the product's limits. The first problem wins. */
+export declare const validateFiles: (files: SupportFilePart[], config: SupportContactInfo) => string | undefined;
+export {};
+//# sourceMappingURL=validation.d.ts.map

package/package.json

@@ -0,0 +1,124 @@
+{
+  "name": "@webority/mobile-support",
+  "version": "0.0.9",
+  "description": "Customer support tickets for Webority React Native apps: the support API client, hooks, ticket screens, contact card and a report-an-issue button that attaches a screenshot.",
+  "keywords": [
+    "react-native",
+    "support",
+    "helpdesk",
+    "tickets",
+    "feedback",
+    "webority"
+  ],
+  "homepage": "https://www.webority.com",
+  "license": "MIT",
+  "author": {
+    "name": "Webority Technologies",
+    "email": "contact@webority.com",
+    "url": "https://www.webority.com"
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/typescript/module/index.d.ts",
+        "default": "./lib/module/index.js"
+      },
+      "require": {
+        "types": "./lib/typescript/commonjs/index.d.ts",
+        "default": "./lib/commonjs/index.js"
+      }
+    },
+    "./report": {
+      "import": {
+        "types": "./lib/typescript/module/report/index.d.ts",
+        "default": "./lib/module/report/index.js"
+      },
+      "require": {
+        "types": "./lib/typescript/commonjs/report/index.d.ts",
+        "default": "./lib/commonjs/report/index.js"
+      }
+    },
+    "./share": {
+      "import": {
+        "types": "./lib/typescript/module/share/index.d.ts",
+        "default": "./lib/module/share/index.js"
+      },
+      "require": {
+        "types": "./lib/typescript/commonjs/share/index.d.ts",
+        "default": "./lib/commonjs/share/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./lib/commonjs/index.js",
+  "module": "./lib/module/index.js",
+  "react-native": "./lib/module/index.js",
+  "types": "./lib/typescript/commonjs/index.d.ts",
+  "files": [
+    "lib",
+    "!**/__tests__",
+    "!**/*.test.*",
+    "!**/*.spec.*",
+    "!**/*.map"
+  ],
+  "scripts": {
+    "build": "bob build",
+    "clean": "rimraf lib",
+    "lint": "biome lint ./src",
+    "lint:fix": "biome lint --write ./src",
+    "test": "jest",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@webority/mobile-core": "^0.0.23",
+    "@webority/mobile-ui": "^0.0.33"
+  },
+  "peerDependencies": {
+    "expo": ">=57.0.0",
+    "expo-clipboard": ">=57.0.0",
+    "expo-file-system": ">=57.0.0",
+    "expo-image-manipulator": ">=57.0.0",
+    "expo-image-picker": ">=57.0.0",
+    "expo-sharing": ">=57.0.0",
+    "react": "^19.1.0",
+    "react-native": ">=0.81.0",
+    "react-native-gesture-handler": "^2.21.0 || ^3.0.0",
+    "react-native-view-shot": ">=4.0.0"
+  },
+  "peerDependenciesMeta": {
+    "expo-sharing": {
+      "optional": true
+    },
+    "react-native-view-shot": {
+      "optional": true
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      [
+        "commonjs",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json"
+        }
+      ]
+    ]
+  }
+}