@clickmax/public-sdk 0.0.0 → 12.5.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 reasonable and customary use in 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 Additional Liability. 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 additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026-present Bilhon Technologies
+
+   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

@@ -1,3 +1,174 @@
 # @clickmax/public-sdk
 
-This 0.0.0 release has no code. Install the latest version.
+TypeScript client for the [Clickmax public API](https://docs.clickmax.io/en/reference/api). It is generated from the API's OpenAPI document, so every operation and its input and output types match the API version the package was built from.
+
+```sh
+npm install @clickmax/public-sdk
+```
+
+The package is ESM only and has one runtime dependency ([`try`](https://www.npmjs.com/package/try)). It runs on Node.js 22 or later, Deno, Bun, Cloudflare Workers and any other runtime with `fetch` and `AbortSignal.any`.
+
+## Quickstart
+
+Create an API key for your workspace ([authentication guide](https://docs.clickmax.io/en/reference/api)), then:
+
+```ts
+import { Clickmax } from '@clickmax/public-sdk';
+
+const clickmax = new Clickmax(process.env.CLICKMAX_API_KEY!);
+
+const result = await clickmax.tags.list();
+
+if (result.ok) {
+  console.log(result.value.data);
+} else {
+  const { type, code, message } = result.error;
+  console.error('tags.list failed', { type, code, message });
+}
+```
+
+Operations are grouped by resource: `clickmax.<resource>.<operation>(input?, options?)`. Operations without a resource, such as `clickmax.whoami()`, are methods on the client itself. Your editor lists them all with their descriptions, and the [API reference](https://docs.clickmax.io/en/api-reference) documents each one.
+
+Read operations take their query parameters as the first argument and write operations take the request body:
+
+```ts
+await clickmax.tags.manualList({ name: 'vip', perPage: 50 });
+await clickmax.tags.create({ name: 'VIP', color: 'ff8800' });
+```
+
+> [!WARNING]
+> An API key acts on behalf of its whole workspace. Use the SDK only on a server and load the key from an environment variable or a secret manager. Never ship it in browser or mobile code.
+
+## Results and errors
+
+Methods never throw and never reject. Each one resolves to a result that you can read as an object or destructure as a tuple:
+
+```ts
+const [ok, error, tags] = await clickmax.tags.list();
+
+if (!ok) {
+  // error is a ClickmaxError
+  return;
+}
+```
+
+The result is a `Result` from the [`try`](https://www.npmjs.com/package/try) package, so it also works with `t()` and `instanceof Result`.
+
+On failure, `error` is a `ClickmaxError` (a subclass of `Error`) with these fields:
+
+|Field|Description|
+|-|-|
+|`type`|Category of the error, listed below. Use it for control flow.|
+|`code`|Specific reason in lower_snake case, such as `invalid_input`, `missing_permission` or `plan_limit_reached`.|
+|`status`|HTTP status, or `0` when no response was received.|
+|`message`|Description meant for logs. It may change between releases.|
+|`requestId`|Identifier of the request. Include it when you contact support.|
+|`retryAfter`|Seconds to wait before retrying, when the API sent `Retry-After`.|
+|`issues`|Field-level problems of an `invalid_input` error.|
+|`raw`|Response body as returned by the API.|
+
+|`type`|When|
+|-|-|
+|`invalid_request`|The input was rejected (400, 405, 413, 415, 422).|
+|`authentication`|The key is missing, invalid or revoked (401).|
+|`plan_limit`|The workspace reached a limit of its plan (402).|
+|`permission`|The key lacks a permission for this operation (403).|
+|`not_found`|The resource does not exist (404, 410).|
+|`conflict`|The request conflicts with the current state (409, 412).|
+|`rate_limit`|Too many requests (429). Wait `retryAfter` seconds.|
+|`api`|Clickmax or an upstream service failed (408, 5xx).|
+|`network`|`fetch` failed before a response arrived.|
+|`timeout`|The request took longer than `timeout`.|
+|`aborted`|Your `signal` aborted the request.|
+|`parse`|A successful response had a body that is not valid JSON.|
+
+When the SDK rejects an argument before sending the request, such as a negative `timeout` or a body that cannot be converted to JSON, the error has type `invalid_request`, code `invalid_argument` and status `0`.
+
+Retrying on rate limits:
+
+```ts
+async function listTags() {
+  for (let attempt = 0; attempt < 3; attempt++) {
+    const result = await clickmax.tags.list();
+    if (result.ok || result.error.type !== 'rate_limit') return result;
+    await new Promise((resolve) => setTimeout(resolve, (result.error.retryAfter ?? 10) * 1000));
+  }
+  return clickmax.tags.list();
+}
+```
+
+The constructor is the only place that throws: it throws a `TypeError` when the key is empty or malformed, or when an option is invalid.
+
+## Options
+
+```ts
+const clickmax = new Clickmax(apiKey, {
+  fetch: globalThis.fetch, // default, looked up on each call
+  headers: { 'x-request-source': 'billing-sync' }, // sent with every request
+  timeout: 60_000 // milliseconds, default 60000, 0 disables
+});
+```
+
+The last argument of every method accepts per-call options. Each one overrides the instance value for that call:
+
+```ts
+const controller = new AbortController();
+
+await clickmax.tags.list({
+  signal: controller.signal,
+  timeout: 5_000,
+  headers: { 'x-request-id': crypto.randomUUID() },
+  fetch: myInstrumentedFetch
+});
+```
+
+Per-call headers are applied over instance headers. `Authorization` always comes from the instance key.
+
+## Several workspaces
+
+Each instance holds its own key and options, and instances share no state. Create one per workspace:
+
+```ts
+const storeA = new Clickmax(process.env.STORE_A_KEY!);
+const storeB = new Clickmax(process.env.STORE_B_KEY!);
+
+const [a, b] = await Promise.all([storeA.tags.list(), storeB.tags.list()]);
+```
+
+## Validating with zod
+
+`@clickmax/public-sdk/zod` exports [zod](https://zod.dev) schemas for the input and the successful response of every operation. They are optional: the client does not import them and does not validate anything before sending a request. Install zod 4.1.13 or a later 4.x to use them:
+
+```sh
+npm install zod
+```
+
+A schema is named after the resource and method in PascalCase plus a suffix: `TagsCreateBody` is the body of `clickmax.tags.create()`, `TagsManualListQueryParams` the query of `clickmax.tags.manualList()` and `TagsListResponse` the response of `clickmax.tags.list()`. Root methods use the method name alone, such as `WhoamiResponse`.
+
+```ts
+import { TagsCreateBody } from '@clickmax/public-sdk/zod';
+
+const input = TagsCreateBody.safeParse(formData);
+
+if (input.success) {
+  await clickmax.tags.create(input.data);
+} else {
+  console.error('tags.create input rejected', { op: 'tags.create', issues: input.error.issues });
+}
+```
+
+The schemas are built with `zod/mini` and every export is marked side-effect free, so a bundler keeps only the schemas you import. Without a bundler, importing `@clickmax/public-sdk/zod` builds every schema (roughly 120 MB of heap in Node), so unbundled server code should import it only where it validates data. The subpath also exports the camelCase constants the schemas are built from (limits, defaults and patterns), and their names can change between releases.
+
+## Stability
+
+The API is at version 0 (`/api/v0`). Operations and fields can still change between releases, and each package release matches the API at the time it was published. Pin the version you tested against and read the release notes before upgrading.
+
+## Links
+
+- [API overview, authentication and errors](https://docs.clickmax.io/en/reference/api)
+- [SDK guide](https://docs.clickmax.io/en/reference/api/sdk)
+- [Interactive API reference](https://docs.clickmax.io/en/api-reference)
+
+## License
+
+[Apache-2.0](./LICENSE)