@hypercerts-org/lexicon 0.10.0-beta.6 → 0.10.0-beta.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. package/CHANGELOG.md +50 -0
  2. package/README.md +46 -0
  3. package/SCHEMAS.md +103 -97
  4. package/dist/exports.d.ts +44 -18
  5. package/dist/exports.d.ts.map +1 -1
  6. package/dist/generated/exports.d.ts +44 -18
  7. package/dist/generated/exports.d.ts.map +1 -1
  8. package/dist/generated/lexicons.d.ts +100 -48
  9. package/dist/generated/lexicons.d.ts.map +1 -1
  10. package/dist/generated/types/app/bsky/richtext/facet.d.ts +8 -0
  11. package/dist/generated/types/app/bsky/richtext/facet.d.ts.map +1 -0
  12. package/dist/generated/types/org/hypercerts/claim/activity.d.ts +9 -12
  13. package/dist/generated/types/org/hypercerts/claim/activity.d.ts.map +1 -1
  14. package/dist/generated/types/org/hypercerts/claim/collection.d.ts +18 -2
  15. package/dist/generated/types/org/hypercerts/claim/collection.d.ts.map +1 -1
  16. package/dist/index.cjs +124 -61
  17. package/dist/index.cjs.map +1 -1
  18. package/dist/index.mjs +124 -61
  19. package/dist/index.mjs.map +1 -1
  20. package/dist/lexicons.cjs +56 -24
  21. package/dist/lexicons.cjs.map +1 -1
  22. package/dist/lexicons.d.ts +100 -48
  23. package/dist/lexicons.d.ts.map +1 -1
  24. package/dist/lexicons.mjs +56 -24
  25. package/dist/lexicons.mjs.map +1 -1
  26. package/dist/types/app/bsky/richtext/facet.d.ts +8 -0
  27. package/dist/types/app/bsky/richtext/facet.d.ts.map +1 -0
  28. package/dist/types/org/hypercerts/claim/activity.d.ts +9 -12
  29. package/dist/types/org/hypercerts/claim/activity.d.ts.map +1 -1
  30. package/dist/types/org/hypercerts/claim/collection.d.ts +18 -2
  31. package/dist/types/org/hypercerts/claim/collection.d.ts.map +1 -1
  32. package/lexicons/org/hypercerts/claim/activity.json +23 -22
  33. package/lexicons/org/hypercerts/claim/collection.json +33 -2
  34. package/package.json +4 -1
package/dist/index.cjs CHANGED
@@ -284,16 +284,32 @@ const schemaDict = {
284
284
  },
285
285
  shortDescription: {
286
286
  type: 'string',
287
- description: 'Short blurb of the impact work done.',
287
+ description: 'Short summary of this activity claim, suitable for previews and list views. Rich text annotations may be provided via `shortDescriptionFacets`.',
288
288
  maxLength: 3000,
289
289
  maxGraphemes: 300,
290
290
  },
291
+ shortDescriptionFacets: {
292
+ type: 'array',
293
+ description: 'Rich text annotations for `shortDescription` (mentions, URLs, hashtags, etc).',
294
+ items: {
295
+ type: 'ref',
296
+ ref: 'lex:app.bsky.richtext.facet',
297
+ },
298
+ },
291
299
  description: {
292
300
  type: 'string',
293
- description: 'Optional longer description of the impact work done.',
301
+ description: 'Optional longer description of this activity claim, including context or interpretation. Rich text annotations may be provided via `descriptionFacets`.',
294
302
  maxLength: 30000,
295
303
  maxGraphemes: 3000,
296
304
  },
305
+ descriptionFacets: {
306
+ type: 'array',
307
+ description: 'Rich text annotations for `description` (mentions, URLs, hashtags, etc).',
308
+ items: {
309
+ type: 'ref',
310
+ ref: 'lex:app.bsky.richtext.facet',
311
+ },
312
+ },
297
313
  image: {
298
314
  type: 'union',
299
315
  refs: [
@@ -348,17 +364,17 @@ const schemaDict = {
348
364
  },
349
365
  contributor: {
350
366
  type: 'object',
351
- required: ['contributorInformation'],
367
+ required: ['contributorIdentity'],
352
368
  properties: {
353
- contributorInformation: {
369
+ contributorIdentity: {
354
370
  type: 'union',
355
371
  refs: [
356
372
  'lex:org.hypercerts.claim.activity#contributorIdentity',
357
373
  'lex:com.atproto.repo.strongRef',
358
374
  ],
359
- description: 'Contributor information as a string (DID or identifier) or strong reference to for instance org.hypercerts.claim.contributorInformation#main.',
375
+ description: 'Contributor identity as a string (DID or identifier) via org.hypercerts.claim.activity#contributorIdentity, or a strong reference to a contributor information record.',
360
376
  },
361
- weight: {
377
+ contributionWeight: {
362
378
  type: 'string',
363
379
  description: 'The relative weight/importance of this contribution (stored as a string to avoid float precision issues). Must be a positive numeric value. Weights do not need to sum to a specific total; normalization can be performed by the consuming application as needed.',
364
380
  },
@@ -368,7 +384,7 @@ const schemaDict = {
368
384
  'lex:org.hypercerts.claim.activity#contributorRole',
369
385
  'lex:com.atproto.repo.strongRef',
370
386
  ],
371
- description: 'Contribution details as a string or strong reference to org.hypercerts.claim.contributionDetails#main.',
387
+ description: 'Contribution details as a string via org.hypercerts.claim.activity#contributorRole, or a strong reference to a contribution details record.',
372
388
  },
373
389
  },
374
390
  },
@@ -382,21 +398,6 @@ const schemaDict = {
382
398
  maxLength: 10000,
383
399
  maxGraphemes: 1000,
384
400
  },
385
- activityWeight: {
386
- type: 'object',
387
- required: ['activity', 'weight'],
388
- properties: {
389
- activity: {
390
- type: 'ref',
391
- ref: 'lex:com.atproto.repo.strongRef',
392
- description: 'A strong reference to a hypercert activity record. This activity must conform to the lexicon org.hypercerts.claim.activity',
393
- },
394
- weight: {
395
- type: 'string',
396
- description: 'The relative weight/importance of this hypercert activity (stored as a string to avoid float precision issues). Weights can be any positive numeric values and do not need to sum to a specific total; normalization can be performed by the consuming application as needed.',
397
- },
398
- },
399
- },
400
401
  },
401
402
  },
402
403
  OrgHypercertsClaimCollection: {
@@ -432,12 +433,28 @@ const schemaDict = {
432
433
  ref: 'lex:pub.leaflet.pages.linearDocument#main',
433
434
  description: 'Rich-text description, represented as a Leaflet linear document.',
434
435
  },
436
+ avatar: {
437
+ type: 'union',
438
+ refs: [
439
+ 'lex:org.hypercerts.defs#uri',
440
+ 'lex:org.hypercerts.defs#smallImage',
441
+ ],
442
+ description: "The collection's avatar/profile image as a URI or image blob.",
443
+ },
444
+ banner: {
445
+ type: 'union',
446
+ refs: [
447
+ 'lex:org.hypercerts.defs#uri',
448
+ 'lex:org.hypercerts.defs#largeImage',
449
+ ],
450
+ description: 'Larger horizontal image to display behind the collection view.',
451
+ },
435
452
  items: {
436
453
  type: 'array',
437
- description: 'Array of strong references to items in this collection. Items can be activities (org.hypercerts.claim.activity) and/or other collections (org.hypercerts.claim.collection).',
454
+ description: 'Array of items in this collection with optional weights.',
438
455
  items: {
439
456
  type: 'ref',
440
- ref: 'lex:com.atproto.repo.strongRef',
457
+ ref: 'lex:org.hypercerts.claim.collection#item',
441
458
  },
442
459
  },
443
460
  createdAt: {
@@ -448,6 +465,21 @@ const schemaDict = {
448
465
  },
449
466
  },
450
467
  },
468
+ item: {
469
+ type: 'object',
470
+ required: ['itemIdentifier'],
471
+ properties: {
472
+ itemIdentifier: {
473
+ type: 'ref',
474
+ ref: 'lex:com.atproto.repo.strongRef',
475
+ description: 'Strong reference to an item in this collection. Items can be activities (org.hypercerts.claim.activity) and/or other collections (org.hypercerts.claim.collection).',
476
+ },
477
+ itemWeight: {
478
+ type: 'string',
479
+ description: 'Optional weight for this item (positive numeric value stored as string). Weights do not need to sum to a specific total; normalization can be performed by the consuming application as needed.',
480
+ },
481
+ },
482
+ },
451
483
  },
452
484
  },
453
485
  OrgHypercertsClaimContributionDetails: {
@@ -1263,16 +1295,32 @@ var defs$b = {
1263
1295
  },
1264
1296
  shortDescription: {
1265
1297
  type: "string",
1266
- description: "Short blurb of the impact work done.",
1298
+ description: "Short summary of this activity claim, suitable for previews and list views. Rich text annotations may be provided via `shortDescriptionFacets`.",
1267
1299
  maxLength: 3000,
1268
1300
  maxGraphemes: 300
1269
1301
  },
1302
+ shortDescriptionFacets: {
1303
+ type: "array",
1304
+ description: "Rich text annotations for `shortDescription` (mentions, URLs, hashtags, etc).",
1305
+ items: {
1306
+ type: "ref",
1307
+ ref: "app.bsky.richtext.facet"
1308
+ }
1309
+ },
1270
1310
  description: {
1271
1311
  type: "string",
1272
- description: "Optional longer description of the impact work done.",
1312
+ description: "Optional longer description of this activity claim, including context or interpretation. Rich text annotations may be provided via `descriptionFacets`.",
1273
1313
  maxLength: 30000,
1274
1314
  maxGraphemes: 3000
1275
1315
  },
1316
+ descriptionFacets: {
1317
+ type: "array",
1318
+ description: "Rich text annotations for `description` (mentions, URLs, hashtags, etc).",
1319
+ items: {
1320
+ type: "ref",
1321
+ ref: "app.bsky.richtext.facet"
1322
+ }
1323
+ },
1276
1324
  image: {
1277
1325
  type: "union",
1278
1326
  refs: [
@@ -1328,18 +1376,18 @@ var defs$b = {
1328
1376
  contributor: {
1329
1377
  type: "object",
1330
1378
  required: [
1331
- "contributorInformation"
1379
+ "contributorIdentity"
1332
1380
  ],
1333
1381
  properties: {
1334
- contributorInformation: {
1382
+ contributorIdentity: {
1335
1383
  type: "union",
1336
1384
  refs: [
1337
1385
  "#contributorIdentity",
1338
1386
  "com.atproto.repo.strongRef"
1339
1387
  ],
1340
- description: "Contributor information as a string (DID or identifier) or strong reference to for instance org.hypercerts.claim.contributorInformation#main."
1388
+ description: "Contributor identity as a string (DID or identifier) via org.hypercerts.claim.activity#contributorIdentity, or a strong reference to a contributor information record."
1341
1389
  },
1342
- weight: {
1390
+ contributionWeight: {
1343
1391
  type: "string",
1344
1392
  description: "The relative weight/importance of this contribution (stored as a string to avoid float precision issues). Must be a positive numeric value. Weights do not need to sum to a specific total; normalization can be performed by the consuming application as needed."
1345
1393
  },
@@ -1349,7 +1397,7 @@ var defs$b = {
1349
1397
  "#contributorRole",
1350
1398
  "com.atproto.repo.strongRef"
1351
1399
  ],
1352
- description: "Contribution details as a string or strong reference to org.hypercerts.claim.contributionDetails#main."
1400
+ description: "Contribution details as a string via org.hypercerts.claim.activity#contributorRole, or a strong reference to a contribution details record."
1353
1401
  }
1354
1402
  }
1355
1403
  },
@@ -1362,24 +1410,6 @@ var defs$b = {
1362
1410
  description: "Contribution details as a string.",
1363
1411
  maxLength: 10000,
1364
1412
  maxGraphemes: 1000
1365
- },
1366
- activityWeight: {
1367
- type: "object",
1368
- required: [
1369
- "activity",
1370
- "weight"
1371
- ],
1372
- properties: {
1373
- activity: {
1374
- type: "ref",
1375
- ref: "com.atproto.repo.strongRef",
1376
- description: "A strong reference to a hypercert activity record. This activity must conform to the lexicon org.hypercerts.claim.activity"
1377
- },
1378
- weight: {
1379
- type: "string",
1380
- description: "The relative weight/importance of this hypercert activity (stored as a string to avoid float precision issues). Weights can be any positive numeric values and do not need to sum to a specific total; normalization can be performed by the consuming application as needed."
1381
- }
1382
- }
1383
1413
  }
1384
1414
  };
1385
1415
  var ACTIVITY_LEXICON_JSON = {
@@ -1424,12 +1454,28 @@ var defs$a = {
1424
1454
  ref: "pub.leaflet.pages.linearDocument#main",
1425
1455
  description: "Rich-text description, represented as a Leaflet linear document."
1426
1456
  },
1457
+ avatar: {
1458
+ type: "union",
1459
+ refs: [
1460
+ "org.hypercerts.defs#uri",
1461
+ "org.hypercerts.defs#smallImage"
1462
+ ],
1463
+ description: "The collection's avatar/profile image as a URI or image blob."
1464
+ },
1465
+ banner: {
1466
+ type: "union",
1467
+ refs: [
1468
+ "org.hypercerts.defs#uri",
1469
+ "org.hypercerts.defs#largeImage"
1470
+ ],
1471
+ description: "Larger horizontal image to display behind the collection view."
1472
+ },
1427
1473
  items: {
1428
1474
  type: "array",
1429
- description: "Array of strong references to items in this collection. Items can be activities (org.hypercerts.claim.activity) and/or other collections (org.hypercerts.claim.collection).",
1475
+ description: "Array of items in this collection with optional weights.",
1430
1476
  items: {
1431
1477
  type: "ref",
1432
- ref: "com.atproto.repo.strongRef"
1478
+ ref: "#item"
1433
1479
  }
1434
1480
  },
1435
1481
  createdAt: {
@@ -1439,6 +1485,23 @@ var defs$a = {
1439
1485
  }
1440
1486
  }
1441
1487
  }
1488
+ },
1489
+ item: {
1490
+ type: "object",
1491
+ required: [
1492
+ "itemIdentifier"
1493
+ ],
1494
+ properties: {
1495
+ itemIdentifier: {
1496
+ type: "ref",
1497
+ ref: "com.atproto.repo.strongRef",
1498
+ description: "Strong reference to an item in this collection. Items can be activities (org.hypercerts.claim.activity) and/or other collections (org.hypercerts.claim.collection)."
1499
+ },
1500
+ itemWeight: {
1501
+ type: "string",
1502
+ description: "Optional weight for this item (positive numeric value stored as string). Weights do not need to sum to a specific total; normalization can be performed by the consuming application as needed."
1503
+ }
1504
+ }
1442
1505
  }
1443
1506
  };
1444
1507
  var COLLECTION_LEXICON_JSON = {
@@ -2129,21 +2192,12 @@ function isContributor(v) {
2129
2192
  function validateContributor(v) {
2130
2193
  return validate$9(v, id$9, hashContributor);
2131
2194
  }
2132
- const hashActivityWeight = 'activityWeight';
2133
- function isActivityWeight(v) {
2134
- return is$typed$9(v, id$9, hashActivityWeight);
2135
- }
2136
- function validateActivityWeight(v) {
2137
- return validate$9(v, id$9, hashActivityWeight);
2138
- }
2139
2195
 
2140
2196
  var activity = /*#__PURE__*/Object.freeze({
2141
2197
  __proto__: null,
2142
- isActivityWeight: isActivityWeight,
2143
2198
  isContributor: isContributor,
2144
2199
  isMain: isMain$8,
2145
2200
  isRecord: isMain$8,
2146
- validateActivityWeight: validateActivityWeight,
2147
2201
  validateContributor: validateContributor,
2148
2202
  validateMain: validateMain$8,
2149
2203
  validateRecord: validateMain$8
@@ -2158,11 +2212,20 @@ function isMain$7(v) {
2158
2212
  function validateMain$7(v) {
2159
2213
  return validate$8(v, id$8, hashMain$7, true);
2160
2214
  }
2215
+ const hashItem = 'item';
2216
+ function isItem(v) {
2217
+ return is$typed$8(v, id$8, hashItem);
2218
+ }
2219
+ function validateItem(v) {
2220
+ return validate$8(v, id$8, hashItem);
2221
+ }
2161
2222
 
2162
2223
  var collection = /*#__PURE__*/Object.freeze({
2163
2224
  __proto__: null,
2225
+ isItem: isItem,
2164
2226
  isMain: isMain$7,
2165
2227
  isRecord: isMain$7,
2228
+ validateItem: validateItem,
2166
2229
  validateMain: validateMain$7,
2167
2230
  validateRecord: validateMain$7
2168
2231
  });
@@ -2360,7 +2423,7 @@ var receipt = /*#__PURE__*/Object.freeze({
2360
2423
  * ⚠️ DO NOT EDIT THIS FILE MANUALLY ⚠️
2361
2424
  *
2362
2425
  * This file is automatically generated by scripts/generate-exports.js
2363
- * Generated: 2026-01-21T07:15:37.790Z
2426
+ * Generated: 2026-01-21T23:12:40.384Z
2364
2427
  *
2365
2428
  * To regenerate this file, run:
2366
2429
  * npm run gen-api