@brownandroot/api 0.1.0 → 0.3.0

package/README.md

@@ -0,0 +1,77 @@
+# @brownandroot/api
+
+TypeScript client for the Brown & Root APIHub employee data service.
+
+## Installation
+
+```bash
+npm install @brownandroot/api
+```
+
+## Setup
+
+```typescript
+import { ApiHubClient } from '@brownandroot/api'
+
+const client = new ApiHubClient({
+	baseUrl: 'https://your-apihub-url.com',
+	apiKey: 'your-api-key',
+})
+```
+
+## Usage
+
+### Get all employees
+
+```typescript
+const employees = await client.getEmployees()
+```
+
+### Get a single employee
+
+```typescript
+const employee = await client.getEmployee(12345)
+```
+
+### Search by name
+
+Case-insensitive partial match:
+
+```typescript
+const results = await client.searchByName('John')
+```
+
+### Get employees by supervisor
+
+```typescript
+const reports = await client.getBySupervisor(12345)
+```
+
+### Get supervisor chain
+
+Returns the chain of supervisors above an employee (excludes the employee themselves):
+
+```typescript
+const chain = await client.getSupervisorChain(12345)
+// [directSupervisor, theirSupervisor, ...]
+```
+
+## Types
+
+The package exports the `Employee` interface and `ApiHubClientOptions`:
+
+```typescript
+import type { Employee, ApiHubClientOptions } from '@brownandroot/api'
+```
+
+## Error Handling
+
+Methods throw an `Error` when the API returns a non-OK response. The error message contains the server's error detail or the HTTP status code.
+
+```typescript
+try {
+	const emp = await client.getEmployee(99999)
+} catch (err) {
+	console.error(err.message) // "Employee not found"
+}
+```

package/package.json

@@ -1,24 +1,29 @@
-{
-	"name": "@brownandroot/api",
-	"version": "0.1.0",
-	"type": "module",
-	"main": "./dist/index.js",
-	"types": "./dist/index.d.ts",
-	"exports": {
-		".": {
-			"import": "./dist/index.js",
-			"types": "./dist/index.d.ts"
-		}
-	},
-	"files": [
-		"dist"
-	],
-	"scripts": {
-		"build": "tsc -p tsconfig.json",
-		"prepublishOnly": "npm run build",
-		"publish:manual": "npm publish --access public"
-	},
-	"devDependencies": {
-		"typescript": "^5.0.0"
-	}
-}
+{
+	"name": "@brownandroot/api",
+	"version": "0.3.0",
+	"type": "module",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/brownandroot/APIHub.git",
+		"directory": "src/client"
+	},
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"exports": {
+		".": {
+			"import": "./dist/index.js",
+			"types": "./dist/index.d.ts"
+		}
+	},
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"build": "tsc -p tsconfig.json",
+		"prepublishOnly": "npm run build",
+		"publish:manual": "npm publish --access public"
+	},
+	"devDependencies": {
+		"typescript": "^5.0.0"
+	}
+}