a collection of lightweight TypeScript packages for AT Protocol, the protocol powering Bluesky
atproto
bluesky
typescript
npm
chore: update package descriptions
+63
-28
+6
-6
README.md
+6
-6
README.md
···
36
36
| [`ozone`](./packages/definitions/ozone): adds `tools.ozone.*` lexicons |
37
37
| [`whitewind`](./packages/definitions/whitewind): adds `com.whtwnd.*` lexicons |
38
38
| **Utility packages** |
39
-
| [`tid`](./packages/utilities/tid): TID record key codec |
40
-
| [`car`](./packages/utilities/car): CAR/repository decoder |
41
-
| [`cid`](./packages/utilities/cid): CIDv1 codec |
42
-
| [`cbor`](./packages/utilities/cbor): DAG-CBOR codec |
43
-
| [`varint`](./packages/utilities/varint): Protobuf-style varint codec |
44
-
| [`multibase`](./packages/utilities/multibase): multibase utilities |
39
+
| [`car`](./packages/utilities/car): DASL CAR and atproto repository decoder |
40
+
| [`cbor`](./packages/utilities/cbor): DASL dCBOR42 codec |
41
+
| [`cid`](./packages/utilities/cid): DASL CID codec |
45
42
| [`crypto`](./packages/utilities/crypto): cryptographic utilities |
43
+
| [`multibase`](./packages/utilities/multibase): multibase utilities |
44
+
| [`tid`](./packages/utilities/tid): atproto timestamp identifier codec |
45
+
| [`varint`](./packages/utilities/varint): protobuf-style LEB128 varint codec |
46
46
| **Bluesky-specific packages** |
47
47
| [`bluesky-richtext-builder`](./packages/bluesky/richtext-builder): builder pattern for Bluesky's rich text facets |
48
48
| [`bluesky-richtext-parser`](./packages/bluesky/richtext-parser): parse Bluesky's (extended) rich text syntax |
+9
-6
packages/utilities/car/README.md
+9
-6
packages/utilities/car/README.md
···
1
1
# @atcute/car
2
2
3
-
CAR (content-addressable archvie) repository decoder
3
+
lightweight [DASL CAR (content-addressable archives)][dasl-car] and atproto repository decoder
4
+
library for AT Protocol.
5
+
6
+
[dasl-car]: https://dasl.ing/car.html
4
7
5
8
```ts
6
-
// convenient iterator for reading through an AT Protocol CAR repository
7
-
for (const { collection, rkey, record } of iterateAtpRepo(buf)) {
8
-
// ...
9
-
}
10
-
11
9
// read through a CAR archive
12
10
const { roots, iterate } = readCar(buf);
13
11
14
12
for (const { cid, bytes } of iterate()) {
13
+
// ...
14
+
}
15
+
16
+
// convenient iterator for reading through an AT Protocol CAR repository
17
+
for (const { collection, rkey, record } of iterateAtpRepo(buf)) {
15
18
// ...
16
19
}
17
20
```
+6
-1
packages/utilities/car/package.json
+6
-1
packages/utilities/car/package.json
···
2
2
"type": "module",
3
3
"name": "@atcute/car",
4
4
"version": "2.0.0",
5
-
"description": "read AT Protocol's CAR (content-addressable archive) repositories",
5
+
"description": "lightweight DASL CAR and atproto repository decoder for AT Protocol.",
6
+
"keywords": [
7
+
"atproto",
8
+
"dasl",
9
+
"car"
10
+
],
6
11
"license": "MIT",
7
12
"repository": {
8
13
"url": "https://github.com/mary-ext/atcute",
+3
-6
packages/utilities/cbor/README.md
+3
-6
packages/utilities/cbor/README.md
···
1
1
# @atcute/cbor
2
2
3
-
DAG-CBOR codec library, focused on dealing with AT Protocol's HTTP wire format.
3
+
lightweight [DASL dCBOR42 (deterministic CBOR with tag 42)][dasl-dcbor42] codec library for AT
4
+
Protocol.
4
5
5
-
- Only JSON types are recognized and almost nothing else, this means:
6
-
- No `Map` objects, it will always be plain objects with string keys
7
-
- No `undefined` values, it will be skipped or will throw an error
8
-
- No tagged value support other than CID, which gets converted to a cid-link interface
9
-
- Same goes for byte arrays, gets converted to a byte interface
6
+
[dasl-dcbor42]: https://dasl.ing/dcbor42.html
10
7
11
8
```ts
12
9
import { encode } from '@atcute/cbor';
+6
-1
packages/utilities/cbor/package.json
+6
-1
packages/utilities/cbor/package.json
···
2
2
"type": "module",
3
3
"name": "@atcute/cbor",
4
4
"version": "2.0.0",
5
-
"description": "DAG-CBOR codec that deals in AT Protocol's HTTP wire format",
5
+
"description": "lightweight DASL dCBOR42 codec library for AT Protocol",
6
+
"keywords": [
7
+
"atproto",
8
+
"dasl",
9
+
"cbor"
10
+
],
6
11
"license": "MIT",
7
12
"repository": {
8
13
"url": "https://github.com/mary-ext/atcute",
+3
-1
packages/utilities/cid/README.md
+3
-1
packages/utilities/cid/README.md
+6
-1
packages/utilities/cid/package.json
+6
-1
packages/utilities/cid/package.json
···
2
2
"type": "module",
3
3
"name": "@atcute/cid",
4
4
"version": "2.0.0",
5
-
"description": "create and parse AT Protocol-blessed CIDv1 format",
5
+
"description": "lightweight DASL CID codec library for AT Protocol",
6
+
"keywords": [
7
+
"atproto",
8
+
"dasl",
9
+
"cid"
10
+
],
6
11
"license": "MIT",
7
12
"repository": {
8
13
"url": "https://github.com/mary-ext/atcute",
+7
-1
packages/utilities/crypto/README.md
+7
-1
packages/utilities/crypto/README.md
···
1
1
# @atcute/crypto
2
2
3
-
cryptographic utilities
3
+
lightweight atproto cryptographic library, supporting its two "blessed" elliptic curve cryptography
4
+
systems:
5
+
6
+
- `p256` (`nistp256`): makes use of WebCrypto API.
7
+
- `secp256k1`: makes use of [`@noble/secp256k1`][noble-secp256k1].
8
+
9
+
[noble-secp256k1]: https://github.com/paulmillr/noble-secp256k1
4
10
5
11
```ts
6
12
import { Secp256k1PrivateKeyExportable, verifySigWithDidKey } from './index.js';
+9
-1
packages/utilities/crypto/package.json
+9
-1
packages/utilities/crypto/package.json
···
2
2
"type": "module",
3
3
"name": "@atcute/crypto",
4
4
"version": "2.0.0-alpha.1",
5
-
"description": "cryptographic utilities",
5
+
"description": "lightweight atproto cryptographic library",
6
+
"keywords": [
7
+
"atproto",
8
+
"cryptography",
9
+
"p256",
10
+
"nistp256",
11
+
"k256",
12
+
"secp256k1"
13
+
],
6
14
"license": "MIT",
7
15
"repository": {
8
16
"url": "https://github.com/mary-ext/atcute",
+1
-1
packages/utilities/tid/README.md
+1
-1
packages/utilities/tid/README.md
+5
-1
packages/utilities/tid/package.json
+5
-1
packages/utilities/tid/package.json
···
2
2
"type": "module",
3
3
"name": "@atcute/tid",
4
4
"version": "1.0.1",
5
-
"description": "create and parse TID identifiers",
5
+
"description": "atproto timestamp identifier identifier codec library",
6
+
"keywords": [
7
+
"atproto",
8
+
"codec"
9
+
],
6
10
"license": "MIT",
7
11
"repository": {
8
12
"url": "https://github.com/mary-ext/atcute",
+1
-1
packages/utilities/varint/README.md
+1
-1
packages/utilities/varint/README.md
+1
-1
packages/utilities/varint/package.json
+1
-1
packages/utilities/varint/package.json