@augstash/sdk 0.2.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 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
+
+   Copyright 2026 Augmentrait Private Limited
+
+   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,80 @@
+# @augstash/sdk
+
+Node / TypeScript client for the Augstash API. Not published yet - see [`../README.md`](../README.md).
+
+```bash
+npm install            # dev dependencies
+python ../tools/refresh.py --base-url http://localhost:8086 node   # generate the client
+npm test
+npm run build
+```
+
+## Using it
+
+```ts
+import { AugstashClient, AugstashError, ContactApi, SmsApi, WalletApi } from '@augstash/sdk';
+
+const client = new AugstashClient({
+  baseUrl: process.env.AUGSTASH_BASE_URL!,   // required - there is no default host
+  apiKey: process.env.AUGSTASH_API_KEY!,     // ask_live_<keyId>.<secret>
+});
+
+const wallet = await client.api(WalletApi).balance();
+
+try {
+  await client.api(SmsApi).sendSms({ sendSmsRequest: { to: '+919000000000', body: 'hello' } });
+} catch (error) {
+  if (error instanceof AugstashError && error.code === 'WALLET_INSUFFICIENT_FUNDS') {
+    // branch on `code`, never on `message` - message is localized
+    console.error(error.detail, error.traceId);
+  }
+}
+```
+
+`client.api(X)` takes any of the 154 generated API classes and hands back a cached, configured
+instance. There is no hand-written list of accessors: one would drift the moment an endpoint is
+added.
+
+### Paging
+
+```ts
+import { collect, paginateCursor, paginatePages } from '@augstash/sdk';
+
+const contacts = client.api(ContactApi);
+for await (const contact of paginatePages((page) => contacts.listContacts({ page, limit: 100 }))) {
+  // ...
+}
+```
+
+Use `paginateCursor` for message, conversation and event history - those endpoints are cursor-paged
+because an offset page over a table that grows at the top repeats and skips rows mid-scroll.
+
+### Webhooks
+
+```ts
+import { verifyWebhookSignature, SIGNATURE_HEADER } from '@augstash/sdk';
+
+app.post('/hooks/augstash', express.raw({ type: 'application/json' }), async (req, res) => {
+  const ok = await verifyWebhookSignature(secret, req.body, req.header(SIGNATURE_HEADER));
+  if (!ok) return res.sendStatus(401);
+  // req.body is the raw Buffer - `express.json()` would re-serialize and the check would fail
+  res.sendStatus(204);
+});
+```
+
+## Options
+
+| Option | Default | |
+|---|---|---|
+| `baseUrl` | - | required |
+| `apiKey` / `bearerToken` | - | one is required; a bearer token reaches endpoints a key cannot |
+| `timeoutMs` | 30000 | per attempt |
+| `retry` | 3 attempts, 0.5s-8s | `{maxAttempts: 1}` disables |
+| `idempotency` | `true` | off also stops mutating calls being retried |
+| `headers`, `fetch`, `middleware` | - | escape hatches |
+
+## Build notes
+
+Compiled to CommonJS so both bundlers and plain Node consumers work without extension-ful imports;
+an ESM build is worth adding before publishing. `src/generated/` is machine-written and gitignored -
+edit `src/*.ts` only.

package/dist/client.d.ts

@@ -0,0 +1,41 @@
+import { Configuration, type Middleware } from './generated/src/runtime';
+import { type RetryOptions } from './transport';
+export interface AugstashClientOptions {
+    /** Origin of the Augstash API for your environment, e.g. `https://api.example.com`. Required. */
+    baseUrl: string;
+    /** An `ask_live_*` API key, sent as `X-Api-Key`. Use this or {@link bearerToken}. */
+    apiKey?: string;
+    /** An Augstash-issued user JWT, sent as `Authorization: Bearer`. Reaches endpoints a key cannot. */
+    bearerToken?: string;
+    /** Per-request timeout in ms (default 30000). */
+    timeoutMs?: number;
+    /** Retry policy for 429/502/503/504 and transport failures. Pass `{maxAttempts: 1}` to disable. */
+    retry?: Partial<RetryOptions>;
+    /**
+     * Send `X-Idempotency-Key` on mutating calls (default true). Turning it off also stops mutating
+     * calls being retried, because a retry would then risk executing twice.
+     */
+    idempotency?: boolean;
+    /** Extra headers on every request. */
+    headers?: Record<string, string>;
+    /** Replacement `fetch`, for tests or a proxy-aware agent. */
+    fetch?: typeof fetch;
+    /** Extra middleware, appended after the SDK's own. */
+    middleware?: Middleware[];
+}
+type ApiConstructor<T> = new (configuration: Configuration) => T;
+export declare class AugstashClient {
+    readonly configuration: Configuration;
+    private readonly instances;
+    constructor(options: AugstashClientOptions);
+    /**
+     * A configured instance of any generated API class, created once and reused.
+     *
+     * ```ts
+     * import { ContactApi } from '@augstash/sdk';
+     * const contacts = client.api(ContactApi);
+     * ```
+     */
+    api<T>(Api: ApiConstructor<T>): T;
+}
+export {};

package/dist/client.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AugstashClient = void 0;
+/**
+ * The entry point: one configured client, from which every API surface is taken.
+ *
+ * ```ts
+ * import { AugstashClient } from '@augstash/sdk';
+ * import { WalletApi, SmsApi } from '@augstash/sdk';
+ *
+ * const client = new AugstashClient({
+ *   baseUrl: process.env.AUGSTASH_BASE_URL!,   // no default beyond localhost - pass your own
+ *   apiKey: process.env.AUGSTASH_API_KEY!,     // ask_live_<keyId>.<secret>
+ * });
+ *
+ * const wallet = await client.api(WalletApi).balance();
+ * ```
+ *
+ * There are 154 API classes, one per controller, and `client.api(X)` is how you reach any of them:
+ * it hands back a cached, fully configured instance. No hand-written list of accessors exists on
+ * purpose - one would drift the moment an endpoint is added.
+ */
+const errors_1 = require("./errors");
+const runtime_1 = require("./generated/src/runtime");
+const transport_1 = require("./transport");
+class AugstashClient {
+    configuration;
+    instances = new Map();
+    constructor(options) {
+        if (!options.baseUrl) {
+            throw new errors_1.AugstashConfigError('baseUrl is required - there is no default Augstash host');
+        }
+        if (!options.apiKey && !options.bearerToken) {
+            throw new errors_1.AugstashConfigError('pass either apiKey (ask_live_*) or bearerToken');
+        }
+        const retry = { ...transport_1.DEFAULT_RETRY, ...options.retry };
+        const headers = { ...options.headers };
+        if (options.bearerToken)
+            headers['Authorization'] = `Bearer ${options.bearerToken}`;
+        const params = {
+            basePath: options.baseUrl.replace(/\/+$/, ''),
+            headers,
+            // The document names the scheme `ApiKeyAuth` on header X-Api-Key; the generated code reads
+            // it through this callback for every operation that declares it.
+            apiKey: options.apiKey ? () => options.apiKey : undefined,
+            fetchApi: withTimeout((0, transport_1.retryingFetch)(retry, options.fetch ?? fetch), options.timeoutMs ?? 30_000),
+            middleware: [
+                ...(options.idempotency === false ? [] : [(0, transport_1.idempotencyMiddleware)()]),
+                (0, transport_1.envelopeMiddleware)(),
+                ...(options.middleware ?? []),
+            ],
+        };
+        this.configuration = new runtime_1.Configuration(params);
+    }
+    /**
+     * A configured instance of any generated API class, created once and reused.
+     *
+     * ```ts
+     * import { ContactApi } from '@augstash/sdk';
+     * const contacts = client.api(ContactApi);
+     * ```
+     */
+    api(Api) {
+        const existing = this.instances.get(Api);
+        if (existing)
+            return existing;
+        const created = new Api(this.configuration);
+        this.instances.set(Api, created);
+        return created;
+    }
+}
+exports.AugstashClient = AugstashClient;
+/** Wraps a fetch so each attempt is bounded, translating an abort into a normal timeout failure. */
+function withTimeout(inner, timeoutMs) {
+    if (!timeoutMs)
+        return inner;
+    return async (input, init) => {
+        const controller = new AbortController();
+        const timer = setTimeout(() => controller.abort(), timeoutMs);
+        try {
+            return await inner(input, { ...(init ?? {}), signal: init?.signal ?? controller.signal });
+        }
+        finally {
+            clearTimeout(timer);
+        }
+    };
+}

package/dist/errors.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Errors the Augstash API can raise, in the shape the API actually sends them.
+ *
+ * A failure arrives as `{success: false, code, data: {code, fieldErrors, detail}, message,
+ * traceId}`. `code` is the stable name to branch on - `message` is localized text that changes
+ * with the caller's language and must never be matched against.
+ */
+/** One field-level validation failure, as sent in `data.fieldErrors`. */
+export interface FieldError {
+    field: string;
+    message: string;
+}
+export interface AugstashErrorInit {
+    status: number;
+    code: string;
+    message: string;
+    traceId?: string;
+    detail?: string;
+    fieldErrors?: FieldError[];
+    requestId?: string;
+    method?: string;
+    url?: string;
+}
+/**
+ * Every error this SDK throws for a call the server answered.
+ *
+ * Branch on {@link code}. Quote {@link traceId} in a support request - it is the correlation id
+ * the backend logged the failure under.
+ */
+export declare class AugstashError extends Error {
+    readonly name: string;
+    /** HTTP status. 0 when the request never got an answer (see {@link AugstashConnectionError}). */
+    readonly status: number;
+    /** Stable error code, e.g. `WALLET_INSUFFICIENT_FUNDS`. Branch on this. */
+    readonly code: string;
+    /** Correlation id of the failed request; give this to support. */
+    readonly traceId?: string;
+    /** Why this particular call was refused, when the code alone does not say. English, for developers. */
+    readonly detail?: string;
+    /** Per-field validation messages; empty for non-validation errors. */
+    readonly fieldErrors: FieldError[];
+    readonly method?: string;
+    readonly url?: string;
+    constructor(init: AugstashErrorInit);
+    /** The caller is not authenticated: no key, an unknown key, or an expired token. */
+    get isAuthenticationError(): boolean;
+    /** Authenticated, but this key lacks the scope - or the endpoint needs a signed-in user. */
+    get isPermissionError(): boolean;
+    /** The key's per-minute budget is spent. Wait {@link retryAfterSeconds}, then retry. */
+    get isRateLimitError(): boolean;
+    /** Set on a 429 from the server's `Retry-After`, in seconds. */
+    retryAfterSeconds?: number;
+    toString(): string;
+}
+/** The request never reached Augstash, or the answer never came back (DNS, TLS, timeout, reset). */
+export declare class AugstashConnectionError extends AugstashError {
+    readonly name: string;
+    /** The underlying transport failure, when there was one. */
+    cause?: unknown;
+    constructor(message: string, cause?: unknown, method?: string, url?: string);
+}
+/** Configuration this SDK refuses to start with - a missing base URL or missing credentials. */
+export declare class AugstashConfigError extends Error {
+    readonly name: string;
+    constructor(message: string);
+}

package/dist/errors.js

@@ -0,0 +1,84 @@
+"use strict";
+/**
+ * Errors the Augstash API can raise, in the shape the API actually sends them.
+ *
+ * A failure arrives as `{success: false, code, data: {code, fieldErrors, detail}, message,
+ * traceId}`. `code` is the stable name to branch on - `message` is localized text that changes
+ * with the caller's language and must never be matched against.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AugstashConfigError = exports.AugstashConnectionError = exports.AugstashError = void 0;
+/**
+ * Every error this SDK throws for a call the server answered.
+ *
+ * Branch on {@link code}. Quote {@link traceId} in a support request - it is the correlation id
+ * the backend logged the failure under.
+ */
+class AugstashError extends Error {
+    // Typed as string, not as the literal, so the subclasses below can name themselves.
+    name = 'AugstashError';
+    /** HTTP status. 0 when the request never got an answer (see {@link AugstashConnectionError}). */
+    status;
+    /** Stable error code, e.g. `WALLET_INSUFFICIENT_FUNDS`. Branch on this. */
+    code;
+    /** Correlation id of the failed request; give this to support. */
+    traceId;
+    /** Why this particular call was refused, when the code alone does not say. English, for developers. */
+    detail;
+    /** Per-field validation messages; empty for non-validation errors. */
+    fieldErrors;
+    method;
+    url;
+    constructor(init) {
+        super(init.message);
+        Object.setPrototypeOf(this, AugstashError.prototype);
+        this.status = init.status;
+        this.code = init.code;
+        this.traceId = init.traceId;
+        this.detail = init.detail;
+        this.fieldErrors = init.fieldErrors ?? [];
+        this.method = init.method;
+        this.url = init.url;
+    }
+    /** The caller is not authenticated: no key, an unknown key, or an expired token. */
+    get isAuthenticationError() {
+        return this.status === 401;
+    }
+    /** Authenticated, but this key lacks the scope - or the endpoint needs a signed-in user. */
+    get isPermissionError() {
+        return this.status === 403;
+    }
+    /** The key's per-minute budget is spent. Wait {@link retryAfterSeconds}, then retry. */
+    get isRateLimitError() {
+        return this.status === 429;
+    }
+    /** Set on a 429 from the server's `Retry-After`, in seconds. */
+    retryAfterSeconds;
+    toString() {
+        const trace = this.traceId ? ` traceId=${this.traceId}` : '';
+        const detail = this.detail ? ` (${this.detail})` : '';
+        return `${this.name}: [${this.status} ${this.code}] ${this.message}${detail}${trace}`;
+    }
+}
+exports.AugstashError = AugstashError;
+/** The request never reached Augstash, or the answer never came back (DNS, TLS, timeout, reset). */
+class AugstashConnectionError extends AugstashError {
+    name = 'AugstashConnectionError';
+    /** The underlying transport failure, when there was one. */
+    cause;
+    constructor(message, cause, method, url) {
+        super({ status: 0, code: 'CONNECTION_ERROR', message, method, url });
+        Object.setPrototypeOf(this, AugstashConnectionError.prototype);
+        this.cause = cause;
+    }
+}
+exports.AugstashConnectionError = AugstashConnectionError;
+/** Configuration this SDK refuses to start with - a missing base URL or missing credentials. */
+class AugstashConfigError extends Error {
+    name = 'AugstashConfigError';
+    constructor(message) {
+        super(message);
+        Object.setPrototypeOf(this, AugstashConfigError.prototype);
+    }
+}
+exports.AugstashConfigError = AugstashConfigError;