Skip to content

Commit b896a95

Browse files
ChrisLallyChrisLally
committed
release: 0.0.0-alpha.1
0 parents  commit b896a95

68 files changed

Lines changed: 3034 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/release.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Release Fide Context Protocol
2+
3+
on:
4+
push:
5+
tags:
6+
- "v*"
7+
8+
permissions:
9+
contents: write
10+
id-token: write
11+
deployments: write
12+
13+
jobs:
14+
publish-fcp:
15+
permissions:
16+
contents: write
17+
id-token: write
18+
deployments: write
19+
uses: ChrisLally/lally-workflows/.github/workflows/npm-publish-release.yml@beeaf5a5511d1270b571b3be1f0485c203b952fa
20+
with:
21+
tag_prefix: "v"
22+
install_working_directory: "sdk/javascript"
23+
package_dir: "sdk/javascript"
24+
deployment_environment: "Preview - Fide Context Protocol"

‎CODE_OF_CONDUCT.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Code Of Conduct
2+
3+
## Our Standard
4+
5+
Contributors and maintainers are expected to keep this project respectful, technically focused, and constructive.
6+
7+
Please:
8+
9+
- engage in good-faith technical discussion
10+
- critique ideas, proposals, and implementations rather than people
11+
- avoid harassment, abuse, discrimination, and personal attacks
12+
- keep feedback direct, specific, and professional
13+
14+
## Scope
15+
16+
This applies to project spaces, including:
17+
18+
- issues
19+
- pull requests
20+
- discussions
21+
- review comments
22+
23+
## Enforcement
24+
25+
Project maintainers may remove, edit, or reject contributions and comments that do not meet this standard.
26+
27+
Serious or repeated violations may lead to temporary or permanent exclusion from project spaces.
28+
29+
## Reporting
30+
31+
If you need to report conduct concerns, contact:
32+
33+
- `conduct@fide.work`

‎CONTRIBUTING.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Contributing to Fide Context Protocol
2+
3+
Thank you for contributing to the Fide Context Protocol.
4+
5+
This repository is specification-first. The protocol definition is the core product, and the JavaScript SDK and generated docs are downstream artifacts.
6+
7+
## Current Stability Policy
8+
9+
The repository is currently in alpha.
10+
11+
- Breaking changes are allowed during alpha.
12+
- SDK releases use `0.0.0-alpha.x`.
13+
- Changes should still be deliberate and easy to review.
14+
15+
## Repository Scope
16+
17+
This repository is responsible for:
18+
19+
- statement structure and protocol rules
20+
- predicate and statement validation behavior
21+
- protocol schemas and generated interoperability artifacts
22+
- JavaScript SDK behavior for working with FCP statements
23+
- generated SDK reference docs
24+
25+
Changes that belong in other repositories should stay there:
26+
27+
- identifier method rules belong in `fide/id`
28+
- entity and reference typing belongs in `fide/vocabulary`
29+
30+
## How To Contribute
31+
32+
1. Open or reference an issue describing the change.
33+
2. Update the relevant spec, SDK, or generator source files.
34+
3. Regenerate affected artifacts if needed.
35+
4. Review the generated diff carefully.
36+
5. Submit a focused pull request with a clear explanation of compatibility impact.
37+
38+
## Generated Files
39+
40+
Generated outputs include protocol artifacts and SDK reference docs.
41+
42+
If you change generator-owned inputs, regenerate the corresponding outputs before submitting your change.
43+
44+
Do not hand-edit generated files unless the change is specifically to the generator or a generator-owned post-processing step.
45+
46+
## Local Commands
47+
48+
From `sdk/javascript/`:
49+
50+
```bash
51+
pnpm run generate:docs
52+
pnpm run build
53+
pnpm run check-types
54+
pnpm test
55+
```
56+
57+
If your change affects generated protocol artifacts or generated docs, verify they are in sync before opening a pull request.
58+
59+
## Pull Request Expectations
60+
61+
A good pull request should make it obvious:
62+
63+
- what changed in the protocol or SDK
64+
- whether the change is breaking, additive, or editorial
65+
- why the change belongs in FCP rather than a related repository
66+
- whether generated artifacts were refreshed
67+
68+
If a change affects protocol validity rules, statement constraints, or normalization behavior, call that out explicitly in the pull request description.
69+
70+
## Editing Guidance
71+
72+
When contributing to FCP:
73+
74+
- keep spec and SDK behavior aligned
75+
- prefer deterministic generation over manual edits
76+
- keep strict behavior as the default and make convenience behavior explicit
77+
- avoid semantic drift between examples, docs, and runtime behavior
78+
79+
## AI Use
80+
81+
If you used AI assistance to prepare a contribution, disclose that in the pull request.
82+
83+
You are still responsible for understanding the change, reviewing the output, and ensuring the contribution is technically correct.

‎LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2026 Fide Holdings, Inc.
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Fide Context Protocol
2+
3+
Canonical specification and SDK for the Fide Context Protocol.
4+
5+
The Fide Context Protocol defines interoperable statement structures for graph-based world models across systems. It depends on [Fide ID](https://github.com/fide/id) for identifier rules and on the [Fide Vocabulary](https://github.com/fide/vocabulary) for entity and predicate typing semantics.
6+
7+
Public docs are published at:
8+
9+
- [fide.work/docs/context-protocol](https://fide.work/docs/context-protocol)
10+
11+
## Structure
12+
13+
- `spec/`: protocol specification artifacts (canonical source in `spec/v0`)
14+
- `docs/`: protocol docs
15+
- `sdk/javascript/`: JavaScript SDK package (`@fide-work/context-protocol`)
16+
17+
## Generate Protocol Artifacts
18+
19+
Predicate prefix mappings and JS SDK constants are generated from:
20+
21+
- `spec/v0/predicate-prefixes.json`
22+
23+
Run from repo root:
24+
25+
```bash
26+
pnpm run generate:context-protocol
27+
pnpm run check:generated:context-protocol
28+
```
29+
30+
## SDK Release
31+
32+
- Monorepo release tag: `context-protocol/v<version>`
33+
- Standalone repo release tag: `v<version>`
34+
35+
## JavaScript SDK
36+
37+
The JavaScript SDK package lives in:
38+
39+
- `sdk/javascript/`
40+
41+
Current package name:
42+
43+
- [`@fide-work/context-protocol`](https://www.npmjs.com/package/@fide-work/context-protocol)
44+
45+
Additional docs:
46+
47+
- [fide.work/docs/context-protocol/specification](https://fide.work/docs/context-protocol/specification)
48+
- [fide.work/docs/context-protocol/sdk/javascript](https://fide.work/docs/context-protocol/sdk/javascript)
49+
50+
## License
51+
52+
Licensed under Apache-2.0. See `LICENSE` for the full text.

0 commit comments

Comments
 (0)