@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.mjs CHANGED
@@ -282,16 +282,32 @@ const schemaDict = {
282
282
  },
283
283
  shortDescription: {
284
284
  type: 'string',
285
- description: 'Short blurb of the impact work done.',
285
+ description: 'Short summary of this activity claim, suitable for previews and list views. Rich text annotations may be provided via `shortDescriptionFacets`.',
286
286
  maxLength: 3000,
287
287
  maxGraphemes: 300,
288
288
  },
289
+ shortDescriptionFacets: {
290
+ type: 'array',
291
+ description: 'Rich text annotations for `shortDescription` (mentions, URLs, hashtags, etc).',
292
+ items: {
293
+ type: 'ref',
294
+ ref: 'lex:app.bsky.richtext.facet',
295
+ },
296
+ },
289
297
  description: {
290
298
  type: 'string',
291
- description: 'Optional longer description of the impact work done.',
299
+ description: 'Optional longer description of this activity claim, including context or interpretation. Rich text annotations may be provided via `descriptionFacets`.',
292
300
  maxLength: 30000,
293
301
  maxGraphemes: 3000,
294
302
  },
303
+ descriptionFacets: {
304
+ type: 'array',
305
+ description: 'Rich text annotations for `description` (mentions, URLs, hashtags, etc).',
306
+ items: {
307
+ type: 'ref',
308
+ ref: 'lex:app.bsky.richtext.facet',
309
+ },
310
+ },
295
311
  image: {
296
312
  type: 'union',
297
313
  refs: [
@@ -346,17 +362,17 @@ const schemaDict = {
346
362
  },
347
363
  contributor: {
348
364
  type: 'object',
349
- required: ['contributorInformation'],
365
+ required: ['contributorIdentity'],
350
366
  properties: {
351
- contributorInformation: {
367
+ contributorIdentity: {
352
368
  type: 'union',
353
369
  refs: [
354
370
  'lex:org.hypercerts.claim.activity#contributorIdentity',
355
371
  'lex:com.atproto.repo.strongRef',
356
372
  ],
357
- description: 'Contributor information as a string (DID or identifier) or strong reference to for instance org.hypercerts.claim.contributorInformation#main.',
373
+ description: 'Contributor identity as a string (DID or identifier) via org.hypercerts.claim.activity#contributorIdentity, or a strong reference to a contributor information record.',
358
374
  },
359
- weight: {
375
+ contributionWeight: {
360
376
  type: 'string',
361
377
  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.',
362
378
  },
@@ -366,7 +382,7 @@ const schemaDict = {
366
382
  'lex:org.hypercerts.claim.activity#contributorRole',
367
383
  'lex:com.atproto.repo.strongRef',
368
384
  ],
369
- description: 'Contribution details as a string or strong reference to org.hypercerts.claim.contributionDetails#main.',
385
+ description: 'Contribution details as a string via org.hypercerts.claim.activity#contributorRole, or a strong reference to a contribution details record.',
370
386
  },
371
387
  },
372
388
  },
@@ -380,21 +396,6 @@ const schemaDict = {
380
396
  maxLength: 10000,
381
397
  maxGraphemes: 1000,
382
398
  },
383
- activityWeight: {
384
- type: 'object',
385
- required: ['activity', 'weight'],
386
- properties: {
387
- activity: {
388
- type: 'ref',
389
- ref: 'lex:com.atproto.repo.strongRef',
390
- description: 'A strong reference to a hypercert activity record. This activity must conform to the lexicon org.hypercerts.claim.activity',
391
- },
392
- weight: {
393
- type: 'string',
394
- 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.',
395
- },
396
- },
397
- },
398
399
  },
399
400
  },
400
401
  OrgHypercertsClaimCollection: {
@@ -430,12 +431,28 @@ const schemaDict = {
430
431
  ref: 'lex:pub.leaflet.pages.linearDocument#main',
431
432
  description: 'Rich-text description, represented as a Leaflet linear document.',
432
433
  },
434
+ avatar: {
435
+ type: 'union',
436
+ refs: [
437
+ 'lex:org.hypercerts.defs#uri',
438
+ 'lex:org.hypercerts.defs#smallImage',
439
+ ],
440
+ description: "The collection's avatar/profile image as a URI or image blob.",
441
+ },
442
+ banner: {
443
+ type: 'union',
444
+ refs: [
445
+ 'lex:org.hypercerts.defs#uri',
446
+ 'lex:org.hypercerts.defs#largeImage',
447
+ ],
448
+ description: 'Larger horizontal image to display behind the collection view.',
449
+ },
433
450
  items: {
434
451
  type: 'array',
435
- 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).',
452
+ description: 'Array of items in this collection with optional weights.',
436
453
  items: {
437
454
  type: 'ref',
438
- ref: 'lex:com.atproto.repo.strongRef',
455
+ ref: 'lex:org.hypercerts.claim.collection#item',
439
456
  },
440
457
  },
441
458
  createdAt: {
@@ -446,6 +463,21 @@ const schemaDict = {
446
463
  },
447
464
  },
448
465
  },
466
+ item: {
467
+ type: 'object',
468
+ required: ['itemIdentifier'],
469
+ properties: {
470
+ itemIdentifier: {
471
+ type: 'ref',
472
+ ref: 'lex:com.atproto.repo.strongRef',
473
+ 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).',
474
+ },
475
+ itemWeight: {
476
+ type: 'string',
477
+ 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.',
478
+ },
479
+ },
480
+ },
449
481
  },
450
482
  },
451
483
  OrgHypercertsClaimContributionDetails: {
@@ -1261,16 +1293,32 @@ var defs$b = {
1261
1293
  },
1262
1294
  shortDescription: {
1263
1295
  type: "string",
1264
- description: "Short blurb of the impact work done.",
1296
+ description: "Short summary of this activity claim, suitable for previews and list views. Rich text annotations may be provided via `shortDescriptionFacets`.",
1265
1297
  maxLength: 3000,
1266
1298
  maxGraphemes: 300
1267
1299
  },
1300
+ shortDescriptionFacets: {
1301
+ type: "array",
1302
+ description: "Rich text annotations for `shortDescription` (mentions, URLs, hashtags, etc).",
1303
+ items: {
1304
+ type: "ref",
1305
+ ref: "app.bsky.richtext.facet"
1306
+ }
1307
+ },
1268
1308
  description: {
1269
1309
  type: "string",
1270
- description: "Optional longer description of the impact work done.",
1310
+ description: "Optional longer description of this activity claim, including context or interpretation. Rich text annotations may be provided via `descriptionFacets`.",
1271
1311
  maxLength: 30000,
1272
1312
  maxGraphemes: 3000
1273
1313
  },
1314
+ descriptionFacets: {
1315
+ type: "array",
1316
+ description: "Rich text annotations for `description` (mentions, URLs, hashtags, etc).",
1317
+ items: {
1318
+ type: "ref",
1319
+ ref: "app.bsky.richtext.facet"
1320
+ }
1321
+ },
1274
1322
  image: {
1275
1323
  type: "union",
1276
1324
  refs: [
@@ -1326,18 +1374,18 @@ var defs$b = {
1326
1374
  contributor: {
1327
1375
  type: "object",
1328
1376
  required: [
1329
- "contributorInformation"
1377
+ "contributorIdentity"
1330
1378
  ],
1331
1379
  properties: {
1332
- contributorInformation: {
1380
+ contributorIdentity: {
1333
1381
  type: "union",
1334
1382
  refs: [
1335
1383
  "#contributorIdentity",
1336
1384
  "com.atproto.repo.strongRef"
1337
1385
  ],
1338
- description: "Contributor information as a string (DID or identifier) or strong reference to for instance org.hypercerts.claim.contributorInformation#main."
1386
+ description: "Contributor identity as a string (DID or identifier) via org.hypercerts.claim.activity#contributorIdentity, or a strong reference to a contributor information record."
1339
1387
  },
1340
- weight: {
1388
+ contributionWeight: {
1341
1389
  type: "string",
1342
1390
  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."
1343
1391
  },
@@ -1347,7 +1395,7 @@ var defs$b = {
1347
1395
  "#contributorRole",
1348
1396
  "com.atproto.repo.strongRef"
1349
1397
  ],
1350
- description: "Contribution details as a string or strong reference to org.hypercerts.claim.contributionDetails#main."
1398
+ description: "Contribution details as a string via org.hypercerts.claim.activity#contributorRole, or a strong reference to a contribution details record."
1351
1399
  }
1352
1400
  }
1353
1401
  },
@@ -1360,24 +1408,6 @@ var defs$b = {
1360
1408
  description: "Contribution details as a string.",
1361
1409
  maxLength: 10000,
1362
1410
  maxGraphemes: 1000
1363
- },
1364
- activityWeight: {
1365
- type: "object",
1366
- required: [
1367
- "activity",
1368
- "weight"
1369
- ],
1370
- properties: {
1371
- activity: {
1372
- type: "ref",
1373
- ref: "com.atproto.repo.strongRef",
1374
- description: "A strong reference to a hypercert activity record. This activity must conform to the lexicon org.hypercerts.claim.activity"
1375
- },
1376
- weight: {
1377
- type: "string",
1378
- 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."
1379
- }
1380
- }
1381
1411
  }
1382
1412
  };
1383
1413
  var ACTIVITY_LEXICON_JSON = {
@@ -1422,12 +1452,28 @@ var defs$a = {
1422
1452
  ref: "pub.leaflet.pages.linearDocument#main",
1423
1453
  description: "Rich-text description, represented as a Leaflet linear document."
1424
1454
  },
1455
+ avatar: {
1456
+ type: "union",
1457
+ refs: [
1458
+ "org.hypercerts.defs#uri",
1459
+ "org.hypercerts.defs#smallImage"
1460
+ ],
1461
+ description: "The collection's avatar/profile image as a URI or image blob."
1462
+ },
1463
+ banner: {
1464
+ type: "union",
1465
+ refs: [
1466
+ "org.hypercerts.defs#uri",
1467
+ "org.hypercerts.defs#largeImage"
1468
+ ],
1469
+ description: "Larger horizontal image to display behind the collection view."
1470
+ },
1425
1471
  items: {
1426
1472
  type: "array",
1427
- 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).",
1473
+ description: "Array of items in this collection with optional weights.",
1428
1474
  items: {
1429
1475
  type: "ref",
1430
- ref: "com.atproto.repo.strongRef"
1476
+ ref: "#item"
1431
1477
  }
1432
1478
  },
1433
1479
  createdAt: {
@@ -1437,6 +1483,23 @@ var defs$a = {
1437
1483
  }
1438
1484
  }
1439
1485
  }
1486
+ },
1487
+ item: {
1488
+ type: "object",
1489
+ required: [
1490
+ "itemIdentifier"
1491
+ ],
1492
+ properties: {
1493
+ itemIdentifier: {
1494
+ type: "ref",
1495
+ ref: "com.atproto.repo.strongRef",
1496
+ 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)."
1497
+ },
1498
+ itemWeight: {
1499
+ type: "string",
1500
+ 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."
1501
+ }
1502
+ }
1440
1503
  }
1441
1504
  };
1442
1505
  var COLLECTION_LEXICON_JSON = {
@@ -2127,21 +2190,12 @@ function isContributor(v) {
2127
2190
  function validateContributor(v) {
2128
2191
  return validate$9(v, id$9, hashContributor);
2129
2192
  }
2130
- const hashActivityWeight = 'activityWeight';
2131
- function isActivityWeight(v) {
2132
- return is$typed$9(v, id$9, hashActivityWeight);
2133
- }
2134
- function validateActivityWeight(v) {
2135
- return validate$9(v, id$9, hashActivityWeight);
2136
- }
2137
2193
 
2138
2194
  var activity = /*#__PURE__*/Object.freeze({
2139
2195
  __proto__: null,
2140
- isActivityWeight: isActivityWeight,
2141
2196
  isContributor: isContributor,
2142
2197
  isMain: isMain$8,
2143
2198
  isRecord: isMain$8,
2144
- validateActivityWeight: validateActivityWeight,
2145
2199
  validateContributor: validateContributor,
2146
2200
  validateMain: validateMain$8,
2147
2201
  validateRecord: validateMain$8
@@ -2156,11 +2210,20 @@ function isMain$7(v) {
2156
2210
  function validateMain$7(v) {
2157
2211
  return validate$8(v, id$8, hashMain$7, true);
2158
2212
  }
2213
+ const hashItem = 'item';
2214
+ function isItem(v) {
2215
+ return is$typed$8(v, id$8, hashItem);
2216
+ }
2217
+ function validateItem(v) {
2218
+ return validate$8(v, id$8, hashItem);
2219
+ }
2159
2220
 
2160
2221
  var collection = /*#__PURE__*/Object.freeze({
2161
2222
  __proto__: null,
2223
+ isItem: isItem,
2162
2224
  isMain: isMain$7,
2163
2225
  isRecord: isMain$7,
2226
+ validateItem: validateItem,
2164
2227
  validateMain: validateMain$7,
2165
2228
  validateRecord: validateMain$7
2166
2229
  });
@@ -2358,7 +2421,7 @@ var receipt = /*#__PURE__*/Object.freeze({
2358
2421
  * ⚠️ DO NOT EDIT THIS FILE MANUALLY ⚠️
2359
2422
  *
2360
2423
  * This file is automatically generated by scripts/generate-exports.js
2361
- * Generated: 2026-01-21T07:15:37.790Z
2424
+ * Generated: 2026-01-21T23:12:40.384Z
2362
2425
  *
2363
2426
  * To regenerate this file, run:
2364
2427
  * npm run gen-api