@wrkrdev/api-contract

Contract package for the current public Wrkr /v1 developer boundary.

Install

bun add @wrkrdev/api-contract

This package ships compiled ESM entrypoints plus .d.ts declarations for standard package-manager installs.

Quick start

import {
  OPERATOR_PAT_ALLOWED_SCOPE_IDS,
  buildClientApiServiceShellPaths,
  clientSubmissionCreateSchema,
} from '@wrkrdev/api-contract';

const paths = buildClientApiServiceShellPaths();
const submission = clientSubmissionCreateSchema.parse({
  note: 'Run a website audit for https://example.com',
});

console.log(paths.proofInvoke, submission.note, OPERATOR_PAT_ALLOWED_SCOPE_IDS.length);

Supported surface

• Root export @wrkrdev/api-contract for shared client error helpers, auth constants/types, client-access helpers, deployment contract schemas/validators, and operator lookup/rollout DTOs.
• Subpath exports: @wrkrdev/api-contract/auth, @wrkrdev/api-contract/client, @wrkrdev/api-contract/client-api-service, @wrkrdev/api-contract/client-request-reference, @wrkrdev/api-contract/deployment-contract, and @wrkrdev/api-contract/operator-control.
• Deployment contract helpers for release import payloads, environment binding payloads, validation helpers, and stored binding reference helpers.
• Operator auth helpers for PAT generation/hashing, scope normalization, scope checks, and session/PAT response types.
• Client access helpers for request-reference schemas/records and API-service shell path helpers, webhook DTOs, and workflow DTOs.
• Operator control DTOs for project lookup, deployment lookup, release list/create, and environment-binding list/create/promote/rollback responses.

Out of scope

• Internal service DTOs and private workspace, worker-runtime, or browser-only contracts.
• Governance JSON and boundary-policy artifacts from this monorepo.
• Generated clients, transport wrappers, or a broader promise beyond the exported /v1 helpers listed above.

License

Apache-2.0.