@brownandroot/api 1.0.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'

package/dist/businessUnits.remote.d.ts

@@ -1,4 +1,4 @@
-export declare const getBusinessUnits: any;
-export declare const getBusinessUnitsDropdown: any;
-export declare const getBusinessUnit: any;
-export declare const searchBusinessUnits: any;
+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/costcodes.remote.d.ts

@@ -1,6 +1,9 @@
-export declare const getCostcodes: any;
-export declare const getCostcodesDropdown: any;
-export declare const getCostcode: any;
-export declare const getCostcodesDropdownByBu: any;
-export declare const getCostcodesDropdownByBuAndPayType: any;
-export declare const searchCostcodes: any;
+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/employees.remote.d.ts

@@ -1,10 +1,18 @@
-export declare const getEmployees: any;
-export declare const getEmployeesDropdown: any;
-export declare const getEmployee: any;
-export declare const searchByName: any;
-export declare const getBySupervisor: any;
-export declare const searchByEmail: any;
-export declare const getSupervisorChain: any;
-export declare const getJdeFromEmail: any;
-export declare const searchByHbu: any;
-export declare const verifyIdentity: any;
+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/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;

package/dist/jobtypejobsteps.remote.d.ts

@@ -1,3 +1,3 @@
-export declare const getJobtypejobsteps: any;
-export declare const getJobtypejobstepsDropdown: any;
-export declare const getJobtypejobstep: any;
+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/llm.remote.d.ts

@@ -1,2 +1,12 @@
-export declare const getLlmLogs: any;
-export declare const chat: any;
+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/paytypes.remote.d.ts

@@ -1,4 +1,4 @@
-export declare const getPaytypes: any;
-export declare const getPaytypesDropdown: any;
-export declare const getPaytype: any;
-export declare const searchPaytypes: any;
+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/rag.remote.d.ts

@@ -1,4 +1,11 @@
-export declare const listDocuments: any;
-export declare const uploadDocument: any;
-export declare const deleteDocument: any;
-export declare const searchDocuments: any;
+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/workorders.remote.d.ts

@@ -1,5 +1,5 @@
-export declare const getWorkorders: any;
-export declare const getWorkordersDropdown: any;
-export declare const getWorkordersDropdownByBu: any;
-export declare const getWorkorder: any;
-export declare const searchWorkorders: any;
+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/package.json

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