@wakata-dev/api-client 0.1.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Support. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or support.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Wakata
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,187 @@
+# `@wakata-dev/api-client`
+
+The official TypeScript SDK for the Wakata Public API. Generated from the same OpenAPI specification that powers the public Swagger UI and Postman collection, then wrapped in an ergonomic `WakataClient` class with typed errors and automatic idempotency.
+
+## Install
+
+```bash
+pnpm add @wakata-dev/api-client
+# or: npm install @wakata-dev/api-client
+# or: yarn add @wakata-dev/api-client
+```
+
+The package targets Node 18+ (uses global `fetch`). It ships both ESM and CJS builds with full TypeScript declarations.
+
+## 60 seconds — your first call
+
+```ts
+import { WakataClient, WakataNotFoundError } from '@wakata-dev/api-client';
+
+const wakata = new WakataClient({
+  apiKey: process.env.WAKATA_API_KEY!,
+  // baseUrl defaults to https://api.wakata.ai/api/v1
+});
+
+const { items } = await wakata.assets.list({
+  query: { page: 1, page_size: 50, asset_class_name: 'Forklift' },
+});
+
+console.log(`Got ${items.length} forklifts`);
+```
+
+Get an API key from your Wakata admin (Settings → API Keys, requires the **Manage API Keys** permission). Keys look like `wk_1A2b3C4d5E…`.
+
+For dev/sandbox traffic, override the base URL:
+
+```ts
+const wakata = new WakataClient({
+  apiKey: process.env.WAKATA_API_KEY!,
+  baseUrl: 'https://dev-api.wakata.ai/api/v1',
+});
+```
+
+## Resources
+
+Every Public API operation is exposed under a tag-grouped namespace:
+
+| Namespace                  | Methods                                         |
+| -------------------------- | ----------------------------------------------- |
+| `wakata.assets`            | `list`, `get`, `create`, `update`               |
+| `wakata.users`             | `list`, `get`, `create`, `update`               |
+| `wakata.sites`             | `list`, `create`, `update`, `delete`            |
+| `wakata.inspections`       | `list`, `submit`                                |
+| `wakata.issues`            | `list`, `get`, `update`, `getHistory`           |
+| `wakata.userProperties`    | `update`, `delete`                              |
+
+Each method takes the operation's `body`, `path`, `query`, and `headers` in a single options object, and returns the response body directly (no `.data` unwrap required).
+
+## Error handling
+
+The Wakata API always returns a standardized error envelope on non-2xx responses (see `apps/api/docs/QUICKSTART.md` § 7). The SDK maps each response to the most specific subclass of `WakataApiError`:
+
+```ts
+import {
+  WakataApiError,
+  WakataAuthError,
+  WakataPermissionError,
+  WakataNotFoundError,
+  WakataValidationError,
+  WakataConflictError,
+  WakataRateLimitError,
+  WakataServerError,
+} from '@wakata-dev/api-client';
+
+try {
+  await wakata.assets.get({ path: { publicId: 'abc-123' } });
+} catch (err) {
+  if (err instanceof WakataNotFoundError) {
+    console.warn('Asset is gone:', err.requestId);
+    return null;
+  }
+  if (err instanceof WakataRateLimitError) {
+    await sleep((err.retryAfterSeconds ?? 60) * 1000);
+    return; // your retry loop
+  }
+  if (err instanceof WakataValidationError) {
+    for (const d of err.details ?? []) {
+      console.error(`  ${d.field}: ${d.message} (${d.code})`);
+    }
+  }
+  throw err; // anything else is a real bug — surface it
+}
+```
+
+Every error carries:
+
+- `code` — canonical error code (e.g. `not_found`, `rate_limited`, `validation_error`).
+- `statusCode` — HTTP status.
+- `requestId` — the server's `X-Request-Id`. **Include this when filing support tickets** — it pinpoints the exact request in Wakata's logs.
+- `docsUrl` — link to the docs page for this error code, when available.
+- `param`, `details` — populated on validation errors.
+
+## Idempotency
+
+`POST` and `PATCH` endpoints accept an `Idempotency-Key` header. Sending the same key with the same body within 24 hours returns the cached response instead of re-executing the write — making retries safe.
+
+**The SDK auto-attaches a fresh key on every POST/PATCH if you don't pass one.** That makes single requests safe-by-default; it does **not** make retries safe-by-default, because a retry from your code calls the SDK again and generates a new key.
+
+To make a logical operation idempotent across retry attempts, mint one key yourself and pass it explicitly:
+
+```ts
+import { generateIdempotencyKey, WakataClient } from '@wakata-dev/api-client';
+
+const idempotencyKey = generateIdempotencyKey(); // mint once
+const payload = {
+  asset_number: 'FORKLIFT-007',
+  asset_class_id: 'abc-…',
+  site_id: 'def-…',
+};
+
+for (let attempt = 0; attempt < 3; attempt++) {
+  try {
+    return await wakata.assets.create({
+      body: payload,
+      headers: { 'Idempotency-Key': idempotencyKey },
+    });
+  } catch (err) {
+    // 5xx is safe to retry under the same key.
+    if (err instanceof WakataServerError) continue;
+    throw err;
+  }
+}
+```
+
+Replayed responses include `Idempotent-Replayed: true` so you can see at a glance that you hit the cache.
+
+## Rate limits
+
+The Public API throttles at **1000 requests/minute per key** by default. On `429`, catch `WakataRateLimitError` and sleep for `retryAfterSeconds` before retrying:
+
+```ts
+try {
+  await wakata.users.list();
+} catch (err) {
+  if (err instanceof WakataRateLimitError) {
+    await new Promise((r) => setTimeout(r, (err.retryAfterSeconds ?? 60) * 1000));
+  } else throw err;
+}
+```
+
+## BigInt IDs are strings
+
+Wakata uses `BIGINT` primary keys internally but serializes them as JSON **strings** at the API boundary to avoid JavaScript's 2⁵³ integer precision cliff. The SDK's generated types reflect this — every `id`, `*Id`, `*_id`, `*Ids`, `*_ids` field is typed `string`:
+
+```ts
+const asset = await wakata.assets.get({ path: { publicId: 'abc-123' } });
+asset.id;          // string — even though server-side it's a BIGINT
+asset.companyId;   // string
+asset.siteId;      // string
+```
+
+When passing IDs back into the API (path params, filters, body fields), pass them as strings — the SDK doesn't coerce.
+
+## Regenerating the client
+
+When the API changes shape:
+
+```bash
+# from monorepo root
+pnpm --filter @wakata/api run docs:export        # refresh OpenAPI JSON
+pnpm --filter @wakata-dev/api-client run generate    # regenerate SDK
+pnpm --filter @wakata-dev/api-client run build       # verify it compiles
+```
+
+The generator (`scripts/generate.ts`) post-processes the OpenAPI spec to rewrite the BigInt-as-number ID fields to strings before feeding it into `@hey-api/openapi-ts`. The generated output lives in `src/generated/` and is checked into the repo — consumers don't need the codegen toolchain.
+
+## Escape hatch — raw client
+
+The `WakataClient` exposes the underlying `@hey-api/client-fetch` instance as `wakata.raw` for advanced cases (custom interceptors, low-level retries, unwrapped operations):
+
+```ts
+wakata.raw.interceptors.request.use((req) => {
+  req.headers.set('X-My-Custom-Tracing', traceId);
+  return req;
+});
+```
+
+Generated operation functions are also re-exported from the package root if you want to use them directly without the wrapper.