@caitlyn-ai/sdk 0.0.0-stage → 0.0.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 [yyyy] [name of copyright owner]
+
+   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/NOTICE

@@ -0,0 +1,4 @@
+Caitlyn SDKs
+Copyright 2026 Custom D Ltd
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).

package/README.md

@@ -1,3 +1,165 @@
-# Temporary Holding Version
+# Caitlyn SDK for TypeScript
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+> **Preview.** This SDK needs a Caitlyn with the v3 API, which is not released yet, and its API will change
+> before version 1.0.
+
+`@caitlyn-ai/sdk` is the TypeScript client for the Caitlyn v3 API. It runs on Node 20 and later, Bun, Deno,
+browsers and edge runtimes, ships ECMAScript modules and CommonJS with types, and has no AWS runtime: its
+only telemetry dependency is the OpenTelemetry API.
+
+```bash
+npm install @caitlyn-ai/sdk
+```
+
+Runnable examples are in `examples/typescript/` in the SDK repository.
+
+## Creating a client
+
+`workspace` is your workspace's hostname. `auth.mode` says how the client signs in. Every mode except
+`session` ends in the same short-lived Caitlyn bearer token, which the client caches and renews a minute
+before it expires, one request at a time however many calls are waiting.
+
+```ts
+import { Caitlyn } from '@caitlyn-ai/sdk';
+
+// A script using a personal access token
+const caitlyn = new Caitlyn({ workspace: 'your-company.getcaitlyn.ai', auth: { mode: 'token', token: process.env.CAITLYN_TOKEN! } });
+```
+
+| Mode | For | Options |
+| --- | --- | --- |
+| `token` | Scripts run by a person, with a personal access token | `token` |
+| `clientCredentials` | A registered machine integration (an API client) outside AWS | `clientId`, `clientSecret`, `scopes` |
+| `oauth` | An application acting as a signed-in person | `clientId`, `clientSecret` (servers only), `redirectUri`, `scopes`, `tokenStore` |
+| `awsIam` | A workload on AWS (Lambda, ECS, AgentCore), with no stored secret | `region`, `credentials`, `signingAlgorithm` |
+| `workloadIdentity` | A CI job or other workload with an OpenID Connect token (GitLab CI `id_tokens`) | `token`: a function returning the current token |
+| `session` | The Caitlyn app itself, or a tool driving a local app with a session cookie | `cookie` (server side only), `origin` |
+
+The workspace works as a region does in the AWS SDKs: it decides where requests go (`https://<workspace>/api`)
+and the audience every token is bound to (`https://<workspace>/api/v3`). `endpoint` overrides only where
+requests go, for a proxy or a local app; the audience still comes from the workspace. `caitlyn.auth.workspace`
+and `caitlyn.auth.resource` show what the client uses.
+
+### Signing in as a person (`oauth`)
+
+```ts
+const app = new Caitlyn({
+  workspace: 'your-company.getcaitlyn.ai',
+  auth: { mode: 'oauth', clientId, clientSecret, redirectUri: 'https://app.example.com/callback', scopes: ['chat:write'], tokenStore },
+});
+
+// Start: send the person to `url`, and keep `state` and `codeVerifier` (in their session, for example)
+const { url, state, codeVerifier } = await app.auth.authorizationUrl();
+
+// The callback: checks the state, exchanges the code and saves the tokens in tokenStore
+await app.auth.handleCallback({ code, state: returnedState, expectedState: state, codeVerifier });
+```
+
+`tokenStore` is `{load, save, clear}`, so an application can keep each person's tokens encrypted on its own
+server. Without one, tokens live in memory for the life of the client. Refresh is automatic. A refresh token
+the server refuses (`invalid_grant`) clears the store and fails the call with `CaitlynAuthError`, code
+`invalid_grant`; sign the person in again.
+
+### Workloads on AWS (`awsIam`)
+
+```ts
+const worker = new Caitlyn({ workspace: 'your-company.getcaitlyn.ai', auth: { mode: 'awsIam', region: 'ap-southeast-2' } });
+```
+
+The client calls AWS STS `GetWebIdentityToken` on the regional endpoint with the workload's own AWS
+credentials, and exchanges the AWS-signed token for a Caitlyn token. No secret is stored, and no AWS SDK is
+needed: the client signs that one request itself. It finds credentials in `AWS_ACCESS_KEY_ID` and
+`AWS_SECRET_ACCESS_KEY` (AWS Lambda) or the container credentials endpoint (ECS, Fargate, AgentCore). For
+anything else, such as profiles or single sign-on, pass any AWS SDK credential provider:
+
+```ts
+import { fromNodeProviderChain } from '@aws-sdk/credential-providers';
+new Caitlyn({ workspace, auth: { mode: 'awsIam', region: 'ap-southeast-2', credentials: fromNodeProviderChain() } });
+```
+
+Code the browser never needs stays out of its bundle: the request signer loads only when a client signs in
+with `awsIam`.
+
+Outbound identity federation must be turned on in the AWS account, and the workspace must have an API client
+that trusts the account's issuer and the role.
+
+### CI jobs (`workloadIdentity`)
+
+```yaml
+# .gitlab-ci.yml
+publish:
+  id_tokens:
+    CAITLYN_ID_TOKEN:
+      aud: https://your-company.getcaitlyn.ai/api/v3
+```
+
+```ts
+new Caitlyn({ workspace, auth: { mode: 'workloadIdentity', token: () => process.env.CAITLYN_ID_TOKEN! } });
+```
+
+## Calls
+
+Every operation is a method on a namespace (`caitlyn.documents.list`) and also a standalone function that
+takes a client (`listDocuments(client, …)`). Import the standalone functions and `createCaitlynClient` for
+the smallest bundle; a bundler then keeps only the operations you use.
+
+```ts
+import { createCaitlynClient, getAgentVersion } from '@caitlyn-ai/sdk';
+const client = createCaitlynClient({ workspace, auth });
+const draft = await getAgentVersion(client, { agentId: 'GHT7YRWXPL', version: 'draft' });
+```
+
+- **Lists** are async iterables that fetch the next page as you go: `for await (const doc of caitlyn.documents.list({knowledgeBaseId}))`.
+- **Streams** (`conversations.send`) are async iterables of typed events. If the connection drops, the
+  client re-attaches from the last event it saw, so no event is lost or repeated. `await stream.finalMessage()` returns the finished answer.
+- **Updates** take `ifMatch` (the ETag you read) as a call option, and `clear: [...]` to return members to their defaults.
+- **Creates** take an `idempotencyKey` call option; without one the client makes one per call and reuses it on retries.
+- **Cancellation and timeouts:** every call takes `signal`. Use `AbortSignal.timeout(ms)` for a deadline.
+- **Retries:** 429 and 503, and connection failures, are retried up to `maxAttempts` (default 3), only for
+  reads, idempotent operations and creates with their idempotency key. `Retry-After` is honoured up to
+  `maxRetryDelayMs` (default 60 seconds).
+- **Unknown fields** the server added after this SDK was built are kept on each result's `raw`.
+- **Older servers:** calling an operation or member the server is too old for fails before sending, with `NotSupportedByServer`.
+
+## Errors
+
+Every API error is a `CaitlynError` subclass, one per status (`ValidationError`, `NotFoundError`,
+`ConflictError`, `PreconditionFailedError`, `TooManyRequestsError`…), carrying the problem details: `status`,
+`code`, `title`, `detail`, `requestId` (quote it to Caitlyn support) and, on a 400, `errors`, one entry per
+field. An error page from something in front of the API (an HTML 404, a proxy's 502) is the same class for its
+status, with `code` `HTTP_<status>` and the page in `rawBody`. Sign-in failures are `CaitlynAuthError`, with
+the OAuth error code.
+
+```ts
+try {
+  await caitlyn.versions.updateDraft('GHT7YRWXPL', { instructions }, { ifMatch: etag });
+} catch (err) {
+  if (err instanceof PreconditionFailedError) { /* someone else changed it: read again and reapply */ }
+  else if (err instanceof ValidationError) for (const e of err.errors ?? []) console.error(e.pointer, e.code, e.detail);
+  else throw err;
+}
+```
+
+## Waiting
+
+`waitUntil…()` methods poll until the resource reaches a final state, and take `signal` and `maxWaitMs`. A
+failure state throws `WaiterError`. They are generated from the model's `@waitable` traits, so they appear as
+operations gain them.
+
+## Telemetry
+
+The client creates OpenTelemetry spans for each call and each HTTP attempt, and passes `traceparent` on, with
+whatever tracer provider your application has registered. With none registered it costs nothing. Pass
+`telemetry: {tracerProvider}` to use another provider, or `telemetry: {enabled: false}` to switch it off.
+
+## Runtimes
+
+| Runtime | Entry | HTTP |
+| --- | --- | --- |
+| Node and Bun, ECMAScript modules | `dist-es` | Node's `http`/`https` |
+| Node, CommonJS | `dist-cjs` | Node's `http`/`https` |
+| Browsers, Deno, Cloudflare Workers, Vercel Edge (the `browser`, `worker`, `workerd`, `deno` and `edge-light` export conditions) | `dist-browser` | `fetch` |
+
+## Licence
+
+Apache License 2.0. See `LICENSE` and `NOTICE`.