trafficmind-typescript-sdk 1.0.0

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 Trafficmind
+
+   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,355 @@
+# Trafficmind TypeScript SDK
+
+<a href="https://www.npmjs.com/package/trafficmind-typescript-sdk"><img src="https://img.shields.io/npm/v/trafficmind-typescript-sdk" alt="npm"></a>
+
+Official TypeScript SDK for the Trafficmind **Client API** (`/public/v1`): domains, domain records, CDN, firewall rules and domain settings.
+
+## Configuration
+
+Trafficmind SDK requires API credentials to authenticate requests.
+
+### Required environment variables
+
+```dotenv
+# Trafficmind API credentials
+TRAFFICMIND_ACCESS_USER=example@trafficmind.com
+TRAFFICMIND_ACCESS_KEY=example_api_key_123
+```
+
+### Optional environment variable
+
+```dotenv
+# Base URL for Trafficmind API (optional, defaults to https://api.trafficmind.com)
+TRAFFICMIND_BASE_URL=https://api.trafficmind.com
+```
+
+---
+
+## Requirements
+
+- Node.js **18+** (built-in global `fetch`)
+- ESM or CommonJS environment (SDK ships both formats)
+
+## Installation
+
+```bash
+npm install trafficmind-typescript-sdk
+```
+
+### From GitHub
+
+```bash
+npm install github:trafficmind/typescript
+```
+
+## Authentication
+
+All requests automatically include:
+
+- `X-Access-User` — email associated with your account.
+- `X-Access-Key` — global API key.
+
+By default requests go to `https://api.trafficmind.com`. Use `baseURL` to point
+the SDK at a staging or private deployment.
+
+> `baseURL` must use HTTPS. HTTP is only allowed for `localhost` and `127.x` in development.
+
+## Quick start
+
+```ts
+import Trafficmind from 'trafficmind-typescript-sdk';
+
+const client = new Trafficmind({
+    accessUser: process.env.TRAFFICMIND_ACCESS_USER!,
+    accessKey:   process.env.TRAFFICMIND_ACCESS_KEY!,
+});
+
+const domains = await client.domains.listDomains({ page_size: 20 });
+
+console.log('domains count:', domains.length);
+
+for (const domain of domains) {
+    console.log(domain.id, domain.name);
+}
+
+// Auto-pagination — iterate all domains without manual page handling
+for await (const domain of client.domains.listAll({ page_size: 50 })) {
+    console.log(domain.id, domain.name);
+}
+```
+
+See `examples/smoke.mjs` for a more complete example with error handling.
+
+## Available resources
+
+| Resource                        | Description                                    |
+|---------------------------------|------------------------------------------------|
+| `client.domains`                | List, create, get, and delete domains          |
+| `client.domains.domainRecords`  | List and batch domain records                  |
+| `client.domains.settings`       | Get and update domain settings                  |
+| `client.domains.firewallRules`  | Create domain-level firewall rules             |
+| `client.accounts.firewallRules` | Create account-level firewall rules            |
+| `client.cdn.storage`            | List, create, delete, and refresh CDN storages |
+| `client.cdn.users`              | Create and revoke CDN SFTP users               |
+
+## Error handling
+
+Non-2xx responses and `success: false` payloads throw typed error classes:
+
+| Status | Class |
+|--------|-------|
+| 400 | `BadRequestError` |
+| 401 | `AuthenticationError` |
+| 403 | `PermissionDeniedError` |
+| 404 | `NotFoundError` |
+| 409 | `ConflictError` |
+| 422 | `UnprocessableEntityError` |
+| 429 | `RateLimitError` |
+| ≥500 | `InternalServerError` |
+| Network failure | `APIConnectionError` |
+
+```ts
+import Trafficmind, {
+  AuthenticationError,
+  NotFoundError,
+  RateLimitError,
+  APIError,
+} from 'trafficmind-typescript-sdk';
+
+try {
+  const domains = await client.domains.listDomains();
+} catch (e) {
+  if (e instanceof AuthenticationError) {
+    // 401 / 403
+  } else if (e instanceof NotFoundError) {
+    // 404
+  } else if (e instanceof RateLimitError) {
+    console.log('retry after:', e.retryAfter, 's');
+  } else if (e instanceof APIError) {
+    console.log(e.status, e.message);
+  }
+  throw e;
+}
+```
+
+## Retries
+
+The client automatically retries failed requests with exponential backoff and jitter.
+
+- Default: **2 retries** for `429`, `500`, `502`, `503`, `504`, and network errors.
+- `429` responses respect the `Retry-After` header when present.
+- Set `maxRetries: 0` to disable retries entirely.
+
+```ts
+const client = new Trafficmind({
+  accessUser:  process.env.TRAFFICMIND_ACCESS_USER!,
+  accessKey:    process.env.TRAFFICMIND_ACCESS_KEY!,
+  maxRetries: 5,  // default: 2, set 0 to disable
+});
+```
+
+Backoff formula: `min(30s, 2^attempt * 1000ms) + random(0..200ms)`.
+
+## Timeouts
+
+Default timeout is **60 seconds**. Override at the client level or per request via `AbortSignal`.
+
+```ts
+// Client-level timeout
+const client = new Trafficmind({
+  accessUser: process.env.TRAFFICMIND_ACCESS_USER!, 
+  accessKey:   process.env.TRAFFICMIND_ACCESS_KEY!,
+  timeout:   10_000, // 10 seconds, set 0 to disable
+});
+
+// Per-request timeout via AbortSignal
+const domains = await client.domains.listDomains({}, {
+  signal: AbortSignal.timeout(5_000),
+});
+```
+
+When both a client-level timeout and a per-request signal are present, whichever fires first aborts the request.
+
+## Idempotency Key
+
+For safe retries of non-idempotent requests (POST, PUT, PATCH), pass an idempotency key.
+The SDK sends it as the `X-Idempotency-Key` header:
+
+```ts
+import { randomUUID } from 'node:crypto';
+
+await client.domains.createDomain(
+  { name: 'example.com' },
+  { idempotencyKey: randomUUID() },
+);
+```
+
+If the request is retried after a network failure, the server uses the key to return
+the original response instead of creating a duplicate resource.
+
+## Observability
+
+Pass an `onRequest` hook to log every request, response, and error — without any vendor lock-in:
+
+```ts
+const client = new Trafficmind({
+    accessUser:  process.env.TRAFFICMIND_ACCESS_USER!,
+    accessKey:    process.env.TRAFFICMIND_ACCESS_KEY!,
+    onRequest: (event) => {
+        if (event.type === 'request') {
+            console.log(`→ ${event.method} ${event.url} (attempt ${event.attempt})`);
+        } else if (event.type === 'response') {
+            console.log(`← ${event.status} in ${event.durationMs}ms`);
+        } else if (event.type === 'error') {
+            console.error(`✖ ${event.error} in ${event.durationMs}ms`);
+        }
+    },
+});
+```
+
+### OpenTelemetry integration
+
+```ts
+import {trace, SpanStatusCode} from '@opentelemetry/api';
+
+const tracer = trace.getTracer('trafficmind-sdk');
+const spans = new Map<number, ReturnType<typeof tracer.startSpan>>();
+
+const client = new Trafficmind({
+    accessUser: process.env.TRAFFICMIND_ACCESS_USER!,
+    accessKey: process.env.TRAFFICMIND_ACCESS_KEY!,
+    onRequest: (event) => {
+        if (event.type === 'request') {
+            const span = tracer.startSpan(`${event.method} ${event.url}`);
+            spans.set(event.attempt, span);
+        } else if (event.type === 'response') {
+            spans.get(event.attempt)?.setStatus({code: SpanStatusCode.OK}).end();
+        } else if (event.type === 'error') {
+            spans.get(event.attempt)?.setStatus({code: SpanStatusCode.ERROR}).end();
+        }
+    },
+});
+```
+
+## CJS / ESM
+
+The SDK ships both ESM and CommonJS builds — no configuration needed.
+
+```ts
+// ESM (TypeScript, Node with "type": "module")
+import Trafficmind from 'trafficmind-typescript-sdk';
+
+// CommonJS (legacy Node, Jest without transform)
+const Trafficmind = require('trafficmind-typescript-sdk');
+```
+
+## Pagination
+
+Use `listAll()` to lazily iterate all pages without loading everything into memory:
+
+```ts
+// Iterate all domains
+for await (const domain of client.domains.listAll({ page_size: 50 })) {
+    console.log(domain.id, domain.name);
+}
+
+// Iterate all domain records for a domain
+for await (const record of client.domains.domainRecords.listAll({ domain_id: 'domain_123' })) {
+    console.log(record.name, record.type);
+}
+```
+
+Use `listDomains()` for a single page:
+
+```ts
+const page = await client.domains.listDomains({ page: 2, page_size: 50 });
+console.log(page.result_info?.total_count);
+```
+
+## Project structure
+
+```
+src/
+  trafficmind.ts        — root client class
+  core/
+    client.ts           — HTTP client, auth, retry, timeout, hooks
+    api-error.ts        — error class hierarchy
+    api-promise.ts      — APIPromise wrapper
+    hooks.ts            — onRequest hook types
+    pagination.ts       — Page type and helpers
+    resource.ts         — base APIResource class
+    retry.ts            — backoff and retry logic
+  resources/
+    domains.ts          — domains resource
+    domains/            — domain records, settings, firewall rules
+    accounts.ts         — accounts resource
+    accounts/           — firewall rules
+    cdn.ts              — CDN resource
+    cdn/                — storage, users
+  types.ts              — shared API types
+dist/
+  esm/                  — ESM build output
+  cjs/                  — CommonJS build output
+examples/
+  smoke.mjs             — live API smoke test
+test/
+  sdk.test.js           — unit tests (no real network calls)
+```
+
+## Running tests & checks
+
+Tests use an injected `fetch` stub and do not require network access:
+```bash
+# Build + run all tests
+npm test
+
+# Run all checks at once (format + lint + typecheck + test)
+npm run check
+```
+
+### Individual commands
+```bash
+# Type check without emitting files
+npm run typecheck
+
+# ESLint
+npm run lint
+
+# Prettier format check (dry-run)
+npm run cs-check
+
+# Prettier auto-fix
+npm run cs-fix
+
+# Test coverage report
+npm run coverage
+```
+
+## Security
+
+- Treat API keys as secrets — do not commit credentials.
+- Prefer environment variables or a secrets manager.
+- Credentials are automatically redacted from `util.inspect()` and `JSON.stringify()` output.
+- See [SECURITY.md](SECURITY.md) for vulnerability reporting.
+
+## Support & Compatibility
+
+- Supported Node versions: **18, 20, 22**
+- Supported API: `/public/v1`
+- Deprecated SDK APIs will be marked with a JSDoc `@deprecated` tag at least one minor version before removal.
+
+## Versioning
+
+This SDK follows [Semantic Versioning](https://semver.org/):
+
+- Patch releases `1.0.x` — bug fixes, no breaking changes
+- Minor releases `1.x.0` — new features, no breaking changes
+- Major releases `x.0.0` — breaking changes, migration guide provided
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for release history and breaking changes.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "trafficmind-typescript-sdk",
+  "version": "1.0.0",
+  "description": "TypeScript client (SDK) for Trafficmind API",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/trafficmind/typescript.git"
+  },
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/esm/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.cjs"
+    }
+  },
+  "main": "./dist/esm/index.js",
+  "types": "./dist/esm/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build:esm": "tsc -p tsconfig.build.json --outDir dist/esm",
+    "build:cjs": "tsc -p tsconfig.cjs.json && node scripts/fix-cjs.mjs",
+    "build": "npm run build:esm && npm run build:cjs",
+    "test": "node --test ./test/*.test.js",
+    "pretest": "npm run build",
+    "smoke": "node ./examples/smoke.mjs",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src --ext .ts",
+    "cs-check": "prettier --check \"src/**/*.ts\"",
+    "cs-fix": "prettier --write \"src/**/*.ts\"",
+    "coverage": "c8 node --test ./test/*.test.js",
+    "check": "npm run cs-check && npm run lint && npm run typecheck && npm test"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "devDependencies": {
+    "@types/node": "^25.3.3",
+    "typescript": "^5.8.0",
+    "eslint": "^9.0.0",
+    "typescript-eslint": "^8.0.0",
+    "prettier": "^3.0.0",
+    "c8": "^10.0.0"
+  },
+  "c8": {
+    "reporter": ["text", "html"],
+    "exclude": ["test/**", "scripts/**", "examples/**"]
+  }
+}