@wilnertech/halopsa-mcp-server 1.0.0

package/dist/tools/users.d.ts

@@ -0,0 +1,317 @@
+/**
+ * HaloPSA User tools with token optimization
+ * Provides CRUD operations for users with caching and deduplication
+ *
+ * CRITICAL: Users are a secondary billing entity
+ * - Only ACTIVE users (inactive=false) count toward billing
+ * - Duplicates cause billing errors = revenue loss
+ */
+import { z } from 'zod';
+import type { HaloPSAAPIClient } from '../api/client.js';
+import type { ZodToolDefinition } from './registry.js';
+/**
+ * List users schema
+ */
+export declare const ListUsersArgsSchema: z.ZodObject<{
+    client_id: z.ZodOptional<z.ZodNumber>;
+    site_id: z.ZodOptional<z.ZodNumber>;
+    search: z.ZodOptional<z.ZodString>;
+    count: z.ZodOptional<z.ZodNumber>;
+    page_no: z.ZodOptional<z.ZodNumber>;
+    includeactive: z.ZodOptional<z.ZodBoolean>;
+    includeinactive: z.ZodOptional<z.ZodBoolean>;
+    format_options: z.ZodOptional<z.ZodObject<{
+        format: z.ZodOptional<z.ZodEnum<["compact", "standard", "detailed"]>>;
+        fields: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        omit_empty: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        format?: "compact" | "standard" | "detailed" | undefined;
+        fields?: string[] | undefined;
+        omit_empty?: boolean | undefined;
+    }, {
+        format?: "compact" | "standard" | "detailed" | undefined;
+        fields?: string[] | undefined;
+        omit_empty?: boolean | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    client_id?: number | undefined;
+    count?: number | undefined;
+    page_no?: number | undefined;
+    site_id?: number | undefined;
+    search?: string | undefined;
+    includeactive?: boolean | undefined;
+    includeinactive?: boolean | undefined;
+    format_options?: {
+        format?: "compact" | "standard" | "detailed" | undefined;
+        fields?: string[] | undefined;
+        omit_empty?: boolean | undefined;
+    } | undefined;
+}, {
+    client_id?: number | undefined;
+    count?: number | undefined;
+    page_no?: number | undefined;
+    site_id?: number | undefined;
+    search?: string | undefined;
+    includeactive?: boolean | undefined;
+    includeinactive?: boolean | undefined;
+    format_options?: {
+        format?: "compact" | "standard" | "detailed" | undefined;
+        fields?: string[] | undefined;
+        omit_empty?: boolean | undefined;
+    } | undefined;
+}>;
+/**
+ * Get single user schema
+ */
+export declare const GetUserArgsSchema: z.ZodObject<{
+    user_id: z.ZodNumber;
+    format_options: z.ZodOptional<z.ZodObject<{
+        format: z.ZodOptional<z.ZodEnum<["compact", "standard", "detailed"]>>;
+        fields: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        omit_empty: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        format?: "compact" | "standard" | "detailed" | undefined;
+        fields?: string[] | undefined;
+        omit_empty?: boolean | undefined;
+    }, {
+        format?: "compact" | "standard" | "detailed" | undefined;
+        fields?: string[] | undefined;
+        omit_empty?: boolean | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    user_id: number;
+    format_options?: {
+        format?: "compact" | "standard" | "detailed" | undefined;
+        fields?: string[] | undefined;
+        omit_empty?: boolean | undefined;
+    } | undefined;
+}, {
+    user_id: number;
+    format_options?: {
+        format?: "compact" | "standard" | "detailed" | undefined;
+        fields?: string[] | undefined;
+        omit_empty?: boolean | undefined;
+    } | undefined;
+}>;
+/**
+ * Search users by email schema
+ */
+export declare const SearchUsersByEmailArgsSchema: z.ZodObject<{
+    email: z.ZodString;
+    client_id: z.ZodOptional<z.ZodNumber>;
+    format_options: z.ZodOptional<z.ZodObject<{
+        format: z.ZodOptional<z.ZodEnum<["compact", "standard", "detailed"]>>;
+        fields: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        omit_empty: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        format?: "compact" | "standard" | "detailed" | undefined;
+        fields?: string[] | undefined;
+        omit_empty?: boolean | undefined;
+    }, {
+        format?: "compact" | "standard" | "detailed" | undefined;
+        fields?: string[] | undefined;
+        omit_empty?: boolean | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    email: string;
+    client_id?: number | undefined;
+    format_options?: {
+        format?: "compact" | "standard" | "detailed" | undefined;
+        fields?: string[] | undefined;
+        omit_empty?: boolean | undefined;
+    } | undefined;
+}, {
+    email: string;
+    client_id?: number | undefined;
+    format_options?: {
+        format?: "compact" | "standard" | "detailed" | undefined;
+        fields?: string[] | undefined;
+        omit_empty?: boolean | undefined;
+    } | undefined;
+}>;
+/**
+ * Create user schema
+ */
+export declare const CreateUserArgsSchema: z.ZodObject<{
+    client_id: z.ZodNumber;
+    site_id: z.ZodOptional<z.ZodNumber>;
+    name: z.ZodString;
+    emailaddress: z.ZodOptional<z.ZodString>;
+    username: z.ZodOptional<z.ZodString>;
+    inactive: z.ZodOptional<z.ZodBoolean>;
+    user_customfields: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        id: number;
+    }, {
+        value: string;
+        id: number;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    client_id: number;
+    name: string;
+    inactive?: boolean | undefined;
+    emailaddress?: string | undefined;
+    site_id?: number | undefined;
+    username?: string | undefined;
+    user_customfields?: {
+        value: string;
+        id: number;
+    }[] | undefined;
+}, {
+    client_id: number;
+    name: string;
+    inactive?: boolean | undefined;
+    emailaddress?: string | undefined;
+    site_id?: number | undefined;
+    username?: string | undefined;
+    user_customfields?: {
+        value: string;
+        id: number;
+    }[] | undefined;
+}>;
+/**
+ * Update user schema
+ */
+export declare const UpdateUserArgsSchema: z.ZodObject<{
+    user_id: z.ZodNumber;
+    site_id: z.ZodOptional<z.ZodNumber>;
+    name: z.ZodOptional<z.ZodString>;
+    emailaddress: z.ZodOptional<z.ZodString>;
+    username: z.ZodOptional<z.ZodString>;
+    inactive: z.ZodOptional<z.ZodBoolean>;
+    user_customfields: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        id: number;
+    }, {
+        value: string;
+        id: number;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    user_id: number;
+    name?: string | undefined;
+    inactive?: boolean | undefined;
+    emailaddress?: string | undefined;
+    site_id?: number | undefined;
+    username?: string | undefined;
+    user_customfields?: {
+        value: string;
+        id: number;
+    }[] | undefined;
+}, {
+    user_id: number;
+    name?: string | undefined;
+    inactive?: boolean | undefined;
+    emailaddress?: string | undefined;
+    site_id?: number | undefined;
+    username?: string | undefined;
+    user_customfields?: {
+        value: string;
+        id: number;
+    }[] | undefined;
+}>;
+/**
+ * Find user match schema (deduplication)
+ */
+export declare const FindUserMatchArgsSchema: z.ZodObject<{
+    email: z.ZodOptional<z.ZodString>;
+    upn: z.ZodOptional<z.ZodString>;
+    username: z.ZodOptional<z.ZodString>;
+    client_id: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    client_id: number;
+    email?: string | undefined;
+    username?: string | undefined;
+    upn?: string | undefined;
+}, {
+    client_id: number;
+    email?: string | undefined;
+    username?: string | undefined;
+    upn?: string | undefined;
+}>;
+/**
+ * Scan user duplicates schema
+ */
+export declare const ScanUserDuplicatesArgsSchema: z.ZodObject<{
+    client_id: z.ZodOptional<z.ZodNumber>;
+    format_options: z.ZodOptional<z.ZodObject<{
+        format: z.ZodOptional<z.ZodEnum<["compact", "standard", "detailed"]>>;
+        fields: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        omit_empty: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        format?: "compact" | "standard" | "detailed" | undefined;
+        fields?: string[] | undefined;
+        omit_empty?: boolean | undefined;
+    }, {
+        format?: "compact" | "standard" | "detailed" | undefined;
+        fields?: string[] | undefined;
+        omit_empty?: boolean | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    client_id?: number | undefined;
+    format_options?: {
+        format?: "compact" | "standard" | "detailed" | undefined;
+        fields?: string[] | undefined;
+        omit_empty?: boolean | undefined;
+    } | undefined;
+}, {
+    client_id?: number | undefined;
+    format_options?: {
+        format?: "compact" | "standard" | "detailed" | undefined;
+        fields?: string[] | undefined;
+        omit_empty?: boolean | undefined;
+    } | undefined;
+}>;
+/**
+ * List users with optional filtering and token optimization
+ * Uses 1-minute cache TTL (billing-critical data)
+ */
+export declare function listUsers(client: HaloPSAAPIClient, args: z.infer<typeof ListUsersArgsSchema>): Promise<string>;
+/**
+ * Get a single user by ID with full details
+ */
+export declare function getUser(client: HaloPSAAPIClient, args: z.infer<typeof GetUserArgsSchema>): Promise<string>;
+/**
+ * Search users by email address
+ * Returns warning if multiple found (potential duplicates)
+ */
+export declare function searchUsersByEmail(client: HaloPSAAPIClient, args: z.infer<typeof SearchUsersByEmailArgsSchema>): Promise<string>;
+/**
+ * Create a new user
+ * Invalidates user cache on success
+ */
+export declare function createUser(client: HaloPSAAPIClient, args: z.infer<typeof CreateUserArgsSchema>): Promise<string>;
+/**
+ * Update an existing user
+ * Invalidates user cache on success
+ */
+export declare function updateUser(client: HaloPSAAPIClient, args: z.infer<typeof UpdateUserArgsSchema>): Promise<string>;
+/**
+ * Find matching user using deduplication algorithm
+ * Returns confidence scoring and action recommendation
+ *
+ * Confidence Thresholds:
+ * - 100%: Exact email match -> Auto-update
+ * - 95%: UPN match (Entra source of truth) -> Auto-update
+ * - 70%: Username match only -> Manual review
+ * - 0%: No match -> Create new
+ */
+export declare function findUserMatch(client: HaloPSAAPIClient, args: z.infer<typeof FindUserMatchArgsSchema>): Promise<string>;
+/**
+ * Scan for duplicate users
+ * Returns groups of duplicate entities with confidence scores
+ */
+export declare function scanUserDuplicates(client: HaloPSAAPIClient, args: z.infer<typeof ScanUserDuplicatesArgsSchema>): Promise<string>;
+export declare const listUsersTool: ZodToolDefinition;
+export declare const getUserTool: ZodToolDefinition;
+export declare const searchUsersByEmailTool: ZodToolDefinition;
+export declare const createUserTool: ZodToolDefinition;
+export declare const updateUserTool: ZodToolDefinition;
+export declare const findUserMatchTool: ZodToolDefinition;
+export declare const scanUserDuplicatesTool: ZodToolDefinition;
+//# sourceMappingURL=users.d.ts.map

package/dist/tools/users.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../src/tools/users.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAavD;;GAEG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgB9B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAI5B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAMvC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAkB/B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAkB/B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;EASlC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAIvC,CAAC;AAMH;;;GAGG;AACH,wBAAsB,SAAS,CAC7B,MAAM,EAAE,gBAAgB,EACxB,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,GACxC,OAAO,CAAC,MAAM,CAAC,CA8CjB;AAED;;GAEG;AACH,wBAAsB,OAAO,CAC3B,MAAM,EAAE,gBAAgB,EACxB,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,GACtC,OAAO,CAAC,MAAM,CAAC,CAQjB;AAED;;;GAGG;AACH,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,gBAAgB,EACxB,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,GACjD,OAAO,CAAC,MAAM,CAAC,CA+CjB;AAED;;;GAGG;AACH,wBAAsB,UAAU,CAC9B,MAAM,EAAE,gBAAgB,EACxB,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,GACzC,OAAO,CAAC,MAAM,CAAC,CAiCjB;AAED;;;GAGG;AACH,wBAAsB,UAAU,CAC9B,MAAM,EAAE,gBAAgB,EACxB,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,GACzC,OAAO,CAAC,MAAM,CAAC,CAwCjB;AAED;;;;;;;;;GASG;AACH,wBAAsB,aAAa,CACjC,MAAM,EAAE,gBAAgB,EACxB,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,GAC5C,OAAO,CAAC,MAAM,CAAC,CAqFjB;AAED;;;GAGG;AACH,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,gBAAgB,EACxB,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,GACjD,OAAO,CAAC,MAAM,CAAC,CAiHjB;AAMD,eAAO,MAAM,aAAa,EAAE,iBAK3B,CAAC;AAEF,eAAO,MAAM,WAAW,EAAE,iBAKzB,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,iBAKpC,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,iBAK5B,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,iBAK5B,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,iBAK/B,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,iBAKpC,CAAC"}