{"_id":"@ank1015/agents-contracts","_rev":"6-77acec5e755359cf0eb695c346730ac2","name":"@ank1015/agents-contracts","dist-tags":{"latest":"0.1.11"},"versions":{"0.1.1":{"name":"@ank1015/agents-contracts","version":"0.1.1","keywords":["agents","llm","schemas","zod","typescript"],"license":"UNLICENSED","_id":"@ank1015/agents-contracts@0.1.1","maintainers":[{"name":"ananya150","email":"ananyakhandelwal60@gmail.com"}],"homepage":"https://github.com/ank1015/agent#readme","bugs":{"url":"https://github.com/ank1015/agent/issues"},"dist":{"shasum":"48af847600178597eb85890cebb03fc1c846832a","tarball":"https://registry.npmjs.org/@ank1015/agents-contracts/-/agents-contracts-0.1.1.tgz","fileCount":63,"integrity":"sha512-mhhoItRT1vx6T730j8Zkam+uk5t86K/sBdE0wlb9NGxlGM+XR2pdySDrSpJDCaiZ4F7CdK9NNqkxX6mnKbHePw==","signatures":[{"sig":"MEUCIB1YpLnhnB0iglpVnHJpHSUb5OHOM05an3vyRyjO4bFnAiEAlutonomkIYCT8zu3JnUqt7Cm+iIZkfbFC4aAsNS5uP8=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":109092},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"},"./llm":{"types":"./dist/llm/index.d.ts","import":"./dist/llm/index.js"},"./models":{"types":"./dist/models/index.d.ts","import":"./dist/models/index.js"},"./content":{"types":"./dist/content/index.d.ts","import":"./dist/content/index.js"},"./messages":{"types":"./dist/messages/index.d.ts","import":"./dist/messages/index.js"},"./providers":{"types":"./dist/providers/index.d.ts","import":"./dist/providers/index.js"}},"gitHead":"4f23584ea42cf46f5338a4b498658f698063a115","scripts":{"build":"tsc -b","check":"tsc -b --pretty false","clean":"rm -rf dist ../../.tsbuildinfo/contracts.tsbuildinfo","prepack":"tsc -b"},"_npmUser":{"name":"ananya150","email":"ananyakhandelwal60@gmail.com"},"repository":{"url":"git+https://github.com/ank1015/agent.git","type":"git","directory":"packages/contracts"},"_npmVersion":"11.17.0","description":"Shared schemas and TypeScript contracts for @ank1015/agents.","directories":{},"sideEffects":false,"_nodeVersion":"26.4.0","dependencies":{"zod":"^4.4.3"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/agents-contracts_0.1.1_1782739894914_0.5280660764886915","host":"s3://npm-registry-packages-npm-production"}},"0.1.11":{"name":"@ank1015/agents-contracts","version":"0.1.11","description":"Shared schemas and TypeScript contracts for @ank1015/agents.","keywords":["agents","llm","schemas","zod","typescript"],"license":"UNLICENSED","type":"module","sideEffects":false,"main":"./dist/index.js","types":"./dist/index.d.ts","repository":{"type":"git","url":"git+https://github.com/ank1015/agent.git","directory":"packages/contracts"},"bugs":{"url":"https://github.com/ank1015/agent/issues"},"homepage":"https://github.com/ank1015/agent#readme","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"},"./agent":{"types":"./dist/agent/index.d.ts","import":"./dist/agent/index.js"},"./content":{"types":"./dist/content/index.d.ts","import":"./dist/content/index.js"},"./llm":{"types":"./dist/llm/index.d.ts","import":"./dist/llm/index.js"},"./messages":{"types":"./dist/messages/index.d.ts","import":"./dist/messages/index.js"},"./models":{"types":"./dist/models/index.d.ts","import":"./dist/models/index.js"},"./providers":{"types":"./dist/providers/index.d.ts","import":"./dist/providers/index.js"}},"publishConfig":{"access":"public"},"scripts":{"prepack":"tsc -b","build":"tsc -b","check":"tsc -b --pretty false","test":"vitest run","clean":"rm -rf dist ../../.tsbuildinfo/contracts.tsbuildinfo"},"dependencies":{"zod":"^4.4.3"},"devDependencies":{"vitest":"^4.1.10"},"gitHead":"621232a246d0d99569ea3cf02bdc37801c1c71df","_id":"@ank1015/agents-contracts@0.1.11","_nodeVersion":"26.4.0","_npmVersion":"11.17.0","dist":{"integrity":"sha512-CHivglxHwNlE0DZl84LHmMYWEdIwzsIvs73nloucTBZBu7lDp4BaokvC2a59qq7zFz7cV4uiKTSdT9+eUzWKbw==","shasum":"21037bdedd76796d24452491d2d6821aa901efb0","tarball":"https://registry.npmjs.org/@ank1015/agents-contracts/-/agents-contracts-0.1.11.tgz","fileCount":95,"unpackedSize":143241,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIErmHnRF0GVe8ip0HCH2MW0WRMXgWtlaC0AmD9nAJvx1AiAM5O38IrBjtu1nlxRxwKWuzIdebBw7ubAd96+mvNFRWg=="}]},"_npmUser":{"name":"ananya150","email":"ananyakhandelwal60@gmail.com"},"directories":{},"maintainers":[{"name":"ananya150","email":"ananyakhandelwal60@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/agents-contracts_0.1.11_1783677140801_0.45905008743929465"},"_hasShrinkwrap":false}},"time":{"created":"2026-06-29T13:31:34.756Z","modified":"2026-07-10T09:52:21.086Z","0.1.0":"2026-06-24T19:21:14.677Z","0.1.1":"2026-06-29T13:31:35.049Z","0.1.11":"2026-07-10T09:52:20.946Z"},"bugs":{"url":"https://github.com/ank1015/agent/issues"},"license":"UNLICENSED","homepage":"https://github.com/ank1015/agent#readme","keywords":["agents","llm","schemas","zod","typescript"],"repository":{"type":"git","url":"git+https://github.com/ank1015/agent.git","directory":"packages/contracts"},"description":"Shared schemas and TypeScript contracts for @ank1015/agents.","maintainers":[{"name":"ananya150","email":"ananyakhandelwal60@gmail.com"}],"readme":"# @ank1015/agents-contracts\n\nShared runtime schemas and TypeScript contracts for the `@ank1015/agents` packages.\n\nThis package is the lowest-level public boundary for agent messages, LLM requests, model metadata, provider registration types, tool definitions, usage accounting, and streaming events. It intentionally does not depend on any provider SDK or runtime adapter.\n\n## Install\n\n```sh\npnpm add @ank1015/agents-contracts\n```\n\n## What This Package Provides\n\n- Zod schemas for provider-neutral structural validation.\n- TypeScript types inferred from those schemas.\n- Provider augmentation maps for provider-specific native messages, config, options, and model IDs.\n- Optional prompt-token pricing tiers and shared model-cost resolution.\n- Shared LLM transport and adapter interfaces.\n- Shared assistant event-stream types and `createEventStream`.\n\n## Import Paths\n\n```ts\nimport {\n  llmRequestSchema,\n  messageSchema,\n  createEventStream,\n} from '@ank1015/agents-contracts';\n\nimport { contentSchema } from '@ank1015/agents-contracts/content';\nimport type { AssistantEvent } from '@ank1015/agents-contracts/llm';\nimport type { Message } from '@ank1015/agents-contracts/messages';\nimport type { Model } from '@ank1015/agents-contracts/models';\nimport type { ModelSelection } from '@ank1015/agents-contracts/providers';\n```\n\n## Contract Areas\n\n### Content\n\nContent parts are provider-neutral user/tool payloads:\n\n- `text`\n- `image`\n\nImages use base64 data plus a MIME type. Provider adapters are responsible for enforcing provider-specific MIME support.\n\n### Messages\n\nThe shared message union includes:\n\n- `user`\n- `assistant`\n- `toolResult`\n- `custom`\n\nAssistant messages carry normalized assistant content plus optional provider-native data.\n\n### Models And Providers\n\nModel and provider contracts are open by design. Provider packages can augment:\n\n- `ProviderNativeMessageMap`\n- `ProviderOptionsMap`\n- `ProviderModelIdMap`\n- `ProviderConfigMap`\n\nThat lets provider packages narrow generic contracts without making this package depend on provider implementations.\n\nModels always provide a base `cost` and may provide ordered `pricingTiers` keyed by prompt-token intervals. `resolveModelCost` returns the first matching tier, falling back to the base cost so existing flat-priced models remain compatible.\n\n### LLM Requests And Streams\n\n`LLMRequest` describes a provider-neutral request shape. `LLMTransport` and `LLMProviderAdapter` describe the streaming transport boundary.\n\n`createEventStream` creates a queue-backed `EventStreamSource` that buffers pushed events until consumed and resolves a final result when ended.\n\n## Runtime Validation Scope\n\nThe schemas in this package validate provider-neutral structure. They do not validate provider-specific semantics such as:\n\n- whether a model ID exists for a provider,\n- whether `providerOptions` matches a provider SDK,\n- whether an image MIME type is supported by a provider,\n- whether a native provider message matches that provider's SDK shape.\n\nProvider packages should add provider-specific validation at their adapter boundaries.\n\n## Versioning\n\nThis package is currently `0.1.11`. Until `1.0.0`, public contracts may still evolve as the runtime packages settle.\n","readmeFilename":"README.md"}