@aiworkforce/sdk
v1.0.1
Published
Public Professional Package contracts for AI Workforce
Readme
@aiworkforce/sdk
Public Professional Package contracts for AI Workforce.
Installation
npm install @aiworkforce/sdkImport
This package is ESM-only. Prefer named imports:
import {
IProfession,
ProfessionalPackage,
PROFESSIONAL_PACKAGE_SDK_VERSION,
} from "@aiworkforce/sdk";Purpose
@aiworkforce/sdk is the public contract surface for Professional Package authors. It defines the shared types and domain classes hosts and packages use together.
Boundary
This package does not include:
- the Professional Engine;
- loaders or Direct Load machinery;
- registries;
- installers or installation catalogs;
- Work persistence (Work store);
- authorize / reject APIs;
- Work execution;
- a Host SDK, Host framework, or Host npm package.
Authors complete judgment and packaging against this SDK. Host composition, Work persistence, and human authorize/reject mediation remain outside this package.
Created != installed
Direct Load != installation
Proposed != Authorized
Authorized != executedPublic author journey
- Scaffold with
@aiworkforce/create-profession. - Implement
IProfessionjudgment and export namedprofessionalPackage. npm test,npm run build,npm run demo.npm pack(or publish your package when ready).- A consumer may import your package module and read
professionalPackage.
After step 5 you have not installed into a Host, registered in a platform registry, authorized Work, or executed Work.
Host boundary (honest next step)
There is no public Host npm package today (@aiworkforce/host, @aiworkforce/engine, and similar names do not exist on the public registry).
When an adopting application (a Host) exists, it typically:
- resolves and loads your module;
- constructs your profession;
- coordinates thinking and optional proposals;
- persists Proposed Work;
- mediates an actual human authorize or reject decision.
Those responsibilities are not provided by @aiworkforce/sdk. Loading a module is not installation. Proposing Work is not authorization. Authorization is not execution.
If you are building a Host inside the AI Workforce repository, see the repository docs/HostInhabitationGuide.md when you have repository access. If you do not have repository access, treat Host composition as application-owned integration against the contracts in this SDK until a separately published Host surface exists.
More detail ships with this package: ADOPTION.md.
Documentation
- This README and ADOPTION.md - public adoption guidance published with the package
@aiworkforce/create-profession- create, test, build, demo
Repository guides (Author Guide, Host Inhabitation Guide, Current Architecture) require access to the AI Workforce repository. Do not assume anonymous GitHub URLs resolve.
AI advises. The professional decides.