bamboohr-cli 1.0.15 → 1.0.16

package/dist/index.js

@@ -106,32 +106,13 @@ function getClient() {
   return new BambooHRClient({ apiToken, companyDomain });
 }
 
-// src/utils/strip-response.ts
-function stripResponse(obj) {
-  if (Array.isArray(obj)) {
-    return obj.map(stripResponse);
-  }
-  if (obj === null || typeof obj !== "object") {
-    return obj;
-  }
-  const record = obj;
-  const result = {};
-  for (const [key, value] of Object.entries(record)) {
-    if (value === null || value === void 0) {
-      continue;
-    }
-    result[key] = stripResponse(value);
-  }
-  return result;
-}
-
 // src/utils/output.ts
 var prettyPrint = false;
 function setPretty(value) {
   prettyPrint = value;
 }
 function output(data) {
-  process.stdout.write(`${JSON.stringify(stripResponse(data), null, prettyPrint ? 2 : void 0)}
+  process.stdout.write(`${JSON.stringify(data, null, prettyPrint ? 2 : void 0)}
 `);
 }
 function handleError(err) {
@@ -197,35 +178,166 @@ function handleError(err) {
   process.exit(1);
 }
 
+// src/utils/transformers/base.ts
+function bamboohrBaseUrl() {
+  return `https://${process.env.BAMBOO_COMPANY_DOMAIN ?? ""}.bamboohr.com`;
+}
+function stripNullish(value) {
+  if (Array.isArray(value)) {
+    return value.map(stripNullish);
+  }
+  if (value === null || typeof value !== "object") {
+    return value;
+  }
+  const record = value;
+  const result = {};
+  for (const [key, v] of Object.entries(record)) {
+    if (v === null || v === void 0) {
+      continue;
+    }
+    result[key] = stripNullish(v);
+  }
+  return result;
+}
+
+// src/utils/transformers/employee.ts
+function employeeUrl(id) {
+  return `${bamboohrBaseUrl()}/employees/employee.php?id=${id}`;
+}
+function transformEmployee(employee, opts = {}) {
+  const { photoUrl, canUploadPhoto: _canUploadPhoto, photoUploaded, ...rest } = employee;
+  const id = typeof rest.id === "string" ? rest.id : void 0;
+  const withUrl = id ? { ...rest, url: employeeUrl(id) } : { ...rest };
+  if (opts.withPhotos) {
+    if (photoUrl !== null && photoUrl !== void 0) {
+      withUrl.photoUrl = photoUrl;
+    }
+    if (photoUploaded !== null && photoUploaded !== void 0) {
+      withUrl.photoUploaded = photoUploaded;
+    }
+  }
+  return stripNullish(withUrl);
+}
+function transformEmployeeDirectory(directory2, opts = {}) {
+  return { employees: directory2.employees.map((e) => transformEmployee(e, opts)) };
+}
+
+// src/utils/transformers/goal.ts
+function transformGoalMilestone(milestone) {
+  return stripNullish(milestone);
+}
+function transformGoal(goal) {
+  const { milestones, ...rest } = goal;
+  const shaped = {
+    ...rest,
+    ...milestones && { milestones: milestones.map(transformGoalMilestone) }
+  };
+  return stripNullish(shaped);
+}
+function transformGoals(response) {
+  return { goals: response.goals.map(transformGoal) };
+}
+
+// src/utils/transformers/timeoff.ts
+function transformTimeOffRequest(request) {
+  const { actions: _actions, ...rest } = request;
+  return stripNullish(rest);
+}
+function transformTimeOffRequests(requests2) {
+  return requests2.map(transformTimeOffRequest);
+}
+function transformTimeOffBalance(balance2) {
+  return stripNullish(balance2);
+}
+function transformTimeOffBalances(balances) {
+  return balances.map(transformTimeOffBalance);
+}
+function transformTimeOffType(type) {
+  return stripNullish(type);
+}
+function transformTimeOffTypesResponse(response) {
+  return {
+    timeOffTypes: response.timeOffTypes.map(transformTimeOffType),
+    defaultHours: response.defaultHours
+  };
+}
+function transformWhosOutEvent(event) {
+  return stripNullish(event);
+}
+function transformWhosOut(events) {
+  return events.map(transformWhosOutEvent);
+}
+
+// src/utils/transformers/file.ts
+function transformCompanyFile(file) {
+  const {
+    shareWithEmployees: _shareWithEmployees,
+    canRenameFile: _canRenameFile,
+    canDeleteFile: _canDeleteFile,
+    ...rest
+  } = file;
+  return stripNullish(rest);
+}
+function transformCompanyFileCategory(category) {
+  const { files, canUploadFiles: _canUploadFiles, ...rest } = category;
+  return stripNullish({ ...rest, files: files.map(transformCompanyFile) });
+}
+function transformCompanyFiles(response) {
+  return { categories: response.categories.map(transformCompanyFileCategory) };
+}
+
+// src/utils/transformers/meta.ts
+function transformField(field) {
+  return stripNullish(field);
+}
+function transformFields(fields2) {
+  return fields2.map(transformField);
+}
+
 // src/commands/employee/directory.ts
 function directory(parent) {
-  parent.command("directory").description("Get the company employee directory").addHelpText("after", "\nExamples:\n  $ bamboohr employee directory").action(async () => {
+  parent.command("directory").description("Get the company employee directory").option("--with-photos", "Include each employee's signed photo URL and photoUploaded flag (large)").addHelpText(
+    "after",
+    `
+Examples:
+  $ bamboohr employee directory
+  $ bamboohr employee directory --with-photos`
+  ).action(async (opts) => {
     const client = getClient();
     const result = await getDirectory(client);
-    output(result);
+    output(transformEmployeeDirectory(result, { withPhotos: opts.withPhotos }));
   });
 }
 
 // src/commands/employee/get.ts
 function get(parent) {
-  parent.command("get [id]").description("Get employee data by ID (default: current user)").option("--fields <fields>", "Comma-separated field names", "firstName,lastName,email,jobTitle").option("--include-future", "Include future-dated values from history fields").addHelpText(
+  parent.command("get [id]").description("Get employee data by ID (default: current user)").option("--fields <fields>", "Comma-separated field names", "firstName,lastName,email,jobTitle").option("--include-future", "Include future-dated values from history fields").option("--with-photos", "Include the employee's signed photo URL and photoUploaded flag").addHelpText(
     "after",
     `
 Examples:
   $ bamboohr employee get
   $ bamboohr employee get 123
   $ bamboohr employee get 123 --fields "firstName,lastName,department,hireDate"
-  $ bamboohr employee get 123 --include-future`
+  $ bamboohr employee get 123 --include-future
+  $ bamboohr employee get 123 --with-photos`
   ).action(async (id, opts) => {
     const client = getClient();
+    const fields2 = opts.withPhotos ? mergeFields(opts.fields, ["photoUrl", "photoUploaded"]) : opts.fields;
     const result = await client.employees.get({
       id: id ?? "0",
-      fields: opts.fields,
+      fields: fields2,
       onlyCurrent: !opts.includeFuture
     });
-    output(result);
+    output(transformEmployee(result, { withPhotos: opts.withPhotos }));
   });
 }
+function mergeFields(existing, extra) {
+  const set = new Set(
+    existing.split(",").map((s) => s.trim()).filter(Boolean)
+  );
+  for (const f of extra) set.add(f);
+  return [...set].join(",");
+}
 
 // src/commands/employee/goals.ts
 import { Option } from "commander";
@@ -243,7 +355,7 @@ Examples:
       employeeId: id,
       filter: opts.filter === "all" ? void 0 : opts.filter
     });
-    output(result);
+    output(transformGoals(result));
   });
 }
 
@@ -278,14 +390,15 @@ async function resolveEmployeeId(client, employeeId) {
 
 // src/commands/employee/search.ts
 function search(parent) {
-  parent.command("search [query]").description("Search and filter employees").option("--supervisor <name>", 'Filter by supervisor name (use "me" for current user)').option("--department <name>", "Filter by department").option("--location <name>", "Filter by location").option("--division <name>", "Filter by division").addHelpText(
+  parent.command("search [query]").description("Search and filter employees").option("--supervisor <name>", 'Filter by supervisor name (use "me" for current user)').option("--department <name>", "Filter by department").option("--location <name>", "Filter by location").option("--division <name>", "Filter by division").option("--with-photos", "Include each result's signed photo URL and photoUploaded flag").addHelpText(
     "after",
     `
 Examples:
   bamboohr employee search john
   bamboohr employee search --supervisor me
   bamboohr employee search --department "R&D" --location Sofia
-  bamboohr employee search --supervisor "Borislav Mihaylov"`
+  bamboohr employee search --supervisor "Borislav Mihaylov"
+  bamboohr employee search john --with-photos`
   ).action(
     async (query, opts) => {
       const client = getClient();
@@ -320,7 +433,7 @@ Examples:
         const dv = opts.division.toLowerCase();
         matches = matches.filter((e) => (e.division ?? "").toLowerCase().includes(dv));
       }
-      output(matches);
+      output(matches.map((e) => transformEmployee(e, { withPhotos: opts.withPhotos })));
     }
   );
 }
@@ -366,7 +479,7 @@ function list(parent) {
   parent.command("list").description("List all company files and categories").addHelpText("after", "\nExamples:\n  $ bamboohr file list").action(async () => {
     const client = getClient();
     const result = await client.files.list();
-    output(result);
+    output(transformCompanyFiles(result));
   });
 }
 
@@ -409,7 +522,7 @@ function fields(parent) {
   parent.command("fields").description("List all available BambooHR fields").addHelpText("after", "\nExamples:\n  $ bamboohr meta fields").action(async () => {
     const client = getClient();
     const result = await getMetaFields(client);
-    output(result);
+    output(transformFields(result));
   });
 }
 
@@ -454,7 +567,7 @@ Examples:
     const client = getClient();
     const id = await resolveEmployeeId(client, employeeId);
     const result = await client.timeOff.getBalance({ employeeId: id, date: opts.date });
-    output(result);
+    output(transformTimeOffBalances(result));
   });
 }
 
@@ -495,7 +608,7 @@ Examples:
         notes: opts.note ? [{ from: "employee", note: opts.note }] : void 0,
         dates: opts.dates ? JSON.parse(opts.dates) : void 0
       });
-      output(result || { created: true, employeeId: id, start: opts.start, end: opts.end });
+      output(result ? stripNullish(result) : { created: true, employeeId: id, start: opts.start, end: opts.end });
     }
   );
 }
@@ -538,7 +651,7 @@ Examples:
         status: opts.status,
         type: opts.type
       });
-      output(result);
+      output(transformTimeOffRequests(result));
     }
   );
 }
@@ -554,7 +667,7 @@ Examples:
   ).action(async (opts) => {
     const client = getClient();
     const result = opts.requestable ? await client.timeOff.getTypes({ mode: "request" }) : await getTimeOffTypes(client);
-    output(result);
+    output(transformTimeOffTypesResponse(result));
   });
 }
 
@@ -577,7 +690,7 @@ Examples:
       status: opts.status,
       note: opts.note
     });
-    output(result || { updated: true, requestId, status: opts.status });
+    output(result ? stripNullish(result) : { updated: true, requestId, status: opts.status });
   });
 }
 
@@ -595,7 +708,7 @@ Examples:
     const start = opts.start ?? today;
     const end = opts.end ?? (opts.start ? void 0 : today);
     const result = await client.timeOff.getWhosOut({ start, end });
-    output(result);
+    output(transformWhosOut(result));
   });
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bamboohr-cli",
-  "version": "1.0.15",
+  "version": "1.0.16",
   "publish": true,
   "type": "module",
   "main": "dist/index.js",
@@ -12,7 +12,7 @@
   ],
   "dependencies": {
     "commander": "^13.1.0",
-    "bamboohr-client": "1.0.22"
+    "bamboohr-client": "1.0.23"
   },
   "devDependencies": {
     "@types/node": "24.10.4",
@@ -22,8 +22,8 @@
     "tsx": "^4.19.2",
     "typescript": "^5.7.2",
     "vitest": "^4.0.16",
-    "cli-utils": "1.0.0",
     "config-eslint": "0.0.0",
+    "cli-utils": "1.0.0",
     "config-typescript": "0.0.0"
   },
   "engines": {