@async/api-contract 0.1.0

package/examples/db-ledger/api-contract.json

@@ -0,0 +1,42 @@
+{
+  "format": "api-contract.package.v1",
+  "packageName": "@async/db",
+  "catalogs": [
+    {
+      "format": "api-contract.catalog.v1",
+      "contractId": "@async/db.package",
+      "title": "Async DB Package Surface",
+      "features": [
+        {
+          "id": "cli.sync",
+          "title": "async-db sync command",
+          "releaseTag": "public",
+          "stability": "stable",
+          "group": "cli"
+        },
+        {
+          "id": "export.hono",
+          "title": "Optional Hono integration export",
+          "releaseTag": "beta",
+          "stability": "preview",
+          "group": "package-exports"
+        },
+        {
+          "id": "export.root",
+          "title": "Root package export",
+          "releaseTag": "public",
+          "stability": "stable",
+          "group": "package-exports"
+        }
+      ]
+    }
+  ],
+  "supported": [
+    {
+      "format": "api-contract.surface.v1",
+      "contractId": "@async/db.package",
+      "features": ["cli.sync", "export.hono", "export.root"],
+      "hash": "sha256:30ee7f5f65023461567b6de4e3bd81370207de1231e5d85c6153d4161dc43a36"
+    }
+  ]
+}

package/examples/pipeline/API_SURFACE.md

@@ -0,0 +1,37 @@
+# @async/pipeline API Surface Ledger
+
+This file is the generated review ledger for semantic API contract features. It is current-state contract documentation, not a changelog or tutorial.
+
+## Async Pipeline Declarations
+
+Contract: `@async/pipeline.declaration`
+
+### Agents
+
+| Feature | Title | Release | Stability | Lifecycle | Replacement | Docs |
+| --- | --- | --- | --- | --- | --- | --- |
+| `agent.stdoutTo` | Agent stdout routing | beta | preview | active |  |  |
+
+### Steps
+
+| Feature | Title | Release | Stability | Lifecycle | Replacement | Docs |
+| --- | --- | --- | --- | --- | --- | --- |
+| `step.shell` | Shell step declaration | public | stable | active |  |  |
+
+### Tasks
+
+| Feature | Title | Release | Stability | Lifecycle | Replacement | Docs |
+| --- | --- | --- | --- | --- | --- | --- |
+| `task.run` | Runnable task declaration | public | stable | active |  |  |
+
+## Supported Surfaces
+
+| Contract | Hash | Features |
+| --- | --- | --- |
+| `@async/pipeline.declaration` | `sha256:634b6857ff21d8793f56cb78a0fbfd552c1148b11b4a6e14a0c58c894439dd3f` | `agent.stdoutTo`, `step.shell`, `task.run` |
+
+## Required Surfaces
+
+| Contract | Hash | Features |
+| --- | --- | --- |
+| `@async/pipeline.declaration` | `sha256:6ed689db2412e486f7b1c57ba255d8ab244e9d1a801ebc143049449bc4b21a95` | `step.shell`, `task.run` |

package/examples/pipeline/api-contract.json

@@ -0,0 +1,53 @@
+{
+  "format": "api-contract.package.v1",
+  "packageName": "@async/pipeline",
+  "catalogs": [
+    {
+      "format": "api-contract.catalog.v1",
+      "contractId": "@async/pipeline.declaration",
+      "title": "Async Pipeline Declarations",
+      "features": [
+        {
+          "id": "agent.stdoutTo",
+          "title": "Agent stdout routing",
+          "releaseTag": "beta",
+          "stability": "preview",
+          "lifecycle": "active",
+          "group": "agents"
+        },
+        {
+          "id": "step.shell",
+          "title": "Shell step declaration",
+          "releaseTag": "public",
+          "stability": "stable",
+          "lifecycle": "active",
+          "group": "steps"
+        },
+        {
+          "id": "task.run",
+          "title": "Runnable task declaration",
+          "releaseTag": "public",
+          "stability": "stable",
+          "lifecycle": "active",
+          "group": "tasks"
+        }
+      ]
+    }
+  ],
+  "supported": [
+    {
+      "format": "api-contract.surface.v1",
+      "contractId": "@async/pipeline.declaration",
+      "features": ["agent.stdoutTo", "step.shell", "task.run"],
+      "hash": "sha256:634b6857ff21d8793f56cb78a0fbfd552c1148b11b4a6e14a0c58c894439dd3f"
+    }
+  ],
+  "required": [
+    {
+      "format": "api-contract.surface.v1",
+      "contractId": "@async/pipeline.declaration",
+      "features": ["step.shell", "task.run"],
+      "hash": "sha256:6ed689db2412e486f7b1c57ba255d8ab244e9d1a801ebc143049449bc4b21a95"
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@async/api-contract",
+  "version": "0.1.0",
+  "description": "Semantic API contract surfaces, ledgers, and impact checks for Async packages.",
+  "license": "MIT",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/async/api-contract.git"
+  },
+  "packageManager": "pnpm@10.20.0",
+  "engines": {
+    "node": ">=24"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./types": {
+      "types": "./dist/types.d.ts",
+      "default": "./dist/types.js"
+    }
+  },
+  "bin": {
+    "api-contract": "./dist/cli.js"
+  },
+  "scripts": {
+    "async-pipeline": "async-pipeline",
+    "build": "tsc -p tsconfig.json && chmod +x dist/cli.js",
+    "pack:check": "npm --cache .async/npm-cache pack --dry-run",
+    "pipeline:github:check": "async-pipeline github check",
+    "pipeline:github:generate": "async-pipeline github generate",
+    "pipeline:publish": "async-pipeline run publish",
+    "pipeline:sync:check": "async-pipeline sync check",
+    "pipeline:verify": "async-pipeline run verify",
+    "release:check": "pnpm pipeline:verify",
+    "release:publish": "node scripts/publish-npm.mjs",
+    "test": "pnpm build && pnpm typecheck:contracts && node --test test/*.test.js",
+    "typecheck": "tsc --noEmit -p tsconfig.json",
+    "typecheck:contracts": "tsc --ignoreConfig --noEmit --module NodeNext --moduleResolution NodeNext --target ES2024 --strict test/types.test-d.ts"
+  },
+  "files": [
+    "dist",
+    "examples",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": false,
+  "devDependencies": {
+    "@async/pipeline": "0.2.4",
+    "@types/node": "24.12.4",
+    "typescript": "6.0.3"
+  }
+}