a collection of lightweight TypeScript packages for AT Protocol, the protocol powering Bluesky
atproto
bluesky
typescript
npm
fix(bluesky): add missing JSDoc annotations for exported embed types
+26
+5
.changeset/upset-bears-hang.md
+5
.changeset/upset-bears-hang.md
+21
packages/definitions/bluesky/lib/utilities/embeds.ts
+21
packages/definitions/bluesky/lib/utilities/embeds.ts
···
5
5
import type * as AppBskyFeedDefs from '../lexicons/types/app/bsky/feed/defs.js';
6
6
import type * as AppBskyFeedPost from '../lexicons/types/app/bsky/feed/post.js';
7
7
8
+
/**
9
+
* a union type of all possible raw embeds.
10
+
*/
8
11
export interface RawEmbeds {
9
12
media?: AppBskyEmbedRecordWithMedia.Main['media'];
10
13
record?: AppBskyEmbedRecordWithMedia.Main['record'];
11
14
}
12
15
16
+
/**
17
+
* a raw media embed.
18
+
*/
13
19
export type RawMediaEmbed = NonNullable<RawEmbeds['media']>;
20
+
/**
21
+
* a raw record embed.
22
+
*/
14
23
export type RawRecordEmbed = NonNullable<RawEmbeds['record']>;
15
24
16
25
/**
···
56
65
};
57
66
};
58
67
68
+
/**
69
+
* a union type of all possible embeds.
70
+
*/
59
71
export interface Embeds {
60
72
media?: AppBskyEmbedRecordWithMedia.View['media'];
61
73
record?: AppBskyEmbedRecordWithMedia.View['record']['record'];
62
74
}
63
75
76
+
/**
77
+
* a media embed.
78
+
*/
64
79
export type MediaEmbed = NonNullable<Embeds['media']>;
80
+
/**
81
+
* a record embed.
82
+
*/
65
83
export type RecordEmbed = NonNullable<Embeds['record']>;
66
84
67
85
/**
···
107
125
};
108
126
};
109
127
128
+
/**
129
+
* a quote embed.
130
+
*/
110
131
export type QuoteEmbed = $type.enforce<
111
132
| AppBskyEmbedRecord.ViewBlocked
112
133
| AppBskyEmbedRecord.ViewDetached