@opensoha/contracts 0.1.4

package/COMPATIBILITY.md

@@ -0,0 +1,306 @@
+# Compatibility and Versioning
+
+This repository owns the public OpenSoha contract surface. Consumers should
+pin released versions and treat this repository as the first place where public
+API, schema, and SDK behavior changes are proposed.
+
+## Version Streams
+
+Current stream: `0.1.x`.
+
+- `0.x` releases may still evolve quickly, but compatibility gates must run for
+  every change.
+- `0.1.x` patch releases may add optional fields, optional query parameters,
+  new enum values, new response status codes, new operations, and new schemas.
+- `0.1.x` patch releases must not remove existing operations, rename
+  `operationId` values, remove response status codes, remove schema properties,
+  add required request properties, remove enum values, or narrow existing
+  schema types.
+- Minor `0.x` releases may include intentional breaking changes only when the
+  migration is documented in the release notes and consumers have a clear
+  adoption path.
+- `1.0.0` starts the stable contract line. After `1.0.0`, breaking changes
+  require a major version bump, a migration note, and consumer coordination.
+
+## Version Synchronization
+
+Each release must keep these values aligned:
+
+- `package.json` `version`
+- `package-lock.json` root package version
+- `openapi/soha-api.yaml` `info.version`
+- `gen/go/sohaapi/client.go` default user agent version
+- Git tag `v<version>`
+- Go module tag for consumers importing
+  `github.com/opensoha/soha-contracts/gen/go/sohaapi`
+
+The version sync gate runs with:
+
+```sh
+npm run check:version-sync
+```
+
+The gate fails when any of the synchronized versions diverge. In GitHub tag
+release workflows it also verifies that the pushed tag is exactly
+`v<package.json version>`.
+
+Release order for `0.1.x`:
+
+1. Update `package.json`, `package-lock.json`, and OpenAPI `info.version` to
+   the same patch version.
+2. Regenerate SDKs when OpenAPI changed.
+3. Run `npm test`, `npm pack --dry-run`, `npm run release:artifacts`, and
+   the consumer matrix.
+4. Create tag `v<version>`.
+5. Let the release workflow publish npm when `NPM_TOKEN` is configured and
+   create the GitHub release with the npm tarball, `.sha256` checksum, and
+   release manifest attached.
+
+## Compatibility Baseline
+
+`compat/openapi-0.1.0.snapshot.json` is the current OpenAPI compatibility
+baseline. It is generated from `openapi/soha-api.yaml` by:
+
+```sh
+npm run check:openapi-breaking:update
+```
+
+Do not update the baseline just to make a failing check pass. Update it only
+when starting a new compatibility baseline after an intentional versioned break
+or when establishing a baseline for a newly stabilized stream.
+
+The breaking-change check currently blocks these high-risk changes:
+
+- Removing a path or HTTP operation.
+- Changing an existing `operationId`.
+- Removing an existing response status or media type.
+- Adding a required request body or required parameter.
+- Removing a component schema.
+- Removing an existing schema property.
+- Adding a required schema property.
+- Removing an enum value.
+- Changing an existing schema type, format, `$ref`, array item schema, or
+  object `additionalProperties` contract in a narrowing direction.
+
+This is a baseline guard, not a full API review substitute. Contract changes
+that pass this script can still require consumer tests when semantics change.
+
+## OpenAPI Loose Boundary Baseline
+
+`compat/openapi-loose-boundaries-0.1.0.json` records every current OpenAPI use
+of `AnyValue`, `GenericObject`, and bare `additionalProperties: true`. The
+check runs with:
+
+```sh
+npm run check:openapi-loose-boundaries
+```
+
+New loose boundaries must not be added accidentally. If a future contract truly
+requires dynamic JSON, add it to the baseline with an intentional review note.
+If a loose boundary is tightened, remove it from the baseline in the same
+change so the contract surface keeps moving toward named schemas.
+
+## Public Cloud Extension Points
+
+`CloudExtensionPoint` OpenAPI DTOs describe only public extension points that
+Cloud can consume through shared contracts, HTTP APIs, SDKs, webhooks, or event
+sinks. Billing, quota, and SaaS IAM remain Cloud-only domains and must not be
+promoted into this public contracts repository.
+
+For `0.1.x`, patch releases may add optional public extension point fields,
+new extension point kinds, new public boundary kinds, and new supported
+consumer names. They must not remove or rename `id`, `name`, `kind`,
+`boundary`, `contractRefs`, or `excludedCloudOnlyDomains`; must not add new
+required fields; and must not remove `billing`, `quota`, or `saas-iam` from
+the Cloud-only exclusion enum.
+
+## Fixture Policy
+
+Every JSON Schema owned by this repository must have at least one valid and one
+invalid fixture under `fixtures/json-schema/<contract>/`.
+
+High-value OpenAPI DTOs must have valid and invalid fixtures under
+`fixtures/openapi/<SchemaName>/`. Add fixtures when a schema becomes important
+to a cross-repository workflow, especially auth, runner callbacks, AI Gateway,
+MCP, plugins, tokens, approvals, and governance.
+
+Fixture validation runs with:
+
+```sh
+npm run validate
+```
+
+Request/response and manifest examples under `examples/` are also validated
+by `npm run validate`. Examples are release documentation assets, so they
+should be valid positive payloads rather than negative test cases.
+
+## Ecosystem JSON Schema Baseline
+
+`compat/json-schema-ecosystem-0.1.0.json` protects the public plugin, skill,
+and connector JSON Schemas from accidental breaking changes. The check runs
+with:
+
+```sh
+npm run check:json-schema-compat
+```
+
+The baseline blocks removing existing root properties, adding new root required
+properties, and removing existing enum values. Optional fields and enum values
+may be added in `0.1.x` patch releases when fixtures and compatibility notes
+are updated.
+
+## Cluster Capability Matrix
+
+`capabilities/cluster-capability-matrix.schema.json` owns the public
+Direct/Agent runtime capability matrix consumed by Core, Web, CLI, Agent,
+Skills, Connectors, and Cloud extension points. It describes Kubernetes, Helm,
+YAML, logs, exec, port-forward, Docker, and runtime support with explicit
+available, partial, and unsupported states.
+
+For `0.1.x`, patch releases may add optional fields, new capability entries,
+new categories, new risk levels, and new support diagnostics. They must not
+remove or rename `items`, entry `key`, `label`, `category`, `riskLevel`,
+`requiresApproval`, `direct`, or `agent`; must not add new required fields; and
+must not narrow the existing `available`, `partial`, or `unsupported` status
+values. Any `partial` or `unsupported` support state must continue to provide a
+human-readable reason so downstream UI and diagnostics can explain degraded
+runtime behavior.
+
+## Plugin Manifest
+
+`plugins/plugin-manifest.schema.json` owns the public package manifest for
+skills, skill packs, MCP presets, connectors, AI provider adapters, agent
+profiles, and gateway policy packs. Marketplace, CLI, Web, Skills, Connectors,
+and Cloud consumers should use this schema as the source of truth for package
+identity, compatibility declarations, asset references, permissions, secrets,
+and integrity metadata.
+
+For `0.1.x`, patch releases may add optional plugin types, optional asset
+groups, optional capability groups, optional permission fields, optional secret
+metadata, and optional integrity metadata. They must not remove or rename `id`,
+`name`, `version`, `publisher`, or `type`; must not add new required fields;
+must not narrow the plugin ID pattern; must not remove existing plugin `type`
+enum values; and must not allow unknown top-level fields outside explicitly
+versioned metadata.
+
+## Skill Manifest
+
+`skills/skill-manifest.schema.json` owns the public structured front matter
+contract for official and ecosystem skill assets. Skill repositories may add
+repository-local metadata, but cross-repository routing, permission review, and
+capability binding should use this schema first.
+
+For `0.1.x`, patch releases may add optional fields, optional provider skill
+reference metadata, optional capability reference conventions, and optional
+permission or scope annotations. They must not remove or rename `id`, `name`,
+or `category`; must not add new required fields; must not narrow the skill ID
+pattern; and must not allow unknown top-level fields outside `metadata`.
+
+## Agent Profile
+
+`profiles/agent-profile.schema.json` owns the public agent runtime profile
+manifest used by official skills, CLI installers, Web previews, Agent runtime
+selection, and Cloud managed fleet configuration. It binds skills, MCP presets,
+capabilities, scopes, enabled/disabled tools, execution budgets, and guardrails.
+
+For `0.1.x`, patch releases may add optional modes, optional budget fields,
+optional guardrail conventions, and optional metadata. They must not remove or
+rename `schemaVersion`, `id`, `name`, `version`, `mode`, `providerKind`,
+`skillRefs`, `mcpPresetRefs`, `capabilityRefs`, `platformCapabilityRefs`,
+`requiredScopes`, `enabledToolRefs`, or `guardrails`; must not add new required
+fields; must not narrow the ID pattern or semantic version pattern; and must
+not allow unknown top-level fields outside `metadata`.
+
+## MCP Preset
+
+`presets/mcp-preset.schema.json` owns the public MCP preset manifest used by
+official skills, CLI installers, Gateway capability binding, Web previews, and
+Cloud/local preset packaging. It declares a bounded set of tools, resources,
+prompts, scopes, capabilities, risk level, and guardrails.
+
+For `0.1.x`, patch releases may add optional risk levels, optional capability
+metadata, optional top-level metadata, and optional tool/resource/prompt fields.
+They must not remove or rename `schemaVersion`, `id`, `name`, `version`,
+`riskLevel`, `skillRefs`, `platformCapabilityRefs`, `requiredScopes`, `tools`,
+or `guardrails`; must not add new required fields; must not narrow the ID
+pattern or semantic version pattern; and must not allow unknown top-level
+fields outside `metadata`.
+
+## Governance Approval Request
+
+`governance/approval-request.schema.json` owns the public approval request,
+trace, decision, stage, and timeline event contract for high-risk Gateway and
+platform operations. OpenAPI approval DTOs should stay compatible with this
+schema when the same fields are exposed over HTTP.
+
+For `0.1.x`, patch releases may add optional approval fields, optional trace
+fields, optional decision metadata, optional stage metadata, and optional
+timeline event metadata. They must not remove or rename `id`, `status`,
+`strategy`, `actorType`, `actorId`, `toolName`, `riskLevel`,
+`requiresApproval`, `summary`, `createdAt`, or `updatedAt`; must not add new
+required fields; must not remove existing risk level values; and must not allow
+unknown top-level fields outside explicitly modeled metadata objects.
+
+## Governance Audit Log
+
+`governance/audit-log.schema.json` owns the public audit log contract for
+Gateway, platform, connector, plugin, skill, and Cloud extension point actions.
+OpenAPI audit DTOs and event pipeline audit payloads should stay compatible
+with this schema when the same fields are exposed outside a repository.
+
+For `0.1.x`, patch releases may add optional audit fields, optional actor
+display metadata, optional resource scope fields, optional request correlation
+fields, and optional metadata conventions. They must not remove or rename `id`,
+`actorType`, `actorId`, `action`, `result`, `summary`, or `createdAt`; must not
+add new required fields; must not remove existing risk level values; and must
+not allow unknown top-level fields outside `metadata` or `resourceScope`.
+
+## Connector Event Envelope
+
+`connectors/connector-event-envelope.schema.json` owns the public connector
+runtime event sink batch envelope. Connector repositories may mirror this file
+for package compatibility, but the canonical `$id` remains
+`https://contracts.opensoha.dev/connectors/connector-event-envelope.schema.json`.
+
+For `0.1.x`, patch releases may add optional fields to the wrapper or event
+items and optional provider payload conventions, but must not remove or rename
+top-level `connectorId` or `events`; must not remove or rename event `id`,
+`type`, `source`, `occurredAt`, `subject`, or `payload`; must not add new
+required fields, allow unknown wrapper/event fields, narrow the connector ID
+pattern, or move provider-specific data out of `payload`.
+
+## Runner Operation Lifecycle
+
+`runner/operation-lifecycle.schema.json` owns the public event contract for
+long-running operation lifecycle breadcrumbs across delivery, Docker, VM, AI
+provider, agent run, and connector action runners.
+
+For `0.1.x`, patch releases may add optional operation kinds, optional states,
+optional evidence kinds, and optional metadata fields. They must not remove or
+rename `operationId`, `operationKind`, `runnerId`, `state`, `occurredAt`,
+`evidence`, `finalState`, or `callback`; must not add new required fields; and
+must not narrow existing lifecycle state names or final status values.
+
+## Consumer Adoption
+
+Recommended adoption flow:
+
+1. Change contracts and fixtures here first.
+2. Run `npm test` in this repository.
+3. Regenerate SDKs with `npm run generate` when OpenAPI changes.
+4. Update consumers to the same contract version.
+5. Run consumer build/test gates before release.
+
+Private staging may use sibling checkouts, `go.work`, Go `replace`, or
+`file:../soha-contracts`. Public release builds should pin tagged versions or
+published npm packages.
+
+The consumer matrix gate is:
+
+```sh
+npm run check:consumers
+```
+
+Local runs skip missing sibling checkouts by default. CI and release candidate
+validation should use `--require-all` or a specific `--consumer <name>` so a
+missing checkout is a failure.

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "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 modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "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 thereof, that is intentionally
+      submitted to 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. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated 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
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   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,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   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.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.