@hypercerts-org/lexicon 0.10.0-beta.12 → 0.10.0-beta.14

package/lexicons/app/certified/defs.json

@@ -4,9 +4,17 @@
   "description": "Common type definitions used across certified protocols.",
   "defs": {
     "did": {
-      "type": "string",
-      "format": "did",
-      "description": "A Decentralized Identifier (DID) string."
+      "type": "object",
+      "description": "A Decentralized Identifier (DID) string.",
+      "required": ["did"],
+      "properties": {
+        "did": {
+          "type": "string",
+          "format": "did",
+          "description": "The DID string value.",
+          "maxLength": 256
+        }
+      }
     }
   }
 }

package/lexicons/app/certified/location.json

@@ -37,9 +37,10 @@
             "type": "union",
             "refs": [
               "org.hypercerts.defs#uri",
-              "org.hypercerts.defs#smallBlob"
+              "org.hypercerts.defs#smallBlob",
+              "#string"
             ],
-            "description": "The location of where the work was performed as a URI or blob."
+            "description": "The location of where the work was performed as a URI, blob, or inline string."
           },
           "name": {
             "type": "string",
@@ -60,6 +61,19 @@
           }
         }
       }
+    },
+    "string": {
+      "type": "object",
+      "required": ["string"],
+      "description": "A location represented as a string, e.g. coordinates or a small GeoJSON string.",
+      "properties": {
+        "string": {
+          "type": "string",
+          "description": "The location string value",
+          "maxLength": 10000,
+          "maxGraphemes": 1000
+        }
+      }
     }
   }
 }

package/lexicons/org/hypercerts/claim/activity.json

@@ -116,20 +116,43 @@
       }
     },
     "contributorIdentity": {
-      "type": "string",
-      "description": "Contributor information as a string (DID or identifier)."
+      "type": "object",
+      "description": "Contributor information as a string (DID or identifier).",
+      "required": ["identity"],
+      "properties": {
+        "identity": {
+          "type": "string",
+          "description": "The contributor identity string (DID or identifier).",
+          "maxLength": 1000,
+          "maxGraphemes": 100
+        }
+      }
     },
     "contributorRole": {
-      "type": "string",
+      "type": "object",
       "description": "Contribution details as a string.",
-      "maxLength": 10000,
-      "maxGraphemes": 1000
+      "required": ["role"],
+      "properties": {
+        "role": {
+          "type": "string",
+          "description": "The contribution role or details.",
+          "maxLength": 1000,
+          "maxGraphemes": 100
+        }
+      }
     },
     "workScopeString": {
-      "type": "string",
+      "type": "object",
       "description": "A free-form string describing the work scope for simple or legacy scopes.",
-      "maxLength": 10000,
-      "maxGraphemes": 1000
+      "required": ["scope"],
+      "properties": {
+        "scope": {
+          "type": "string",
+          "description": "The work scope description string.",
+          "maxLength": 1000,
+          "maxGraphemes": 100
+        }
+      }
     }
   }
 }

package/lexicons/org/hypercerts/claim/attachment.json

@@ -0,0 +1,86 @@
+{
+  "lexicon": 1,
+  "id": "org.hypercerts.claim.attachment",
+  "defs": {
+    "main": {
+      "type": "record",
+      "description": "An attachment providing commentary, context, evidence, or documentary material related to a hypercert record (e.g. an activity, project, claim, or evaluation).",
+      "key": "tid",
+      "record": {
+        "type": "object",
+        "required": ["title", "content", "createdAt"],
+        "properties": {
+          "subjects": {
+            "type": "array",
+            "description": "References to the subject(s) the attachment is connected to—this may be an activity claim, outcome claim, measurement, evaluation, or even another attachment. This is optional as the attachment can exist before the claim is recorded.",
+            "items": {
+              "type": "ref",
+              "ref": "com.atproto.repo.strongRef"
+            },
+            "maxLength": 100
+          },
+          "contentType": {
+            "type": "string",
+            "maxLength": 64,
+            "description": "The type of attachment, e.g. report, audit, evidence, testimonial, methodology, etc."
+          },
+          "content": {
+            "type": "array",
+            "description": "The files, documents, or external references included in this attachment record.",
+            "items": {
+              "type": "union",
+              "refs": [
+                "org.hypercerts.defs#uri",
+                "org.hypercerts.defs#smallBlob"
+              ]
+            },
+            "maxLength": 100
+          },
+          "title": {
+            "type": "string",
+            "maxLength": 256,
+            "description": "Title of this attachment."
+          },
+          "shortDescription": {
+            "type": "string",
+            "description": "Short summary of this attachment, suitable for previews and list views. Rich text annotations may be provided via `shortDescriptionFacets`.",
+            "maxLength": 3000,
+            "maxGraphemes": 300
+          },
+          "shortDescriptionFacets": {
+            "type": "array",
+            "description": "Rich text annotations for `shortDescription` (mentions, URLs, hashtags, etc).",
+            "items": {
+              "type": "ref",
+              "ref": "app.bsky.richtext.facet"
+            }
+          },
+          "description": {
+            "type": "string",
+            "description": "Optional longer description of this attachment, including context or interpretation. Rich text annotations may be provided via `descriptionFacets`.",
+            "maxLength": 30000,
+            "maxGraphemes": 3000
+          },
+          "descriptionFacets": {
+            "type": "array",
+            "description": "Rich text annotations for `description` (mentions, URLs, hashtags, etc).",
+            "items": {
+              "type": "ref",
+              "ref": "app.bsky.richtext.facet"
+            }
+          },
+          "location": {
+            "type": "ref",
+            "ref": "com.atproto.repo.strongRef",
+            "description": "A strong reference to the location where this attachment's subject matter occurred. The record referenced must conform with the lexicon app.certified.location."
+          },
+          "createdAt": {
+            "type": "string",
+            "format": "datetime",
+            "description": "Client-declared timestamp when this record was originally created."
+          }
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hypercerts-org/lexicon",
-  "version": "0.10.0-beta.12",
+  "version": "0.10.0-beta.14",
   "description": "ATProto lexicon definitions and TypeScript types for the Hypercerts protocol",
   "type": "module",
   "main": "./dist/index.cjs",

package/dist/generated/types/org/hypercerts/claim/evidence.d.ts

@@ -1,29 +0,0 @@
-/**
- * GENERATED CODE - DO NOT MODIFY
- */
-import { type ValidationResult } from '@atproto/lexicon';
-import { type $Typed } from '../../../../util';
-import type * as ComAtprotoRepoStrongRef from '../../../com/atproto/repo/strongRef.js';
-import type * as OrgHypercertsDefs from '../defs.js';
-export interface Main {
-    $type: 'org.hypercerts.claim.evidence';
-    subject?: ComAtprotoRepoStrongRef.Main;
-    content: $Typed<OrgHypercertsDefs.Uri> | $Typed<OrgHypercertsDefs.SmallBlob> | {
-        $type: string;
-    };
-    /** Title to describe the nature of the evidence. */
-    title: string;
-    /** Short description explaining what this evidence shows. */
-    shortDescription?: string;
-    /** Longer description describing the evidence in more detail. */
-    description?: string;
-    /** How this evidence relates to the subject. */
-    relationType?: 'supports' | 'challenges' | 'clarifies' | (string & {});
-    /** Client-declared timestamp when this record was originally created */
-    createdAt: string;
-    [k: string]: unknown;
-}
-export declare function isMain<V>(v: V): v is import("../../../../util").$TypedObject<V, "org.hypercerts.claim.evidence", "main">;
-export declare function validateMain<V>(v: V): ValidationResult<Main & V>;
-export { type Main as Record, isMain as isRecord, validateMain as validateRecord, };
-//# sourceMappingURL=evidence.d.ts.map

package/dist/generated/types/org/hypercerts/claim/evidence.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"evidence.d.ts","sourceRoot":"","sources":["../../../../../../generated/types/org/hypercerts/claim/evidence.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,KAAK,gBAAgB,EAAW,MAAM,kBAAkB,CAAA;AAGjE,OAAO,EACL,KAAK,MAAM,EAGZ,MAAM,kBAAkB,CAAA;AACzB,OAAO,KAAK,KAAK,uBAAuB,MAAM,wCAAwC,CAAA;AACtF,OAAO,KAAK,KAAK,iBAAiB,MAAM,YAAY,CAAA;AAMpD,MAAM,WAAW,IAAI;IACnB,KAAK,EAAE,+BAA+B,CAAA;IACtC,OAAO,CAAC,EAAE,uBAAuB,CAAC,IAAI,CAAA;IACtC,OAAO,EACH,MAAM,CAAC,iBAAiB,CAAC,GAAG,CAAC,GAC7B,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,GACnC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IACrB,oDAAoD;IACpD,KAAK,EAAE,MAAM,CAAA;IACb,6DAA6D;IAC7D,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,iEAAiE;IACjE,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,gDAAgD;IAChD,YAAY,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,WAAW,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;IACtE,wEAAwE;IACxE,SAAS,EAAE,MAAM,CAAA;IACjB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CACrB;AAID,wBAAgB,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,4FAE7B;AAED,wBAAgB,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,8BAEnC;AAED,OAAO,EACL,KAAK,IAAI,IAAI,MAAM,EACnB,MAAM,IAAI,QAAQ,EAClB,YAAY,IAAI,cAAc,GAC/B,CAAA"}

package/dist/types/org/hypercerts/claim/evidence.d.ts

@@ -1,29 +0,0 @@
-/**
- * GENERATED CODE - DO NOT MODIFY
- */
-import { type ValidationResult } from '@atproto/lexicon';
-import { type $Typed } from '../../../../util';
-import type * as ComAtprotoRepoStrongRef from '../../../com/atproto/repo/strongRef.js';
-import type * as OrgHypercertsDefs from '../defs.js';
-export interface Main {
-    $type: 'org.hypercerts.claim.evidence';
-    subject?: ComAtprotoRepoStrongRef.Main;
-    content: $Typed<OrgHypercertsDefs.Uri> | $Typed<OrgHypercertsDefs.SmallBlob> | {
-        $type: string;
-    };
-    /** Title to describe the nature of the evidence. */
-    title: string;
-    /** Short description explaining what this evidence shows. */
-    shortDescription?: string;
-    /** Longer description describing the evidence in more detail. */
-    description?: string;
-    /** How this evidence relates to the subject. */
-    relationType?: 'supports' | 'challenges' | 'clarifies' | (string & {});
-    /** Client-declared timestamp when this record was originally created */
-    createdAt: string;
-    [k: string]: unknown;
-}
-export declare function isMain<V>(v: V): v is import("../../../../util").$TypedObject<V, "org.hypercerts.claim.evidence", "main">;
-export declare function validateMain<V>(v: V): ValidationResult<Main & V>;
-export { type Main as Record, isMain as isRecord, validateMain as validateRecord, };
-//# sourceMappingURL=evidence.d.ts.map

package/dist/types/org/hypercerts/claim/evidence.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"evidence.d.ts","sourceRoot":"","sources":["../../../../../generated/types/org/hypercerts/claim/evidence.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,KAAK,gBAAgB,EAAW,MAAM,kBAAkB,CAAA;AAGjE,OAAO,EACL,KAAK,MAAM,EAGZ,MAAM,kBAAkB,CAAA;AACzB,OAAO,KAAK,KAAK,uBAAuB,MAAM,wCAAwC,CAAA;AACtF,OAAO,KAAK,KAAK,iBAAiB,MAAM,YAAY,CAAA;AAMpD,MAAM,WAAW,IAAI;IACnB,KAAK,EAAE,+BAA+B,CAAA;IACtC,OAAO,CAAC,EAAE,uBAAuB,CAAC,IAAI,CAAA;IACtC,OAAO,EACH,MAAM,CAAC,iBAAiB,CAAC,GAAG,CAAC,GAC7B,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,GACnC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IACrB,oDAAoD;IACpD,KAAK,EAAE,MAAM,CAAA;IACb,6DAA6D;IAC7D,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,iEAAiE;IACjE,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,gDAAgD;IAChD,YAAY,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,WAAW,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;IACtE,wEAAwE;IACxE,SAAS,EAAE,MAAM,CAAA;IACjB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CACrB;AAID,wBAAgB,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,4FAE7B;AAED,wBAAgB,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,8BAEnC;AAED,OAAO,EACL,KAAK,IAAI,IAAI,MAAM,EACnB,MAAM,IAAI,QAAQ,EAClB,YAAY,IAAI,cAAc,GAC/B,CAAA"}

package/lexicons/org/hypercerts/claim/evidence.json

@@ -1,57 +0,0 @@
-{
-  "lexicon": 1,
-  "id": "org.hypercerts.claim.evidence",
-  "defs": {
-    "main": {
-      "type": "record",
-      "description": "A piece of evidence related to a hypercert record (e.g. an activity, project, claim, or evaluation). Evidence may support, clarify, or challenge the referenced subject.",
-      "key": "tid",
-      "record": {
-        "type": "object",
-        "required": ["content", "title", "createdAt"],
-        "properties": {
-          "subject": {
-            "type": "ref",
-            "ref": "com.atproto.repo.strongRef",
-            "description": "A strong reference to the record this evidence relates to (e.g. an activity, project, claim, or evaluation)."
-          },
-          "content": {
-            "type": "union",
-            "refs": [
-              "org.hypercerts.defs#uri",
-              "org.hypercerts.defs#smallBlob"
-            ],
-            "description": "A piece of evidence (URI or blob) related to the subject record; it may support, clarify, or challenge a hypercert claim."
-          },
-          "title": {
-            "type": "string",
-            "maxLength": 256,
-            "description": "Title to describe the nature of the evidence."
-          },
-          "shortDescription": {
-            "type": "string",
-            "maxLength": 3000,
-            "maxGraphemes": 300,
-            "description": "Short description explaining what this evidence shows."
-          },
-          "description": {
-            "type": "string",
-            "description": "Longer description describing the evidence in more detail.",
-            "maxLength": 30000,
-            "maxGraphemes": 3000
-          },
-          "relationType": {
-            "type": "string",
-            "description": "How this evidence relates to the subject.",
-            "knownValues": ["supports", "challenges", "clarifies"]
-          },
-          "createdAt": {
-            "type": "string",
-            "format": "datetime",
-            "description": "Client-declared timestamp when this record was originally created"
-          }
-        }
-      }
-    }
-  }
-}