@titus-system/syncdesk 0.3.1 → 0.4.0

package/CHANGELOG.md

@@ -0,0 +1,21 @@
+# CHANGELOG
+
+All notable changes to this project will be documented in this file.
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### Security
+
+### Dev Notes

package/README.md

@@ -14,6 +14,8 @@ npm install @titus-system/syncdesk
 
 ### Install locally
 
+Alternatively, you can install locally bypassing the npm registry.
+
 ```sh
 npm run build
 npm pack
@@ -31,7 +33,8 @@ npm install /path/to/your/library-1.0.0.tgz
 # You may have to login to npm registry first with `npm login`
 npm login
 
-npm run build && npm publish
+npm run build
+npm publish --access public
 ```
 
 ---

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@titus-system/syncdesk",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "",
   "keywords": [],
   "author": "",

package/src/auth/hooks/useAuth.ts

@@ -1,12 +1,18 @@
 import { useQuery, useMutation, useQueryClient } from "@tanstack/react-query";
 import { apiClient, ApiResponse } from "../../api";
 import {
+  AdminRegisterUserRequest,
+  ChangePasswordRequest,
+  ForgotPasswordRequest,
+  ForgotPasswordResponse,
   LoginResponse,
   RegisterUserRequest,
+  ResetPasswordRequest,
   UserCreatedResponse,
   UserLoginRequest,
   UserWithRoles,
 } from "../types/auth";
+import { User } from "../../users/types/user";
 
 const PATH = "auth";
 
@@ -93,3 +99,61 @@ export const useLogout = () => {
     },
   });
 };
+
+/**
+ * Register a new user as admin.
+ */
+export const useAdminRegister = () => {
+  const queryClient = useQueryClient();
+
+  return useMutation({
+    mutationFn: async (userData: AdminRegisterUserRequest): Promise<User> => {
+      const response = await apiClient.post<ApiResponse<User>>(
+        `${PATH}/admin/register`,
+        userData,
+      );
+      return response.data.data;
+    },
+    onSuccess: () => {
+      queryClient.invalidateQueries({ queryKey: ["users"] });
+    },
+  });
+};
+
+/**
+ * Change the password of the current user.
+ */
+export const useChangePassword = () => {
+  return useMutation({
+    mutationFn: async (data: ChangePasswordRequest): Promise<void> => {
+      await apiClient.post(`${PATH}/change-password`, data);
+    },
+  });
+};
+
+/**
+ * Request a password reset email.
+ */
+export const useForgotPassword = () => {
+  return useMutation({
+    mutationFn: async (
+      data: ForgotPasswordRequest,
+    ): Promise<ForgotPasswordResponse> => {
+      const response = await apiClient.post<
+        ApiResponse<ForgotPasswordResponse>
+      >(`${PATH}/forgot-password`, data);
+      return response.data.data;
+    },
+  });
+};
+
+/**
+ * Reset a user's password using a valid reset token.
+ */
+export const useResetPassword = () => {
+  return useMutation({
+    mutationFn: async (data: ResetPasswordRequest): Promise<void> => {
+      await apiClient.post(`${PATH}/reset-password`, data);
+    },
+  });
+};

package/src/auth/types/auth.ts

@@ -3,6 +3,8 @@ export type OAuthProvider = "local" | "google" | "microsoft";
 export interface LoginResponse {
   access_token: string;
   refresh_token: string;
+  must_change_password?: boolean;
+  must_accept_terms?: boolean;
 }
 
 export interface UserCreatedResponse {
@@ -20,11 +22,35 @@ export interface UserLoginRequest {
 
 export interface RegisterUserRequest {
   email: string;
-  name: string;
-  username: string;
+  name?: string;
+  username?: string;
   password: string;
 }
 
+export interface AdminRegisterUserRequest {
+  email: string;
+  name?: string | null;
+  role_ids?: number[];
+}
+
+export interface ChangePasswordRequest {
+  current_password: string;
+  new_password: string;
+}
+
+export interface ForgotPasswordRequest {
+  email: string;
+}
+
+export interface ResetPasswordRequest {
+  token: string;
+  new_password: string;
+}
+
+export interface ForgotPasswordResponse {
+  message: string;
+}
+
 // I am making a safe assumption for your /me route based on "user_with_roles"
 export interface UserWithRoles {
   id: string;

package/src/health/hooks/useHealth.ts

@@ -6,6 +6,8 @@ import type {
   ReadyResponse,
 } from "../types/health";
 
+const PATH = "";
+
 /**
  * Ping the server to check for basic connectivity.
  */
@@ -13,7 +15,9 @@ export const usePing = () => {
   return useQuery({
     queryKey: ["health", "ping"],
     queryFn: async (): Promise<PingResponse> => {
-      const response = await apiClient.get<ApiResponse<PingResponse>>("/ping");
+      const response = await apiClient.get<ApiResponse<PingResponse>>(
+        `${PATH}/ping`,
+      );
       return response.data.data;
     },
   });
@@ -26,8 +30,9 @@ export const useHealth = () => {
   return useQuery({
     queryKey: ["health", "status"],
     queryFn: async (): Promise<HealthResponse> => {
-      const response =
-        await apiClient.get<ApiResponse<HealthResponse>>("/health");
+      const response = await apiClient.get<ApiResponse<HealthResponse>>(
+        `${PATH}/health`,
+      );
       return response.data.data;
     },
   });
@@ -40,8 +45,9 @@ export const useReady = () => {
   return useQuery({
     queryKey: ["health", "ready"],
     queryFn: async (): Promise<ReadyResponse> => {
-      const response =
-        await apiClient.get<ApiResponse<ReadyResponse>>("/ready");
+      const response = await apiClient.get<ApiResponse<ReadyResponse>>(
+        `${PATH}/ready`,
+      );
       return response.data.data;
     },
   });

package/src/index.ts

@@ -5,6 +5,7 @@ export * from "./roles";
 export * from "./permissions";
 export * from "./live_chat";
 export * from "./health";
+export * from "./ticket";
 
 export { config } from "./config";
 export type { LibraryConfig } from "./config";

package/src/permissions/hooks/usePermissions.ts

@@ -9,12 +9,15 @@ import type {
   AddPermissionRolesDTO,
 } from "../types/permission";
 
+const PATH = "/permissions";
+
 export function usePermissions() {
   return useQuery<Permission[]>({
     queryKey: ["permissions"],
     queryFn: async () => {
-      const response =
-        await apiClient.get<ApiResponse<Permission[]>>("/permissions/");
+      const response = await apiClient.get<ApiResponse<Permission[]>>(
+        `${PATH}/`,
+      );
       return response.data.data;
     },
   });
@@ -25,7 +28,7 @@ export function usePermission(id: number) {
     queryKey: ["permissions", id],
     queryFn: async () => {
       const response = await apiClient.get<ApiResponse<Permission>>(
-        `/permissions/${id}`,
+        `${PATH}/${id}`,
       );
       return response.data.data;
     },
@@ -38,7 +41,7 @@ export function useCreatePermission() {
   return useMutation<Permission, Error, CreatePermissionDTO>({
     mutationFn: async (dto) => {
       const response = await apiClient.post<ApiResponse<Permission>>(
-        "/permissions/",
+        `${PATH}/`,
         dto,
       );
       return response.data.data;
@@ -58,7 +61,7 @@ export function useReplacePermission() {
   >({
     mutationFn: async ({ id, dto }) => {
       const response = await apiClient.put<ApiResponse<Permission>>(
-        `/permissions/${id}`,
+        `${PATH}/${id}`,
         dto,
       );
       return response.data.data;
@@ -79,7 +82,7 @@ export function useUpdatePermission() {
   >({
     mutationFn: async ({ id, dto }) => {
       const response = await apiClient.patch<ApiResponse<Permission>>(
-        `/permissions/${id}`,
+        `${PATH}/${id}`,
         dto,
       );
       return response.data.data;
@@ -96,7 +99,7 @@ export function useDeletePermission() {
   return useMutation<Permission, Error, number>({
     mutationFn: async (id) => {
       const response = await apiClient.delete<ApiResponse<Permission>>(
-        `/permissions/${id}`,
+        `${PATH}/${id}`,
       );
       return response.data.data;
     },
@@ -112,7 +115,7 @@ export function usePermissionRoles(id: number) {
     queryKey: ["permissions", id, "roles"],
     queryFn: async () => {
       const response = await apiClient.get<ApiResponse<Permission>>(
-        `/permissions/${id}/roles`,
+        `${PATH}/${id}/roles`,
       );
       return response.data.data;
     },
@@ -129,7 +132,7 @@ export function useAddPermissionRoles() {
   >({
     mutationFn: async ({ id, dto }) => {
       const response = await apiClient.post<ApiResponse<Permission>>(
-        `/permissions/${id}/roles`,
+        `${PATH}/${id}/roles`,
         dto,
       );
       return response.data.data;

package/src/roles/hooks/useRoles.ts

@@ -1,12 +1,20 @@
 import { useQuery, useMutation, useQueryClient } from "@tanstack/react-query";
 import { apiClient, ApiResponse } from "../../api";
-import type { Role, CreateRoleDTO, ReplaceRoleDTO, UpdateRoleDTO, AddRolePermissionsDTO } from "../types/role";
+import type {
+  Role,
+  CreateRoleDTO,
+  ReplaceRoleDTO,
+  UpdateRoleDTO,
+  AddRolePermissionsDTO,
+} from "../types/role";
+
+const PATH = "/roles";
 
 export function useRoles() {
   return useQuery<Role[]>({
     queryKey: ["roles"],
     queryFn: async () => {
-      const response = await apiClient.get<ApiResponse<Role[]>>("/roles/");
+      const response = await apiClient.get<ApiResponse<Role[]>>(`${PATH}/`);
       return response.data.data;
     },
   });
@@ -16,7 +24,7 @@ export function useRole(id: number) {
   return useQuery<Role>({
     queryKey: ["roles", id],
     queryFn: async () => {
-      const response = await apiClient.get<ApiResponse<Role>>(`/roles/${id}`);
+      const response = await apiClient.get<ApiResponse<Role>>(`${PATH}/${id}`);
       return response.data.data;
     },
     enabled: !!id,
@@ -27,7 +35,7 @@ export function useCreateRole() {
   const queryClient = useQueryClient();
   return useMutation<Role, Error, CreateRoleDTO>({
     mutationFn: async (dto) => {
-      const response = await apiClient.post<ApiResponse<Role>>("/roles/", dto);
+      const response = await apiClient.post<ApiResponse<Role>>(`${PATH}/`, dto);
       return response.data.data;
     },
     onSuccess: () => {
@@ -40,7 +48,10 @@ export function useReplaceRole() {
   const queryClient = useQueryClient();
   return useMutation<Role, Error, { id: number; dto: ReplaceRoleDTO }>({
     mutationFn: async ({ id, dto }) => {
-      const response = await apiClient.put<ApiResponse<Role>>(`/roles/${id}`, dto);
+      const response = await apiClient.put<ApiResponse<Role>>(
+        `${PATH}/${id}`,
+        dto,
+      );
       return response.data.data;
     },
     onSuccess: (_, { id }) => {
@@ -54,7 +65,10 @@ export function useUpdateRole() {
   const queryClient = useQueryClient();
   return useMutation<Role, Error, { id: number; dto: UpdateRoleDTO }>({
     mutationFn: async ({ id, dto }) => {
-      const response = await apiClient.patch<ApiResponse<Role>>(`/roles/${id}`, dto);
+      const response = await apiClient.patch<ApiResponse<Role>>(
+        `${PATH}/${id}`,
+        dto,
+      );
       return response.data.data;
     },
     onSuccess: (_, { id }) => {
@@ -68,7 +82,9 @@ export function useDeleteRole() {
   const queryClient = useQueryClient();
   return useMutation<Role, Error, number>({
     mutationFn: async (id) => {
-      const response = await apiClient.delete<ApiResponse<Role>>(`/roles/${id}`);
+      const response = await apiClient.delete<ApiResponse<Role>>(
+        `${PATH}/${id}`,
+      );
       return response.data.data;
     },
     onSuccess: (_, id) => {
@@ -82,7 +98,9 @@ export function useRolePermissions(id: number) {
   return useQuery<Role>({
     queryKey: ["roles", id, "permissions"],
     queryFn: async () => {
-      const response = await apiClient.get<ApiResponse<Role>>(`/roles/${id}/permissions`);
+      const response = await apiClient.get<ApiResponse<Role>>(
+        `${PATH}/${id}/permissions`,
+      );
       return response.data.data;
     },
     enabled: !!id,
@@ -93,7 +111,10 @@ export function useAddRolePermissions() {
   const queryClient = useQueryClient();
   return useMutation<Role, Error, { id: number; dto: AddRolePermissionsDTO }>({
     mutationFn: async ({ id, dto }) => {
-      const response = await apiClient.post<ApiResponse<Role>>(`/roles/${id}/permissions`, dto);
+      const response = await apiClient.post<ApiResponse<Role>>(
+        `${PATH}/${id}/permissions`,
+        dto,
+      );
       return response.data.data;
     },
     onSuccess: (_, { id }) => {

package/src/ticket/hooks/useTickets.ts

@@ -0,0 +1,77 @@
+import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
+import { apiClient, ApiResponse } from "../../api";
+import {
+  CreateTicketRequest,
+  CreateTicketResponse,
+  TicketResponse,
+  TicketSearchFilters,
+  UpdateTicketStatusRequest,
+  UpdateTicketStatusResponse,
+} from "../types/ticket";
+
+const PATH = "/tickets";
+
+// Query keys
+export const TICKET_KEYS = {
+  all: ["tickets"] as const,
+  list: (filters: TicketSearchFilters) =>
+    [...TICKET_KEYS.all, "list", filters] as const,
+};
+
+/** Get all tickets. */
+export const useTickets = (filters: TicketSearchFilters = {}) => {
+  return useQuery({
+    queryKey: TICKET_KEYS.list(filters),
+    queryFn: async (): Promise<TicketResponse[]> => {
+      const response = await apiClient.get<ApiResponse<TicketResponse[]>>(
+        `${PATH}/`,
+        { params: filters },
+      );
+      return response.data.data;
+    },
+  });
+};
+
+/** Create a new ticket. */
+export const useCreateTicket = () => {
+  const queryClient = useQueryClient();
+
+  return useMutation({
+    mutationFn: async (
+      payload: CreateTicketRequest,
+    ): Promise<CreateTicketResponse> => {
+      const response = await apiClient.post<ApiResponse<CreateTicketResponse>>(
+        `${PATH}/`,
+        payload,
+      );
+      return response.data.data;
+    },
+    onSuccess: () => {
+      // Invalidate tickets list queries on success
+      queryClient.invalidateQueries({ queryKey: TICKET_KEYS.all });
+    },
+  });
+};
+
+/** Update a ticket's status. */
+export const useUpdateTicketStatus = () => {
+  const queryClient = useQueryClient();
+
+  return useMutation({
+    mutationFn: async ({
+      ticketId,
+      payload,
+    }: {
+      ticketId: string;
+      payload: UpdateTicketStatusRequest;
+    }): Promise<UpdateTicketStatusResponse> => {
+      const response = await apiClient.patch<
+        ApiResponse<UpdateTicketStatusResponse>
+      >(`${PATH}/${ticketId}/status`, payload);
+      return response.data.data;
+    },
+    onSuccess: () => {
+      queryClient.invalidateQueries({ queryKey: TICKET_KEYS.all });
+    },
+  });
+};

package/src/ticket/index.ts

@@ -0,0 +1,2 @@
+export * from "./types/ticket";
+export * from "./hooks/useTickets";

package/src/ticket/types/ticket.ts

@@ -0,0 +1,88 @@
+export type TicketType = "issue" | "access" | "new_feature";
+export type TicketCriticality = "high" | "medium" | "low";
+export type TicketStatus =
+  | "open"
+  | "in_progress"
+  | "waiting_for_provider"
+  | "waiting_for_validation"
+  | "finished";
+
+export interface CreateTicketRequest {
+  triage_id: string; // PydanticObjectId as string
+  type: TicketType;
+  criticality: TicketCriticality;
+  product: string;
+  description: string;
+  chat_ids: string[]; // List of PydanticObjectId as string
+  client_id: string; // UUID as string
+}
+
+export interface CreateTicketResponse {
+  id: string;
+  status: TicketStatus;
+  creation_date: string; // ISO datetime
+}
+
+export interface TicketSearchFilters {
+  ticket_id?: string;
+  client_id?: string;
+  triage_id?: string;
+  status?: TicketStatus;
+  criticality?: TicketCriticality;
+  type?: TicketType;
+  product?: string;
+}
+
+export interface TicketCompanyResponse {
+  id: string;
+  name: string;
+}
+
+export interface TicketClientResponse {
+  id: string;
+  name: string;
+  email: string;
+  company: TicketCompanyResponse;
+}
+
+export interface TicketHistoryResponse {
+  agent_id: string;
+  name: string;
+  level: string;
+  assignment_date: string;
+  exit_date: string;
+  transfer_reason: string;
+}
+
+export interface TicketCommentResponse {
+  comment_id: string;
+  author: string;
+  text: string;
+  date: string;
+  internal: boolean;
+}
+
+export interface TicketResponse {
+  id: string;
+  triage_id: string;
+  type: TicketType;
+  criticality: TicketCriticality;
+  product: string;
+  status: TicketStatus;
+  creation_date: string;
+  description: string;
+  chat_ids: string[];
+  agent_history: TicketHistoryResponse[];
+  client: TicketClientResponse;
+  comments: TicketCommentResponse[];
+}
+
+export interface UpdateTicketStatusRequest {
+  status: TicketStatus;
+}
+
+export interface UpdateTicketStatusResponse {
+  id: string;
+  previous_status: TicketStatus;
+  current_status: TicketStatus;
+}