@brownandroot/api 0.6.0 → 0.7.0

package/README.md

@@ -1,6 +1,6 @@
 # @brownandroot/api
 
-TypeScript client for the Brown & Root APIHub employee data service.
+Read-only TypeScript client for the Brown & Root APIHub data service. All methods are GET-only — no create, update, or delete operations are supported.
 
 ## Installation
 
@@ -21,47 +21,67 @@ const client = new ApiHubClient({
 
 ## Usage
 
-### Get all employees
+### Employees
 
 ```typescript
 const employees = await client.getEmployees()
+const employee = await client.getEmployee(12345)
+const results = await client.searchByName('John')
+const results = await client.searchByEmail('john@example.com')
+const reports = await client.getBySupervisor(12345)
+const chain = await client.getSupervisorChain(12345)
+const { jde, employee } = await client.getJdeFromEmail('john@example.com')
 ```
 
-### Get a single employee
+### Business Units
 
 ```typescript
-const employee = await client.getEmployee(12345)
+const units = await client.getBusinessUnits()
+const unit = await client.getBusinessUnit('BU001')
 ```
 
-### Search by name
-
-Case-insensitive partial match:
+### Cost Codes
 
 ```typescript
-const results = await client.searchByName('John')
+const codes = await client.getCostcodes()
+const code = await client.getCostcode('CC001')
 ```
 
-### Get employees by supervisor
+### Pay Types
 
 ```typescript
-const reports = await client.getBySupervisor(12345)
+const types = await client.getPaytypes()
+const type = await client.getPaytype('PT001')
 ```
 
-### Get supervisor chain
+### Work Orders
+
+```typescript
+const orders = await client.getWorkorders()
+const order = await client.getWorkorder('WO001')
+```
 
-Returns the chain of supervisors above an employee (excludes the employee themselves):
+### LLM Logs
 
 ```typescript
-const chain = await client.getSupervisorChain(12345)
-// [directSupervisor, theirSupervisor, ...]
+const logs = await client.getLlmLogs()
 ```
 
 ## Types
 
-The package exports the `Employee` interface and `ApiHubClientOptions`:
+The package exports interfaces for all resource types:
 
 ```typescript
-import type { Employee, ApiHubClientOptions } from '@brownandroot/api'
+import type {
+	Employee,
+	BusinessUnit,
+	Costcode,
+	Paytype,
+	Shift,
+	Workorder,
+	LlmLog,
+	ApiHubClientOptions,
+} from '@brownandroot/api'
 ```
 
 ## Error Handling

package/dist/index.d.ts

@@ -2,7 +2,7 @@
  * Employee type matching the API response shape.
  */
 export interface Employee {
-    employeeId: number | null;
+    employeeId: string;
     name: string | null;
     email: string | null;
     badgeNumber: string | null;
@@ -26,22 +26,25 @@ export interface Employee {
     reportingLevel: string | null;
     recordType: string | null;
     payCycleCode: string | null;
-    dateTimeStamps: string | null;
     benefitGroup: string | null;
-    supervisor: number | null;
+    supervisor: string | null;
     adjustedServiceDate: string | null;
     departmentCode: string | null;
-    dateUpdated: string | null;
     nccerNumber: string | null;
-    mentor: number | null;
+    mentor: string | null;
     source: string | null;
     createdAt: string | null;
+    updatedAtJulian: number | null;
     updatedAt: string | null;
 }
 export interface ApiHubClientOptions {
     baseUrl: string;
     apiKey: string;
 }
+export interface DropdownOption {
+    value: number | string;
+    label: string;
+}
 /**
  * LLM log entry matching the API response shape.
  */
@@ -55,22 +58,6 @@ export interface LlmLog {
     totalTokens: number | null;
     createdAt: string | null;
 }
-export interface CreateLlmLogInput {
-    source: string;
-    user: string;
-    function?: string;
-    tokensIn?: number;
-    tokensOut?: number;
-    totalTokens?: number;
-}
-export interface UpdateLlmLogInput {
-    source?: string;
-    user?: string;
-    function?: string;
-    tokensIn?: number;
-    tokensOut?: number;
-    totalTokens?: number;
-}
 export interface BusinessUnit {
     id: string;
     companyId: string;
@@ -115,21 +102,6 @@ export interface Paytype {
     perDiemPayType: boolean;
     type: string | null;
 }
-export interface Shift {
-    drky: string;
-    drsy: string | null;
-    drrt: string | null;
-    drdl01: string | null;
-    drdl02: string | null;
-    drsphd: string | null;
-    drudco: string | null;
-    drhrdc: string | null;
-    druser: string | null;
-    drpid: string | null;
-    drumpmj: string | null;
-    drjobn: string | null;
-    drupmt: string | null;
-}
 export interface Workorder {
     id: string;
     businessUnitId: string;
@@ -152,19 +124,20 @@ export declare class ApiHubClient {
     private apiKey;
     constructor(options: ApiHubClientOptions);
     private request;
-    private requestWithBody;
     /** Get all employees */
     getEmployees(): Promise<Employee[]>;
+    /** Get employees formatted for dropdown controls */
+    getEmployeesDropdown(): Promise<DropdownOption[]>;
     /** Get a single employee by employeeId */
-    getEmployee(employeeId: number): Promise<Employee>;
+    getEmployee(employeeId: string): Promise<Employee>;
     /** Search employees by name (case-insensitive partial match) */
     searchByName(name: string): Promise<Employee[]>;
     /** Get all employees reporting to a supervisor */
-    getBySupervisor(supervisorId: number): Promise<Employee[]>;
+    getBySupervisor(supervisorId: string): Promise<Employee[]>;
     /** Search employees by email (case-insensitive partial match) */
     searchByEmail(email: string): Promise<Employee[]>;
     /** Get the supervisor chain above an employee */
-    getSupervisorChain(employeeId: number): Promise<Employee[]>;
+    getSupervisorChain(employeeId: string): Promise<Employee[]>;
     /** Look up JDE number and employee data from email (with JDEService/CoreService fallback) */
     getJdeFromEmail(email: string): Promise<{
         jde: string | null;
@@ -172,33 +145,16 @@ export declare class ApiHubClient {
     }>;
     /** List all LLM log entries (newest first) */
     getLlmLogs(): Promise<LlmLog[]>;
-    /** Create a new LLM log entry */
-    createLlmLog(input: CreateLlmLogInput): Promise<LlmLog>;
-    /** Update an existing LLM log entry */
-    updateLlmLog(id: number, input: UpdateLlmLogInput): Promise<LlmLog>;
     getBusinessUnits(): Promise<BusinessUnit[]>;
+    getBusinessUnitsDropdown(): Promise<DropdownOption[]>;
     getBusinessUnit(id: string): Promise<BusinessUnit>;
-    createBusinessUnit(input: Partial<BusinessUnit>): Promise<BusinessUnit>;
-    updateBusinessUnit(id: string, input: Partial<BusinessUnit>): Promise<BusinessUnit>;
-    deleteBusinessUnit(id: string): Promise<BusinessUnit>;
     getCostcodes(): Promise<Costcode[]>;
+    getCostcodesDropdown(): Promise<DropdownOption[]>;
     getCostcode(id: string): Promise<Costcode>;
-    createCostcode(input: Partial<Costcode>): Promise<Costcode>;
-    updateCostcode(id: string, input: Partial<Costcode>): Promise<Costcode>;
-    deleteCostcode(id: string): Promise<Costcode>;
     getPaytypes(): Promise<Paytype[]>;
+    getPaytypesDropdown(): Promise<DropdownOption[]>;
     getPaytype(id: string): Promise<Paytype>;
-    createPaytype(input: Partial<Paytype>): Promise<Paytype>;
-    updatePaytype(id: string, input: Partial<Paytype>): Promise<Paytype>;
-    deletePaytype(id: string): Promise<Paytype>;
-    getShifts(): Promise<Shift[]>;
-    getShift(id: string): Promise<Shift>;
-    createShift(input: Partial<Shift>): Promise<Shift>;
-    updateShift(id: string, input: Partial<Shift>): Promise<Shift>;
-    deleteShift(id: string): Promise<Shift>;
     getWorkorders(): Promise<Workorder[]>;
+    getWorkordersDropdown(): Promise<DropdownOption[]>;
     getWorkorder(id: string): Promise<Workorder>;
-    createWorkorder(input: Partial<Workorder>): Promise<Workorder>;
-    updateWorkorder(id: string, input: Partial<Workorder>): Promise<Workorder>;
-    deleteWorkorder(id: string): Promise<Workorder>;
 }

package/dist/index.js

@@ -15,25 +15,17 @@ export class ApiHubClient {
         }
         return res.json();
     }
-    async requestWithBody(path, method, body) {
-        const res = await fetch(`${this.baseUrl}${path}`, {
-            method,
-            headers: { 'x-api-key': this.apiKey, 'Content-Type': 'application/json' },
-            body: JSON.stringify(body),
-        });
-        if (!res.ok) {
-            const respBody = await res.json().catch(() => ({}));
-            throw new Error(respBody.error ?? `Request failed: ${res.status}`);
-        }
-        return res.json();
-    }
     /** Get all employees */
     async getEmployees() {
         return this.request('/employees');
     }
+    /** Get employees formatted for dropdown controls */
+    async getEmployeesDropdown() {
+        return this.request('/employees/dropdown');
+    }
     /** Get a single employee by employeeId */
     async getEmployee(employeeId) {
-        return this.request(`/employees/${employeeId}`);
+        return this.request(`/employees/${encodeURIComponent(employeeId)}`);
     }
     /** Search employees by name (case-insensitive partial match) */
     async searchByName(name) {
@@ -41,7 +33,7 @@ export class ApiHubClient {
     }
     /** Get all employees reporting to a supervisor */
     async getBySupervisor(supervisorId) {
-        return this.request(`/employees/by-supervisor/${supervisorId}`);
+        return this.request(`/employees/by-supervisor/${encodeURIComponent(supervisorId)}`);
     }
     /** Search employees by email (case-insensitive partial match) */
     async searchByEmail(email) {
@@ -49,7 +41,7 @@ export class ApiHubClient {
     }
     /** Get the supervisor chain above an employee */
     async getSupervisorChain(employeeId) {
-        return this.request(`/employees/${employeeId}/supervisor-chain`);
+        return this.request(`/employees/${encodeURIComponent(employeeId)}/supervisor-chain`);
     }
     /** Look up JDE number and employee data from email (with JDEService/CoreService fallback) */
     async getJdeFromEmail(email) {
@@ -62,102 +54,52 @@ export class ApiHubClient {
     async getLlmLogs() {
         return this.request('/llm-logs');
     }
-    /** Create a new LLM log entry */
-    async createLlmLog(input) {
-        return this.requestWithBody('/llm-logs', 'POST', input);
-    }
-    /** Update an existing LLM log entry */
-    async updateLlmLog(id, input) {
-        return this.requestWithBody(`/llm-logs/${id}`, 'PATCH', input);
-    }
     // -----------------------------------------------------------------------
     // Business Units
     // -----------------------------------------------------------------------
     async getBusinessUnits() {
         return this.request('/business-units');
     }
+    async getBusinessUnitsDropdown() {
+        return this.request('/business-units/dropdown');
+    }
     async getBusinessUnit(id) {
         return this.request(`/business-units/${encodeURIComponent(id)}`);
     }
-    async createBusinessUnit(input) {
-        return this.requestWithBody('/business-units', 'POST', input);
-    }
-    async updateBusinessUnit(id, input) {
-        return this.requestWithBody(`/business-units/${encodeURIComponent(id)}`, 'PATCH', input);
-    }
-    async deleteBusinessUnit(id) {
-        return this.requestWithBody(`/business-units/${encodeURIComponent(id)}`, 'DELETE', {});
-    }
     // -----------------------------------------------------------------------
     // Cost Codes
     // -----------------------------------------------------------------------
     async getCostcodes() {
         return this.request('/costcodes');
     }
+    async getCostcodesDropdown() {
+        return this.request('/costcodes/dropdown');
+    }
     async getCostcode(id) {
         return this.request(`/costcodes/${encodeURIComponent(id)}`);
     }
-    async createCostcode(input) {
-        return this.requestWithBody('/costcodes', 'POST', input);
-    }
-    async updateCostcode(id, input) {
-        return this.requestWithBody(`/costcodes/${encodeURIComponent(id)}`, 'PATCH', input);
-    }
-    async deleteCostcode(id) {
-        return this.requestWithBody(`/costcodes/${encodeURIComponent(id)}`, 'DELETE', {});
-    }
     // -----------------------------------------------------------------------
     // Pay Types
     // -----------------------------------------------------------------------
     async getPaytypes() {
         return this.request('/paytypes');
     }
+    async getPaytypesDropdown() {
+        return this.request('/paytypes/dropdown');
+    }
     async getPaytype(id) {
         return this.request(`/paytypes/${encodeURIComponent(id)}`);
     }
-    async createPaytype(input) {
-        return this.requestWithBody('/paytypes', 'POST', input);
-    }
-    async updatePaytype(id, input) {
-        return this.requestWithBody(`/paytypes/${encodeURIComponent(id)}`, 'PATCH', input);
-    }
-    async deletePaytype(id) {
-        return this.requestWithBody(`/paytypes/${encodeURIComponent(id)}`, 'DELETE', {});
-    }
-    // -----------------------------------------------------------------------
-    // Shifts
-    // -----------------------------------------------------------------------
-    async getShifts() {
-        return this.request('/shifts');
-    }
-    async getShift(id) {
-        return this.request(`/shifts/${encodeURIComponent(id)}`);
-    }
-    async createShift(input) {
-        return this.requestWithBody('/shifts', 'POST', input);
-    }
-    async updateShift(id, input) {
-        return this.requestWithBody(`/shifts/${encodeURIComponent(id)}`, 'PATCH', input);
-    }
-    async deleteShift(id) {
-        return this.requestWithBody(`/shifts/${encodeURIComponent(id)}`, 'DELETE', {});
-    }
     // -----------------------------------------------------------------------
     // Work Orders
     // -----------------------------------------------------------------------
     async getWorkorders() {
         return this.request('/workorders');
     }
+    async getWorkordersDropdown() {
+        return this.request('/workorders/dropdown');
+    }
     async getWorkorder(id) {
         return this.request(`/workorders/${encodeURIComponent(id)}`);
     }
-    async createWorkorder(input) {
-        return this.requestWithBody('/workorders', 'POST', input);
-    }
-    async updateWorkorder(id, input) {
-        return this.requestWithBody(`/workorders/${encodeURIComponent(id)}`, 'PATCH', input);
-    }
-    async deleteWorkorder(id) {
-        return this.requestWithBody(`/workorders/${encodeURIComponent(id)}`, 'DELETE', {});
-    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@brownandroot/api",
-	"version": "0.6.0",
+	"version": "0.7.0",
 	"type": "module",
 	"repository": {
 		"type": "git",