@brownandroot/api 0.15.0 → 1.1.0

package/README.md

@@ -8,7 +8,65 @@ TypeScript client for the Brown & Root APIHub data service. Provides access to e
 npm install @brownandroot/api
 ```
 
-## Setup
+---
+
+## SvelteKit Remote Functions
+
+For SvelteKit apps, the package ships ready-to-use remote functions that run on the server and read credentials from environment variables automatically — no manual client instantiation needed.
+
+### Setup
+
+Add to your app's `.env`:
+
+```
+APIHUB_URL=https://your-apihub-url.com
+APIHUB_API_KEY=your-api-key
+```
+
+Enable remote functions in `svelte.config.js` (if not already):
+
+```js
+kit: {
+  experimental: { remoteFunctions: true }
+}
+```
+
+### Usage
+
+Import directly from the domain sub-path and call in components:
+
+```svelte
+<script lang="ts">
+  import { getEmployeesDropdown } from '@brownandroot/api/employees'
+  import { getBusinessUnitsDropdown } from '@brownandroot/api/businessUnits'
+
+  const employees = $derived(await getEmployeesDropdown())
+  const businessUnits = $derived(await getBusinessUnitsDropdown())
+</script>
+```
+
+Or compose with your own remote functions:
+
+```typescript
+import { query } from '$app/server'
+import { getSupervisorChain } from '@brownandroot/api/employees'
+
+export const getMyManagers = query(async () => {
+  return (await getSupervisorChain('12345')).slice(0, 2)
+})
+```
+
+**Available sub-paths:** `employees`, `businessUnits`, `costcodes`, `paytypes`, `workorders`, `jobtypejobsteps`, `llm`, `rag`
+
+> `chatStream` is not available as a remote function — use `ApiHubClient` directly to proxy the SSE response.
+
+---
+
+## ApiHubClient (direct usage)
+
+For non-SvelteKit environments or when you need full control (caching, streaming):
+
+### Setup
 
 ```typescript
 import { ApiHubClient } from '@brownandroot/api'
@@ -171,6 +229,9 @@ interface Employee {
 const units = await client.getBusinessUnits()
 const dropdown = await client.getBusinessUnitsDropdown() // { value, label }[]
 const unit = await client.getBusinessUnit('BU001')
+
+// Search by description (case-insensitive partial match)
+const results = await client.searchBusinessUnits('west')
 ```
 
 ---
@@ -183,10 +244,13 @@ const dropdown = await client.getCostcodesDropdown() // { value, label }[]
 const code = await client.getCostcode('CC001')
 
 // Filtered by business unit
-const dropdown = await client.getCostcodesDropdownByBu('BU001')
+const buDropdown = await client.getCostcodesDropdownByBu('BU001')
 
 // Filtered by business unit and pay type
-const dropdown = await client.getCostcodesDropdownByBuAndPayType('BU001', 'PT01')
+const buPtDropdown = await client.getCostcodesDropdownByBuAndPayType('BU001', 'PT01')
+
+// Search by description or JDE cost code (case-insensitive partial match)
+const results = await client.searchCostcodes('labor')
 ```
 
 ---
@@ -197,6 +261,9 @@ const dropdown = await client.getCostcodesDropdownByBuAndPayType('BU001', 'PT01'
 const types = await client.getPaytypes()
 const dropdown = await client.getPaytypesDropdown() // { value, label, payClass }[]
 const type = await client.getPaytype('PT001')
+
+// Search by description (case-insensitive partial match)
+const results = await client.searchPaytypes('regular')
 ```
 
 ---
@@ -209,7 +276,10 @@ const dropdown = await client.getWorkordersDropdown() // { value, label }[]
 const order = await client.getWorkorder('WO001')
 
 // Filtered by business unit
-const dropdown = await client.getWorkordersDropdownByBu('BU001')
+const buDropdown = await client.getWorkordersDropdownByBu('BU001')
+
+// Search by description or client work order ID (case-insensitive partial match)
+const results = await client.searchWorkorders('pipe')
 ```
 
 ---

package/dist/businessUnits.remote.d.ts

@@ -0,0 +1,4 @@
+export declare const getBusinessUnits: import("@sveltejs/kit").RemoteQueryFunction<void, import("./index.js").BusinessUnit[]>;
+export declare const getBusinessUnitsDropdown: import("@sveltejs/kit").RemoteQueryFunction<void, import("./index.js").DropdownOption[]>;
+export declare const getBusinessUnit: import("@sveltejs/kit").RemoteQueryFunction<string, import("./index.js").BusinessUnit>;
+export declare const searchBusinessUnits: import("@sveltejs/kit").RemoteQueryFunction<string, import("./index.js").BusinessUnit[]>;

package/dist/businessUnits.remote.js

@@ -0,0 +1,7 @@
+import { query } from '$app/server';
+import { z } from 'zod';
+import { getClient } from './client.js';
+export const getBusinessUnits = query(async () => getClient().getBusinessUnits());
+export const getBusinessUnitsDropdown = query(async () => getClient().getBusinessUnitsDropdown());
+export const getBusinessUnit = query(z.string(), async (id) => getClient().getBusinessUnit(id));
+export const searchBusinessUnits = query(z.string(), async (q) => getClient().searchBusinessUnits(q));

package/dist/client.d.ts

@@ -0,0 +1,8 @@
+import { ApiHubClient } from './index.js';
+/**
+ * Returns a singleton ApiHubClient configured from the consuming app's
+ * APIHUB_URL and APIHUB_API_KEY environment variables.
+ *
+ * Must only be called inside remote function bodies (server-side only).
+ */
+export declare function getClient(): ApiHubClient;

package/dist/client.js

@@ -0,0 +1,21 @@
+import { env } from '$env/dynamic/private';
+import { ApiHubClient } from './index.js';
+let _client = null;
+/**
+ * Returns a singleton ApiHubClient configured from the consuming app's
+ * APIHUB_URL and APIHUB_API_KEY environment variables.
+ *
+ * Must only be called inside remote function bodies (server-side only).
+ */
+export function getClient() {
+    if (!_client) {
+        const baseUrl = env.APIHUB_URL;
+        const apiKey = env.APIHUB_API_KEY;
+        if (!baseUrl)
+            throw new Error('APIHUB_URL environment variable is not set');
+        if (!apiKey)
+            throw new Error('APIHUB_API_KEY environment variable is not set');
+        _client = new ApiHubClient({ baseUrl, apiKey });
+    }
+    return _client;
+}

package/dist/costcodes.remote.d.ts

@@ -0,0 +1,9 @@
+export declare const getCostcodes: import("@sveltejs/kit").RemoteQueryFunction<void, import("./index.js").Costcode[]>;
+export declare const getCostcodesDropdown: import("@sveltejs/kit").RemoteQueryFunction<void, import("./index.js").DropdownOption[]>;
+export declare const getCostcode: import("@sveltejs/kit").RemoteQueryFunction<string, import("./index.js").Costcode>;
+export declare const getCostcodesDropdownByBu: import("@sveltejs/kit").RemoteQueryFunction<string, import("./index.js").DropdownOption[]>;
+export declare const getCostcodesDropdownByBuAndPayType: import("@sveltejs/kit").RemoteQueryFunction<{
+    businessUnitId: string;
+    payTypeCode: string;
+}, import("./index.js").DropdownOption[]>;
+export declare const searchCostcodes: import("@sveltejs/kit").RemoteQueryFunction<string, import("./index.js").Costcode[]>;

package/dist/costcodes.remote.js

@@ -0,0 +1,13 @@
+import { query } from '$app/server';
+import { z } from 'zod';
+import { getClient } from './client.js';
+const buPayTypeSchema = z.object({
+    businessUnitId: z.string(),
+    payTypeCode: z.string(),
+});
+export const getCostcodes = query(async () => getClient().getCostcodes());
+export const getCostcodesDropdown = query(async () => getClient().getCostcodesDropdown());
+export const getCostcode = query(z.string(), async (id) => getClient().getCostcode(id));
+export const getCostcodesDropdownByBu = query(z.string(), async (businessUnitId) => getClient().getCostcodesDropdownByBu(businessUnitId));
+export const getCostcodesDropdownByBuAndPayType = query(buPayTypeSchema, async ({ businessUnitId, payTypeCode }) => getClient().getCostcodesDropdownByBuAndPayType(businessUnitId, payTypeCode));
+export const searchCostcodes = query(z.string(), async (q) => getClient().searchCostcodes(q));

package/dist/employees.remote.d.ts

@@ -0,0 +1,18 @@
+export declare const getEmployees: import("@sveltejs/kit").RemoteQueryFunction<void, import("./index.js").Employee[]>;
+export declare const getEmployeesDropdown: import("@sveltejs/kit").RemoteQueryFunction<void, import("./index.js").DropdownOption[]>;
+export declare const getEmployee: import("@sveltejs/kit").RemoteQueryFunction<string, import("./index.js").Employee>;
+export declare const searchByName: import("@sveltejs/kit").RemoteQueryFunction<string, import("./index.js").Employee[]>;
+export declare const getBySupervisor: import("@sveltejs/kit").RemoteQueryFunction<string, import("./index.js").Employee[]>;
+export declare const searchByEmail: import("@sveltejs/kit").RemoteQueryFunction<string, import("./index.js").Employee[]>;
+export declare const getSupervisorChain: import("@sveltejs/kit").RemoteQueryFunction<string, import("./index.js").Employee[]>;
+export declare const getJdeFromEmail: import("@sveltejs/kit").RemoteQueryFunction<string, {
+    jde: string | null;
+    employee: import("./index.js").Employee | null;
+}>;
+export declare const searchByHbu: import("@sveltejs/kit").RemoteQueryFunction<string, import("./index.js").Employee[]>;
+export declare const verifyIdentity: import("@sveltejs/kit").RemoteCommand<{
+    first3FirstName: string;
+    first3LastName: string;
+    dob: string;
+    ssn4: string;
+}, Promise<import("./index.js").Employee | null>>;

package/dist/employees.remote.js

@@ -0,0 +1,20 @@
+import { query, command } from '$app/server';
+import { z } from 'zod';
+import { getClient } from './client.js';
+const employeeIdSchema = z.string().min(1);
+const verifyIdentitySchema = z.object({
+    first3FirstName: z.string(),
+    first3LastName: z.string(),
+    dob: z.string(),
+    ssn4: z.string(),
+});
+export const getEmployees = query(async () => getClient().getEmployees());
+export const getEmployeesDropdown = query(async () => getClient().getEmployeesDropdown());
+export const getEmployee = query(employeeIdSchema, async (employeeId) => getClient().getEmployee(employeeId));
+export const searchByName = query(z.string(), async (name) => getClient().searchByName(name));
+export const getBySupervisor = query(employeeIdSchema, async (supervisorId) => getClient().getBySupervisor(supervisorId));
+export const searchByEmail = query(z.string(), async (email) => getClient().searchByEmail(email));
+export const getSupervisorChain = query(employeeIdSchema, async (employeeId) => getClient().getSupervisorChain(employeeId));
+export const getJdeFromEmail = query(z.string(), async (email) => getClient().getJdeFromEmail(email));
+export const searchByHbu = query(z.string(), async (hbu) => getClient().searchByHbu(hbu));
+export const verifyIdentity = command(verifyIdentitySchema, async (inputs) => getClient().verifyIdentity(inputs));

package/dist/index.d.ts

@@ -5,6 +5,9 @@ export interface Employee {
     employeeId: string;
     name: string | null;
     email: string | null;
+    personalEmail: string | null;
+    clientEmail: string | null;
+    workEmail: string | null;
     badgeNumber: string | null;
     employementStatus: string | null;
     residentTaxArea: string | null;
@@ -258,6 +261,7 @@ export declare class ApiHubClient {
     getBusinessUnits(): Promise<BusinessUnit[]>;
     getBusinessUnitsDropdown(): Promise<DropdownOption[]>;
     getBusinessUnit(id: string): Promise<BusinessUnit>;
+    searchBusinessUnits(q: string): Promise<BusinessUnit[]>;
     getCostcodes(): Promise<Costcode[]>;
     getCostcodesDropdown(): Promise<DropdownOption[]>;
     getCostcode(id: string): Promise<Costcode>;
@@ -265,14 +269,17 @@ export declare class ApiHubClient {
     getCostcodesDropdownByBu(businessUnitId: string): Promise<DropdownOption[]>;
     /** Get cost codes for a specific business unit and pay type, formatted for dropdown controls */
     getCostcodesDropdownByBuAndPayType(businessUnitId: string, payTypeCode: string): Promise<DropdownOption[]>;
+    searchCostcodes(q: string): Promise<Costcode[]>;
     getPaytypes(): Promise<Paytype[]>;
     getPaytypesDropdown(): Promise<PaytypeDropdownOption[]>;
     getPaytype(id: string): Promise<Paytype>;
+    searchPaytypes(q: string): Promise<Paytype[]>;
     getWorkorders(): Promise<Workorder[]>;
     getWorkordersDropdown(): Promise<DropdownOption[]>;
     /** Get work orders for a specific business unit, formatted for dropdown controls */
     getWorkordersDropdownByBu(businessUnitId: string): Promise<DropdownOption[]>;
     getWorkorder(id: string): Promise<Workorder>;
+    searchWorkorders(q: string): Promise<Workorder[]>;
     getJobtypejobsteps(): Promise<Jobtypejobstep[]>;
     getJobtypejobstepsDropdown(): Promise<DropdownOption[]>;
     getJobtypejobstep(id: string): Promise<Jobtypejobstep>;

package/dist/index.js

@@ -256,6 +256,9 @@ export class ApiHubClient {
     async getBusinessUnit(id) {
         return this.request(`/business-units/${encodeURIComponent(id)}`);
     }
+    async searchBusinessUnits(q) {
+        return this.request(`/business-units/search?q=${encodeURIComponent(q)}`);
+    }
     // -----------------------------------------------------------------------
     // Cost Codes
     // -----------------------------------------------------------------------
@@ -276,6 +279,9 @@ export class ApiHubClient {
     async getCostcodesDropdownByBuAndPayType(businessUnitId, payTypeCode) {
         return this.cachedRequest(`/costcodes/by-bu/${encodeURIComponent(businessUnitId)}/by-paytype/${encodeURIComponent(payTypeCode)}/dropdown`);
     }
+    async searchCostcodes(q) {
+        return this.request(`/costcodes/search?q=${encodeURIComponent(q)}`);
+    }
     // -----------------------------------------------------------------------
     // Pay Types
     // -----------------------------------------------------------------------
@@ -288,6 +294,9 @@ export class ApiHubClient {
     async getPaytype(id) {
         return this.request(`/paytypes/${encodeURIComponent(id)}`);
     }
+    async searchPaytypes(q) {
+        return this.request(`/paytypes/search?q=${encodeURIComponent(q)}`);
+    }
     // -----------------------------------------------------------------------
     // Work Orders
     // -----------------------------------------------------------------------
@@ -304,6 +313,9 @@ export class ApiHubClient {
     async getWorkorder(id) {
         return this.request(`/workorders/${encodeURIComponent(id)}`);
     }
+    async searchWorkorders(q) {
+        return this.request(`/workorders/search?q=${encodeURIComponent(q)}`);
+    }
     // -----------------------------------------------------------------------
     // Job Type / Job Steps
     // -----------------------------------------------------------------------

package/dist/jobtypejobsteps.remote.d.ts

@@ -0,0 +1,3 @@
+export declare const getJobtypejobsteps: import("@sveltejs/kit").RemoteQueryFunction<void, import("./index.js").Jobtypejobstep[]>;
+export declare const getJobtypejobstepsDropdown: import("@sveltejs/kit").RemoteQueryFunction<void, import("./index.js").DropdownOption[]>;
+export declare const getJobtypejobstep: import("@sveltejs/kit").RemoteQueryFunction<string, import("./index.js").Jobtypejobstep>;

package/dist/jobtypejobsteps.remote.js

@@ -0,0 +1,6 @@
+import { query } from '$app/server';
+import { z } from 'zod';
+import { getClient } from './client.js';
+export const getJobtypejobsteps = query(async () => getClient().getJobtypejobsteps());
+export const getJobtypejobstepsDropdown = query(async () => getClient().getJobtypejobstepsDropdown());
+export const getJobtypejobstep = query(z.string(), async (id) => getClient().getJobtypejobstep(id));

package/dist/llm.remote.d.ts

@@ -0,0 +1,12 @@
+export declare const getLlmLogs: import("@sveltejs/kit").RemoteQueryFunction<void, import("./index.js").LlmLog[]>;
+export declare const chat: import("@sveltejs/kit").RemoteCommand<{
+    user: string;
+    messages: {
+        role: "system" | "user" | "assistant";
+        content: string;
+    }[];
+    source: string;
+    function?: string | undefined;
+    temperature?: number | undefined;
+    maxTokens?: number | undefined;
+}, Promise<import("./index.js").ChatResponse>>;

package/dist/llm.remote.js

@@ -0,0 +1,17 @@
+import { query, command } from '$app/server';
+import { z } from 'zod';
+import { getClient } from './client.js';
+const chatMessageSchema = z.object({
+    role: z.enum(['system', 'user', 'assistant']),
+    content: z.string(),
+});
+const chatRequestSchema = z.object({
+    messages: z.array(chatMessageSchema),
+    source: z.string(),
+    user: z.string(),
+    function: z.string().optional(),
+    temperature: z.number().min(0).max(2).optional(),
+    maxTokens: z.number().int().positive().optional(),
+});
+export const getLlmLogs = query(async () => getClient().getLlmLogs());
+export const chat = command(chatRequestSchema, async (request) => getClient().chat(request));

package/dist/paytypes.remote.d.ts

@@ -0,0 +1,4 @@
+export declare const getPaytypes: import("@sveltejs/kit").RemoteQueryFunction<void, import("./index.js").Paytype[]>;
+export declare const getPaytypesDropdown: import("@sveltejs/kit").RemoteQueryFunction<void, import("./index.js").PaytypeDropdownOption[]>;
+export declare const getPaytype: import("@sveltejs/kit").RemoteQueryFunction<string, import("./index.js").Paytype>;
+export declare const searchPaytypes: import("@sveltejs/kit").RemoteQueryFunction<string, import("./index.js").Paytype[]>;

package/dist/paytypes.remote.js

@@ -0,0 +1,7 @@
+import { query } from '$app/server';
+import { z } from 'zod';
+import { getClient } from './client.js';
+export const getPaytypes = query(async () => getClient().getPaytypes());
+export const getPaytypesDropdown = query(async () => getClient().getPaytypesDropdown());
+export const getPaytype = query(z.string(), async (id) => getClient().getPaytype(id));
+export const searchPaytypes = query(z.string(), async (q) => getClient().searchPaytypes(q));

package/dist/rag.remote.d.ts

@@ -0,0 +1,11 @@
+export declare const listDocuments: import("@sveltejs/kit").RemoteQueryFunction<void, import("./index.js").DocumentRecord[]>;
+export declare const uploadDocument: import("@sveltejs/kit").RemoteCommand<{
+    fileName: string;
+    base64Content: string;
+    uploadedBy: string;
+}, Promise<import("./index.js").DocumentRecord>>;
+export declare const deleteDocument: import("@sveltejs/kit").RemoteCommand<number, Promise<void>>;
+export declare const searchDocuments: import("@sveltejs/kit").RemoteCommand<{
+    query: string;
+    topK?: number | undefined;
+}, Promise<import("./index.js").SearchResult[]>>;

package/dist/rag.remote.js

@@ -0,0 +1,16 @@
+import { query, command } from '$app/server';
+import { z } from 'zod';
+import { getClient } from './client.js';
+const uploadDocumentSchema = z.object({
+    fileName: z.string().min(1),
+    base64Content: z.string().min(1),
+    uploadedBy: z.string().min(1),
+});
+const searchDocumentsSchema = z.object({
+    query: z.string().min(1),
+    topK: z.number().int().positive().optional(),
+});
+export const listDocuments = query(async () => getClient().listDocuments());
+export const uploadDocument = command(uploadDocumentSchema, async ({ fileName, base64Content, uploadedBy }) => getClient().uploadDocument(fileName, base64Content, uploadedBy));
+export const deleteDocument = command(z.number().int().positive(), async (id) => getClient().deleteDocument(id));
+export const searchDocuments = command(searchDocumentsSchema, async ({ query: q, topK }) => getClient().searchDocuments(q, topK));

package/dist/workorders.remote.d.ts

@@ -0,0 +1,5 @@
+export declare const getWorkorders: import("@sveltejs/kit").RemoteQueryFunction<void, import("./index.js").Workorder[]>;
+export declare const getWorkordersDropdown: import("@sveltejs/kit").RemoteQueryFunction<void, import("./index.js").DropdownOption[]>;
+export declare const getWorkordersDropdownByBu: import("@sveltejs/kit").RemoteQueryFunction<string, import("./index.js").DropdownOption[]>;
+export declare const getWorkorder: import("@sveltejs/kit").RemoteQueryFunction<string, import("./index.js").Workorder>;
+export declare const searchWorkorders: import("@sveltejs/kit").RemoteQueryFunction<string, import("./index.js").Workorder[]>;

package/dist/workorders.remote.js

@@ -0,0 +1,8 @@
+import { query } from '$app/server';
+import { z } from 'zod';
+import { getClient } from './client.js';
+export const getWorkorders = query(async () => getClient().getWorkorders());
+export const getWorkordersDropdown = query(async () => getClient().getWorkordersDropdown());
+export const getWorkordersDropdownByBu = query(z.string(), async (businessUnitId) => getClient().getWorkordersDropdownByBu(businessUnitId));
+export const getWorkorder = query(z.string(), async (id) => getClient().getWorkorder(id));
+export const searchWorkorders = query(z.string(), async (q) => getClient().searchWorkorders(q));

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@brownandroot/api",
-	"version": "0.15.0",
+	"version": "1.1.0",
 	"type": "module",
 	"repository": {
 		"type": "git",
@@ -11,19 +11,71 @@
 	"types": "./dist/index.d.ts",
 	"exports": {
 		".": {
-			"import": "./dist/index.js",
-			"types": "./dist/index.d.ts"
+			"types": "./dist/index.d.ts",
+			"default": "./dist/index.js"
+		},
+		"./employees": {
+			"types": "./dist/employees.remote.d.ts",
+			"default": "./dist/employees.remote.js"
+		},
+		"./businessUnits": {
+			"types": "./dist/businessUnits.remote.d.ts",
+			"default": "./dist/businessUnits.remote.js"
+		},
+		"./costcodes": {
+			"types": "./dist/costcodes.remote.d.ts",
+			"default": "./dist/costcodes.remote.js"
+		},
+		"./paytypes": {
+			"types": "./dist/paytypes.remote.d.ts",
+			"default": "./dist/paytypes.remote.js"
+		},
+		"./workorders": {
+			"types": "./dist/workorders.remote.d.ts",
+			"default": "./dist/workorders.remote.js"
+		},
+		"./jobtypejobsteps": {
+			"types": "./dist/jobtypejobsteps.remote.d.ts",
+			"default": "./dist/jobtypejobsteps.remote.js"
+		},
+		"./llm": {
+			"types": "./dist/llm.remote.d.ts",
+			"default": "./dist/llm.remote.js"
+		},
+		"./rag": {
+			"types": "./dist/rag.remote.d.ts",
+			"default": "./dist/rag.remote.js"
 		}
 	},
 	"files": [
 		"dist"
 	],
 	"scripts": {
-		"build": "tsc -p tsconfig.json",
-		"prepublishOnly": "npm run build",
+		"prepare": "bun svelte-kit sync || echo ''",
+		"build": "bun svelte-kit sync && bun svelte-package",
+		"prepublishOnly": "bun run build",
 		"publish:manual": "npm publish --access public"
 	},
+	"peerDependencies": {
+		"@sveltejs/kit": "^2.0.0",
+		"svelte": "^5.0.0"
+	},
+	"peerDependenciesMeta": {
+		"@sveltejs/kit": {
+			"optional": true
+		},
+		"svelte": {
+			"optional": true
+		}
+	},
 	"devDependencies": {
-		"typescript": "^5.0.0"
+		"@sveltejs/adapter-node": "^5.0.0",
+		"@sveltejs/kit": "^2.0.0",
+		"@sveltejs/package": "^2.0.0",
+		"@sveltejs/vite-plugin-svelte": "^6.0.0",
+		"svelte": "^5.0.0",
+		"typescript": "^5.0.0",
+		"vite": "^6.0.0",
+		"zod": "^3.0.0"
 	}
 }