@appport/extraction
v0.1.0
Published
AppWorks capability extraction: binds one assessed candidate of an existing application, a proposed AppPort contract, its adapter and verification evidence into an appport.capability-extraction/1 artifact. Executes nothing and grants no authority.
Readme
@appport/extraction
AppWorks capability extraction. It takes one candidate from a verified appport.application-assessment/1 artifact and binds, into a
versioned, content-addressed appport.capability-extraction/2 artifact:
- the existing operation, at an immutable source revision;
- a proposed AppPort canonical contract;
- the adapter that exposes the operation through the application's existing AppPort boundary;
- the AppPort fulfillment claim that boundary publishes (
appport.fulfillment/1, checked against the contract withclaimFor); - the runtime the verification ran on;
- verification records for named behaviors, each tied to the source, contract, adapter, declaration and runtime it tested, and saying whether it ran against the real application or a stub.
It reads /1 artifacts with the /1 rules. Specification: spec/extraction-1.md in
rkendel1/appworks. The JSON Schemas ship in schemas/ (capability-extraction-2.schema.json,
capability-extraction-1.schema.json). This package also provides the appworks command:
appworks assess <repo> --output assessment.json
appworks extract assessment.json --candidate <id> --repo <repo> --output proposed.json # no plan: a proposal
appworks extract assessment.json --candidate <id> --repo <repo> --plan plan.json --verification results.json --output x.json
appworks verify-extraction x.json --assessment assessment.json --repo <repo> --plan-dir <dir>Exit codes: 0 when the artifact is written or valid, 1 for an unreadable input or an invalid artifact, 2 for invalid arguments or an output that would overwrite or land inside the repository, and 4 when the extraction is refused (always with reason codes).
| Export | Purpose |
|---|---|
| createExtraction | the eligibility, contract, mapping, adapter, verification and revision rules; throws ExtractionRefused with every reason |
| verifyExtraction, verifyExtractionAt | integrity and honesty of an artifact, optionally against its assessment, repository and adapter sources |
| compareExtractions | revision rules; contract differences are AppPort's compareManifests |
| candidateRefusals, assessmentRefusals, contractProblems, schemaProblems, contractChanges, fulfillmentProblems | the individual checks |
| report | the report extract and verify-extraction print: passed (real, stub-only, static), failed, inconclusive and not-run behaviors separately, never an overall success while one has not passed |
| BEHAVIORS, REQUIRED_BEHAVIORS, VERIFICATION_STATUSES | what a read-only extraction verifies, and how results are stated |
It reads JSON and files and executes nothing: it never runs, imports or loads an adapter, and it uses no network or language model. An extraction grants no authority, is not executable, establishes no equivalence beyond the behaviors recorded as passed, modifies nothing and deploys nothing. Read-only request/response operations only.
Runtime dependencies are @appport/protocol 1.3.0, @appport/schema 1.1.3 and @appport/assessment. It does not depend on
@appport/core, @appport/sdk or Distribution Protocol. Adapters live in private packages under extractions/.
