@procyon-creative/harvest-sdk 0.1.0

package/dist/index.cjs

@@ -0,0 +1,762 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  ClientsResource: () => ClientsResource,
+  CompanyResource: () => CompanyResource,
+  ContactsResource: () => ContactsResource,
+  EstimateItemCategoriesResource: () => EstimateItemCategoriesResource,
+  EstimateMessagesResource: () => EstimateMessagesResource,
+  EstimatesResource: () => EstimatesResource,
+  ExpenseCategoriesResource: () => ExpenseCategoriesResource,
+  ExpenseReports: () => ExpenseReports,
+  ExpensesResource: () => ExpensesResource,
+  Harvest: () => Harvest,
+  HarvestApiError: () => HarvestApiError,
+  HarvestClient: () => HarvestClient,
+  HarvestNotFoundError: () => HarvestNotFoundError,
+  HarvestRateLimitError: () => HarvestRateLimitError,
+  HarvestUnprocessableError: () => HarvestUnprocessableError,
+  InvoiceItemCategoriesResource: () => InvoiceItemCategoriesResource,
+  InvoiceMessagesResource: () => InvoiceMessagesResource,
+  InvoicesResource: () => InvoicesResource,
+  Paginator: () => Paginator,
+  ProjectTaskAssignmentsResource: () => ProjectTaskAssignmentsResource,
+  ProjectUserAssignmentsResource: () => ProjectUserAssignmentsResource,
+  ProjectsResource: () => ProjectsResource,
+  ReportsResource: () => ReportsResource,
+  RolesResource: () => RolesResource,
+  TaskAssignmentsResource: () => TaskAssignmentsResource,
+  TasksResource: () => TasksResource,
+  TimeEntriesResource: () => TimeEntriesResource,
+  TimeReports: () => TimeReports,
+  UserAssignmentsResource: () => UserAssignmentsResource,
+  UserBillableRatesResource: () => UserBillableRatesResource,
+  UserCostRatesResource: () => UserCostRatesResource,
+  UserProjectAssignmentsResource: () => UserProjectAssignmentsResource,
+  UserTeammatesResource: () => UserTeammatesResource,
+  UsersResource: () => UsersResource
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/params.ts
+function serializeParams(params) {
+  const parts = [];
+  function encode(prefix, value) {
+    if (value === null || value === void 0) return;
+    if (Array.isArray(value)) {
+      value.forEach((item, i) => {
+        encode(`${prefix}[${i}]`, item);
+      });
+    } else if (typeof value === "object" && !(value instanceof Date)) {
+      for (const [k, v] of Object.entries(value)) {
+        encode(`${prefix}[${k}]`, v);
+      }
+    } else {
+      parts.push(
+        `${encodeURIComponent(prefix)}=${encodeURIComponent(String(value))}`
+      );
+    }
+  }
+  for (const [key, value] of Object.entries(params)) {
+    if (value === null || value === void 0) continue;
+    if (Array.isArray(value)) {
+      value.forEach((item, i) => {
+        if (typeof item === "object" && item !== null) {
+          encode(`${key}[${i}]`, item);
+        } else {
+          parts.push(
+            `${encodeURIComponent(key)}=${encodeURIComponent(String(item))}`
+          );
+        }
+      });
+    } else if (typeof value === "object" && !(value instanceof Date)) {
+      encode(key, value);
+    } else {
+      parts.push(
+        `${encodeURIComponent(key)}=${encodeURIComponent(String(value))}`
+      );
+    }
+  }
+  return parts.join("&");
+}
+function buildQueryString(params) {
+  if (!params) return "";
+  const parts = [];
+  for (const [key, value] of Object.entries(params)) {
+    if (value === null || value === void 0) continue;
+    if (typeof value === "boolean") {
+      parts.push(`${encodeURIComponent(key)}=${value}`);
+    } else {
+      parts.push(
+        `${encodeURIComponent(key)}=${encodeURIComponent(String(value))}`
+      );
+    }
+  }
+  return parts.length ? `?${parts.join("&")}` : "";
+}
+
+// src/errors.ts
+var HarvestApiError = class extends Error {
+  constructor(status, statusText, body) {
+    super(`Harvest API error ${status}: ${statusText}`);
+    this.status = status;
+    this.statusText = statusText;
+    this.body = body;
+    this.name = "HarvestApiError";
+  }
+};
+var HarvestRateLimitError = class extends HarvestApiError {
+  retryAfter;
+  constructor(retryAfter, body) {
+    super(429, "Too Many Requests", body);
+    this.name = "HarvestRateLimitError";
+    this.retryAfter = retryAfter;
+  }
+};
+var HarvestNotFoundError = class extends HarvestApiError {
+  constructor(body) {
+    super(404, "Not Found", body);
+    this.name = "HarvestNotFoundError";
+  }
+};
+var HarvestUnprocessableError = class extends HarvestApiError {
+  constructor(body) {
+    super(422, "Unprocessable Entity", body);
+    this.name = "HarvestUnprocessableError";
+  }
+};
+
+// src/client.ts
+var HarvestClient = class {
+  baseUrl;
+  headers;
+  constructor(config) {
+    this.baseUrl = config.baseUrl ?? "https://api.harvestapp.com/v2";
+    this.headers = {
+      "Harvest-Account-Id": config.accountId,
+      Authorization: `Bearer ${config.accessToken}`,
+      "User-Agent": config.userAgent ?? "harvest-sdk-typescript"
+    };
+  }
+  async get(path, params) {
+    const qs = buildQueryString(params);
+    const url = `${this.baseUrl}${path}${qs}`;
+    return this.request(url, { method: "GET" });
+  }
+  async post(path, body) {
+    const url = `${this.baseUrl}${path}`;
+    const init = { method: "POST" };
+    if (body && Object.keys(body).length > 0) {
+      init.headers = {
+        "Content-Type": "application/x-www-form-urlencoded"
+      };
+      init.body = serializeParams(body);
+    }
+    return this.request(url, init);
+  }
+  async patch(path, body) {
+    const url = `${this.baseUrl}${path}`;
+    const init = { method: "PATCH" };
+    if (body && Object.keys(body).length > 0) {
+      init.headers = {
+        "Content-Type": "application/x-www-form-urlencoded"
+      };
+      init.body = serializeParams(body);
+    }
+    return this.request(url, init);
+  }
+  async delete(path) {
+    const url = `${this.baseUrl}${path}`;
+    await this.request(url, { method: "DELETE" });
+  }
+  async request(url, init) {
+    const response = await fetch(url, {
+      ...init,
+      headers: {
+        ...this.headers,
+        ...init.headers ?? {}
+      }
+    });
+    if (response.status === 204) return void 0;
+    if (!response.ok) {
+      const body = await response.json().catch(() => null);
+      if (response.status === 429) {
+        const retryAfter = Number(response.headers.get("Retry-After")) || 15;
+        throw new HarvestRateLimitError(retryAfter, body);
+      }
+      if (response.status === 404) {
+        throw new HarvestNotFoundError(body);
+      }
+      if (response.status === 422) {
+        throw new HarvestUnprocessableError(body);
+      }
+      throw new HarvestApiError(response.status, response.statusText, body);
+    }
+    return response.json();
+  }
+};
+
+// src/paginator.ts
+var Paginator = class {
+  client;
+  path;
+  dataKey;
+  params;
+  constructor(client, path, dataKey, params = {}) {
+    this.client = client;
+    this.path = path;
+    this.dataKey = dataKey;
+    this.params = params;
+  }
+  async *[Symbol.asyncIterator]() {
+    let page = 1;
+    let totalPages = 1;
+    do {
+      const response = await this.client.get(
+        this.path,
+        { ...this.params, page, per_page: this.params.per_page ?? 100 }
+      );
+      const items = response[this.dataKey];
+      if (!items || items.length === 0) return;
+      for (const item of items) {
+        yield item;
+      }
+      const totalPagesValue = response.total_pages;
+      totalPages = typeof totalPagesValue === "number" ? totalPagesValue : 1;
+      page++;
+    } while (page <= totalPages);
+  }
+  async toArray() {
+    const results = [];
+    for await (const item of this) {
+      results.push(item);
+    }
+    return results;
+  }
+};
+
+// src/resources/base.ts
+var BaseResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+};
+var CrudResource = class extends BaseResource {
+  async list(params) {
+    const response = await this.client.get(
+      this.path,
+      params
+    );
+    return response[this.dataKey] ?? [];
+  }
+  listAll(params) {
+    return new Paginator(this.client, this.path, this.dataKey, params);
+  }
+  async get(id) {
+    return this.client.get(`${this.path}/${id}`);
+  }
+  async create(data) {
+    return this.client.post(this.path, data);
+  }
+  async update(id, data) {
+    return this.client.patch(`${this.path}/${id}`, data);
+  }
+  async delete(id) {
+    return this.client.delete(`${this.path}/${id}`);
+  }
+};
+
+// src/resources/clients.ts
+var ClientsResource = class extends CrudResource {
+  path = "/clients";
+  dataKey = "clients";
+};
+
+// src/resources/company.ts
+var CompanyResource = class extends BaseResource {
+  async get() {
+    return this.client.get("/company");
+  }
+};
+
+// src/resources/contacts.ts
+var ContactsResource = class extends CrudResource {
+  path = "/contacts";
+  dataKey = "contacts";
+};
+
+// src/resources/estimateItemCategories.ts
+var EstimateItemCategoriesResource = class extends CrudResource {
+  path = "/estimate_item_categories";
+  dataKey = "estimate_item_categories";
+};
+
+// src/resources/estimates.ts
+var EstimatesResource = class extends CrudResource {
+  path = "/estimates";
+  dataKey = "estimates";
+  /** Access messages for an estimate. */
+  messages(estimateId) {
+    return new EstimateMessagesResource(this.client, estimateId);
+  }
+};
+var EstimateMessagesResource = class {
+  constructor(client, estimateId) {
+    this.client = client;
+    this.estimateId = estimateId;
+  }
+  get path() {
+    return `/estimates/${this.estimateId}/messages`;
+  }
+  async list(params) {
+    const response = await this.client.get(this.path, params);
+    return response.estimate_messages ?? [];
+  }
+  listAll(params) {
+    return new Paginator(this.client, this.path, "estimate_messages", params);
+  }
+  async create(data) {
+    return this.client.post(this.path, data);
+  }
+  async delete(id) {
+    return this.client.delete(`${this.path}/${id}`);
+  }
+};
+
+// src/resources/expenseCategories.ts
+var ExpenseCategoriesResource = class extends CrudResource {
+  path = "/expense_categories";
+  dataKey = "expense_categories";
+};
+
+// src/resources/expenses.ts
+var ExpensesResource = class extends CrudResource {
+  path = "/expenses";
+  dataKey = "expenses";
+};
+
+// src/resources/invoiceItemCategories.ts
+var InvoiceItemCategoriesResource = class extends CrudResource {
+  path = "/invoice_item_categories";
+  dataKey = "invoice_item_categories";
+};
+
+// src/resources/invoices.ts
+var InvoicesResource = class extends CrudResource {
+  path = "/invoices";
+  dataKey = "invoices";
+  /** Access messages (send, list, delete) for an invoice. */
+  messages(invoiceId) {
+    return new InvoiceMessagesResource(this.client, invoiceId);
+  }
+};
+var InvoiceMessagesResource = class {
+  constructor(client, invoiceId) {
+    this.client = client;
+    this.invoiceId = invoiceId;
+  }
+  get path() {
+    return `/invoices/${this.invoiceId}/messages`;
+  }
+  async list(params) {
+    const response = await this.client.get(this.path, params);
+    return response.invoice_messages ?? [];
+  }
+  listAll(params) {
+    return new Paginator(this.client, this.path, "invoice_messages", params);
+  }
+  async create(data) {
+    return this.client.post(this.path, data);
+  }
+  async delete(id) {
+    return this.client.delete(`${this.path}/${id}`);
+  }
+};
+
+// src/resources/userAssignments.ts
+var UserAssignmentsResource = class extends BaseResource {
+  async list(params) {
+    const response = await this.client.get(
+      "/user_assignments",
+      params
+    );
+    return response.user_assignments ?? [];
+  }
+  listAll(params) {
+    return new Paginator(this.client, "/user_assignments", "user_assignments", params);
+  }
+};
+var ProjectUserAssignmentsResource = class {
+  constructor(client, projectId) {
+    this.client = client;
+    this.projectId = projectId;
+  }
+  get path() {
+    return `/projects/${this.projectId}/user_assignments`;
+  }
+  async list(params) {
+    const response = await this.client.get(this.path, params);
+    return response.user_assignments ?? [];
+  }
+  listAll(params) {
+    return new Paginator(this.client, this.path, "user_assignments", params);
+  }
+  async get(id) {
+    return this.client.get(`${this.path}/${id}`);
+  }
+  async create(data) {
+    return this.client.post(this.path, data);
+  }
+  async update(id, data) {
+    return this.client.patch(`${this.path}/${id}`, data);
+  }
+  async delete(id) {
+    return this.client.delete(`${this.path}/${id}`);
+  }
+};
+
+// src/resources/taskAssignments.ts
+var TaskAssignmentsResource = class extends BaseResource {
+  async list(params) {
+    const response = await this.client.get(
+      "/task_assignments",
+      params
+    );
+    return response.task_assignments ?? [];
+  }
+  listAll(params) {
+    return new Paginator(this.client, "/task_assignments", "task_assignments", params);
+  }
+};
+var ProjectTaskAssignmentsResource = class {
+  constructor(client, projectId) {
+    this.client = client;
+    this.projectId = projectId;
+  }
+  get path() {
+    return `/projects/${this.projectId}/task_assignments`;
+  }
+  async list(params) {
+    const response = await this.client.get(this.path, params);
+    return response.task_assignments ?? [];
+  }
+  listAll(params) {
+    return new Paginator(this.client, this.path, "task_assignments", params);
+  }
+  async get(id) {
+    return this.client.get(`${this.path}/${id}`);
+  }
+  async create(data) {
+    return this.client.post(this.path, data);
+  }
+  async update(id, data) {
+    return this.client.patch(`${this.path}/${id}`, data);
+  }
+  async delete(id) {
+    return this.client.delete(`${this.path}/${id}`);
+  }
+};
+
+// src/resources/projects.ts
+var ProjectsResource = class extends CrudResource {
+  path = "/projects";
+  dataKey = "projects";
+  /** Access user assignments nested under a project. */
+  userAssignments(projectId) {
+    return new ProjectUserAssignmentsResource(this.client, projectId);
+  }
+  /** Access task assignments nested under a project. */
+  taskAssignments(projectId) {
+    return new ProjectTaskAssignmentsResource(this.client, projectId);
+  }
+};
+
+// src/resources/reports.ts
+var TimeReports = class {
+  constructor(client) {
+    this.client = client;
+  }
+  async byClients(params) {
+    return this.client.get("/reports/time/clients", params);
+  }
+  async byProjects(params) {
+    return this.client.get("/reports/time/projects", params);
+  }
+  async byTasks(params) {
+    return this.client.get("/reports/time/tasks", params);
+  }
+  async byTeam(params) {
+    return this.client.get("/reports/time/team", params);
+  }
+};
+var ExpenseReports = class {
+  constructor(client) {
+    this.client = client;
+  }
+  async byClients(params) {
+    return this.client.get("/reports/expenses/clients", params);
+  }
+  async byProjects(params) {
+    return this.client.get("/reports/expenses/projects", params);
+  }
+  async byCategories(params) {
+    return this.client.get("/reports/expenses/categories", params);
+  }
+  async byTeam(params) {
+    return this.client.get("/reports/expenses/team", params);
+  }
+};
+var ReportsResource = class {
+  constructor(client) {
+    this.client = client;
+    this.time = new TimeReports(client);
+    this.expenses = new ExpenseReports(client);
+  }
+  time;
+  expenses;
+  async uninvoiced(params) {
+    return this.client.get("/reports/uninvoiced", params);
+  }
+  async projectBudget(params) {
+    return this.client.get("/reports/project_budget", params);
+  }
+};
+
+// src/resources/roles.ts
+var RolesResource = class extends CrudResource {
+  path = "/roles";
+  dataKey = "roles";
+};
+
+// src/resources/tasks.ts
+var TasksResource = class extends CrudResource {
+  path = "/tasks";
+  dataKey = "tasks";
+};
+
+// src/resources/timeEntries.ts
+var TimeEntriesResource = class extends CrudResource {
+  path = "/time_entries";
+  dataKey = "time_entries";
+  /** Stop a running time entry timer. */
+  async stop(id) {
+    return this.client.patch(`/time_entries/${id}/stop`);
+  }
+  /** Restart a stopped time entry timer. */
+  async restart(id) {
+    return this.client.patch(`/time_entries/${id}/restart`);
+  }
+  /** Delete external reference for a time entry. */
+  async deleteExternalReference(id) {
+    return this.client.delete(`/time_entries/${id}/external_reference`);
+  }
+};
+
+// src/resources/users.ts
+var UsersResource = class extends CrudResource {
+  path = "/users";
+  dataKey = "users";
+  /** Retrieve the currently authenticated user. */
+  async me() {
+    return this.client.get("/users/me");
+  }
+  /** List project assignments for the current user. */
+  async myProjectAssignments(params) {
+    const response = await this.client.get(
+      "/users/me/project_assignments",
+      params
+    );
+    return response.project_assignments ?? [];
+  }
+  /** Access billable rates for a user. */
+  billableRates(userId) {
+    return new UserBillableRatesResource(this.client, userId);
+  }
+  /** Access cost rates for a user. */
+  costRates(userId) {
+    return new UserCostRatesResource(this.client, userId);
+  }
+  /** Access teammates for a user. */
+  teammates(userId) {
+    return new UserTeammatesResource(this.client, userId);
+  }
+  /** List project assignments for a specific user. */
+  projectAssignments(userId) {
+    return new UserProjectAssignmentsResource(this.client, userId);
+  }
+};
+var UserBillableRatesResource = class {
+  constructor(client, userId) {
+    this.client = client;
+    this.userId = userId;
+  }
+  get path() {
+    return `/users/${this.userId}/billable_rates`;
+  }
+  async list(params) {
+    const response = await this.client.get(this.path, params);
+    return response.billable_rates ?? [];
+  }
+  listAll(params) {
+    return new Paginator(this.client, this.path, "billable_rates", params);
+  }
+  async get(id) {
+    return this.client.get(`${this.path}/${id}`);
+  }
+  async create(data) {
+    return this.client.post(this.path, data);
+  }
+};
+var UserCostRatesResource = class {
+  constructor(client, userId) {
+    this.client = client;
+    this.userId = userId;
+  }
+  get path() {
+    return `/users/${this.userId}/cost_rates`;
+  }
+  async list(params) {
+    const response = await this.client.get(this.path, params);
+    return response.cost_rates ?? [];
+  }
+  listAll(params) {
+    return new Paginator(this.client, this.path, "cost_rates", params);
+  }
+  async get(id) {
+    return this.client.get(`${this.path}/${id}`);
+  }
+  async create(data) {
+    return this.client.post(this.path, data);
+  }
+};
+var UserTeammatesResource = class {
+  constructor(client, userId) {
+    this.client = client;
+    this.userId = userId;
+  }
+  get path() {
+    return `/users/${this.userId}/teammates`;
+  }
+  async list(params) {
+    const response = await this.client.get(this.path, params);
+    return response.teammates ?? [];
+  }
+  /** Update (replace) teammates for a user. */
+  async update(data) {
+    const response = await this.client.patch(this.path, data);
+    return response.teammates ?? [];
+  }
+};
+var UserProjectAssignmentsResource = class {
+  constructor(client, userId) {
+    this.client = client;
+    this.userId = userId;
+  }
+  get path() {
+    return `/users/${this.userId}/project_assignments`;
+  }
+  async list(params) {
+    const response = await this.client.get(this.path, params);
+    return response.project_assignments ?? [];
+  }
+  listAll(params) {
+    return new Paginator(this.client, this.path, "project_assignments", params);
+  }
+};
+
+// src/index.ts
+var Harvest = class {
+  clients;
+  company;
+  contacts;
+  estimateItemCategories;
+  estimates;
+  expenseCategories;
+  expenses;
+  invoiceItemCategories;
+  invoices;
+  projects;
+  reports;
+  roles;
+  taskAssignments;
+  tasks;
+  timeEntries;
+  userAssignments;
+  users;
+  constructor(config) {
+    const client = new HarvestClient(config);
+    this.clients = new ClientsResource(client);
+    this.company = new CompanyResource(client);
+    this.contacts = new ContactsResource(client);
+    this.estimateItemCategories = new EstimateItemCategoriesResource(client);
+    this.estimates = new EstimatesResource(client);
+    this.expenseCategories = new ExpenseCategoriesResource(client);
+    this.expenses = new ExpensesResource(client);
+    this.invoiceItemCategories = new InvoiceItemCategoriesResource(client);
+    this.invoices = new InvoicesResource(client);
+    this.projects = new ProjectsResource(client);
+    this.reports = new ReportsResource(client);
+    this.roles = new RolesResource(client);
+    this.taskAssignments = new TaskAssignmentsResource(client);
+    this.tasks = new TasksResource(client);
+    this.timeEntries = new TimeEntriesResource(client);
+    this.userAssignments = new UserAssignmentsResource(client);
+    this.users = new UsersResource(client);
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ClientsResource,
+  CompanyResource,
+  ContactsResource,
+  EstimateItemCategoriesResource,
+  EstimateMessagesResource,
+  EstimatesResource,
+  ExpenseCategoriesResource,
+  ExpenseReports,
+  ExpensesResource,
+  Harvest,
+  HarvestApiError,
+  HarvestClient,
+  HarvestNotFoundError,
+  HarvestRateLimitError,
+  HarvestUnprocessableError,
+  InvoiceItemCategoriesResource,
+  InvoiceMessagesResource,
+  InvoicesResource,
+  Paginator,
+  ProjectTaskAssignmentsResource,
+  ProjectUserAssignmentsResource,
+  ProjectsResource,
+  ReportsResource,
+  RolesResource,
+  TaskAssignmentsResource,
+  TasksResource,
+  TimeEntriesResource,
+  TimeReports,
+  UserAssignmentsResource,
+  UserBillableRatesResource,
+  UserCostRatesResource,
+  UserProjectAssignmentsResource,
+  UserTeammatesResource,
+  UsersResource
+});