@openenvelope/schema 1.0.0

package/LICENSE

@@ -0,0 +1,53 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship made available under the License, as indicated by a copyright notice that is included in or attached to the work.
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other transformations represent, as a whole, an original work of authorship.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works of the Work, that is intentionally submitted to the Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner.
+
+"Contributor" shall mean Licensor and any Legal Entity on behalf of whom a Contribution has been received by the Licensor and included within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+(a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work; and
+
+(d) If the Work includes a "NOTICE" text file, you must include a readable copy of the attribution notices contained within such NOTICE file.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND.
+
+8. Limitation of Liability. In no event and under no legal theory shall any Contributor be liable for damages arising out of this License or use of the Work.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work, You may offer acceptance of warranty or liability obligations. However, in accepting such obligations, You may act only on Your own behalf.
+
+END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,99 @@
+# @openenvelope/schema
+
+JSON Schema and TypeScript types for the [Envelope Team Definition](https://schema.openenvelope.org/team/v1.json) — the open standard for defining AI agent teams.
+
+## What is this?
+
+Envelope teams are defined in `.envelope.json` files — a single versioned document that declares which agents exist, their roles, what tools they can use, access policies, and orchestration pipelines.
+
+This package gives you:
+- The **JSON Schema** file (for validation and IDE autocomplete)
+- **TypeScript types** (`TeamDefinition`, `AgentDefinition`, `Gate`, `Schedule`, and all sub-types)
+- A **`validate()` helper** that returns structured errors
+
+## Installation
+
+```bash
+npm install @openenvelope/schema
+```
+
+## Usage
+
+### TypeScript types
+
+```typescript
+import type { TeamDefinition, AgentDefinition } from '@openenvelope/schema';
+
+const team: TeamDefinition = {
+  name: 'Support Triage',
+  slug: 'support-triage',
+  version: '1.0.0',
+  agents: [
+    {
+      key: 'classifier',
+      name: 'Ticket Classifier',
+      role: 'Classifies incoming support tickets by urgency and category.',
+      adapterType: 'claude_local',
+      model: 'anthropic:claude-opus-4-5',
+      prompt: 'You are a support ticket classifier...',
+    }
+  ]
+};
+```
+
+### Validation
+
+```typescript
+import { validate } from '@openenvelope/schema';
+
+const result = validate(myTeamDefinition);
+
+if (result.valid) {
+  console.log('Team definition is valid');
+} else {
+  console.error('Validation errors:', result.errors);
+}
+```
+
+### Import the raw schema
+
+```typescript
+import schema from '@openenvelope/schema/schema.json';
+
+// Use with any JSON Schema validator (Ajv, etc.)
+import Ajv from 'ajv';
+const ajv = new Ajv();
+const validate = ajv.compile(schema);
+```
+
+### `$schema` field
+
+Add this to your `.envelope.json` files for automatic IDE autocomplete without installing anything:
+
+```json
+{
+  "$schema": "https://schema.openenvelope.org/team/v1.json"
+}
+```
+
+VS Code, JetBrains, and any editor using the JSON Language Server will automatically offer autocomplete and validation once the `$schema` field is present — no extension required.
+
+## Versioning
+
+This package follows the schema version. `1.x.x` covers all v1 schema releases. Patch versions contain type or validator fixes; no breaking changes within `1.x`.
+
+## Schema registry
+
+The canonical schema URL is registered with [SchemaStore](https://www.schemastore.org) — which means `.envelope.json` files get IDE support automatically, even without the `$schema` field, once your editor has the SchemaStore catalog.
+
+- **Canonical URL:** https://schema.openenvelope.org/team/v1.json
+- **GitHub:** https://github.com/openenvelope/schema
+- **SchemaStore PR:** https://github.com/SchemaStore/schemastore/pull/5645
+
+## RFC process
+
+The schema is an open standard. Proposed changes go through a public RFC process documented in [RFC_PROCESS.md](./RFC_PROCESS.md). Within v1, the schema is additive only — no fields are removed or renamed.
+
+## License
+
+Apache 2.0