@apostra/sdk 0.0.0-stage → 0.37.0

package/examples/first-value.ts

@@ -0,0 +1,58 @@
+import { Apostra } from '@apostra/sdk'
+
+function required(name: string): string {
+  const value = process.env[name]
+  if (!value) throw new Error(`${name} is required`)
+  return value
+}
+
+const api = new Apostra({
+  apiKey: required('APOSTRA_API_KEY'),
+  accountId: process.env.APOSTRA_ACCOUNT_ID,
+  baseUrl: process.env.APOSTRA_BASE_URL ?? 'https://api.apostra.com/api/v3',
+})
+const campaignId = required('APOSTRA_CAMPAIGN_ID')
+
+// Verify the credential and discover the resolved account before any write.
+const status = await api.getStatus({})
+if (!status.account)
+  throw new Error('The credential did not resolve an account')
+
+// A unique key belongs to this exact preview request. Reuse it only to retry
+// the same request after an uncertain response.
+const previewKey = crypto.randomUUID()
+const preview = await api.saveCampaign(
+  {
+    campaignId,
+    desiredPhase: 'active',
+    idempotencyKey: previewKey,
+  },
+  { idempotencyKey: previewKey },
+)
+
+// Inspect `preview` before confirming. Confirmation is deliberately opt-in so
+// running the sample against the synthetic seller remains a preview by default.
+if (process.env.APOSTRA_CONFIRM_LAUNCH === 'true') {
+  const confirmKey = crypto.randomUUID()
+  await api.saveCampaign(
+    {
+      campaignId,
+      desiredPhase: 'active',
+      confirmLaunch: true,
+      idempotencyKey: confirmKey,
+    },
+    { idempotencyKey: confirmKey },
+  )
+}
+
+const delivery = await api.getDelivery({
+  report: 'campaign_delivery',
+  filters: { campaignId },
+  range: {
+    startDate: required('APOSTRA_START_DATE'),
+    endDate: required('APOSTRA_END_DATE'),
+  },
+  limit: 100,
+})
+
+void [preview, delivery]

package/llms.txt

@@ -0,0 +1,11 @@
+# Apostra TypeScript SDK
+
+Read `SKILL.md` in this package before implementing an Apostra task.
+
+- SDK guide: https://docs.apostra.com/v2/sdk
+- V3 HTTP contract: https://docs.apostra.com/v3/http-api
+- Authentication: https://docs.apostra.com/v3/authentication
+- Complete documentation corpus: https://docs.apostra.com/llms-full.txt
+
+The public documentation is the source of truth for operation inputs, results,
+permissions, and behaviour.

package/package.json

@@ -1,6 +1,62 @@
 {
   "name": "@apostra/sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.37.0",
+  "description": "The official Apostra V3 HTTP SDK",
+  "type": "module",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/apostra-public/apostra.git",
+    "directory": "sdk/typescript"
+  },
+  "homepage": "https://docs.apostra.com/v2/sdk",
+  "engines": {
+    "node": ">=22.18.0"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./models": {
+      "types": "./dist/generated/types.gen.d.ts",
+      "import": "./dist/generated/types.gen.js"
+    },
+    "./metadata": {
+      "types": "./dist/generated/metadata.d.ts",
+      "import": "./dist/generated/metadata.js"
+    },
+    "./webhooks": {
+      "types": "./dist/webhooks.d.ts",
+      "import": "./dist/webhooks.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "SKILL.md",
+    "llms.txt",
+    "examples",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "scripts": {
+    "build": "tsc6 -p tsconfig.build.json",
+    "type-check": "tsc6 --noEmit",
+    "test": "vitest run",
+    "lint": "biome check src/transport.ts src/webhooks.ts src/index.ts __tests__ examples --error-on-warnings",
+    "prepack": "npm run build"
+  },
+  "devDependencies": {
+    "@adcp/sdk": "15.8.1",
+    "@types/node": "^22.15.17",
+    "typescript": "npm:@typescript/typescript6@^6.0.2",
+    "vitest": "^4.1.9"
+  }
+}