@apostra/sdk 0.0.0-stage → 0.38.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 Scope3 PBC
+
+   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,118 @@
-# Temporary Holding Version
+# Apostra TypeScript SDK
 
-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.
+Typed calls to the public V3 HTTP API. Requires Node.js 22.18 or later.
+
+```bash
+npm install @apostra/sdk
+```
+
+Start with the [SDK quickstart](https://docs.apostra.com/v3/sdk-quickstart).
+It covers account discovery, a campaign launch preview and confirmation, and
+delivery reporting. The [runnable synthetic-seller
+example](https://github.com/apostra-public/apostra/blob/main/sdk/typescript/examples/first-value.ts)
+is in the SDK source checkout. It previews by default and only confirms a
+launch when `APOSTRA_CONFIRM_LAUNCH=true` is set deliberately.
+
+```ts
+import { Apostra } from '@apostra/sdk'
+const api = new Apostra()
+const status = await api.getStatus()
+```
+
+The client reads `APOSTRA_API_KEY`, `APOSTRA_ACCOUNT_ID` and
+`APOSTRA_BASE_URL` by default. Explicit constructor options override those
+values. Use `accessToken` for an existing REST/M2M bearer token, or
+`tokenProvider` for application-managed acquisition and refresh. Supply exactly
+one credential source. `m2mTokenProvider` acquires and caches a server-side
+client-credentials token with the published M2M endpoint; it refreshes 60
+seconds before expiry and shares a concurrent refresh. Never put API keys or
+client secrets in browser bundles, URLs, examples or logs. The package does not
+persist credentials or replay 401 responses. M2M token refreshes have a
+30-second deadline by default; pass `timeoutMs` to override it.
+
+```ts
+import { Apostra, m2mTokenProvider } from '@apostra/sdk'
+
+const api = new Apostra({
+  tokenProvider: m2mTokenProvider({
+    clientId: process.env.APOSTRA_CLIENT_ID!,
+    clientSecret: process.env.APOSTRA_CLIENT_SECRET!,
+    scope: 'interchange:read',
+  }),
+})
+```
+
+Methods accept the generated wire input and return the envelope's `data`.
+Every generated method also has a `WithResponse` variant, such as
+`getStatusWithResponse`. It returns `{ data, requestId, headers, status }` for
+successful calls, so support tools can retain `x-request-id` and response
+headers without dispatching by a wire operation name.
+`ApostraError` exposes `status`, `code`, `recovery`, `retryAfter`, `retryable`,
+the typed `error`, and `requestId`. Catch `RateLimitError`, `ValidationError`,
+or another typed subclass instead of parsing an exception string. The default
+exception string excludes response text. Static types do not replace server
+validation of patterns, lengths, conditional requirements or permissions.
+
+Read calls accept `{ accountId, signal, timeoutMs }`; write calls require those
+options to include a caller-owned `{ idempotencyKey }`. The SDK sends it as
+`Idempotency-Key`, and never creates or replaces it. Account selection uses
+`X-SCOPE3-CUSTOMER-ID`; it must match the account resolved by the credential.
+Cancellation stops waiting for HTTP; it does not undo server work. Requests
+have a 30-second timeout, do not follow redirects, and retry transient network,
+429 and 5xx failures twice by default with full-jitter backoff. Set
+`maxRetries: 0` to opt out. Reads retry automatically. Writes retry only with
+the same caller-owned idempotency key, which generated write methods require.
+The SDK never creates or replaces that key. Server `retry_after` is a minimum
+retry delay.
+
+```ts
+const { data, requestId, headers } = await api.getStatusWithResponse()
+const correlationId = headers.get('x-request-id')
+```
+
+A `202` raises `InFlightReceiptError` rather than returning a completed value.
+Use `settle` to replay the same keyed operation until it completes; it honours
+the receipt's `Retry-After`, deadline and cancellation signal:
+
+```ts
+const key = 'preview-123'
+const result = await settle(
+  (signal) => api.saveAsk(input, { idempotencyKey: key, signal }),
+  { timeoutMs: 30_000 },
+)
+```
+
+`paginate` and `poll` take typed callbacks. Preserve original query parameters,
+revisions and keys; provide the operation's cursor/status accessor. No helper
+assumes that a POST is safe to retry without its caller-owned key or that every
+list has the same cursor.
+Polling passes its signal to `read(signal)`; pagination passes it to
+`read(cursor, signal)`. Forward that signal into the SDK call to cancel the
+underlying HTTP request. Timeouts cover credentials, HTTP and response-body
+consumption; an injected fetch/provider must cooperate with cancellation to
+stop its own work. Cancellation still stops the SDK from waiting.
+
+Import `verifyWebhook` from the server-only `@apostra/sdk/webhooks` subpath. It
+validates duplicate-preserving V3 webhook headers, the raw body, the five-minute
+delivery window, and a rotating key map before you parse JSON. Provide every raw
+occurrence of `signature`, `timestamp`, and `deliveryId`; do not flatten duplicate
+headers or log secrets. The browser-safe `@apostra/sdk` root does not load Node
+cryptography.
+
+`openHandoff(url, opener?)` accepts an actual HTTPS URL returned by the API.
+Without an opener it just returns the URL. Some UI operations currently return
+only parameters. URL construction, login, wait/resume, and byte uploads are
+unsupported unless a future public contract defines them.
+`getHandoff(result)` narrows a supported human-action result to its `kind`,
+`url`, `expiresAt` and `resume` instructions, or returns `null`. Pass that
+typed value to `openHandoff(handoff, opener?)`; without an opener it only
+returns the supplied HTTPS URL. Opening or closing the browser is not
+completion: follow `resume` and read the affected object before continuing.
+The SDK never constructs a URL or embeds a login flow.
+`uploadCreativeAsset` exposes the current typed human task and fallback URL.
+
+`@apostra/sdk/metadata` exports generated operation names, paths, security and
+parameter descriptions for CLI discovery. The SDK has no terminal, browser,
+profile-store or MCP dependencies. Import wire models from `@apostra/sdk/models`.
+
+Source and releases: https://github.com/apostra-public/apostra

package/SKILL.md

@@ -0,0 +1,29 @@
+---
+name: apostra-sdk
+description: Choose the Apostra TypeScript SDK method for a coding task, then read the public documentation for the current contract.
+---
+
+# Apostra TypeScript SDK
+
+Read the [SDK guide](https://docs.apostra.com/v2/sdk), [V3 HTTP API
+guide](https://docs.apostra.com/v3/http-api), and [authentication
+guide](https://docs.apostra.com/v3/authentication) before relying on an
+operation. They are the source of truth for inputs, results, permissions, and
+behaviour.
+
+## Job-to-method map
+
+| Job | Method |
+| --- | --- |
+| Check the resolved account | `getStatus` |
+| Discover objects or read one object | `search`, `get` |
+| Create, update, preview, or confirm a campaign | `saveCampaign` |
+| Read delivery | `getDelivery` |
+| Inspect a successful call's request ID or headers | `getStatusWithResponse` (and the matching `WithResponse` method) |
+| Handle a human handoff and resume safely | `getHandoff`, then `openHandoff` |
+| Authenticate a deployed backend with M2M OAuth | `m2mTokenProvider` |
+| Verify an inbound V3 webhook on a server | `@apostra/sdk/webhooks` → `verifyWebhook` |
+
+Use the generated types and the current documentation to construct requests. Do
+not infer fields, permissions, lifecycle transitions, or URL formats from this
+map.