@openproficiency/schema 0.0.1

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.

package/README.md

@@ -0,0 +1,144 @@
+# Open Proficiency Model
+
+The Open Proficiency Model (OPM) is an open definition for quantifying an individual's familiarity with skills, capabilities, and other abilities.
+
+Definitions to define the knowledge space:
+
+- [Topic](specs/topic.md) - a defined unique area of knowledge for gaining experience and becoming proficient.
+- [Topic List](specs/topic-list.md) - A list of topics provided by an issuer.
+- [Issuer](specs/issuer.md) - A verified entity that can provide a topic list and/or create transcript entries.
+
+Definitions to define and store proficiency:
+
+- [Experience Source](specs/experience-source.md) - activities a user can complete to increase proficiency in topics. (regular work, projects, tutorials, etc.)
+- [Topic Score](specs/topic-score.md) - a label indicating the degree of understanding for a specific topic.
+- [Transcript Entry](specs/transcript-entry.md) - a topic score assigned to a specific user, claimed by an issuer.
+- [Transcript](specs/transcript.md) - a collection of transcript entries for easier portability.
+
+Definitions to interpret proficiency:
+
+- [Topic Score Interpretation](specs/score-interpretation.md) - a standardized interpretation for a set of topic scores.
+- [Topic Score Interpretation List](specs/score-interpretation-list.md) - a collection of topic score interpretations. Examples:
+  - [Badging](specs/score-interpretation-list.md#badges---goldsilverbronze)
+  - [Skill Proficiency Levels](specs/score-interpretation-list.md#simple-progression---arithmetic)
+  - [Job Role Levels](specs/score-interpretation-list.md#job-roles---math-teacher)
+
+## Advantages
+
+- **Verified** - All proficiency is signed by the issuer.
+- **Distributed** - All transcript records are independent of the issuer and learning source.
+- **Never Repeat** - Knowledge topics and proficiency are transferrable. New courses on the same topics don't invalidate old courses.
+
+## Get started
+
+Install the versioned JSON schema package:
+
+```bash
+npm install @openproficiency/schema
+```
+
+```js
+import topicSchema from "@openproficiency/schema/topic.schema.json";
+import topicListSchema from "@openproficiency/schema/topic-list.schema.json";
+import scoreInterpretationSchema from "@openproficiency/schema/score-interpretation.schema.json";
+import scoreInterpretationListSchema from "@openproficiency/schema/score-interpretation-list.schema.json";
+import transcriptEntrySchema from "@openproficiency/schema/transcript-entry.schema.json";
+import transcriptEntryVerificationSchema from "@openproficiency/schema/transcript-entry-verification.schema.json";
+import transcriptSchema from "@openproficiency/schema/transcript.schema.json";
+```
+
+## Works With Open Proficiency
+
+The **Works With Open Profiency** badge helps indicate to users of your platform, that their (new) proficiencies will be easy to manage, distribute, and validate across ecosystems.
+
+<img width="180px" src="works-with/wwop-pink.png" />
+
+### Can I add this to my service?
+
+If your product or service follows all or most of the expectations in the specifications, then yes.
+
+> [!TIP]
+> A "Works With" program is planned but not in development yet. Self-regulation by the community is the preferred method for now.
+
+## Diagram
+
+```mermaid
+flowchart BT
+
+  subgraph knowledge-domain["Knowledge Domain"]
+    %% Components
+    topic[/topic\]
+    pretopic[/pretopic*\]
+    subtopic[/subtopic*\]
+    topic-list@{ shape: docs, label: "topic-list" }
+    dependency-list@{ shape: docs, label: "topic-list<br/>dependency" }
+
+    %% Mapping
+    topic --"N Topics"--> topic-list
+    subtopic --> topic
+    pretopic -.-x topic
+    dependency-list -.-x topic-list
+  end
+
+  subgraph tracking-and-verification["Tracking and Verification"]
+    %% Components
+    topic-score[/"topic-score"\]
+    transcript-entry@{ shape: subproc, label: "transcript-entry" }
+    transcript@{ shape: div-rect, label: "transcript" }
+    issuer@{ shape: flag, label: "issuer" }
+
+    %% Mapping
+    issuer --"adds signature"-->  transcript-entry
+    topic-score --->  transcript-entry
+    transcript-entry --"N entries"--> transcript
+
+    %% Mapping - External
+    topic-list --"1 topic"--> topic-score
+  end
+
+  subgraph official-interpretation["Official Interpretation"]
+    direction BT
+    %% Components
+    score-requirement[/score-requirement\]
+    score-interpretation{{"score-interpretation<br/>"}}
+    score-interpretation-list@{ shape: docs, label: "score-interpretation-list" }
+
+
+    %% Mapping
+    score-requirement --"N requirements"--> score-interpretation
+    score-interpretation --"N interpretations"--> score-interpretation-list
+
+    %% Mapping - External
+    topic-list --"1 topic<br/>1 score"--> score-requirement
+    issuer --"adds signature"--> score-interpretation-list
+  end
+
+  %% ----- YOUR RESOURCES ----- %%
+
+  subgraph experience-sources["Experience Source"]
+    %% Components
+    tutorial
+    product-usage
+    test
+    etc.
+  end
+
+  %% Mapping
+  topic-list -."N Topics from N Lists".-x experience-sources
+  experience-sources --"1 score<br/>1 user"--> topic-score
+
+  subgraph your-application["Your Services"]
+    %% Components
+    web-app@{ shape: stadium, label: "Web App" }
+    mobile-app@{ shape: stadium, label: "Mobile App" }
+    desktop-app@{ shape: stadium, label: "Desktop App" }
+    database@{ shape: lin-cyl, label: "Database" }
+  end
+
+  %% Mapping
+  score-interpretation-list --> your-application
+  transcript --> your-application
+
+```
+
+\* The `pre-` and `sub-` prefixes only indicate relationships between topics. They are not a different component.

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@openproficiency/schema",
+  "version": "0.0.1",
+  "description": "JSON schemas for the Open Proficiency Model.",
+  "license": "Apache-2.0",
+  "files": [
+    "schemas"
+  ],
+  "exports": {
+    "./*.schema.json": "./schemas/*.schema.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/openproficiency/model.git"
+  },
+  "bugs": {
+    "url": "https://github.com/openproficiency/model/issues"
+  },
+  "homepage": "https://github.com/openproficiency/model#readme",
+  "scripts": {
+    "test": "node --test tests/**/*.test.mjs"
+  },
+  "devDependencies": {
+    "ajv": "^8.20.0",
+    "ajv-formats": "^3.0.1",
+    "yaml": "^2.9.0"
+  }
+}

package/schemas/score-interpretation-list.schema.json

@@ -0,0 +1,109 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "score-interpretation-list.schema.json",
+
+  "title": "Score Interpretation List",
+  "description": "A collection of score interpretations that imply order via their naming or required proficiencies.",
+  "type": "object",
+
+  "properties": {
+    "$schema": {
+      "description": "JSON Schema version",
+      "type": "string"
+    },
+
+    "owner": {
+      "description": "The entity that maintains this score interpretation list. Domain name. Ex: 'example.com'",
+      "type": "string",
+      "format": "hostname",
+      "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*\\.[a-z]{2,}$"
+    },
+
+    "name": {
+      "description": "A namespace to associate the interpretations. Kebab case. Ex: 'my-list-name'",
+      "type": "string",
+      "format": "kebab-case",
+      "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
+    },
+
+    "description": {
+      "description": "A brief description of the knowledge domain covered by this interpretation list.",
+      "type": "string"
+    },
+
+    "version": {
+      "description": "Version of this list. Semantic versioning format. Ex: '1.0.0'",
+      "type": "string",
+      "format": "semver",
+      "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"
+    },
+
+    "issued-at": {
+      "description": "ISO 8601 timestamp of when this version was created.",
+      "type": "string",
+      "format": "date-time"
+    },
+
+    "signature": {
+      "description": "ASCII-armored detached OpenPGP (GPG) signature over the protected fields of this interpretation list, used to verify authenticity.",
+      "oneOf": [
+        {
+          "type": "string",
+          "pattern": "^-----BEGIN PGP SIGNATURE-----\\r?\\n(?:[^\\n]+\\r?\\n)*\\r?\\n(?:[A-Za-z0-9+/]+=*\\r?\\n)+=[A-Za-z0-9+/]{4}\\r?\\n-----END PGP SIGNATURE-----\\r?\\n?$"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+
+    "signed-by": {
+      "description": "Email address of the GPG key that produced 'signature'. For convenience only. Verify with signature. Convention: 'proficiency@<owner>'.",
+      "oneOf": [
+        {
+          "type": "string",
+          "format": "email"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+
+    "score-interpretations": {
+      "description": "Map of score interpretation identifiers to their definitions",
+      "type": "object",
+      "patternProperties": {
+        "^[a-z0-9]+(?:-[a-z0-9]+)*$": {
+          "$ref": "https://raw.githubusercontent.com/openproficiency/model/refs/heads/main/schemas/score-interpretation.schema.json"
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "dependencies": {
+      "description": "Map of shorthand aliases to external topic list references",
+      "type": "object",
+      "patternProperties": {
+        "^[a-z0-9]+(?:-[a-z0-9]+)*$": {
+          "type": "string",
+          "description": "HTTP(S) URL to a versioned topic list (YAML/JSON)",
+          "format": "uri"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+
+  "required": [
+    "owner",
+    "name",
+    "description",
+    "version",
+    "issued-at",
+    "signature",
+    "signed-by",
+    "score-interpretations"
+  ],
+  "additionalProperties": false
+}

package/schemas/score-interpretation.schema.json

@@ -0,0 +1,60 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "score-interpretation.schema.json",
+
+  "title": "Score Interpretation",
+  "description": "A standardized interpretation of a set of topic scores, typically one of several in a score interpretation list.",
+  "type": "object",
+
+  "properties": {
+    "$schema": {
+      "description": "JSON Schema version",
+      "type": "string"
+    },
+
+    "id": {
+      "description": "Unique identifier for this score interpretation. Kebab case. Ex: 'my-interpretation-id'",
+      "type": "string",
+      "format": "kebab-case",
+      "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
+    },
+
+    "name": {
+      "description": "A friendly name used for display",
+      "type": "string"
+    },
+
+    "description": {
+      "description": "A brief explanation of this score interpretation",
+      "type": "string"
+    },
+
+    "requirements": {
+      "description": "A logical expression of topics and required scores for this interpretation. Supports logical operators (all, any, at-least-N) for composing requirements. A flat topic-score map is treated as implicit 'all'. Operators may have a unique identifier suffix (e.g., 'all-abc1', 'any-abc2', 'at-least-3-abc3'). Topic keys always contain a dot (dependency.topic) so they cannot conflict with operator keywords.",
+      "$id": "requirements-expression",
+      "type": "object",
+      "patternProperties": {
+        "^all(-[a-z][a-z0-9]*(?:-[a-z0-9]+)*)?$": {
+          "description": "All expressions must be satisfied. Each entry in the value is a separate operand.",
+          "$ref": "requirements-expression"
+        },
+        "^any(-[a-z][a-z0-9]*(?:-[a-z0-9]+)*)?$": {
+          "description": "At least one expression must be satisfied. Each entry in the value is a separate operand.",
+          "$ref": "requirements-expression"
+        },
+        "^at-least-[1-9][0-9]*(-[a-z][a-z0-9]*(?:-[a-z0-9]+)*)?$": {
+          "description": "At least N expressions must be satisfied, where N is encoded in the operator name. Each entry in the value is a separate operand.",
+          "$ref": "requirements-expression"
+        },
+        "^[a-z0-9]+(?:-[a-z0-9]+)*(?:\\.[a-z0-9]+(?:-[a-z0-9]+)*)+$": {
+          "type": "string",
+          "description": "Score level required for the topic"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+
+  "required": ["name", "description", "requirements"],
+  "additionalProperties": false
+}

package/schemas/topic-list.schema.json

@@ -0,0 +1,140 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "topic-list.schema.json",
+
+  "title": "Topic List",
+  "description": "A collection of topics that define a knowledge domain declared by a particular issuer.",
+  "type": "object",
+
+  "properties": {
+    "$schema": {
+      "description": "JSON Schema version",
+      "type": "string"
+    },
+
+    "owner": {
+      "description": "The entity that maintains this topic list. Domain name. Ex: 'example.com'",
+      "type": "string",
+      "format": "hostname",
+      "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*\\.[a-z]{2,}$"
+    },
+
+    "name": {
+      "description": "A name to define scope for this topic list. Kebab case. Ex: 'my-list-name'",
+      "type": "string",
+      "format": "kebab-case",
+      "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
+    },
+
+    "description": {
+      "description": "A brief description of the knowledge domain covered by this topic list.",
+      "type": "string",
+      "maxLength": 100
+    },
+
+    "version": {
+      "description": "Version of this topic list. Semantic versioning format. Ex: '1.0.0'",
+      "type": "string",
+      "format": "semver",
+      "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"
+    },
+
+    "issued-at": {
+      "description": "ISO 8601 timestamp of when this version was created.",
+      "type": "string",
+      "format": "date-time"
+    },
+
+    "signature": {
+      "description": "ASCII-armored detached OpenPGP (GPG) signature over the protected fields of this topic list, used to verify authenticity.",
+      "oneOf": [
+        {
+          "type": "string",
+          "pattern": "^-----BEGIN PGP SIGNATURE-----\\r?\\n(?:[^\\n]+\\r?\\n)*\\r?\\n(?:[A-Za-z0-9+/]+=*\\r?\\n)+=[A-Za-z0-9+/]{4}\\r?\\n-----END PGP SIGNATURE-----\\r?\\n?$"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+
+    "signed-by": {
+      "description": "Email address of the GPG key that produced 'signature'. For convenience only. Verify with signature. Convention: 'proficiency@<owner>'.",
+      "oneOf": [
+        {
+          "type": "string",
+          "format": "email"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+
+    "topics": {
+      "description": "Map of topic identifiers to their definitions",
+      "type": "object",
+      "patternProperties": {
+        "^[a-z0-9]+(?:-[a-z0-9]+)*$": {
+          "$ref": "https://raw.githubusercontent.com/openproficiency/model/refs/heads/main/schemas/topic.schema.json"
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "dependencies": {
+      "description": "Map of shorthand aliases to external topic list references",
+      "type": "object",
+      "patternProperties": {
+        "^[a-z0-9]+(?:-[a-z0-9]+)*$": {
+          "oneOf": [
+            {
+              "type": "string",
+              "description": "Shorthand reference: a fully qualified name 'owner/name@version' (e.g. 'example.com/math@0.1.0') for registry lookup.",
+              "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*\\.[a-z]{2,}/[a-z0-9]+(?:-[a-z0-9]+)*@(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"
+            },
+            {
+              "type": "object",
+              "description": "Long-form reference using explicit fields. Optionally provides exact locations, removing dependency on any registry.",
+              "properties": {
+                "topic-list-owner": {
+                  "description": "The owner of the referenced topic list. Domain name. Ex: 'example.com'",
+                  "type": "string",
+                  "format": "hostname",
+                  "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*\\.[a-z]{2,}$"
+                },
+                "topic-list-name": {
+                  "description": "The name of the referenced topic list. Kebab case. Ex: 'math'",
+                  "type": "string",
+                  "format": "kebab-case",
+                  "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
+                },
+                "topic-list-version": {
+                  "description": "The version of the referenced topic list. Semantic versioning format. Ex: '0.1.0'",
+                  "type": "string",
+                  "format": "semver",
+                  "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"
+                },
+                "locations": {
+                  "description": "Optional list of exact HTTP(S) URLs where this topic list version can be retrieved. Removes dependency on any registry. Not included in the issuer's signature verification, so it may be amended by redistributors without invalidating the signature.",
+                  "type": "array",
+                  "items": {
+                    "type": "string",
+                    "format": "uri"
+                  },
+                  "uniqueItems": true
+                }
+              },
+              "required": ["topic-list-owner", "topic-list-name", "topic-list-version"],
+              "additionalProperties": false
+            }
+          ]
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+
+  "required": ["owner", "name", "description", "version", "issued-at", "signature", "signed-by", "topics"],
+  "additionalProperties": false
+}

package/schemas/topic.schema.json

@@ -0,0 +1,77 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "topic.schema.json",
+
+  "title": "Topic",
+  "description": "A defined unique area of knowledge",
+
+  "type": "object",
+  "properties": {
+    "$schema": {
+      "description": "JSON Schema version",
+      "type": "string"
+    },
+
+    "id": {
+      "description": "Unique identifier for this topic within its topic list. Kebab case. Ex: 'my-topic-id'",
+      "type": "string",
+      "format": "kebab-case",
+      "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
+    },
+
+    "display-name": {
+      "description": "Optional human-friendly name for this topic.",
+      "type": "string",
+      "maxLength": 100
+    },
+
+    "description": {
+      "description": "A brief explanation of the knowledge represented by this topic. Max 100 characters.",
+      "type": "string",
+      "maxLength": 100
+    },
+
+    "docs-url": {
+      "description": "HTTP(S) URL to a reference that explains this topic.",
+      "type": "string",
+      "format": "uri"
+    },
+
+    "validity-period": {
+      "description": "The suggested validity period when assigning a score to this topic. Min 30 days. Default is 732 days (~2 years).",
+      "type": "integer",
+      "minimum": 1,
+      "default": 732
+    },
+
+    "subtopics": {
+      "description": "List of topics that directly represent proficiency in a subspace of this topic.",
+      "type": "array",
+      "items": {
+        "oneOf": [
+          {
+            "type": "string",
+            "description": "Reference to a topic identifier"
+          },
+          {
+            "$ref": "#"
+          }
+        ]
+      },
+      "uniqueItems": true
+    },
+
+    "pretopics": {
+      "description": "List of topics required as prerequisites before beginning to obtain proficiency in this topic.",
+      "type": "array",
+      "items": {
+        "type": "string",
+        "description": "Reference to a topic identifier or external topic (e.g., 'namespace.topic-id')"
+      },
+      "uniqueItems": true
+    }
+  },
+
+  "required": ["description"],
+  "additionalProperties": false
+}

package/schemas/transcript-entry-verification.schema.json

@@ -0,0 +1,49 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "transcript-entry-verification.schema.json",
+
+  "title": "Transcript Entry Verification Response",
+  "description": "Response envelope for batch transcript entry verification lookups.",
+
+  "type": "object",
+  "patternProperties": {
+    "^[a-f0-9]{64}$": {
+      "oneOf": [{ "$ref": "#/$defs/valid-entry" }, { "$ref": "#/$defs/invalid-entry" }]
+    }
+  },
+  "additionalProperties": false,
+
+  "$defs": {
+    "valid-entry": {
+      "type": "object",
+      "properties": {
+        "valid": {
+          "const": true
+        }
+      },
+      "required": ["valid"],
+      "additionalProperties": false
+    },
+
+    "invalid-entry": {
+      "type": "object",
+      "properties": {
+        "valid": {
+          "const": false
+        },
+        "reason": {
+          "description": "Issuer provided reason for invalid status.",
+          "type": "string",
+          "enum": ["dishonesty", "policy-violation", "incorrect", "other"]
+        },
+        "invalidated-at": {
+          "description": "ISO 8601 timestamp indicating when validity ended.",
+          "type": "string",
+          "format": "date-time"
+        }
+      },
+      "required": ["valid", "invalidated-at"],
+      "additionalProperties": false
+    }
+  }
+}

package/schemas/transcript-entry.schema.json

@@ -0,0 +1,123 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "transcript-entry.schema.json",
+
+  "title": "Transcript Entry",
+  "description": "A permanent record of a user's proficiency score for a single topic.",
+  "type": "object",
+
+  "properties": {
+    "$schema": {
+      "description": "JSON Schema version",
+      "type": "string"
+    },
+
+    "user-email": {
+      "description": "The user's email address to act as a unique identifier. Ex: 'user@example.com'",
+      "type": "string",
+      "format": "email"
+    },
+
+    "topic": {
+      "description": "The topic identifier for which proficiency is being recorded. Kebab case. Ex: 'addition'",
+      "type": "string",
+      "format": "kebab-case",
+      "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
+    },
+
+    "topic-list": {
+      "description": "Name of the topic list that defines the topic. Kebab case. Ex: 'math'",
+      "type": "string",
+      "format": "kebab-case",
+      "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
+    },
+
+    "topic-list-version": {
+      "description": "Version of the topic list. Semantic versioning format. Ex: '1.0.0'",
+      "type": "string",
+      "format": "semver",
+      "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"
+    },
+
+    "topic-list-owner": {
+      "description": "Domain name of the entity that maintains the topic list. Ex: 'example.com'",
+      "type": "string",
+      "format": "hostname",
+      "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*\\.[a-z]{2,}$"
+    },
+
+    "topic-list-sources": {
+      "description": "Optional list of URLs where the topic list is hosted. The issuer's original is recommended first.",
+      "type": "array",
+      "items": {
+        "type": "string",
+        "format": "uri"
+      }
+    },
+
+    "score": {
+      "description": "The degree of proficiency for a specific topic. [unaware, aware, familiar, competent, fluent]",
+      "type": "string",
+      "enum": ["unaware", "aware", "familiar", "competent", "fluent"]
+    },
+
+    "issued-at": {
+      "description": "ISO 8601 timestamp of when this topic's score was recorded.",
+      "type": "string",
+      "format": "date-time"
+    },
+
+    "valid-until": {
+      "description": "ISO 8601 timestamp of when this topic's score expires.",
+      "type": "string",
+      "format": "date-time"
+    },
+
+    "issued-by": {
+      "description": "Domain name of the entity that issued this transcript entry. Ex: 'example.com'",
+      "type": "string",
+      "format": "hostname",
+      "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*\\.[a-z]{2,}$"
+    },
+
+    "verification-url": {
+      "description": "HTTPS URL to the issuer verification API endpoint. Used for additional confirmation of this transcript entry.",
+      "type": "string",
+      "format": "uri"
+    },
+
+    "signature": {
+      "description": "ASCII-armored detached OpenPGP (GPG) signature over the protected fields of this transcript entry, used to verify authenticity.",
+      "oneOf": [
+        {
+          "type": "string",
+          "pattern": "^-----BEGIN PGP SIGNATURE-----\\r?\\n(?:[^\\n]+\\r?\\n)*\\r?\\n(?:[A-Za-z0-9+/]+=*\\r?\\n)+=[A-Za-z0-9+/]{4}\\r?\\n-----END PGP SIGNATURE-----\\r?\\n?$"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+
+    "signed-by": {
+      "description": "Email address of the GPG key that produced 'signature'. For convenience only. Verify with signature. Convention: 'proficiency@<owner>'.",
+      "type": "string",
+      "format": "email"
+    }
+  },
+
+  "required": [
+    "user-email",
+    "topic",
+    "topic-list",
+    "topic-list-version",
+    "topic-list-owner",
+    "score",
+    "issued-at",
+    "valid-until",
+    "issued-by",
+    "signature",
+    "signed-by"
+  ],
+  "additionalProperties": false
+}

package/schemas/transcript.schema.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "transcript.schema.json",
+
+  "title": "Transcript",
+  "description": "A collection of transcript entries representing a user's proficiency across multiple topics.",
+  "type": "array",
+  "items": {
+    "$ref": "https://raw.githubusercontent.com/openproficiency/model/refs/heads/main/schemas/transcript-entry.schema.json"
+  }
+}