@hypercerts-org/lexicon 0.13.0 → 1.0.0
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.
- package/CHANGELOG.md +30 -0
- package/SCHEMAS.md +95 -95
- package/dist/exports.d.ts +1 -1
- package/dist/generated/exports.d.ts +1 -1
- package/dist/generated/lexicons.d.ts +4 -4
- package/dist/index.cjs +5 -5
- package/dist/index.cjs.map +1 -1
- package/dist/index.mjs +5 -5
- package/dist/index.mjs.map +1 -1
- package/dist/lexicons.cjs +2 -2
- package/dist/lexicons.cjs.map +1 -1
- package/dist/lexicons.d.ts +4 -4
- package/dist/lexicons.mjs +2 -2
- package/dist/lexicons.mjs.map +1 -1
- package/lexicons/org/hypercerts/claim/activity.json +2 -2
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,35 @@
|
|
|
1
1
|
# @hypercerts-org/lexicon
|
|
2
2
|
|
|
3
|
+
## 1.0.0
|
|
4
|
+
|
|
5
|
+
### Major Changes
|
|
6
|
+
|
|
7
|
+
- [#220](https://github.com/hypercerts-org/hypercerts-lexicon/pull/220) [`dd78ed4`](https://github.com/hypercerts-org/hypercerts-lexicon/commit/dd78ed41406b460cea6c407f789a5eb3ae8bd2f8) Thanks [@s-adamantine](https://github.com/s-adamantine)! - Promote `@hypercerts-org/lexicon` to v1.0.0 — first stable release.
|
|
8
|
+
|
|
9
|
+
This changeset contributes no schema or type changes of its own; it
|
|
10
|
+
exists solely to force a major version bump so the package crosses the
|
|
11
|
+
0.x → 1.0 line. From v1.0.0 onward, the lexicons, TypeScript types,
|
|
12
|
+
and generated exports are considered stable for downstream consumers,
|
|
13
|
+
and the package follows standard SemVer semantics: breaking changes
|
|
14
|
+
bump the major version, non-breaking additions the minor version, and
|
|
15
|
+
fixes the patch version. (Prior to v1.0.0, breaking changes were
|
|
16
|
+
allowed under `minor` per the SemVer 0.x convention — see
|
|
17
|
+
`.claude/skills/writing-changesets/SKILL.md`.)
|
|
18
|
+
|
|
19
|
+
Any other changesets pending at the time this one is consumed are
|
|
20
|
+
folded into the same v1.0.0 release; see the other entries below for
|
|
21
|
+
those contributions.
|
|
22
|
+
|
|
23
|
+
### Minor Changes
|
|
24
|
+
|
|
25
|
+
- [#212](https://github.com/hypercerts-org/hypercerts-lexicon/pull/212) [`871608f`](https://github.com/hypercerts-org/hypercerts-lexicon/commit/871608f50fc4a16d4290e56f02035574d71be8ed) Thanks [@Kzoeps](https://github.com/Kzoeps)! - Increase the free-form activity work scope string limit from 100 to 1,000 graphemes, with a 10,000-byte cap.
|
|
26
|
+
|
|
27
|
+
The previous 100-grapheme limit was too tight for simple work scope descriptions: if the relevant terms are around 10–15 characters each, the field only fits roughly 5–6 words. Gainforest hit this limit while implementing the work scope string field and had to move to the CEL-based work scope form earlier than intended.
|
|
28
|
+
|
|
29
|
+
Most invalid work scope records were caused by the newer typed shape requiring `$type`; the length cap only affects two known accounts at the time, so raising it fixes those without changing currently valid claims.
|
|
30
|
+
|
|
31
|
+
The string form is the simplest option for producers that do not need CEL's structured, machine-evaluable semantics. Raising the grapheme and byte limits keeps that simple path viable for concise natural-language scopes while CEL remains available for more complex tagging and query logic.
|
|
32
|
+
|
|
3
33
|
## 0.13.0
|
|
4
34
|
|
|
5
35
|
### Minor Changes
|
package/SCHEMAS.md
CHANGED
|
@@ -36,35 +36,35 @@ Hypercerts-specific lexicons for tracking impact work and claims.
|
|
|
36
36
|
|
|
37
37
|
A contributor to the activity, with identity, weight, and contribution details.
|
|
38
38
|
|
|
39
|
-
| Property | Type | Required | Description |
|
|
40
|
-
| --------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
41
|
-
| `contributorIdentity` | `union` | ✅ | Inline contributor identity object with an identity string (DID or identifier) via org.hypercerts.claim.activity#contributorIdentity, or a strong reference to a contributor information record. The record referenced must conform with the lexicon org.hypercerts.claim.contributorInformation. |
|
|
42
|
-
| `contributionWeight` | `string` | ❌ | 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. |
|
|
43
|
-
| `contributionDetails` | `union` | ❌ | Inline contribution role object with a role string via org.hypercerts.claim.activity#contributorRole, or a strong reference to a contribution details record. The record referenced must conform with the lexicon org.hypercerts.claim.contribution. |
|
|
39
|
+
| Property | Type | Required | Description | Comments |
|
|
40
|
+
| --------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
|
|
41
|
+
| `contributorIdentity` | `union` | ✅ | Inline contributor identity object with an identity string (DID or identifier) via org.hypercerts.claim.activity#contributorIdentity, or a strong reference to a contributor information record. The record referenced must conform with the lexicon org.hypercerts.claim.contributorInformation. | |
|
|
42
|
+
| `contributionWeight` | `string` | ❌ | 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. | maxLength: 100 |
|
|
43
|
+
| `contributionDetails` | `union` | ❌ | Inline contribution role object with a role string via org.hypercerts.claim.activity#contributorRole, or a strong reference to a contribution details record. The record referenced must conform with the lexicon org.hypercerts.claim.contribution. | |
|
|
44
44
|
|
|
45
45
|
##### `org.hypercerts.claim.activity#contributorIdentity`
|
|
46
46
|
|
|
47
47
|
Contributor information as a string (DID or identifier).
|
|
48
48
|
|
|
49
|
-
| Property | Type | Required | Description |
|
|
50
|
-
| ---------- | -------- | -------- | ---------------------------------------------------- |
|
|
51
|
-
| `identity` | `string` | ✅ | The contributor identity string (DID or identifier). |
|
|
49
|
+
| Property | Type | Required | Description | Comments |
|
|
50
|
+
| ---------- | -------- | -------- | ---------------------------------------------------- | ---------------------------------- |
|
|
51
|
+
| `identity` | `string` | ✅ | The contributor identity string (DID or identifier). | maxLength: 1000, maxGraphemes: 100 |
|
|
52
52
|
|
|
53
53
|
##### `org.hypercerts.claim.activity#contributorRole`
|
|
54
54
|
|
|
55
55
|
Contribution details as a string.
|
|
56
56
|
|
|
57
|
-
| Property | Type | Required | Description |
|
|
58
|
-
| -------- | -------- | -------- | --------------------------------- |
|
|
59
|
-
| `role` | `string` | ✅ | The contribution role or details. |
|
|
57
|
+
| Property | Type | Required | Description | Comments |
|
|
58
|
+
| -------- | -------- | -------- | --------------------------------- | ---------------------------------- |
|
|
59
|
+
| `role` | `string` | ✅ | The contribution role or details. | maxLength: 1000, maxGraphemes: 100 |
|
|
60
60
|
|
|
61
61
|
##### `org.hypercerts.claim.activity#workScopeString`
|
|
62
62
|
|
|
63
63
|
A free-form string describing the work scope for simple or legacy scopes.
|
|
64
64
|
|
|
65
|
-
| Property | Type | Required | Description |
|
|
66
|
-
| -------- | -------- | -------- | ---------------------------------- |
|
|
67
|
-
| `scope` | `string` | ✅ | The work scope description string. |
|
|
65
|
+
| Property | Type | Required | Description | Comments |
|
|
66
|
+
| -------- | -------- | -------- | ---------------------------------- | ------------------------------------ |
|
|
67
|
+
| `scope` | `string` | ✅ | The work scope description string. | maxLength: 10000, maxGraphemes: 1000 |
|
|
68
68
|
|
|
69
69
|
---
|
|
70
70
|
|
|
@@ -148,10 +148,10 @@ A free-form string describing the work scope for simple or legacy scopes.
|
|
|
148
148
|
|
|
149
149
|
An item in a collection, with an identifier and optional weight.
|
|
150
150
|
|
|
151
|
-
| Property | Type | Required | Description |
|
|
152
|
-
| ---------------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
153
|
-
| `itemIdentifier` | `ref` | ✅ | Strong reference to an item in this collection. Items can be activities (org.hypercerts.claim.activity) and/or other collections (org.hypercerts.collection). |
|
|
154
|
-
| `itemWeight` | `string` | ❌ | 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. |
|
|
151
|
+
| Property | Type | Required | Description | Comments |
|
|
152
|
+
| ---------------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
|
|
153
|
+
| `itemIdentifier` | `ref` | ✅ | Strong reference to an item in this collection. Items can be activities (org.hypercerts.claim.activity) and/or other collections (org.hypercerts.collection). | |
|
|
154
|
+
| `itemWeight` | `string` | ❌ | 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. | maxLength: 100 |
|
|
155
155
|
|
|
156
156
|
---
|
|
157
157
|
|
|
@@ -220,11 +220,11 @@ An item in a collection, with an identifier and optional weight.
|
|
|
220
220
|
|
|
221
221
|
Overall score for an evaluation on a numeric scale.
|
|
222
222
|
|
|
223
|
-
| Property | Type | Required | Description |
|
|
224
|
-
| -------- | -------- | -------- | ----------------------------------------------------------------------------- |
|
|
225
|
-
| `min` | `string` | ✅ | Minimum value of the scale as a numeric string (e.g. '0', '1'). |
|
|
226
|
-
| `max` | `string` | ✅ | Maximum value of the scale as a numeric string (e.g. '5', '10'). |
|
|
227
|
-
| `value` | `string` | ✅ | Score within the inclusive range [min, max] as a numeric string (e.g. '3.7'). |
|
|
223
|
+
| Property | Type | Required | Description | Comments |
|
|
224
|
+
| -------- | -------- | -------- | ----------------------------------------------------------------------------- | ------------- |
|
|
225
|
+
| `min` | `string` | ✅ | Minimum value of the scale as a numeric string (e.g. '0', '1'). | maxLength: 50 |
|
|
226
|
+
| `max` | `string` | ✅ | Maximum value of the scale as a numeric string (e.g. '5', '10'). | maxLength: 50 |
|
|
227
|
+
| `value` | `string` | ✅ | Score within the inclusive range [min, max] as a numeric string (e.g. '3.7'). | maxLength: 50 |
|
|
228
228
|
|
|
229
229
|
---
|
|
230
230
|
|
|
@@ -283,9 +283,9 @@ Overall score for an evaluation on a numeric scale.
|
|
|
283
283
|
|
|
284
284
|
A free-text string value (e.g. a display name, wallet address, or other identifier).
|
|
285
285
|
|
|
286
|
-
| Property | Type | Required | Description |
|
|
287
|
-
| -------- | -------- | -------- | ----------------- |
|
|
288
|
-
| `value` | `string` | ✅ | The string value. |
|
|
286
|
+
| Property | Type | Required | Description | Comments |
|
|
287
|
+
| -------- | -------- | -------- | ----------------- | --------------- |
|
|
288
|
+
| `value` | `string` | ✅ | The string value. | maxLength: 2048 |
|
|
289
289
|
|
|
290
290
|
---
|
|
291
291
|
|
|
@@ -356,9 +356,9 @@ Certified lexicons are common/shared lexicons that can be used across multiple p
|
|
|
356
356
|
|
|
357
357
|
A location represented as a string, e.g. coordinates or a small GeoJSON string.
|
|
358
358
|
|
|
359
|
-
| Property | Type | Required | Description |
|
|
360
|
-
| -------- | -------- | -------- | ------------------------- |
|
|
361
|
-
| `string` | `string` | ✅ | The location string value |
|
|
359
|
+
| Property | Type | Required | Description | Comments |
|
|
360
|
+
| -------- | -------- | -------- | ------------------------- | ------------------------------------ |
|
|
361
|
+
| `string` | `string` | ✅ | The location string value | maxLength: 10000, maxGraphemes: 1000 |
|
|
362
362
|
|
|
363
363
|
---
|
|
364
364
|
|
|
@@ -440,10 +440,10 @@ A location represented as a string, e.g. coordinates or a small GeoJSON string.
|
|
|
440
440
|
|
|
441
441
|
A labeled URL reference.
|
|
442
442
|
|
|
443
|
-
| Property | Type | Required | Description |
|
|
444
|
-
| -------- | -------- | -------- | ---------------------------------------------------------------------------------- |
|
|
445
|
-
| `url` | `string` | ✅ | The URL. |
|
|
446
|
-
| `label` | `string` | ❌ | Optional human-readable label for this URL (e.g. 'Support page', 'Donation page'). |
|
|
443
|
+
| Property | Type | Required | Description | Comments |
|
|
444
|
+
| -------- | -------- | -------- | ---------------------------------------------------------------------------------- | ------------------------------------ |
|
|
445
|
+
| `url` | `string` | ✅ | The URL. | maxLength: 10000, maxGraphemes: 2048 |
|
|
446
|
+
| `label` | `string` | ❌ | Optional human-readable label for this URL (e.g. 'Support page', 'Donation page'). | maxLength: 640, maxGraphemes: 64 |
|
|
447
447
|
|
|
448
448
|
---
|
|
449
449
|
|
|
@@ -503,22 +503,22 @@ A labeled URL reference.
|
|
|
503
503
|
|
|
504
504
|
EOA wallet ownership proof via EIP-712 typed data signature. Contains both the structured message that was signed and the resulting signature.
|
|
505
505
|
|
|
506
|
-
| Property | Type | Required | Description |
|
|
507
|
-
| ----------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
508
|
-
| `signature` | `string` | ✅ | ECDSA signature over the EIP-712 hash (hex-encoded with 0x prefix, 64 or 65 bytes). |
|
|
509
|
-
| `message` | `ref` | ✅ | The EIP-712 typed data message that was signed by the wallet. Contains the fields binding an ATProto DID to an EVM address on a specific chain. |
|
|
506
|
+
| Property | Type | Required | Description | Comments |
|
|
507
|
+
| ----------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
|
|
508
|
+
| `signature` | `string` | ✅ | ECDSA signature over the EIP-712 hash (hex-encoded with 0x prefix, 64 or 65 bytes). | maxLength: 132 |
|
|
509
|
+
| `message` | `ref` | ✅ | The EIP-712 typed data message that was signed by the wallet. Contains the fields binding an ATProto DID to an EVM address on a specific chain. | |
|
|
510
510
|
|
|
511
511
|
##### `app.certified.link.evm#eip712Message`
|
|
512
512
|
|
|
513
513
|
The EIP-712 typed data message that was signed by the wallet. Contains the fields binding an ATProto DID to an EVM address on a specific chain.
|
|
514
514
|
|
|
515
|
-
| Property | Type | Required | Description |
|
|
516
|
-
| ------------ | -------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
517
|
-
| `did` | `string` | ✅ | The ATProto DID being linked to the EVM address. |
|
|
518
|
-
| `evmAddress` | `string` | ✅ | The EVM wallet address (must match the top-level address field). |
|
|
519
|
-
| `chainId` | `string` | ✅ | EVM chain ID as string (bigint serialized). Identifies which chain was used for signing; for EOA wallets the identity link applies across all EVM-compatible chains. |
|
|
520
|
-
| `timestamp` | `string` | ✅ | Unix timestamp when the attestation was created (bigint serialized). |
|
|
521
|
-
| `nonce` | `string` | ✅ | Replay-protection nonce (bigint serialized). |
|
|
515
|
+
| Property | Type | Required | Description | Comments |
|
|
516
|
+
| ------------ | -------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
|
|
517
|
+
| `did` | `string` | ✅ | The ATProto DID being linked to the EVM address. | maxLength: 256 |
|
|
518
|
+
| `evmAddress` | `string` | ✅ | The EVM wallet address (must match the top-level address field). | maxLength: 42 |
|
|
519
|
+
| `chainId` | `string` | ✅ | EVM chain ID as string (bigint serialized). Identifies which chain was used for signing; for EOA wallets the identity link applies across all EVM-compatible chains. | maxLength: 78 |
|
|
520
|
+
| `timestamp` | `string` | ✅ | Unix timestamp when the attestation was created (bigint serialized). | maxLength: 78 |
|
|
521
|
+
| `nonce` | `string` | ✅ | Replay-protection nonce (bigint serialized). | maxLength: 78 |
|
|
522
522
|
|
|
523
523
|
---
|
|
524
524
|
|
|
@@ -536,9 +536,9 @@ Common type definitions used across all protocols.
|
|
|
536
536
|
|
|
537
537
|
A Decentralized Identifier (DID) string.
|
|
538
538
|
|
|
539
|
-
| Property | Type | Required | Description |
|
|
540
|
-
| -------- | -------- | -------- | --------------------- |
|
|
541
|
-
| `did` | `string` | ✅ | The DID string value. |
|
|
539
|
+
| Property | Type | Required | Description | Comments |
|
|
540
|
+
| -------- | -------- | -------- | --------------------- | -------------- |
|
|
541
|
+
| `did` | `string` | ✅ | The DID string value. | maxLength: 256 |
|
|
542
542
|
|
|
543
543
|
---
|
|
544
544
|
|
|
@@ -552,10 +552,10 @@ A Decentralized Identifier (DID) string.
|
|
|
552
552
|
|
|
553
553
|
An inline long-form description as plain text or markdown, with optional rich-text annotations.
|
|
554
554
|
|
|
555
|
-
| Property | Type | Required | Description |
|
|
556
|
-
| -------- | -------- | -------- | -------------------------------------------------------------------------- |
|
|
557
|
-
| `value` | `string` | ✅ | The description text (plain text or markdown). |
|
|
558
|
-
| `facets` | `ref[]` | ❌ | Rich text annotations for the description (mentions, URLs, hashtags, etc). |
|
|
555
|
+
| Property | Type | Required | Description | Comments |
|
|
556
|
+
| -------- | -------- | -------- | -------------------------------------------------------------------------- | -------------------------------------- |
|
|
557
|
+
| `value` | `string` | ✅ | The description text (plain text or markdown). | maxLength: 250000, maxGraphemes: 25000 |
|
|
558
|
+
| `facets` | `ref[]` | ❌ | Rich text annotations for the description (mentions, URLs, hashtags, etc). | |
|
|
559
559
|
|
|
560
560
|
##### `org.hypercerts.defs#uri`
|
|
561
561
|
|
|
@@ -569,41 +569,41 @@ Object containing a URI to external data
|
|
|
569
569
|
|
|
570
570
|
Object containing a blob to external data
|
|
571
571
|
|
|
572
|
-
| Property | Type | Required | Description |
|
|
573
|
-
| -------- | ------ | -------- | ---------------------------------- |
|
|
574
|
-
| `blob` | `blob` | ✅ | Blob to external data (up to 10MB) |
|
|
572
|
+
| Property | Type | Required | Description | Comments |
|
|
573
|
+
| -------- | ------ | -------- | ---------------------------------- | --------------------------------- |
|
|
574
|
+
| `blob` | `blob` | ✅ | Blob to external data (up to 10MB) | maxSize: 10485760, accepts: `*/*` |
|
|
575
575
|
|
|
576
576
|
##### `org.hypercerts.defs#largeBlob`
|
|
577
577
|
|
|
578
578
|
Object containing a blob to external data
|
|
579
579
|
|
|
580
|
-
| Property | Type | Required | Description |
|
|
581
|
-
| -------- | ------ | -------- | ----------------------------------- |
|
|
582
|
-
| `blob` | `blob` | ✅ | Blob to external data (up to 100MB) |
|
|
580
|
+
| Property | Type | Required | Description | Comments |
|
|
581
|
+
| -------- | ------ | -------- | ----------------------------------- | ---------------------------------- |
|
|
582
|
+
| `blob` | `blob` | ✅ | Blob to external data (up to 100MB) | maxSize: 104857600, accepts: `*/*` |
|
|
583
583
|
|
|
584
584
|
##### `org.hypercerts.defs#smallImage`
|
|
585
585
|
|
|
586
586
|
Object containing a small image
|
|
587
587
|
|
|
588
|
-
| Property | Type | Required | Description |
|
|
589
|
-
| -------- | ------ | -------- | ----------------- |
|
|
590
|
-
| `image` | `blob` | ✅ | Image (up to 5MB) |
|
|
588
|
+
| Property | Type | Required | Description | Comments |
|
|
589
|
+
| -------- | ------ | -------- | ----------------- | ------------------------------------------------------------------------------- |
|
|
590
|
+
| `image` | `blob` | ✅ | Image (up to 5MB) | maxSize: 5242880, accepts: `image/jpeg`, `image/jpg`, `image/png`, `image/webp` |
|
|
591
591
|
|
|
592
592
|
##### `org.hypercerts.defs#smallVideo`
|
|
593
593
|
|
|
594
594
|
Object containing a small video
|
|
595
595
|
|
|
596
|
-
| Property | Type | Required | Description |
|
|
597
|
-
| -------- | ------ | -------- | ------------------ |
|
|
598
|
-
| `video` | `blob` | ✅ | Video (up to 20MB) |
|
|
596
|
+
| Property | Type | Required | Description | Comments |
|
|
597
|
+
| -------- | ------ | -------- | ------------------ | ----------------------------------------------------- |
|
|
598
|
+
| `video` | `blob` | ✅ | Video (up to 20MB) | maxSize: 20971520, accepts: `video/mp4`, `video/webm` |
|
|
599
599
|
|
|
600
600
|
##### `org.hypercerts.defs#largeImage`
|
|
601
601
|
|
|
602
602
|
Object containing a large image
|
|
603
603
|
|
|
604
|
-
| Property | Type | Required | Description |
|
|
605
|
-
| -------- | ------ | -------- | ------------------ |
|
|
606
|
-
| `image` | `blob` | ✅ | Image (up to 10MB) |
|
|
604
|
+
| Property | Type | Required | Description | Comments |
|
|
605
|
+
| -------- | ------ | -------- | ------------------ | -------------------------------------------------------------------------------- |
|
|
606
|
+
| `image` | `blob` | ✅ | Image (up to 10MB) | maxSize: 10485760, accepts: `image/jpeg`, `image/jpg`, `image/png`, `image/webp` |
|
|
607
607
|
|
|
608
608
|
---
|
|
609
609
|
|
|
@@ -644,9 +644,9 @@ Facet feature for a URL. The text URL may have been simplified or truncated, but
|
|
|
644
644
|
|
|
645
645
|
Facet feature for a hashtag. The text usually includes a '#' prefix, but the facet reference should not (except in the case of 'double hash tags').
|
|
646
646
|
|
|
647
|
-
| Property | Type | Required | Description |
|
|
648
|
-
| -------- | -------- | -------- | ----------- |
|
|
649
|
-
| `tag` | `string` | ✅ | |
|
|
647
|
+
| Property | Type | Required | Description | Comments |
|
|
648
|
+
| -------- | -------- | -------- | ----------- | -------------------------------- |
|
|
649
|
+
| `tag` | `string` | ✅ | | maxLength: 640, maxGraphemes: 64 |
|
|
650
650
|
|
|
651
651
|
##### `app.bsky.richtext.facet#byteSlice`
|
|
652
652
|
|
|
@@ -691,33 +691,33 @@ Specifies the sub-string range a facet feature applies to. Start index is inclus
|
|
|
691
691
|
|
|
692
692
|
Visual configuration for a hyperboard's background, colors, and layout.
|
|
693
693
|
|
|
694
|
-
| Property | Type | Required | Description |
|
|
695
|
-
| --------------------- | --------- | -------- | --------------------------------------------------------------------- |
|
|
696
|
-
| `backgroundType` | `string` | ❌ | Type of background content. |
|
|
697
|
-
| `backgroundImage` | `union` | ❌ | Background image as a URI or image blob. |
|
|
698
|
-
| `backgroundIframeUrl` | `string` | ❌ | URI of the background iframe. |
|
|
699
|
-
| `backgroundGrayscale` | `boolean` | ❌ | Whether the background is rendered in grayscale. Default: true. |
|
|
700
|
-
| `backgroundOpacity` | `integer` | ❌ | Background opacity as a percentage (0–100). |
|
|
701
|
-
| `backgroundColor` | `string` | ❌ | Background color as a hex string (e.g. '#ffffff'). |
|
|
702
|
-
| `borderColor` | `string` | ❌ | Border color as a hex string (e.g. '#000000'). |
|
|
703
|
-
| `grayscaleImages` | `boolean` | ❌ | Whether contributor images are rendered in grayscale. Default: false. |
|
|
704
|
-
| `imageShape` | `string` | ❌ | Shape used to crop contributor images on this board. |
|
|
705
|
-
| `aspectRatio` | `string` | ❌ | Display aspect ratio of the board. |
|
|
694
|
+
| Property | Type | Required | Description | Comments |
|
|
695
|
+
| --------------------- | --------- | -------- | --------------------------------------------------------------------- | ------------------------------------------------- |
|
|
696
|
+
| `backgroundType` | `string` | ❌ | Type of background content. | maxLength: 10, Known values: `image`, `iframe` |
|
|
697
|
+
| `backgroundImage` | `union` | ❌ | Background image as a URI or image blob. | |
|
|
698
|
+
| `backgroundIframeUrl` | `string` | ❌ | URI of the background iframe. | maxLength: 2048 |
|
|
699
|
+
| `backgroundGrayscale` | `boolean` | ❌ | Whether the background is rendered in grayscale. Default: true. | |
|
|
700
|
+
| `backgroundOpacity` | `integer` | ❌ | Background opacity as a percentage (0–100). | |
|
|
701
|
+
| `backgroundColor` | `string` | ❌ | Background color as a hex string (e.g. '#ffffff'). | maxLength: 20 |
|
|
702
|
+
| `borderColor` | `string` | ❌ | Border color as a hex string (e.g. '#000000'). | maxLength: 20 |
|
|
703
|
+
| `grayscaleImages` | `boolean` | ❌ | Whether contributor images are rendered in grayscale. Default: false. | |
|
|
704
|
+
| `imageShape` | `string` | ❌ | Shape used to crop contributor images on this board. | maxLength: 20, Known values: `circular`, `square` |
|
|
705
|
+
| `aspectRatio` | `string` | ❌ | Display aspect ratio of the board. | maxLength: 10, Known values: `16:9`, `4:3`, `1:1` |
|
|
706
706
|
|
|
707
707
|
##### `org.hyperboards.board#contributorConfig`
|
|
708
708
|
|
|
709
709
|
Configuration for a specific contributor within a board. Values serve as fallbacks when the contributor has not defined them on their profile. It can also be used to override contributor settings on this board without changing their global profile.
|
|
710
710
|
|
|
711
|
-
| Property | Type | Required | Description |
|
|
712
|
-
| ---------------- | --------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
713
|
-
| `contributor` | `union` | ✅ | Identifies the contributor being styled. A strong reference to an org.hypercerts.claim.contributorInformation record, or a contributorIdentity (DID or identifier string) for contributors without a dedicated record. |
|
|
714
|
-
| `override` | `boolean` | ❌ | When true, these values take precedence over the contributor's own profile and display settings. When false or omitted, they are only used as fallbacks if the contributor has not set their own settings. |
|
|
715
|
-
| `displayName` | `string` | ❌ | Display name for this contributor on this board. |
|
|
716
|
-
| `image` | `union` | ❌ | Avatar or face image for this contributor on this board, as a URI or image blob. |
|
|
717
|
-
| `video` | `union` | ❌ | Video for this contributor, as a URI (embed/direct link) or uploaded video blob. |
|
|
718
|
-
| `hoverImage` | `union` | ❌ | Image overlay shown when hovering over this contributor, as a URI or image blob. |
|
|
719
|
-
| `hoverIframeUrl` | `string` | ❌ | Iframe overlay shown when hovering over this contributor. |
|
|
720
|
-
| `url` | `string` | ❌ | Click-through link URL for this contributor. |
|
|
711
|
+
| Property | Type | Required | Description | Comments |
|
|
712
|
+
| ---------------- | --------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |
|
|
713
|
+
| `contributor` | `union` | ✅ | Identifies the contributor being styled. A strong reference to an org.hypercerts.claim.contributorInformation record, or a contributorIdentity (DID or identifier string) for contributors without a dedicated record. | |
|
|
714
|
+
| `override` | `boolean` | ❌ | When true, these values take precedence over the contributor's own profile and display settings. When false or omitted, they are only used as fallbacks if the contributor has not set their own settings. | |
|
|
715
|
+
| `displayName` | `string` | ❌ | Display name for this contributor on this board. | maxLength: 640, maxGraphemes: 64 |
|
|
716
|
+
| `image` | `union` | ❌ | Avatar or face image for this contributor on this board, as a URI or image blob. | |
|
|
717
|
+
| `video` | `union` | ❌ | Video for this contributor, as a URI (embed/direct link) or uploaded video blob. | |
|
|
718
|
+
| `hoverImage` | `union` | ❌ | Image overlay shown when hovering over this contributor, as a URI or image blob. | |
|
|
719
|
+
| `hoverIframeUrl` | `string` | ❌ | Iframe overlay shown when hovering over this contributor. | maxLength: 2048 |
|
|
720
|
+
| `url` | `string` | ❌ | Click-through link URL for this contributor. | maxLength: 2048 |
|
|
721
721
|
|
|
722
722
|
---
|
|
723
723
|
|
|
@@ -948,10 +948,10 @@ Configuration for a specific contributor within a board. Values serve as fallbac
|
|
|
948
948
|
|
|
949
949
|
##### `pub.leaflet.pages.linearDocument#block`
|
|
950
950
|
|
|
951
|
-
| Property | Type | Required | Description |
|
|
952
|
-
| ----------- | -------- | -------- | ----------- |
|
|
953
|
-
| `block` | `union` | ✅ | |
|
|
954
|
-
| `alignment` | `string` | ❌ | |
|
|
951
|
+
| Property | Type | Required | Description | Comments |
|
|
952
|
+
| ----------- | -------- | -------- | ----------- | ------------------------------------------------------------------------------------------ |
|
|
953
|
+
| `block` | `union` | ✅ | | |
|
|
954
|
+
| `alignment` | `string` | ❌ | | Known values: `#textAlignLeft`, `#textAlignCenter`, `#textAlignRight`, `#textAlignJustify` |
|
|
955
955
|
|
|
956
956
|
##### `pub.leaflet.pages.linearDocument#quote`
|
|
957
957
|
|
package/dist/exports.d.ts
CHANGED
|
@@ -921,8 +921,8 @@ export declare const schemaDict: {
|
|
|
921
921
|
readonly scope: {
|
|
922
922
|
readonly type: "string";
|
|
923
923
|
readonly description: "The work scope description string.";
|
|
924
|
-
readonly maxLength:
|
|
925
|
-
readonly maxGraphemes:
|
|
924
|
+
readonly maxLength: 10000;
|
|
925
|
+
readonly maxGraphemes: 1000;
|
|
926
926
|
};
|
|
927
927
|
};
|
|
928
928
|
};
|
|
@@ -3269,8 +3269,8 @@ export declare const schemas: ({
|
|
|
3269
3269
|
readonly scope: {
|
|
3270
3270
|
readonly type: "string";
|
|
3271
3271
|
readonly description: "The work scope description string.";
|
|
3272
|
-
readonly maxLength:
|
|
3273
|
-
readonly maxGraphemes:
|
|
3272
|
+
readonly maxLength: 10000;
|
|
3273
|
+
readonly maxGraphemes: 1000;
|
|
3274
3274
|
};
|
|
3275
3275
|
};
|
|
3276
3276
|
};
|
package/dist/index.cjs
CHANGED
|
@@ -1045,8 +1045,8 @@ const schemaDict = {
|
|
|
1045
1045
|
scope: {
|
|
1046
1046
|
type: 'string',
|
|
1047
1047
|
description: 'The work scope description string.',
|
|
1048
|
-
maxLength:
|
|
1049
|
-
maxGraphemes:
|
|
1048
|
+
maxLength: 10000,
|
|
1049
|
+
maxGraphemes: 1000,
|
|
1050
1050
|
},
|
|
1051
1051
|
},
|
|
1052
1052
|
},
|
|
@@ -3785,8 +3785,8 @@ var defs$v = {
|
|
|
3785
3785
|
scope: {
|
|
3786
3786
|
type: "string",
|
|
3787
3787
|
description: "The work scope description string.",
|
|
3788
|
-
maxLength:
|
|
3789
|
-
maxGraphemes:
|
|
3788
|
+
maxLength: 10000,
|
|
3789
|
+
maxGraphemes: 1000
|
|
3790
3790
|
}
|
|
3791
3791
|
}
|
|
3792
3792
|
}
|
|
@@ -6731,7 +6731,7 @@ var facet = /*#__PURE__*/Object.freeze({
|
|
|
6731
6731
|
* ⚠️ DO NOT EDIT THIS FILE MANUALLY ⚠️
|
|
6732
6732
|
*
|
|
6733
6733
|
* This file is automatically generated by scripts/generate-exports.js
|
|
6734
|
-
* Generated: 2026-
|
|
6734
|
+
* Generated: 2026-06-17T10:19:35.326Z
|
|
6735
6735
|
*
|
|
6736
6736
|
* To regenerate this file, run:
|
|
6737
6737
|
* npm run gen-api
|