+3
-1
app/[leaflet_id]/actions/PublishButton.tsx
+3
-1
app/[leaflet_id]/actions/PublishButton.tsx
+6
-1
app/lish/[did]/[publication]/[rkey]/CanvasPage.tsx
+6
-1
app/lish/[did]/[publication]/[rkey]/CanvasPage.tsx
···
202
isSubpage: boolean | undefined;
203
data: PostPageData;
204
profile: ProfileViewDetailed;
205
-
preferences: { showComments?: boolean };
206
quotesCount: number | undefined;
207
commentsCount: number | undefined;
208
}) => {
···
213
quotesCount={props.quotesCount || 0}
214
commentsCount={props.commentsCount || 0}
215
showComments={props.preferences.showComments}
216
pageId={props.pageId}
217
/>
218
{!props.isSubpage && (
···
202
isSubpage: boolean | undefined;
203
data: PostPageData;
204
profile: ProfileViewDetailed;
205
+
preferences: {
206
+
showComments?: boolean;
207
+
showMentions?: boolean;
208
+
showPrevNext?: boolean;
209
+
};
210
quotesCount: number | undefined;
211
commentsCount: number | undefined;
212
}) => {
···
217
quotesCount={props.quotesCount || 0}
218
commentsCount={props.commentsCount || 0}
219
showComments={props.preferences.showComments}
220
+
showMentions={props.preferences.showMentions}
221
pageId={props.pageId}
222
/>
223
{!props.isSubpage && (
+4
-1
app/lish/[did]/[publication]/[rkey]/Interactions/Comments/index.tsx
+4
-1
app/lish/[did]/[publication]/[rkey]/Interactions/Comments/index.tsx
+2
-1
app/lish/[did]/[publication]/[rkey]/Interactions/InteractionDrawer.tsx
+2
-1
app/lish/[did]/[publication]/[rkey]/Interactions/InteractionDrawer.tsx
···
9
import { decodeQuotePosition } from "../quotePosition";
10
11
export const InteractionDrawer = (props: {
12
document_uri: string;
13
quotesAndMentions: { uri: string; link?: string }[];
14
comments: Comment[];
···
38
<div className="snap-center h-full flex z-10 shrink-0 w-[calc(var(--page-width-units)-6px)] sm:w-[calc(var(--page-width-units))]">
39
<div
40
id="interaction-drawer"
41
-
className="opaque-container rounded-l-none! rounded-r-lg! h-full w-full px-3 sm:px-4 pt-2 sm:pt-3 pb-6 overflow-scroll -ml-[1px] "
42
>
43
{drawer.drawer === "quotes" ? (
44
<Quotes {...props} quotesAndMentions={filteredQuotesAndMentions} />
···
9
import { decodeQuotePosition } from "../quotePosition";
10
11
export const InteractionDrawer = (props: {
12
+
showPageBackground: boolean | undefined;
13
document_uri: string;
14
quotesAndMentions: { uri: string; link?: string }[];
15
comments: Comment[];
···
39
<div className="snap-center h-full flex z-10 shrink-0 w-[calc(var(--page-width-units)-6px)] sm:w-[calc(var(--page-width-units))]">
40
<div
41
id="interaction-drawer"
42
+
className={`opaque-container h-full w-full px-3 sm:px-4 pt-2 sm:pt-3 pb-6 overflow-scroll -ml-[1px] ${props.showPageBackground ? "rounded-l-none! rounded-r-lg!" : "rounded-lg! sm:mx-2"}`}
43
>
44
{drawer.drawer === "quotes" ? (
45
<Quotes {...props} quotesAndMentions={filteredQuotesAndMentions} />
+68
-44
app/lish/[did]/[publication]/[rkey]/Interactions/Interactions.tsx
+68
-44
app/lish/[did]/[publication]/[rkey]/Interactions/Interactions.tsx
···
108
commentsCount: number;
109
className?: string;
110
showComments?: boolean;
111
pageId?: string;
112
}) => {
113
const data = useContext(PostPageContext);
···
131
<div className={`flex gap-2 text-tertiary text-sm ${props.className}`}>
132
{tagCount > 0 && <TagPopover tags={tags} tagCount={tagCount} />}
133
134
-
{props.quotesCount > 0 && (
135
<button
136
className="flex w-fit gap-2 items-center"
137
onClick={() => {
···
168
commentsCount: number;
169
className?: string;
170
showComments?: boolean;
171
pageId?: string;
172
}) => {
173
const data = useContext(PostPageContext);
···
189
const tags = (data?.data as any)?.tags as string[] | undefined;
190
const tagCount = tags?.length || 0;
191
192
let subscribed =
193
identity?.atp_did &&
194
publication?.publication_subscriptions &&
···
229
<TagList tags={tags} className="mb-3" />
230
</>
231
)}
232
<hr className="border-border-light mb-3 " />
233
<div className="flex gap-2 justify-between">
234
-
<div className="flex gap-2">
235
-
{props.quotesCount > 0 && (
236
-
<button
237
-
className="flex w-fit gap-2 items-center px-1 py-0.5 border border-border-light rounded-lg trasparent-outline selected-outline"
238
-
onClick={() => {
239
-
if (!drawerOpen || drawer !== "quotes")
240
-
openInteractionDrawer("quotes", document_uri, props.pageId);
241
-
else setInteractionState(document_uri, { drawerOpen: false });
242
-
}}
243
-
onMouseEnter={handleQuotePrefetch}
244
-
onTouchStart={handleQuotePrefetch}
245
-
aria-label="Post quotes"
246
-
>
247
-
<QuoteTiny aria-hidden /> {props.quotesCount}{" "}
248
-
<span
249
-
aria-hidden
250
-
>{`Mention${props.quotesCount === 1 ? "" : "s"}`}</span>
251
-
</button>
252
-
)}
253
-
{props.showComments === false ? null : (
254
-
<button
255
-
className="flex gap-2 items-center w-fit px-1 py-0.5 border border-border-light rounded-lg trasparent-outline selected-outline"
256
-
onClick={() => {
257
-
if (
258
-
!drawerOpen ||
259
-
drawer !== "comments" ||
260
-
pageId !== props.pageId
261
-
)
262
-
openInteractionDrawer("comments", document_uri, props.pageId);
263
-
else setInteractionState(document_uri, { drawerOpen: false });
264
-
}}
265
-
aria-label="Post comments"
266
-
>
267
-
<CommentTiny aria-hidden />{" "}
268
-
{props.commentsCount > 0 ? (
269
-
<span aria-hidden>
270
-
{`${props.commentsCount} Comment${props.commentsCount === 1 ? "" : "s"}`}
271
-
</span>
272
-
) : (
273
-
"Comment"
274
)}
275
-
</button>
276
-
)}
277
-
</div>
278
<EditButton document={data} />
279
{subscribed && publication && (
280
<ManageSubscription
···
108
commentsCount: number;
109
className?: string;
110
showComments?: boolean;
111
+
showMentions?: boolean;
112
pageId?: string;
113
}) => {
114
const data = useContext(PostPageContext);
···
132
<div className={`flex gap-2 text-tertiary text-sm ${props.className}`}>
133
{tagCount > 0 && <TagPopover tags={tags} tagCount={tagCount} />}
134
135
+
{props.quotesCount === 0 || props.showMentions === false ? null : (
136
<button
137
className="flex w-fit gap-2 items-center"
138
onClick={() => {
···
169
commentsCount: number;
170
className?: string;
171
showComments?: boolean;
172
+
showMentions?: boolean;
173
pageId?: string;
174
}) => {
175
const data = useContext(PostPageContext);
···
191
const tags = (data?.data as any)?.tags as string[] | undefined;
192
const tagCount = tags?.length || 0;
193
194
+
let noInteractions = !props.showComments && !props.showMentions;
195
+
196
let subscribed =
197
identity?.atp_did &&
198
publication?.publication_subscriptions &&
···
233
<TagList tags={tags} className="mb-3" />
234
</>
235
)}
236
+
237
<hr className="border-border-light mb-3 " />
238
+
239
<div className="flex gap-2 justify-between">
240
+
{noInteractions ? (
241
+
<div />
242
+
) : (
243
+
<>
244
+
<div className="flex gap-2">
245
+
{props.quotesCount === 0 ||
246
+
props.showMentions === false ? null : (
247
+
<button
248
+
className="flex w-fit gap-2 items-center px-1 py-0.5 border border-border-light rounded-lg trasparent-outline selected-outline"
249
+
onClick={() => {
250
+
if (!drawerOpen || drawer !== "quotes")
251
+
openInteractionDrawer(
252
+
"quotes",
253
+
document_uri,
254
+
props.pageId,
255
+
);
256
+
else
257
+
setInteractionState(document_uri, { drawerOpen: false });
258
+
}}
259
+
onMouseEnter={handleQuotePrefetch}
260
+
onTouchStart={handleQuotePrefetch}
261
+
aria-label="Post quotes"
262
+
>
263
+
<QuoteTiny aria-hidden /> {props.quotesCount}{" "}
264
+
<span
265
+
aria-hidden
266
+
>{`Mention${props.quotesCount === 1 ? "" : "s"}`}</span>
267
+
</button>
268
)}
269
+
{props.showComments === false ? null : (
270
+
<button
271
+
className="flex gap-2 items-center w-fit px-1 py-0.5 border border-border-light rounded-lg trasparent-outline selected-outline"
272
+
onClick={() => {
273
+
if (
274
+
!drawerOpen ||
275
+
drawer !== "comments" ||
276
+
pageId !== props.pageId
277
+
)
278
+
openInteractionDrawer(
279
+
"comments",
280
+
document_uri,
281
+
props.pageId,
282
+
);
283
+
else
284
+
setInteractionState(document_uri, { drawerOpen: false });
285
+
}}
286
+
aria-label="Post comments"
287
+
>
288
+
<CommentTiny aria-hidden />{" "}
289
+
{props.commentsCount > 0 ? (
290
+
<span aria-hidden>
291
+
{`${props.commentsCount} Comment${props.commentsCount === 1 ? "" : "s"}`}
292
+
</span>
293
+
) : (
294
+
"Comment"
295
+
)}
296
+
</button>
297
+
)}
298
+
</div>
299
+
</>
300
+
)}
301
+
302
<EditButton document={data} />
303
{subscribed && publication && (
304
<ManageSubscription
+7
-2
app/lish/[did]/[publication]/[rkey]/LinearDocumentPage.tsx
+7
-2
app/lish/[did]/[publication]/[rkey]/LinearDocumentPage.tsx
···
14
ExpandedInteractions,
15
getCommentCount,
16
getQuoteCount,
17
-
Interactions,
18
} from "./Interactions/Interactions";
19
import { PostContent } from "./PostContent";
20
import { PostHeader } from "./PostHeader/PostHeader";
···
25
import { decodeQuotePosition } from "./quotePosition";
26
import { PollData } from "./fetchPollData";
27
import { SharedPageProps } from "./PostPages";
28
29
export function LinearDocumentPage({
30
blocks,
···
56
57
const isSubpage = !!pageId;
58
59
return (
60
<>
61
<PageWrapper
···
83
did={did}
84
prerenderedCodeBlocks={prerenderedCodeBlocks}
85
/>
86
-
87
<ExpandedInteractions
88
pageId={pageId}
89
showComments={preferences.showComments}
90
commentsCount={getCommentCount(document, pageId) || 0}
91
quotesCount={getQuoteCount(document, pageId) || 0}
92
/>
···
14
ExpandedInteractions,
15
getCommentCount,
16
getQuoteCount,
17
} from "./Interactions/Interactions";
18
import { PostContent } from "./PostContent";
19
import { PostHeader } from "./PostHeader/PostHeader";
···
24
import { decodeQuotePosition } from "./quotePosition";
25
import { PollData } from "./fetchPollData";
26
import { SharedPageProps } from "./PostPages";
27
+
import { PostPrevNextButtons } from "./PostPrevNextButtons";
28
29
export function LinearDocumentPage({
30
blocks,
···
56
57
const isSubpage = !!pageId;
58
59
+
console.log("prev/next?: " + preferences.showPrevNext);
60
+
61
return (
62
<>
63
<PageWrapper
···
85
did={did}
86
prerenderedCodeBlocks={prerenderedCodeBlocks}
87
/>
88
+
<PostPrevNextButtons
89
+
showPrevNext={preferences.showPrevNext && !isSubpage}
90
+
/>
91
<ExpandedInteractions
92
pageId={pageId}
93
showComments={preferences.showComments}
94
+
showMentions={preferences.showMentions}
95
commentsCount={getCommentCount(document, pageId) || 0}
96
quotesCount={getQuoteCount(document, pageId) || 0}
97
/>
+2
-1
app/lish/[did]/[publication]/[rkey]/PostHeader/PostHeader.tsx
+2
-1
app/lish/[did]/[publication]/[rkey]/PostHeader/PostHeader.tsx
···
23
export function PostHeader(props: {
24
data: PostPageData;
25
profile: ProfileViewDetailed;
26
-
preferences: { showComments?: boolean };
27
}) {
28
let { identity } = useIdentityData();
29
let document = props.data;
···
91
</div>
92
<Interactions
93
showComments={props.preferences.showComments}
94
quotesCount={getQuoteCount(document) || 0}
95
commentsCount={getCommentCount(document) || 0}
96
/>
···
23
export function PostHeader(props: {
24
data: PostPageData;
25
profile: ProfileViewDetailed;
26
+
preferences: { showComments?: boolean; showMentions?: boolean };
27
}) {
28
let { identity } = useIdentityData();
29
let document = props.data;
···
91
</div>
92
<Interactions
93
showComments={props.preferences.showComments}
94
+
showMentions={props.preferences.showMentions}
95
quotesCount={getQuoteCount(document) || 0}
96
commentsCount={getCommentCount(document) || 0}
97
/>
+22
-4
app/lish/[did]/[publication]/[rkey]/PostPages.tsx
+22
-4
app/lish/[did]/[publication]/[rkey]/PostPages.tsx
···
147
document: PostPageData;
148
did: string;
149
profile: ProfileViewDetailed;
150
-
preferences: { showComments?: boolean };
151
pubRecord?: PubLeafletPublication.Record;
152
theme?: PubLeafletPublication.Theme | null;
153
prerenderedCodeBlocks?: Map<string, string>;
···
206
did: string;
207
prerenderedCodeBlocks?: Map<string, string>;
208
bskyPostData: AppBskyFeedDefs.PostView[];
209
-
preferences: { showComments?: boolean };
210
pollData: PollData[];
211
}) {
212
let drawer = useDrawerOpen(document_uri);
···
261
262
{drawer && !drawer.pageId && (
263
<InteractionDrawer
264
document_uri={document.uri}
265
comments={
266
pubRecord?.preferences?.showComments === false
267
? []
268
: document.comments_on_documents
269
}
270
-
quotesAndMentions={quotesAndMentions}
271
did={did}
272
/>
273
)}
···
347
/>
348
{drawer && drawer.pageId === page.id && (
349
<InteractionDrawer
350
pageId={page.id}
351
document_uri={document.uri}
352
comments={
···
354
? []
355
: document.comments_on_documents
356
}
357
-
quotesAndMentions={quotesAndMentions}
358
did={did}
359
/>
360
)}
···
147
document: PostPageData;
148
did: string;
149
profile: ProfileViewDetailed;
150
+
preferences: {
151
+
showComments?: boolean;
152
+
showMentions?: boolean;
153
+
showPrevNext?: boolean;
154
+
};
155
pubRecord?: PubLeafletPublication.Record;
156
theme?: PubLeafletPublication.Theme | null;
157
prerenderedCodeBlocks?: Map<string, string>;
···
210
did: string;
211
prerenderedCodeBlocks?: Map<string, string>;
212
bskyPostData: AppBskyFeedDefs.PostView[];
213
+
preferences: {
214
+
showComments?: boolean;
215
+
showMentions?: boolean;
216
+
showPrevNext?: boolean;
217
+
};
218
pollData: PollData[];
219
}) {
220
let drawer = useDrawerOpen(document_uri);
···
269
270
{drawer && !drawer.pageId && (
271
<InteractionDrawer
272
+
showPageBackground={pubRecord?.theme?.showPageBackground}
273
document_uri={document.uri}
274
comments={
275
pubRecord?.preferences?.showComments === false
276
? []
277
: document.comments_on_documents
278
}
279
+
quotesAndMentions={
280
+
pubRecord?.preferences?.showMentions === false
281
+
? []
282
+
: quotesAndMentions
283
+
}
284
did={did}
285
/>
286
)}
···
360
/>
361
{drawer && drawer.pageId === page.id && (
362
<InteractionDrawer
363
+
showPageBackground={pubRecord?.theme?.showPageBackground}
364
pageId={page.id}
365
document_uri={document.uri}
366
comments={
···
368
? []
369
: document.comments_on_documents
370
}
371
+
quotesAndMentions={
372
+
pubRecord?.preferences?.showMentions === false
373
+
? []
374
+
: quotesAndMentions
375
+
}
376
did={did}
377
/>
378
)}
+58
app/lish/[did]/[publication]/[rkey]/PostPrevNextButtons.tsx
+58
app/lish/[did]/[publication]/[rkey]/PostPrevNextButtons.tsx
···
···
1
+
"use client";
2
+
import { PubLeafletDocument } from "lexicons/api";
3
+
import { usePublicationData } from "../dashboard/PublicationSWRProvider";
4
+
import { getPublicationURL } from "app/lish/createPub/getPublicationURL";
5
+
import { AtUri } from "@atproto/api";
6
+
import { useParams } from "next/navigation";
7
+
import { getPostPageData } from "./getPostPageData";
8
+
import { PostPageContext } from "./PostPageContext";
9
+
import { useContext } from "react";
10
+
import { SpeedyLink } from "components/SpeedyLink";
11
+
import { ArrowRightTiny } from "components/Icons/ArrowRightTiny";
12
+
13
+
export const PostPrevNextButtons = (props: {
14
+
showPrevNext: boolean | undefined;
15
+
}) => {
16
+
let postData = useContext(PostPageContext);
17
+
let pub = postData?.documents_in_publications[0]?.publications;
18
+
19
+
if (!props.showPrevNext || !pub || !postData) return;
20
+
21
+
function getPostLink(uri: string) {
22
+
return pub && uri
23
+
? `${getPublicationURL(pub)}/${new AtUri(uri).rkey}`
24
+
: "leaflet.pub/not-found";
25
+
}
26
+
let prevPost = postData?.prevNext?.prev;
27
+
let nextPost = postData?.prevNext?.next;
28
+
29
+
return (
30
+
<div className="flex flex-col gap-1 w-full px-3 sm:px-4 pb-2 pt-2">
31
+
{/*<hr className="border-border-light" />*/}
32
+
<div className="flex justify-between w-full gap-8 ">
33
+
{nextPost ? (
34
+
<SpeedyLink
35
+
href={getPostLink(nextPost.uri)}
36
+
className="flex gap-1 items-center truncate min-w-0 basis-1/2"
37
+
>
38
+
<ArrowRightTiny className="rotate-180 shrink-0" />
39
+
<div className="min-w-0 truncate">{nextPost.title}</div>
40
+
</SpeedyLink>
41
+
) : (
42
+
<div />
43
+
)}
44
+
{prevPost ? (
45
+
<SpeedyLink
46
+
href={getPostLink(prevPost.uri)}
47
+
className="flex gap-1 items-center truncate min-w-0 basis-1/2 justify-end"
48
+
>
49
+
<div className="min-w-0 truncate">{prevPost.title}</div>
50
+
<ArrowRightTiny className="shrink-0" />
51
+
</SpeedyLink>
52
+
) : (
53
+
<div />
54
+
)}
55
+
</div>
56
+
</div>
57
+
);
58
+
};
+3
-2
app/lish/[did]/[publication]/[rkey]/QuoteHandler.tsx
+3
-2
app/lish/[did]/[publication]/[rkey]/QuoteHandler.tsx
···
186
<BlueskyLinkTiny className="shrink-0" />
187
Bluesky
188
</a>
189
-
<Separator classname="h-4" />
190
<button
191
id="copy-quote-link"
192
className="flex gap-1 items-center hover:font-bold px-1"
···
211
</button>
212
{pubRecord?.preferences?.showComments !== false && identity?.atp_did && (
213
<>
214
-
<Separator classname="h-4" />
215
<button
216
className="flex gap-1 items-center hover:font-bold px-1"
217
onClick={() => {
···
186
<BlueskyLinkTiny className="shrink-0" />
187
Bluesky
188
</a>
189
+
<Separator classname="h-4!" />
190
<button
191
id="copy-quote-link"
192
className="flex gap-1 items-center hover:font-bold px-1"
···
211
</button>
212
{pubRecord?.preferences?.showComments !== false && identity?.atp_did && (
213
<>
214
+
<Separator classname="h-4! " />
215
+
216
<button
217
className="flex gap-1 items-center hover:font-bold px-1"
218
onClick={() => {
+58
-1
app/lish/[did]/[publication]/[rkey]/getPostPageData.ts
+58
-1
app/lish/[did]/[publication]/[rkey]/getPostPageData.ts
···
10
data,
11
uri,
12
comments_on_documents(*, bsky_profiles(*)),
13
-
documents_in_publications(publications(*, publication_subscriptions(*))),
14
document_mentions_in_bsky(*),
15
leaflets_in_publications(*)
16
`,
···
51
?.record as PubLeafletPublication.Record
52
)?.theme || (document?.data as PubLeafletDocument.Record)?.theme;
53
54
return {
55
...document,
56
quotesAndMentions,
57
theme,
58
};
59
}
60
···
10
data,
11
uri,
12
comments_on_documents(*, bsky_profiles(*)),
13
+
documents_in_publications(publications(*,
14
+
documents_in_publications(documents(uri, data)),
15
+
publication_subscriptions(*))
16
+
),
17
document_mentions_in_bsky(*),
18
leaflets_in_publications(*)
19
`,
···
54
?.record as PubLeafletPublication.Record
55
)?.theme || (document?.data as PubLeafletDocument.Record)?.theme;
56
57
+
// Calculate prev/next documents from the fetched publication documents
58
+
let prevNext:
59
+
| {
60
+
prev?: { uri: string; title: string };
61
+
next?: { uri: string; title: string };
62
+
}
63
+
| undefined;
64
+
65
+
const currentPublishedAt = (document.data as PubLeafletDocument.Record)
66
+
?.publishedAt;
67
+
const allDocs =
68
+
document.documents_in_publications[0]?.publications
69
+
?.documents_in_publications;
70
+
71
+
if (currentPublishedAt && allDocs) {
72
+
// Filter and sort documents by publishedAt
73
+
const sortedDocs = allDocs
74
+
.map((dip) => ({
75
+
uri: dip?.documents?.uri,
76
+
title: (dip?.documents?.data as PubLeafletDocument.Record).title,
77
+
publishedAt: (dip?.documents?.data as PubLeafletDocument.Record)
78
+
.publishedAt,
79
+
}))
80
+
.filter((doc) => doc.publishedAt) // Only include docs with publishedAt
81
+
.sort(
82
+
(a, b) =>
83
+
new Date(a.publishedAt!).getTime() -
84
+
new Date(b.publishedAt!).getTime(),
85
+
);
86
+
87
+
// Find current document index
88
+
const currentIndex = sortedDocs.findIndex((doc) => doc.uri === uri);
89
+
90
+
if (currentIndex !== -1) {
91
+
prevNext = {
92
+
prev:
93
+
currentIndex > 0
94
+
? {
95
+
uri: sortedDocs[currentIndex - 1].uri || "",
96
+
title: sortedDocs[currentIndex - 1].title,
97
+
}
98
+
: undefined,
99
+
next:
100
+
currentIndex < sortedDocs.length - 1
101
+
? {
102
+
uri: sortedDocs[currentIndex + 1].uri || "",
103
+
title: sortedDocs[currentIndex + 1].title,
104
+
}
105
+
: undefined,
106
+
};
107
+
}
108
+
}
109
+
110
return {
111
...document,
112
quotesAndMentions,
113
theme,
114
+
prevNext,
115
};
116
}
117
+1
app/lish/[did]/[publication]/dashboard/PublishedPostsLists.tsx
+1
app/lish/[did]/[publication]/dashboard/PublishedPostsLists.tsx
+31
-25
app/lish/[did]/[publication]/dashboard/settings/PostOptions.tsx
+31
-25
app/lish/[did]/[publication]/dashboard/settings/PostOptions.tsx
···
22
? true
23
: record.preferences.showComments,
24
);
25
-
let [showMentions, setShowMentions] = useState(true);
26
-
let [showPrevNext, setShowPrevNext] = useState(true);
27
28
let toast = useToaster();
29
return (
30
<form
31
onSubmit={async (e) => {
32
-
// if (!pubData) return;
33
-
// e.preventDefault();
34
-
// props.setLoading(true);
35
-
// let data = await updatePublication({
36
-
// uri: pubData.uri,
37
-
// name: nameValue,
38
-
// description: descriptionValue,
39
-
// iconFile: iconFile,
40
-
// preferences: {
41
-
// showInDiscover: showInDiscover,
42
-
// showComments: showComments,
43
-
// },
44
-
// });
45
-
// toast({ type: "success", content: "Posts Updated!" });
46
-
// props.setLoading(false);
47
-
// mutate("publication-data");
48
}}
49
className="text-primary flex flex-col"
50
>
···
57
Post Options
58
</PubSettingsHeader>
59
<h4 className="mb-1">Layout</h4>
60
-
{/*<div>Max Post Width</div>*/}
61
<Toggle
62
toggle={showPrevNext}
63
onToggle={() => {
64
setShowPrevNext(!showPrevNext);
65
}}
66
>
67
-
<div className="flex flex-col justify-start">
68
-
<div className="font-bold">Show Prev/Next Buttons</div>
69
-
<div className="text-tertiary text-sm leading-tight">
70
-
Show buttons that navigate to the previous and next posts
71
-
</div>
72
-
</div>
73
</Toggle>
74
<hr className="my-2 border-border-light" />
75
<h4 className="mb-1">Interactions</h4>
···
22
? true
23
: record.preferences.showComments,
24
);
25
+
let [showMentions, setShowMentions] = useState(
26
+
record?.preferences?.showMentions === undefined
27
+
? true
28
+
: record.preferences.showMentions,
29
+
);
30
+
let [showPrevNext, setShowPrevNext] = useState(
31
+
record?.preferences?.showPrevNext === undefined
32
+
? true
33
+
: record.preferences.showPrevNext,
34
+
);
35
36
let toast = useToaster();
37
return (
38
<form
39
onSubmit={async (e) => {
40
+
if (!pubData) return;
41
+
e.preventDefault();
42
+
props.setLoading(true);
43
+
let data = await updatePublication({
44
+
name: record.name,
45
+
uri: pubData.uri,
46
+
preferences: {
47
+
showInDiscover:
48
+
record?.preferences?.showInDiscover === undefined
49
+
? true
50
+
: record.preferences.showInDiscover,
51
+
showComments: showComments,
52
+
showMentions: showMentions,
53
+
showPrevNext: showPrevNext,
54
+
},
55
+
});
56
+
toast({ type: "success", content: <strong>Posts Updated!</strong> });
57
+
console.log(record.preferences?.showPrevNext);
58
+
props.setLoading(false);
59
+
mutate("publication-data");
60
}}
61
className="text-primary flex flex-col"
62
>
···
69
Post Options
70
</PubSettingsHeader>
71
<h4 className="mb-1">Layout</h4>
72
<Toggle
73
toggle={showPrevNext}
74
onToggle={() => {
75
setShowPrevNext(!showPrevNext);
76
}}
77
>
78
+
<div className="font-bold">Show Prev/Next Buttons</div>
79
</Toggle>
80
<hr className="my-2 border-border-light" />
81
<h4 className="mb-1">Interactions</h4>
+2
-2
app/lish/[did]/[publication]/dashboard/settings/PublicationSettings.tsx
+2
-2
app/lish/[did]/[publication]/dashboard/settings/PublicationSettings.tsx
+1
app/lish/[did]/[publication]/page.tsx
+1
app/lish/[did]/[publication]/page.tsx
+9
-2
app/lish/createPub/CreatePubForm.tsx
+9
-2
app/lish/createPub/CreatePubForm.tsx
···
53
description: descriptionValue,
54
iconFile: logoFile,
55
subdomain: domainValue,
56
-
preferences: { showInDiscover, showComments: true },
57
});
58
59
if (!result.success) {
···
68
setTimeout(() => {
69
setFormState("normal");
70
if (result.publication)
71
-
router.push(`${getBasePublicationURL(result.publication)}/dashboard`);
72
}, 500);
73
}}
74
>
···
53
description: descriptionValue,
54
iconFile: logoFile,
55
subdomain: domainValue,
56
+
preferences: {
57
+
showInDiscover,
58
+
showComments: true,
59
+
showMentions: true,
60
+
showPrevNext: false,
61
+
},
62
});
63
64
if (!result.success) {
···
73
setTimeout(() => {
74
setFormState("normal");
75
if (result.publication)
76
+
router.push(
77
+
`${getBasePublicationURL(result.publication)}/dashboard`,
78
+
);
79
}, 500);
80
}}
81
>
+19
-14
app/lish/createPub/UpdatePubForm.tsx
+19
-14
app/lish/createPub/UpdatePubForm.tsx
···
21
import { Checkbox } from "components/Checkbox";
22
import type { GetDomainConfigResponseBody } from "@vercel/sdk/esm/models/getdomainconfigop";
23
import { PubSettingsHeader } from "../[did]/[publication]/dashboard/settings/PublicationSettings";
24
25
export const EditPubForm = (props: {
26
backToMenuAction: () => void;
···
43
? true
44
: record.preferences.showComments,
45
);
46
let [descriptionValue, setDescriptionValue] = useState(
47
record?.description || "",
48
);
···
74
preferences: {
75
showInDiscover: showInDiscover,
76
showComments: showComments,
77
},
78
});
79
toast({ type: "success", content: "Updated!" });
···
90
General Settings
91
</PubSettingsHeader>
92
<div className="flex flex-col gap-3 w-[1000px] max-w-full pb-2">
93
-
<div className="flex items-center justify-between gap-2 ">
94
<p className="pl-0.5 pb-0.5 text-tertiary italic text-sm font-bold">
95
Logo <span className="font-normal">(optional)</span>
96
</p>
···
160
<CustomDomainForm />
161
<hr className="border-border-light" />
162
163
-
<Checkbox
164
-
checked={showInDiscover}
165
-
onChange={(e) => setShowInDiscover(e.target.checked)}
166
>
167
-
<div className=" pt-0.5 flex flex-col text-sm italic text-tertiary ">
168
<p className="font-bold">
169
Show In{" "}
170
<a href="/discover" target="_blank">
···
179
page. You can change this at any time!
180
</p>
181
</div>
182
-
</Checkbox>
183
184
-
<Checkbox
185
-
checked={showComments}
186
-
onChange={(e) => setShowComments(e.target.checked)}
187
-
>
188
-
<div className=" pt-0.5 flex flex-col text-sm italic text-tertiary ">
189
-
<p className="font-bold">Show comments on posts</p>
190
-
</div>
191
-
</Checkbox>
192
</div>
193
</form>
194
);
···
21
import { Checkbox } from "components/Checkbox";
22
import type { GetDomainConfigResponseBody } from "@vercel/sdk/esm/models/getdomainconfigop";
23
import { PubSettingsHeader } from "../[did]/[publication]/dashboard/settings/PublicationSettings";
24
+
import { Toggle } from "components/Toggle";
25
26
export const EditPubForm = (props: {
27
backToMenuAction: () => void;
···
44
? true
45
: record.preferences.showComments,
46
);
47
+
let showMentions =
48
+
record?.preferences?.showMentions === undefined
49
+
? true
50
+
: record.preferences.showMentions;
51
+
let showPrevNext =
52
+
record?.preferences?.showPrevNext === undefined
53
+
? true
54
+
: record.preferences.showPrevNext;
55
+
56
let [descriptionValue, setDescriptionValue] = useState(
57
record?.description || "",
58
);
···
84
preferences: {
85
showInDiscover: showInDiscover,
86
showComments: showComments,
87
+
showMentions: showMentions,
88
+
showPrevNext: showPrevNext,
89
},
90
});
91
toast({ type: "success", content: "Updated!" });
···
102
General Settings
103
</PubSettingsHeader>
104
<div className="flex flex-col gap-3 w-[1000px] max-w-full pb-2">
105
+
<div className="flex items-center justify-between gap-2 mt-2 ">
106
<p className="pl-0.5 pb-0.5 text-tertiary italic text-sm font-bold">
107
Logo <span className="font-normal">(optional)</span>
108
</p>
···
172
<CustomDomainForm />
173
<hr className="border-border-light" />
174
175
+
<Toggle
176
+
toggle={showInDiscover}
177
+
onToggle={() => setShowInDiscover(!showInDiscover)}
178
>
179
+
<div className=" pt-0.5 flex flex-col text-sm text-tertiary ">
180
<p className="font-bold">
181
Show In{" "}
182
<a href="/discover" target="_blank">
···
191
page. You can change this at any time!
192
</p>
193
</div>
194
+
</Toggle>
195
196
+
197
</div>
198
</form>
199
);
+2
-2
app/lish/createPub/updatePublication.ts
+2
-2
app/lish/createPub/updatePublication.ts
+6
-3
components/Canvas.tsx
+6
-3
components/Canvas.tsx
···
170
171
let pubRecord = pub.publications.record as PubLeafletPublication.Record;
172
let showComments = pubRecord.preferences?.showComments;
173
174
return (
175
<div className="flex flex-row gap-3 items-center absolute top-6 right-3 sm:top-4 sm:right-4 bg-bg-page border-border-light rounded-md px-2 py-1 h-fit z-20">
···
178
<CommentTiny className="text-border" /> โ
179
</div>
180
)}
181
-
<div className="flex gap-1 text-tertiary items-center">
182
-
<QuoteTiny className="text-border" /> โ
183
-
</div>
184
185
{!props.isSubpage && (
186
<>
···
170
171
let pubRecord = pub.publications.record as PubLeafletPublication.Record;
172
let showComments = pubRecord.preferences?.showComments;
173
+
let showMentions = pubRecord.preferences?.showMentions;
174
175
return (
176
<div className="flex flex-row gap-3 items-center absolute top-6 right-3 sm:top-4 sm:right-4 bg-bg-page border-border-light rounded-md px-2 py-1 h-fit z-20">
···
179
<CommentTiny className="text-border" /> โ
180
</div>
181
)}
182
+
{showComments && (
183
+
<div className="flex gap-1 text-tertiary items-center">
184
+
<QuoteTiny className="text-border" /> โ
185
+
</div>
186
+
)}
187
188
{!props.isSubpage && (
189
<>
+4
-2
components/InteractionsPreview.tsx
+4
-2
components/InteractionsPreview.tsx
···
14
tags?: string[];
15
postUrl: string;
16
showComments: boolean | undefined;
17
share?: boolean;
18
}) => {
19
let smoker = useSmoker();
20
let interactionsAvailable =
21
-
props.quotesCount > 0 ||
22
(props.showComments !== false && props.commentsCount > 0);
23
24
const tagsCount = props.tags?.length || 0;
···
36
</>
37
)}
38
39
-
{props.quotesCount === 0 ? null : (
40
<SpeedyLink
41
aria-label="Post quotes"
42
href={`${props.postUrl}?interactionDrawer=quotes`}
···
14
tags?: string[];
15
postUrl: string;
16
showComments: boolean | undefined;
17
+
showMentions: boolean | undefined;
18
+
19
share?: boolean;
20
}) => {
21
let smoker = useSmoker();
22
let interactionsAvailable =
23
+
(props.quotesCount > 0 && props.showMentions !== false) ||
24
(props.showComments !== false && props.commentsCount > 0);
25
26
const tagsCount = props.tags?.length || 0;
···
38
</>
39
)}
40
41
+
{props.showMentions === false || props.quotesCount === 0 ? null : (
42
<SpeedyLink
43
aria-label="Post quotes"
44
href={`${props.postUrl}?interactionDrawer=quotes`}
+5
-3
components/Pages/PublicationMetadata.tsx
+5
-3
components/Pages/PublicationMetadata.tsx
···
121
<Separator classname="h-4!" />
122
</>
123
)}
124
+
{pubRecord?.preferences?.showMentions && (
125
+
<div className="flex gap-1 items-center">
126
+
<QuoteTiny />โ
127
+
</div>
128
+
)}
129
{pubRecord?.preferences?.showComments && (
130
<div className="flex gap-1 items-center">
131
<CommentTiny />โ
+1
components/PostListing.tsx
+1
components/PostListing.tsx
+7
-7
components/ThemeManager/PublicationThemeProvider.tsx
+7
-7
components/ThemeManager/PublicationThemeProvider.tsx
···
2
import { useMemo, useState } from "react";
3
import { parseColor } from "react-aria-components";
4
import { useEntity } from "src/replicache";
5
-
import { getColorDifference } from "./themeUtils";
6
import { useColorAttribute, colorToString } from "./useColorAttribute";
7
import { BaseThemeProvider, CardBorderHiddenContext } from "./ThemeProvider";
8
import { PubLeafletPublication, PubLeafletThemeColor } from "lexicons/api";
···
174
let newAccentContrast;
175
let sortedAccents = [newTheme.accent1, newTheme.accent2].sort((a, b) => {
176
return (
177
-
getColorDifference(
178
colorToString(b, "rgb"),
179
colorToString(
180
showPageBackground ? newTheme.bgPage : newTheme.bgLeaflet,
181
"rgb",
182
),
183
) -
184
-
getColorDifference(
185
colorToString(a, "rgb"),
186
colorToString(
187
showPageBackground ? newTheme.bgPage : newTheme.bgLeaflet,
···
191
);
192
});
193
if (
194
-
getColorDifference(
195
colorToString(sortedAccents[0], "rgb"),
196
colorToString(newTheme.primary, "rgb"),
197
-
) < 0.15 &&
198
-
getColorDifference(
199
colorToString(sortedAccents[1], "rgb"),
200
colorToString(
201
showPageBackground ? newTheme.bgPage : newTheme.bgLeaflet,
202
"rgb",
203
),
204
-
) > 0.08
205
) {
206
newAccentContrast = sortedAccents[1];
207
} else newAccentContrast = sortedAccents[0];
···
2
import { useMemo, useState } from "react";
3
import { parseColor } from "react-aria-components";
4
import { useEntity } from "src/replicache";
5
+
import { getColorContrast } from "./themeUtils";
6
import { useColorAttribute, colorToString } from "./useColorAttribute";
7
import { BaseThemeProvider, CardBorderHiddenContext } from "./ThemeProvider";
8
import { PubLeafletPublication, PubLeafletThemeColor } from "lexicons/api";
···
174
let newAccentContrast;
175
let sortedAccents = [newTheme.accent1, newTheme.accent2].sort((a, b) => {
176
return (
177
+
getColorContrast(
178
colorToString(b, "rgb"),
179
colorToString(
180
showPageBackground ? newTheme.bgPage : newTheme.bgLeaflet,
181
"rgb",
182
),
183
) -
184
+
getColorContrast(
185
colorToString(a, "rgb"),
186
colorToString(
187
showPageBackground ? newTheme.bgPage : newTheme.bgLeaflet,
···
191
);
192
});
193
if (
194
+
getColorContrast(
195
colorToString(sortedAccents[0], "rgb"),
196
colorToString(newTheme.primary, "rgb"),
197
+
) < 30 &&
198
+
getColorContrast(
199
colorToString(sortedAccents[1], "rgb"),
200
colorToString(
201
showPageBackground ? newTheme.bgPage : newTheme.bgLeaflet,
202
"rgb",
203
),
204
+
) > 12
205
) {
206
newAccentContrast = sortedAccents[1];
207
} else newAccentContrast = sortedAccents[0];
+9
-9
components/ThemeManager/ThemeProvider.tsx
+9
-9
components/ThemeManager/ThemeProvider.tsx
···
22
PublicationThemeProvider,
23
} from "./PublicationThemeProvider";
24
import { PubLeafletPublication } from "lexicons/api";
25
-
import { getColorDifference } from "./themeUtils";
26
27
// define a function to set an Aria Color to a CSS Variable in RGB
28
function setCSSVariableToColor(
···
140
//sorting the accents by contrast on background
141
let sortedAccents = [accent1, accent2].sort((a, b) => {
142
return (
143
-
getColorDifference(
144
colorToString(b, "rgb"),
145
colorToString(showPageBackground ? bgPage : bgLeaflet, "rgb"),
146
) -
147
-
getColorDifference(
148
colorToString(a, "rgb"),
149
colorToString(showPageBackground ? bgPage : bgLeaflet, "rgb"),
150
)
···
156
// then use the not contrasty option
157
158
if (
159
-
getColorDifference(
160
colorToString(sortedAccents[0], "rgb"),
161
colorToString(primary, "rgb"),
162
-
) < 0.15 &&
163
-
getColorDifference(
164
colorToString(sortedAccents[1], "rgb"),
165
colorToString(showPageBackground ? bgPage : bgLeaflet, "rgb"),
166
-
) > 0.08
167
) {
168
accentContrast = sortedAccents[1];
169
} else accentContrast = sortedAccents[0];
···
286
bgPage && accent1 && accent2
287
? [accent1, accent2].sort((a, b) => {
288
return (
289
-
getColorDifference(
290
colorToString(b, "rgb"),
291
colorToString(bgPage, "rgb"),
292
) -
293
-
getColorDifference(
294
colorToString(a, "rgb"),
295
colorToString(bgPage, "rgb"),
296
)
···
22
PublicationThemeProvider,
23
} from "./PublicationThemeProvider";
24
import { PubLeafletPublication } from "lexicons/api";
25
+
import { getColorContrast } from "./themeUtils";
26
27
// define a function to set an Aria Color to a CSS Variable in RGB
28
function setCSSVariableToColor(
···
140
//sorting the accents by contrast on background
141
let sortedAccents = [accent1, accent2].sort((a, b) => {
142
return (
143
+
getColorContrast(
144
colorToString(b, "rgb"),
145
colorToString(showPageBackground ? bgPage : bgLeaflet, "rgb"),
146
) -
147
+
getColorContrast(
148
colorToString(a, "rgb"),
149
colorToString(showPageBackground ? bgPage : bgLeaflet, "rgb"),
150
)
···
156
// then use the not contrasty option
157
158
if (
159
+
getColorContrast(
160
colorToString(sortedAccents[0], "rgb"),
161
colorToString(primary, "rgb"),
162
+
) < 30 &&
163
+
getColorContrast(
164
colorToString(sortedAccents[1], "rgb"),
165
colorToString(showPageBackground ? bgPage : bgLeaflet, "rgb"),
166
+
) > 12
167
) {
168
accentContrast = sortedAccents[1];
169
} else accentContrast = sortedAccents[0];
···
286
bgPage && accent1 && accent2
287
? [accent1, accent2].sort((a, b) => {
288
return (
289
+
getColorContrast(
290
colorToString(b, "rgb"),
291
colorToString(bgPage, "rgb"),
292
) -
293
+
getColorContrast(
294
colorToString(a, "rgb"),
295
colorToString(bgPage, "rgb"),
296
)
+3
-4
components/ThemeManager/themeUtils.ts
+3
-4
components/ThemeManager/themeUtils.ts
···
1
-
import { parse, ColorSpace, sRGB, distance, OKLab } from "colorjs.io/fn";
2
3
// define the color defaults for everything
4
export const ThemeDefaults = {
···
17
};
18
19
// used to calculate the contrast between page and accent1, accent2, and determin which is higher contrast
20
-
export function getColorDifference(color1: string, color2: string) {
21
ColorSpace.register(sRGB);
22
-
ColorSpace.register(OKLab);
23
24
let parsedColor1 = parse(`rgb(${color1})`);
25
let parsedColor2 = parse(`rgb(${color2})`);
26
27
-
return distance(parsedColor1, parsedColor2, "oklab");
28
}
···
1
+
import { parse, contrastLstar, ColorSpace, sRGB } from "colorjs.io/fn";
2
3
// define the color defaults for everything
4
export const ThemeDefaults = {
···
17
};
18
19
// used to calculate the contrast between page and accent1, accent2, and determin which is higher contrast
20
+
export function getColorContrast(color1: string, color2: string) {
21
ColorSpace.register(sRGB);
22
23
let parsedColor1 = parse(`rgb(${color1})`);
24
let parsedColor2 = parse(`rgb(${color2})`);
25
26
+
return contrastLstar(parsedColor1, parsedColor2);
27
}
+837
-829
lexicons/api/lexicons.ts
+837
-829
lexicons/api/lexicons.ts
···
6
Lexicons,
7
ValidationError,
8
type ValidationResult,
9
-
} from "@atproto/lexicon";
10
-
import { type $Typed, is$typed, maybe$typed } from "./util";
11
12
export const schemaDict = {
13
AppBskyActorProfile: {
14
lexicon: 1,
15
-
id: "app.bsky.actor.profile",
16
defs: {
17
main: {
18
-
type: "record",
19
-
description: "A declaration of a Bluesky account profile.",
20
-
key: "literal:self",
21
record: {
22
-
type: "object",
23
properties: {
24
displayName: {
25
-
type: "string",
26
maxGraphemes: 64,
27
maxLength: 640,
28
},
29
description: {
30
-
type: "string",
31
-
description: "Free-form profile description text.",
32
maxGraphemes: 256,
33
maxLength: 2560,
34
},
35
avatar: {
36
-
type: "blob",
37
description:
38
"Small image to be displayed next to posts from account. AKA, 'profile picture'",
39
-
accept: ["image/png", "image/jpeg"],
40
maxSize: 1000000,
41
},
42
banner: {
43
-
type: "blob",
44
description:
45
-
"Larger horizontal image to display behind profile view.",
46
-
accept: ["image/png", "image/jpeg"],
47
maxSize: 1000000,
48
},
49
labels: {
50
-
type: "union",
51
description:
52
-
"Self-label values, specific to the Bluesky application, on the overall account.",
53
-
refs: ["lex:com.atproto.label.defs#selfLabels"],
54
},
55
joinedViaStarterPack: {
56
-
type: "ref",
57
-
ref: "lex:com.atproto.repo.strongRef",
58
},
59
pinnedPost: {
60
-
type: "ref",
61
-
ref: "lex:com.atproto.repo.strongRef",
62
},
63
createdAt: {
64
-
type: "string",
65
-
format: "datetime",
66
},
67
},
68
},
···
71
},
72
ComAtprotoLabelDefs: {
73
lexicon: 1,
74
-
id: "com.atproto.label.defs",
75
defs: {
76
label: {
77
-
type: "object",
78
description:
79
-
"Metadata tag on an atproto resource (eg, repo or record).",
80
-
required: ["src", "uri", "val", "cts"],
81
properties: {
82
ver: {
83
-
type: "integer",
84
-
description: "The AT Protocol version of the label object.",
85
},
86
src: {
87
-
type: "string",
88
-
format: "did",
89
-
description: "DID of the actor who created this label.",
90
},
91
uri: {
92
-
type: "string",
93
-
format: "uri",
94
description:
95
-
"AT URI of the record, repository (account), or other resource that this label applies to.",
96
},
97
cid: {
98
-
type: "string",
99
-
format: "cid",
100
description:
101
"Optionally, CID specifying the specific version of 'uri' resource this label applies to.",
102
},
103
val: {
104
-
type: "string",
105
maxLength: 128,
106
description:
107
-
"The short string name of the value or type of this label.",
108
},
109
neg: {
110
-
type: "boolean",
111
description:
112
-
"If true, this is a negation label, overwriting a previous label.",
113
},
114
cts: {
115
-
type: "string",
116
-
format: "datetime",
117
-
description: "Timestamp when this label was created.",
118
},
119
exp: {
120
-
type: "string",
121
-
format: "datetime",
122
description:
123
-
"Timestamp at which this label expires (no longer applies).",
124
},
125
sig: {
126
-
type: "bytes",
127
-
description: "Signature of dag-cbor encoded label.",
128
},
129
},
130
},
131
selfLabels: {
132
-
type: "object",
133
description:
134
-
"Metadata tags on an atproto record, published by the author within the record.",
135
-
required: ["values"],
136
properties: {
137
values: {
138
-
type: "array",
139
items: {
140
-
type: "ref",
141
-
ref: "lex:com.atproto.label.defs#selfLabel",
142
},
143
maxLength: 10,
144
},
145
},
146
},
147
selfLabel: {
148
-
type: "object",
149
description:
150
-
"Metadata tag on an atproto record, published by the author within the record. Note that schemas should use #selfLabels, not #selfLabel.",
151
-
required: ["val"],
152
properties: {
153
val: {
154
-
type: "string",
155
maxLength: 128,
156
description:
157
-
"The short string name of the value or type of this label.",
158
},
159
},
160
},
161
labelValueDefinition: {
162
-
type: "object",
163
description:
164
-
"Declares a label value and its expected interpretations and behaviors.",
165
-
required: ["identifier", "severity", "blurs", "locales"],
166
properties: {
167
identifier: {
168
-
type: "string",
169
description:
170
"The value of the label being defined. Must only include lowercase ascii and the '-' character ([a-z-]+).",
171
maxLength: 100,
172
maxGraphemes: 100,
173
},
174
severity: {
175
-
type: "string",
176
description:
177
"How should a client visually convey this label? 'inform' means neutral and informational; 'alert' means negative and warning; 'none' means show nothing.",
178
-
knownValues: ["inform", "alert", "none"],
179
},
180
blurs: {
181
-
type: "string",
182
description:
183
"What should this label hide in the UI, if applied? 'content' hides all of the target; 'media' hides the images/video/audio; 'none' hides nothing.",
184
-
knownValues: ["content", "media", "none"],
185
},
186
defaultSetting: {
187
-
type: "string",
188
-
description: "The default setting for this label.",
189
-
knownValues: ["ignore", "warn", "hide"],
190
-
default: "warn",
191
},
192
adultOnly: {
193
-
type: "boolean",
194
description:
195
-
"Does the user need to have adult content enabled in order to configure this label?",
196
},
197
locales: {
198
-
type: "array",
199
items: {
200
-
type: "ref",
201
-
ref: "lex:com.atproto.label.defs#labelValueDefinitionStrings",
202
},
203
},
204
},
205
},
206
labelValueDefinitionStrings: {
207
-
type: "object",
208
description:
209
-
"Strings which describe the label in the UI, localized into a specific language.",
210
-
required: ["lang", "name", "description"],
211
properties: {
212
lang: {
213
-
type: "string",
214
description:
215
-
"The code of the language these strings are written in.",
216
-
format: "language",
217
},
218
name: {
219
-
type: "string",
220
-
description: "A short human-readable name for the label.",
221
maxGraphemes: 64,
222
maxLength: 640,
223
},
224
description: {
225
-
type: "string",
226
description:
227
-
"A longer description of what the label means and why it might be applied.",
228
maxGraphemes: 10000,
229
maxLength: 100000,
230
},
231
},
232
},
233
labelValue: {
234
-
type: "string",
235
knownValues: [
236
-
"!hide",
237
-
"!no-promote",
238
-
"!warn",
239
-
"!no-unauthenticated",
240
-
"dmca-violation",
241
-
"doxxing",
242
-
"porn",
243
-
"sexual",
244
-
"nudity",
245
-
"nsfl",
246
-
"gore",
247
],
248
},
249
},
250
},
251
ComAtprotoRepoApplyWrites: {
252
lexicon: 1,
253
-
id: "com.atproto.repo.applyWrites",
254
defs: {
255
main: {
256
-
type: "procedure",
257
description:
258
-
"Apply a batch transaction of repository creates, updates, and deletes. Requires auth, implemented by PDS.",
259
input: {
260
-
encoding: "application/json",
261
schema: {
262
-
type: "object",
263
-
required: ["repo", "writes"],
264
properties: {
265
repo: {
266
-
type: "string",
267
-
format: "at-identifier",
268
description:
269
-
"The handle or DID of the repo (aka, current account).",
270
},
271
validate: {
272
-
type: "boolean",
273
description:
274
"Can be set to 'false' to skip Lexicon schema validation of record data across all operations, 'true' to require it, or leave unset to validate only for known Lexicons.",
275
},
276
writes: {
277
-
type: "array",
278
items: {
279
-
type: "union",
280
refs: [
281
-
"lex:com.atproto.repo.applyWrites#create",
282
-
"lex:com.atproto.repo.applyWrites#update",
283
-
"lex:com.atproto.repo.applyWrites#delete",
284
],
285
closed: true,
286
},
287
},
288
swapCommit: {
289
-
type: "string",
290
description:
291
-
"If provided, the entire operation will fail if the current repo commit CID does not match this value. Used to prevent conflicting repo mutations.",
292
-
format: "cid",
293
},
294
},
295
},
296
},
297
output: {
298
-
encoding: "application/json",
299
schema: {
300
-
type: "object",
301
required: [],
302
properties: {
303
commit: {
304
-
type: "ref",
305
-
ref: "lex:com.atproto.repo.defs#commitMeta",
306
},
307
results: {
308
-
type: "array",
309
items: {
310
-
type: "union",
311
refs: [
312
-
"lex:com.atproto.repo.applyWrites#createResult",
313
-
"lex:com.atproto.repo.applyWrites#updateResult",
314
-
"lex:com.atproto.repo.applyWrites#deleteResult",
315
],
316
closed: true,
317
},
···
321
},
322
errors: [
323
{
324
-
name: "InvalidSwap",
325
description:
326
"Indicates that the 'swapCommit' parameter did not match current commit.",
327
},
328
],
329
},
330
create: {
331
-
type: "object",
332
-
description: "Operation which creates a new record.",
333
-
required: ["collection", "value"],
334
properties: {
335
collection: {
336
-
type: "string",
337
-
format: "nsid",
338
},
339
rkey: {
340
-
type: "string",
341
maxLength: 512,
342
-
format: "record-key",
343
description:
344
-
"NOTE: maxLength is redundant with record-key format. Keeping it temporarily to ensure backwards compatibility.",
345
},
346
value: {
347
-
type: "unknown",
348
},
349
},
350
},
351
update: {
352
-
type: "object",
353
-
description: "Operation which updates an existing record.",
354
-
required: ["collection", "rkey", "value"],
355
properties: {
356
collection: {
357
-
type: "string",
358
-
format: "nsid",
359
},
360
rkey: {
361
-
type: "string",
362
-
format: "record-key",
363
},
364
value: {
365
-
type: "unknown",
366
},
367
},
368
},
369
delete: {
370
-
type: "object",
371
-
description: "Operation which deletes an existing record.",
372
-
required: ["collection", "rkey"],
373
properties: {
374
collection: {
375
-
type: "string",
376
-
format: "nsid",
377
},
378
rkey: {
379
-
type: "string",
380
-
format: "record-key",
381
},
382
},
383
},
384
createResult: {
385
-
type: "object",
386
-
required: ["uri", "cid"],
387
properties: {
388
uri: {
389
-
type: "string",
390
-
format: "at-uri",
391
},
392
cid: {
393
-
type: "string",
394
-
format: "cid",
395
},
396
validationStatus: {
397
-
type: "string",
398
-
knownValues: ["valid", "unknown"],
399
},
400
},
401
},
402
updateResult: {
403
-
type: "object",
404
-
required: ["uri", "cid"],
405
properties: {
406
uri: {
407
-
type: "string",
408
-
format: "at-uri",
409
},
410
cid: {
411
-
type: "string",
412
-
format: "cid",
413
},
414
validationStatus: {
415
-
type: "string",
416
-
knownValues: ["valid", "unknown"],
417
},
418
},
419
},
420
deleteResult: {
421
-
type: "object",
422
required: [],
423
properties: {},
424
},
···
426
},
427
ComAtprotoRepoCreateRecord: {
428
lexicon: 1,
429
-
id: "com.atproto.repo.createRecord",
430
defs: {
431
main: {
432
-
type: "procedure",
433
description:
434
-
"Create a single new repository record. Requires auth, implemented by PDS.",
435
input: {
436
-
encoding: "application/json",
437
schema: {
438
-
type: "object",
439
-
required: ["repo", "collection", "record"],
440
properties: {
441
repo: {
442
-
type: "string",
443
-
format: "at-identifier",
444
description:
445
-
"The handle or DID of the repo (aka, current account).",
446
},
447
collection: {
448
-
type: "string",
449
-
format: "nsid",
450
-
description: "The NSID of the record collection.",
451
},
452
rkey: {
453
-
type: "string",
454
-
format: "record-key",
455
-
description: "The Record Key.",
456
maxLength: 512,
457
},
458
validate: {
459
-
type: "boolean",
460
description:
461
"Can be set to 'false' to skip Lexicon schema validation of record data, 'true' to require it, or leave unset to validate only for known Lexicons.",
462
},
463
record: {
464
-
type: "unknown",
465
-
description: "The record itself. Must contain a $type field.",
466
},
467
swapCommit: {
468
-
type: "string",
469
-
format: "cid",
470
description:
471
-
"Compare and swap with the previous commit by CID.",
472
},
473
},
474
},
475
},
476
output: {
477
-
encoding: "application/json",
478
schema: {
479
-
type: "object",
480
-
required: ["uri", "cid"],
481
properties: {
482
uri: {
483
-
type: "string",
484
-
format: "at-uri",
485
},
486
cid: {
487
-
type: "string",
488
-
format: "cid",
489
},
490
commit: {
491
-
type: "ref",
492
-
ref: "lex:com.atproto.repo.defs#commitMeta",
493
},
494
validationStatus: {
495
-
type: "string",
496
-
knownValues: ["valid", "unknown"],
497
},
498
},
499
},
500
},
501
errors: [
502
{
503
-
name: "InvalidSwap",
504
description:
505
"Indicates that 'swapCommit' didn't match current repo commit.",
506
},
···
510
},
511
ComAtprotoRepoDefs: {
512
lexicon: 1,
513
-
id: "com.atproto.repo.defs",
514
defs: {
515
commitMeta: {
516
-
type: "object",
517
-
required: ["cid", "rev"],
518
properties: {
519
cid: {
520
-
type: "string",
521
-
format: "cid",
522
},
523
rev: {
524
-
type: "string",
525
-
format: "tid",
526
},
527
},
528
},
···
530
},
531
ComAtprotoRepoDeleteRecord: {
532
lexicon: 1,
533
-
id: "com.atproto.repo.deleteRecord",
534
defs: {
535
main: {
536
-
type: "procedure",
537
description:
538
"Delete a repository record, or ensure it doesn't exist. Requires auth, implemented by PDS.",
539
input: {
540
-
encoding: "application/json",
541
schema: {
542
-
type: "object",
543
-
required: ["repo", "collection", "rkey"],
544
properties: {
545
repo: {
546
-
type: "string",
547
-
format: "at-identifier",
548
description:
549
-
"The handle or DID of the repo (aka, current account).",
550
},
551
collection: {
552
-
type: "string",
553
-
format: "nsid",
554
-
description: "The NSID of the record collection.",
555
},
556
rkey: {
557
-
type: "string",
558
-
format: "record-key",
559
-
description: "The Record Key.",
560
},
561
swapRecord: {
562
-
type: "string",
563
-
format: "cid",
564
description:
565
-
"Compare and swap with the previous record by CID.",
566
},
567
swapCommit: {
568
-
type: "string",
569
-
format: "cid",
570
description:
571
-
"Compare and swap with the previous commit by CID.",
572
},
573
},
574
},
575
},
576
output: {
577
-
encoding: "application/json",
578
schema: {
579
-
type: "object",
580
properties: {
581
commit: {
582
-
type: "ref",
583
-
ref: "lex:com.atproto.repo.defs#commitMeta",
584
},
585
},
586
},
587
},
588
errors: [
589
{
590
-
name: "InvalidSwap",
591
},
592
],
593
},
···
595
},
596
ComAtprotoRepoDescribeRepo: {
597
lexicon: 1,
598
-
id: "com.atproto.repo.describeRepo",
599
defs: {
600
main: {
601
-
type: "query",
602
description:
603
-
"Get information about an account and repository, including the list of collections. Does not require auth.",
604
parameters: {
605
-
type: "params",
606
-
required: ["repo"],
607
properties: {
608
repo: {
609
-
type: "string",
610
-
format: "at-identifier",
611
-
description: "The handle or DID of the repo.",
612
},
613
},
614
},
615
output: {
616
-
encoding: "application/json",
617
schema: {
618
-
type: "object",
619
required: [
620
-
"handle",
621
-
"did",
622
-
"didDoc",
623
-
"collections",
624
-
"handleIsCorrect",
625
],
626
properties: {
627
handle: {
628
-
type: "string",
629
-
format: "handle",
630
},
631
did: {
632
-
type: "string",
633
-
format: "did",
634
},
635
didDoc: {
636
-
type: "unknown",
637
-
description: "The complete DID document for this account.",
638
},
639
collections: {
640
-
type: "array",
641
description:
642
-
"List of all the collections (NSIDs) for which this repo contains at least one record.",
643
items: {
644
-
type: "string",
645
-
format: "nsid",
646
},
647
},
648
handleIsCorrect: {
649
-
type: "boolean",
650
description:
651
-
"Indicates if handle is currently valid (resolves bi-directionally)",
652
},
653
},
654
},
···
658
},
659
ComAtprotoRepoGetRecord: {
660
lexicon: 1,
661
-
id: "com.atproto.repo.getRecord",
662
defs: {
663
main: {
664
-
type: "query",
665
description:
666
-
"Get a single record from a repository. Does not require auth.",
667
parameters: {
668
-
type: "params",
669
-
required: ["repo", "collection", "rkey"],
670
properties: {
671
repo: {
672
-
type: "string",
673
-
format: "at-identifier",
674
-
description: "The handle or DID of the repo.",
675
},
676
collection: {
677
-
type: "string",
678
-
format: "nsid",
679
-
description: "The NSID of the record collection.",
680
},
681
rkey: {
682
-
type: "string",
683
-
description: "The Record Key.",
684
-
format: "record-key",
685
},
686
cid: {
687
-
type: "string",
688
-
format: "cid",
689
description:
690
-
"The CID of the version of the record. If not specified, then return the most recent version.",
691
},
692
},
693
},
694
output: {
695
-
encoding: "application/json",
696
schema: {
697
-
type: "object",
698
-
required: ["uri", "value"],
699
properties: {
700
uri: {
701
-
type: "string",
702
-
format: "at-uri",
703
},
704
cid: {
705
-
type: "string",
706
-
format: "cid",
707
},
708
value: {
709
-
type: "unknown",
710
},
711
},
712
},
713
},
714
errors: [
715
{
716
-
name: "RecordNotFound",
717
},
718
],
719
},
···
721
},
722
ComAtprotoRepoImportRepo: {
723
lexicon: 1,
724
-
id: "com.atproto.repo.importRepo",
725
defs: {
726
main: {
727
-
type: "procedure",
728
description:
729
-
"Import a repo in the form of a CAR file. Requires Content-Length HTTP header to be set.",
730
input: {
731
-
encoding: "application/vnd.ipld.car",
732
},
733
},
734
},
735
},
736
ComAtprotoRepoListMissingBlobs: {
737
lexicon: 1,
738
-
id: "com.atproto.repo.listMissingBlobs",
739
defs: {
740
main: {
741
-
type: "query",
742
description:
743
-
"Returns a list of missing blobs for the requesting account. Intended to be used in the account migration flow.",
744
parameters: {
745
-
type: "params",
746
properties: {
747
limit: {
748
-
type: "integer",
749
minimum: 1,
750
maximum: 1000,
751
default: 500,
752
},
753
cursor: {
754
-
type: "string",
755
},
756
},
757
},
758
output: {
759
-
encoding: "application/json",
760
schema: {
761
-
type: "object",
762
-
required: ["blobs"],
763
properties: {
764
cursor: {
765
-
type: "string",
766
},
767
blobs: {
768
-
type: "array",
769
items: {
770
-
type: "ref",
771
-
ref: "lex:com.atproto.repo.listMissingBlobs#recordBlob",
772
},
773
},
774
},
···
776
},
777
},
778
recordBlob: {
779
-
type: "object",
780
-
required: ["cid", "recordUri"],
781
properties: {
782
cid: {
783
-
type: "string",
784
-
format: "cid",
785
},
786
recordUri: {
787
-
type: "string",
788
-
format: "at-uri",
789
},
790
},
791
},
···
793
},
794
ComAtprotoRepoListRecords: {
795
lexicon: 1,
796
-
id: "com.atproto.repo.listRecords",
797
defs: {
798
main: {
799
-
type: "query",
800
description:
801
-
"List a range of records in a repository, matching a specific collection. Does not require auth.",
802
parameters: {
803
-
type: "params",
804
-
required: ["repo", "collection"],
805
properties: {
806
repo: {
807
-
type: "string",
808
-
format: "at-identifier",
809
-
description: "The handle or DID of the repo.",
810
},
811
collection: {
812
-
type: "string",
813
-
format: "nsid",
814
-
description: "The NSID of the record type.",
815
},
816
limit: {
817
-
type: "integer",
818
minimum: 1,
819
maximum: 100,
820
default: 50,
821
-
description: "The number of records to return.",
822
},
823
cursor: {
824
-
type: "string",
825
},
826
rkeyStart: {
827
-
type: "string",
828
description:
829
-
"DEPRECATED: The lowest sort-ordered rkey to start from (exclusive)",
830
},
831
rkeyEnd: {
832
-
type: "string",
833
description:
834
-
"DEPRECATED: The highest sort-ordered rkey to stop at (exclusive)",
835
},
836
reverse: {
837
-
type: "boolean",
838
-
description: "Flag to reverse the order of the returned records.",
839
},
840
},
841
},
842
output: {
843
-
encoding: "application/json",
844
schema: {
845
-
type: "object",
846
-
required: ["records"],
847
properties: {
848
cursor: {
849
-
type: "string",
850
},
851
records: {
852
-
type: "array",
853
items: {
854
-
type: "ref",
855
-
ref: "lex:com.atproto.repo.listRecords#record",
856
},
857
},
858
},
···
860
},
861
},
862
record: {
863
-
type: "object",
864
-
required: ["uri", "cid", "value"],
865
properties: {
866
uri: {
867
-
type: "string",
868
-
format: "at-uri",
869
},
870
cid: {
871
-
type: "string",
872
-
format: "cid",
873
},
874
value: {
875
-
type: "unknown",
876
},
877
},
878
},
···
880
},
881
ComAtprotoRepoPutRecord: {
882
lexicon: 1,
883
-
id: "com.atproto.repo.putRecord",
884
defs: {
885
main: {
886
-
type: "procedure",
887
description:
888
-
"Write a repository record, creating or updating it as needed. Requires auth, implemented by PDS.",
889
input: {
890
-
encoding: "application/json",
891
schema: {
892
-
type: "object",
893
-
required: ["repo", "collection", "rkey", "record"],
894
-
nullable: ["swapRecord"],
895
properties: {
896
repo: {
897
-
type: "string",
898
-
format: "at-identifier",
899
description:
900
-
"The handle or DID of the repo (aka, current account).",
901
},
902
collection: {
903
-
type: "string",
904
-
format: "nsid",
905
-
description: "The NSID of the record collection.",
906
},
907
rkey: {
908
-
type: "string",
909
-
format: "record-key",
910
-
description: "The Record Key.",
911
maxLength: 512,
912
},
913
validate: {
914
-
type: "boolean",
915
description:
916
"Can be set to 'false' to skip Lexicon schema validation of record data, 'true' to require it, or leave unset to validate only for known Lexicons.",
917
},
918
record: {
919
-
type: "unknown",
920
-
description: "The record to write.",
921
},
922
swapRecord: {
923
-
type: "string",
924
-
format: "cid",
925
description:
926
-
"Compare and swap with the previous record by CID. WARNING: nullable and optional field; may cause problems with golang implementation",
927
},
928
swapCommit: {
929
-
type: "string",
930
-
format: "cid",
931
description:
932
-
"Compare and swap with the previous commit by CID.",
933
},
934
},
935
},
936
},
937
output: {
938
-
encoding: "application/json",
939
schema: {
940
-
type: "object",
941
-
required: ["uri", "cid"],
942
properties: {
943
uri: {
944
-
type: "string",
945
-
format: "at-uri",
946
},
947
cid: {
948
-
type: "string",
949
-
format: "cid",
950
},
951
commit: {
952
-
type: "ref",
953
-
ref: "lex:com.atproto.repo.defs#commitMeta",
954
},
955
validationStatus: {
956
-
type: "string",
957
-
knownValues: ["valid", "unknown"],
958
},
959
},
960
},
961
},
962
errors: [
963
{
964
-
name: "InvalidSwap",
965
},
966
],
967
},
···
969
},
970
ComAtprotoRepoStrongRef: {
971
lexicon: 1,
972
-
id: "com.atproto.repo.strongRef",
973
-
description: "A URI with a content-hash fingerprint.",
974
defs: {
975
main: {
976
-
type: "object",
977
-
required: ["uri", "cid"],
978
properties: {
979
uri: {
980
-
type: "string",
981
-
format: "at-uri",
982
},
983
cid: {
984
-
type: "string",
985
-
format: "cid",
986
},
987
},
988
},
···
990
},
991
ComAtprotoRepoUploadBlob: {
992
lexicon: 1,
993
-
id: "com.atproto.repo.uploadBlob",
994
defs: {
995
main: {
996
-
type: "procedure",
997
description:
998
-
"Upload a new blob, to be referenced from a repository record. The blob will be deleted if it is not referenced within a time window (eg, minutes). Blob restrictions (mimetype, size, etc) are enforced when the reference is created. Requires auth, implemented by PDS.",
999
input: {
1000
-
encoding: "*/*",
1001
},
1002
output: {
1003
-
encoding: "application/json",
1004
schema: {
1005
-
type: "object",
1006
-
required: ["blob"],
1007
properties: {
1008
blob: {
1009
-
type: "blob",
1010
},
1011
},
1012
},
···
1016
},
1017
PubLeafletBlocksBlockquote: {
1018
lexicon: 1,
1019
-
id: "pub.leaflet.blocks.blockquote",
1020
defs: {
1021
main: {
1022
-
type: "object",
1023
-
required: ["plaintext"],
1024
properties: {
1025
plaintext: {
1026
-
type: "string",
1027
},
1028
facets: {
1029
-
type: "array",
1030
items: {
1031
-
type: "ref",
1032
-
ref: "lex:pub.leaflet.richtext.facet",
1033
},
1034
},
1035
},
···
1038
},
1039
PubLeafletBlocksBskyPost: {
1040
lexicon: 1,
1041
-
id: "pub.leaflet.blocks.bskyPost",
1042
defs: {
1043
main: {
1044
-
type: "object",
1045
-
required: ["postRef"],
1046
properties: {
1047
postRef: {
1048
-
type: "ref",
1049
-
ref: "lex:com.atproto.repo.strongRef",
1050
},
1051
},
1052
},
···
1054
},
1055
PubLeafletBlocksButton: {
1056
lexicon: 1,
1057
-
id: "pub.leaflet.blocks.button",
1058
defs: {
1059
main: {
1060
-
type: "object",
1061
-
required: ["text", "url"],
1062
properties: {
1063
text: {
1064
-
type: "string",
1065
},
1066
url: {
1067
-
type: "string",
1068
-
format: "uri",
1069
},
1070
},
1071
},
···
1073
},
1074
PubLeafletBlocksCode: {
1075
lexicon: 1,
1076
-
id: "pub.leaflet.blocks.code",
1077
defs: {
1078
main: {
1079
-
type: "object",
1080
-
required: ["plaintext"],
1081
properties: {
1082
plaintext: {
1083
-
type: "string",
1084
},
1085
language: {
1086
-
type: "string",
1087
},
1088
syntaxHighlightingTheme: {
1089
-
type: "string",
1090
},
1091
},
1092
},
···
1094
},
1095
PubLeafletBlocksHeader: {
1096
lexicon: 1,
1097
-
id: "pub.leaflet.blocks.header",
1098
defs: {
1099
main: {
1100
-
type: "object",
1101
-
required: ["plaintext"],
1102
properties: {
1103
level: {
1104
-
type: "integer",
1105
minimum: 1,
1106
maximum: 6,
1107
},
1108
plaintext: {
1109
-
type: "string",
1110
},
1111
facets: {
1112
-
type: "array",
1113
items: {
1114
-
type: "ref",
1115
-
ref: "lex:pub.leaflet.richtext.facet",
1116
},
1117
},
1118
},
···
1121
},
1122
PubLeafletBlocksHorizontalRule: {
1123
lexicon: 1,
1124
-
id: "pub.leaflet.blocks.horizontalRule",
1125
defs: {
1126
main: {
1127
-
type: "object",
1128
required: [],
1129
properties: {},
1130
},
···
1132
},
1133
PubLeafletBlocksIframe: {
1134
lexicon: 1,
1135
-
id: "pub.leaflet.blocks.iframe",
1136
defs: {
1137
main: {
1138
-
type: "object",
1139
-
required: ["url"],
1140
properties: {
1141
url: {
1142
-
type: "string",
1143
-
format: "uri",
1144
},
1145
height: {
1146
-
type: "integer",
1147
minimum: 16,
1148
maximum: 1600,
1149
},
···
1153
},
1154
PubLeafletBlocksImage: {
1155
lexicon: 1,
1156
-
id: "pub.leaflet.blocks.image",
1157
defs: {
1158
main: {
1159
-
type: "object",
1160
-
required: ["image", "aspectRatio"],
1161
properties: {
1162
image: {
1163
-
type: "blob",
1164
-
accept: ["image/*"],
1165
maxSize: 1000000,
1166
},
1167
alt: {
1168
-
type: "string",
1169
description:
1170
-
"Alt text description of the image, for accessibility.",
1171
},
1172
aspectRatio: {
1173
-
type: "ref",
1174
-
ref: "lex:pub.leaflet.blocks.image#aspectRatio",
1175
},
1176
},
1177
},
1178
aspectRatio: {
1179
-
type: "object",
1180
-
required: ["width", "height"],
1181
properties: {
1182
width: {
1183
-
type: "integer",
1184
},
1185
height: {
1186
-
type: "integer",
1187
},
1188
},
1189
},
···
1191
},
1192
PubLeafletBlocksMath: {
1193
lexicon: 1,
1194
-
id: "pub.leaflet.blocks.math",
1195
defs: {
1196
main: {
1197
-
type: "object",
1198
-
required: ["tex"],
1199
properties: {
1200
tex: {
1201
-
type: "string",
1202
},
1203
},
1204
},
···
1206
},
1207
PubLeafletBlocksPage: {
1208
lexicon: 1,
1209
-
id: "pub.leaflet.blocks.page",
1210
defs: {
1211
main: {
1212
-
type: "object",
1213
-
required: ["id"],
1214
properties: {
1215
id: {
1216
-
type: "string",
1217
},
1218
},
1219
},
···
1221
},
1222
PubLeafletBlocksPoll: {
1223
lexicon: 1,
1224
-
id: "pub.leaflet.blocks.poll",
1225
defs: {
1226
main: {
1227
-
type: "object",
1228
-
required: ["pollRef"],
1229
properties: {
1230
pollRef: {
1231
-
type: "ref",
1232
-
ref: "lex:com.atproto.repo.strongRef",
1233
},
1234
},
1235
},
···
1237
},
1238
PubLeafletBlocksText: {
1239
lexicon: 1,
1240
-
id: "pub.leaflet.blocks.text",
1241
defs: {
1242
main: {
1243
-
type: "object",
1244
-
required: ["plaintext"],
1245
properties: {
1246
plaintext: {
1247
-
type: "string",
1248
},
1249
facets: {
1250
-
type: "array",
1251
items: {
1252
-
type: "ref",
1253
-
ref: "lex:pub.leaflet.richtext.facet",
1254
},
1255
},
1256
},
···
1259
},
1260
PubLeafletBlocksUnorderedList: {
1261
lexicon: 1,
1262
-
id: "pub.leaflet.blocks.unorderedList",
1263
defs: {
1264
main: {
1265
-
type: "object",
1266
-
required: ["children"],
1267
properties: {
1268
children: {
1269
-
type: "array",
1270
items: {
1271
-
type: "ref",
1272
-
ref: "lex:pub.leaflet.blocks.unorderedList#listItem",
1273
},
1274
},
1275
},
1276
},
1277
listItem: {
1278
-
type: "object",
1279
-
required: ["content"],
1280
properties: {
1281
content: {
1282
-
type: "union",
1283
refs: [
1284
-
"lex:pub.leaflet.blocks.text",
1285
-
"lex:pub.leaflet.blocks.header",
1286
-
"lex:pub.leaflet.blocks.image",
1287
],
1288
},
1289
children: {
1290
-
type: "array",
1291
items: {
1292
-
type: "ref",
1293
-
ref: "lex:pub.leaflet.blocks.unorderedList#listItem",
1294
},
1295
},
1296
},
···
1299
},
1300
PubLeafletBlocksWebsite: {
1301
lexicon: 1,
1302
-
id: "pub.leaflet.blocks.website",
1303
defs: {
1304
main: {
1305
-
type: "object",
1306
-
required: ["src"],
1307
properties: {
1308
previewImage: {
1309
-
type: "blob",
1310
-
accept: ["image/*"],
1311
maxSize: 1000000,
1312
},
1313
title: {
1314
-
type: "string",
1315
},
1316
description: {
1317
-
type: "string",
1318
},
1319
src: {
1320
-
type: "string",
1321
-
format: "uri",
1322
},
1323
},
1324
},
···
1326
},
1327
PubLeafletComment: {
1328
lexicon: 1,
1329
-
id: "pub.leaflet.comment",
1330
revision: 1,
1331
-
description: "A lexicon for comments on documents",
1332
defs: {
1333
main: {
1334
-
type: "record",
1335
-
key: "tid",
1336
-
description: "Record containing a comment",
1337
record: {
1338
-
type: "object",
1339
-
required: ["subject", "plaintext", "createdAt"],
1340
properties: {
1341
subject: {
1342
-
type: "string",
1343
-
format: "at-uri",
1344
},
1345
createdAt: {
1346
-
type: "string",
1347
-
format: "datetime",
1348
},
1349
reply: {
1350
-
type: "ref",
1351
-
ref: "lex:pub.leaflet.comment#replyRef",
1352
},
1353
plaintext: {
1354
-
type: "string",
1355
},
1356
facets: {
1357
-
type: "array",
1358
items: {
1359
-
type: "ref",
1360
-
ref: "lex:pub.leaflet.richtext.facet",
1361
},
1362
},
1363
onPage: {
1364
-
type: "string",
1365
},
1366
attachment: {
1367
-
type: "union",
1368
-
refs: ["lex:pub.leaflet.comment#linearDocumentQuote"],
1369
},
1370
},
1371
},
1372
},
1373
linearDocumentQuote: {
1374
-
type: "object",
1375
-
required: ["document", "quote"],
1376
properties: {
1377
document: {
1378
-
type: "string",
1379
-
format: "at-uri",
1380
},
1381
quote: {
1382
-
type: "ref",
1383
-
ref: "lex:pub.leaflet.pages.linearDocument#quote",
1384
},
1385
},
1386
},
1387
replyRef: {
1388
-
type: "object",
1389
-
required: ["parent"],
1390
properties: {
1391
parent: {
1392
-
type: "string",
1393
-
format: "at-uri",
1394
},
1395
},
1396
},
···
1398
},
1399
PubLeafletDocument: {
1400
lexicon: 1,
1401
-
id: "pub.leaflet.document",
1402
revision: 1,
1403
-
description: "A lexicon for long form rich media documents",
1404
defs: {
1405
main: {
1406
-
type: "record",
1407
-
key: "tid",
1408
-
description: "Record containing a document",
1409
record: {
1410
-
type: "object",
1411
-
required: ["pages", "author", "title"],
1412
properties: {
1413
title: {
1414
-
type: "string",
1415
maxLength: 1280,
1416
maxGraphemes: 128,
1417
},
1418
postRef: {
1419
-
type: "ref",
1420
-
ref: "lex:com.atproto.repo.strongRef",
1421
},
1422
description: {
1423
-
type: "string",
1424
maxLength: 3000,
1425
maxGraphemes: 300,
1426
},
1427
publishedAt: {
1428
-
type: "string",
1429
-
format: "datetime",
1430
},
1431
publication: {
1432
-
type: "string",
1433
-
format: "at-uri",
1434
},
1435
author: {
1436
-
type: "string",
1437
-
format: "at-identifier",
1438
},
1439
theme: {
1440
-
type: "ref",
1441
-
ref: "lex:pub.leaflet.publication#theme",
1442
},
1443
tags: {
1444
-
type: "array",
1445
items: {
1446
-
type: "string",
1447
maxLength: 50,
1448
},
1449
},
1450
coverImage: {
1451
-
type: "blob",
1452
-
accept: ["image/png", "image/jpeg", "image/webp"],
1453
maxSize: 1000000,
1454
},
1455
pages: {
1456
-
type: "array",
1457
items: {
1458
-
type: "union",
1459
refs: [
1460
-
"lex:pub.leaflet.pages.linearDocument",
1461
-
"lex:pub.leaflet.pages.canvas",
1462
],
1463
},
1464
},
···
1469
},
1470
PubLeafletGraphSubscription: {
1471
lexicon: 1,
1472
-
id: "pub.leaflet.graph.subscription",
1473
defs: {
1474
main: {
1475
-
type: "record",
1476
-
key: "tid",
1477
-
description: "Record declaring a subscription to a publication",
1478
record: {
1479
-
type: "object",
1480
-
required: ["publication"],
1481
properties: {
1482
publication: {
1483
-
type: "string",
1484
-
format: "at-uri",
1485
},
1486
},
1487
},
···
1490
},
1491
PubLeafletPagesCanvas: {
1492
lexicon: 1,
1493
-
id: "pub.leaflet.pages.canvas",
1494
defs: {
1495
main: {
1496
-
type: "object",
1497
-
required: ["blocks"],
1498
properties: {
1499
id: {
1500
-
type: "string",
1501
},
1502
blocks: {
1503
-
type: "array",
1504
items: {
1505
-
type: "ref",
1506
-
ref: "lex:pub.leaflet.pages.canvas#block",
1507
},
1508
},
1509
},
1510
},
1511
block: {
1512
-
type: "object",
1513
-
required: ["block", "x", "y", "width"],
1514
properties: {
1515
block: {
1516
-
type: "union",
1517
refs: [
1518
-
"lex:pub.leaflet.blocks.iframe",
1519
-
"lex:pub.leaflet.blocks.text",
1520
-
"lex:pub.leaflet.blocks.blockquote",
1521
-
"lex:pub.leaflet.blocks.header",
1522
-
"lex:pub.leaflet.blocks.image",
1523
-
"lex:pub.leaflet.blocks.unorderedList",
1524
-
"lex:pub.leaflet.blocks.website",
1525
-
"lex:pub.leaflet.blocks.math",
1526
-
"lex:pub.leaflet.blocks.code",
1527
-
"lex:pub.leaflet.blocks.horizontalRule",
1528
-
"lex:pub.leaflet.blocks.bskyPost",
1529
-
"lex:pub.leaflet.blocks.page",
1530
-
"lex:pub.leaflet.blocks.poll",
1531
-
"lex:pub.leaflet.blocks.button",
1532
],
1533
},
1534
x: {
1535
-
type: "integer",
1536
},
1537
y: {
1538
-
type: "integer",
1539
},
1540
width: {
1541
-
type: "integer",
1542
},
1543
height: {
1544
-
type: "integer",
1545
},
1546
rotation: {
1547
-
type: "integer",
1548
-
description: "The rotation of the block in degrees",
1549
},
1550
},
1551
},
1552
textAlignLeft: {
1553
-
type: "token",
1554
},
1555
textAlignCenter: {
1556
-
type: "token",
1557
},
1558
textAlignRight: {
1559
-
type: "token",
1560
},
1561
quote: {
1562
-
type: "object",
1563
-
required: ["start", "end"],
1564
properties: {
1565
start: {
1566
-
type: "ref",
1567
-
ref: "lex:pub.leaflet.pages.canvas#position",
1568
},
1569
end: {
1570
-
type: "ref",
1571
-
ref: "lex:pub.leaflet.pages.canvas#position",
1572
},
1573
},
1574
},
1575
position: {
1576
-
type: "object",
1577
-
required: ["block", "offset"],
1578
properties: {
1579
block: {
1580
-
type: "array",
1581
items: {
1582
-
type: "integer",
1583
},
1584
},
1585
offset: {
1586
-
type: "integer",
1587
},
1588
},
1589
},
···
1591
},
1592
PubLeafletPagesLinearDocument: {
1593
lexicon: 1,
1594
-
id: "pub.leaflet.pages.linearDocument",
1595
defs: {
1596
main: {
1597
-
type: "object",
1598
-
required: ["blocks"],
1599
properties: {
1600
id: {
1601
-
type: "string",
1602
},
1603
blocks: {
1604
-
type: "array",
1605
items: {
1606
-
type: "ref",
1607
-
ref: "lex:pub.leaflet.pages.linearDocument#block",
1608
},
1609
},
1610
},
1611
},
1612
block: {
1613
-
type: "object",
1614
-
required: ["block"],
1615
properties: {
1616
block: {
1617
-
type: "union",
1618
refs: [
1619
-
"lex:pub.leaflet.blocks.iframe",
1620
-
"lex:pub.leaflet.blocks.text",
1621
-
"lex:pub.leaflet.blocks.blockquote",
1622
-
"lex:pub.leaflet.blocks.header",
1623
-
"lex:pub.leaflet.blocks.image",
1624
-
"lex:pub.leaflet.blocks.unorderedList",
1625
-
"lex:pub.leaflet.blocks.website",
1626
-
"lex:pub.leaflet.blocks.math",
1627
-
"lex:pub.leaflet.blocks.code",
1628
-
"lex:pub.leaflet.blocks.horizontalRule",
1629
-
"lex:pub.leaflet.blocks.bskyPost",
1630
-
"lex:pub.leaflet.blocks.page",
1631
-
"lex:pub.leaflet.blocks.poll",
1632
-
"lex:pub.leaflet.blocks.button",
1633
],
1634
},
1635
alignment: {
1636
-
type: "string",
1637
knownValues: [
1638
-
"lex:pub.leaflet.pages.linearDocument#textAlignLeft",
1639
-
"lex:pub.leaflet.pages.linearDocument#textAlignCenter",
1640
-
"lex:pub.leaflet.pages.linearDocument#textAlignRight",
1641
-
"lex:pub.leaflet.pages.linearDocument#textAlignJustify",
1642
],
1643
},
1644
},
1645
},
1646
textAlignLeft: {
1647
-
type: "token",
1648
},
1649
textAlignCenter: {
1650
-
type: "token",
1651
},
1652
textAlignRight: {
1653
-
type: "token",
1654
},
1655
textAlignJustify: {
1656
-
type: "token",
1657
},
1658
quote: {
1659
-
type: "object",
1660
-
required: ["start", "end"],
1661
properties: {
1662
start: {
1663
-
type: "ref",
1664
-
ref: "lex:pub.leaflet.pages.linearDocument#position",
1665
},
1666
end: {
1667
-
type: "ref",
1668
-
ref: "lex:pub.leaflet.pages.linearDocument#position",
1669
},
1670
},
1671
},
1672
position: {
1673
-
type: "object",
1674
-
required: ["block", "offset"],
1675
properties: {
1676
block: {
1677
-
type: "array",
1678
items: {
1679
-
type: "integer",
1680
},
1681
},
1682
offset: {
1683
-
type: "integer",
1684
},
1685
},
1686
},
···
1688
},
1689
PubLeafletPollDefinition: {
1690
lexicon: 1,
1691
-
id: "pub.leaflet.poll.definition",
1692
defs: {
1693
main: {
1694
-
type: "record",
1695
-
key: "tid",
1696
-
description: "Record declaring a poll",
1697
record: {
1698
-
type: "object",
1699
-
required: ["name", "options"],
1700
properties: {
1701
name: {
1702
-
type: "string",
1703
maxLength: 500,
1704
maxGraphemes: 100,
1705
},
1706
options: {
1707
-
type: "array",
1708
items: {
1709
-
type: "ref",
1710
-
ref: "lex:pub.leaflet.poll.definition#option",
1711
},
1712
},
1713
endDate: {
1714
-
type: "string",
1715
-
format: "datetime",
1716
},
1717
},
1718
},
1719
},
1720
option: {
1721
-
type: "object",
1722
properties: {
1723
text: {
1724
-
type: "string",
1725
maxLength: 500,
1726
maxGraphemes: 50,
1727
},
···
1731
},
1732
PubLeafletPollVote: {
1733
lexicon: 1,
1734
-
id: "pub.leaflet.poll.vote",
1735
defs: {
1736
main: {
1737
-
type: "record",
1738
-
key: "tid",
1739
-
description: "Record declaring a vote on a poll",
1740
record: {
1741
-
type: "object",
1742
-
required: ["poll", "option"],
1743
properties: {
1744
poll: {
1745
-
type: "ref",
1746
-
ref: "lex:com.atproto.repo.strongRef",
1747
},
1748
option: {
1749
-
type: "array",
1750
items: {
1751
-
type: "string",
1752
},
1753
},
1754
},
···
1758
},
1759
PubLeafletPublication: {
1760
lexicon: 1,
1761
-
id: "pub.leaflet.publication",
1762
defs: {
1763
main: {
1764
-
type: "record",
1765
-
key: "tid",
1766
-
description: "Record declaring a publication",
1767
record: {
1768
-
type: "object",
1769
-
required: ["name"],
1770
properties: {
1771
name: {
1772
-
type: "string",
1773
maxLength: 2000,
1774
},
1775
base_path: {
1776
-
type: "string",
1777
},
1778
description: {
1779
-
type: "string",
1780
maxLength: 2000,
1781
},
1782
icon: {
1783
-
type: "blob",
1784
-
accept: ["image/*"],
1785
maxSize: 1000000,
1786
},
1787
theme: {
1788
-
type: "ref",
1789
-
ref: "lex:pub.leaflet.publication#theme",
1790
},
1791
preferences: {
1792
-
type: "ref",
1793
-
ref: "lex:pub.leaflet.publication#preferences",
1794
},
1795
},
1796
},
1797
},
1798
preferences: {
1799
-
type: "object",
1800
properties: {
1801
showInDiscover: {
1802
-
type: "boolean",
1803
default: true,
1804
},
1805
showComments: {
1806
-
type: "boolean",
1807
default: true,
1808
},
1809
},
1810
},
1811
theme: {
1812
-
type: "object",
1813
properties: {
1814
backgroundColor: {
1815
-
type: "union",
1816
refs: [
1817
-
"lex:pub.leaflet.theme.color#rgba",
1818
-
"lex:pub.leaflet.theme.color#rgb",
1819
],
1820
},
1821
backgroundImage: {
1822
-
type: "ref",
1823
-
ref: "lex:pub.leaflet.theme.backgroundImage",
1824
},
1825
pageWidth: {
1826
-
type: "integer",
1827
-
minimum: 320,
1828
-
maximum: 1200,
1829
},
1830
primary: {
1831
-
type: "union",
1832
refs: [
1833
-
"lex:pub.leaflet.theme.color#rgba",
1834
-
"lex:pub.leaflet.theme.color#rgb",
1835
],
1836
},
1837
pageBackground: {
1838
-
type: "union",
1839
refs: [
1840
-
"lex:pub.leaflet.theme.color#rgba",
1841
-
"lex:pub.leaflet.theme.color#rgb",
1842
],
1843
},
1844
showPageBackground: {
1845
-
type: "boolean",
1846
default: false,
1847
},
1848
accentBackground: {
1849
-
type: "union",
1850
refs: [
1851
-
"lex:pub.leaflet.theme.color#rgba",
1852
-
"lex:pub.leaflet.theme.color#rgb",
1853
],
1854
},
1855
accentText: {
1856
-
type: "union",
1857
refs: [
1858
-
"lex:pub.leaflet.theme.color#rgba",
1859
-
"lex:pub.leaflet.theme.color#rgb",
1860
],
1861
},
1862
},
···
1865
},
1866
PubLeafletRichtextFacet: {
1867
lexicon: 1,
1868
-
id: "pub.leaflet.richtext.facet",
1869
defs: {
1870
main: {
1871
-
type: "object",
1872
-
description: "Annotation of a sub-string within rich text.",
1873
-
required: ["index", "features"],
1874
properties: {
1875
index: {
1876
-
type: "ref",
1877
-
ref: "lex:pub.leaflet.richtext.facet#byteSlice",
1878
},
1879
features: {
1880
-
type: "array",
1881
items: {
1882
-
type: "union",
1883
refs: [
1884
-
"lex:pub.leaflet.richtext.facet#link",
1885
-
"lex:pub.leaflet.richtext.facet#didMention",
1886
-
"lex:pub.leaflet.richtext.facet#atMention",
1887
-
"lex:pub.leaflet.richtext.facet#code",
1888
-
"lex:pub.leaflet.richtext.facet#highlight",
1889
-
"lex:pub.leaflet.richtext.facet#underline",
1890
-
"lex:pub.leaflet.richtext.facet#strikethrough",
1891
-
"lex:pub.leaflet.richtext.facet#id",
1892
-
"lex:pub.leaflet.richtext.facet#bold",
1893
-
"lex:pub.leaflet.richtext.facet#italic",
1894
],
1895
},
1896
},
1897
},
1898
},
1899
byteSlice: {
1900
-
type: "object",
1901
description:
1902
-
"Specifies the sub-string range a facet feature applies to. Start index is inclusive, end index is exclusive. Indices are zero-indexed, counting bytes of the UTF-8 encoded text. NOTE: some languages, like Javascript, use UTF-16 or Unicode codepoints for string slice indexing; in these languages, convert to byte arrays before working with facets.",
1903
-
required: ["byteStart", "byteEnd"],
1904
properties: {
1905
byteStart: {
1906
-
type: "integer",
1907
minimum: 0,
1908
},
1909
byteEnd: {
1910
-
type: "integer",
1911
minimum: 0,
1912
},
1913
},
1914
},
1915
link: {
1916
-
type: "object",
1917
description:
1918
-
"Facet feature for a URL. The text URL may have been simplified or truncated, but the facet reference should be a complete URL.",
1919
-
required: ["uri"],
1920
properties: {
1921
uri: {
1922
-
type: "string",
1923
},
1924
},
1925
},
1926
didMention: {
1927
-
type: "object",
1928
-
description: "Facet feature for mentioning a did.",
1929
-
required: ["did"],
1930
properties: {
1931
did: {
1932
-
type: "string",
1933
-
format: "did",
1934
},
1935
},
1936
},
1937
atMention: {
1938
-
type: "object",
1939
-
description: "Facet feature for mentioning an AT URI.",
1940
-
required: ["atURI"],
1941
properties: {
1942
atURI: {
1943
-
type: "string",
1944
-
format: "uri",
1945
},
1946
},
1947
},
1948
code: {
1949
-
type: "object",
1950
-
description: "Facet feature for inline code.",
1951
required: [],
1952
properties: {},
1953
},
1954
highlight: {
1955
-
type: "object",
1956
-
description: "Facet feature for highlighted text.",
1957
required: [],
1958
properties: {},
1959
},
1960
underline: {
1961
-
type: "object",
1962
-
description: "Facet feature for underline markup",
1963
required: [],
1964
properties: {},
1965
},
1966
strikethrough: {
1967
-
type: "object",
1968
-
description: "Facet feature for strikethrough markup",
1969
required: [],
1970
properties: {},
1971
},
1972
id: {
1973
-
type: "object",
1974
description:
1975
-
"Facet feature for an identifier. Used for linking to a segment",
1976
required: [],
1977
properties: {
1978
id: {
1979
-
type: "string",
1980
},
1981
},
1982
},
1983
bold: {
1984
-
type: "object",
1985
-
description: "Facet feature for bold text",
1986
required: [],
1987
properties: {},
1988
},
1989
italic: {
1990
-
type: "object",
1991
-
description: "Facet feature for italic text",
1992
required: [],
1993
properties: {},
1994
},
···
1996
},
1997
PubLeafletThemeBackgroundImage: {
1998
lexicon: 1,
1999
-
id: "pub.leaflet.theme.backgroundImage",
2000
defs: {
2001
main: {
2002
-
type: "object",
2003
-
required: ["image"],
2004
properties: {
2005
image: {
2006
-
type: "blob",
2007
-
accept: ["image/*"],
2008
maxSize: 1000000,
2009
},
2010
width: {
2011
-
type: "integer",
2012
},
2013
repeat: {
2014
-
type: "boolean",
2015
},
2016
},
2017
},
···
2019
},
2020
PubLeafletThemeColor: {
2021
lexicon: 1,
2022
-
id: "pub.leaflet.theme.color",
2023
defs: {
2024
rgba: {
2025
-
type: "object",
2026
-
required: ["r", "g", "b", "a"],
2027
properties: {
2028
r: {
2029
-
type: "integer",
2030
maximum: 255,
2031
minimum: 0,
2032
},
2033
g: {
2034
-
type: "integer",
2035
maximum: 255,
2036
minimum: 0,
2037
},
2038
b: {
2039
-
type: "integer",
2040
maximum: 255,
2041
minimum: 0,
2042
},
2043
a: {
2044
-
type: "integer",
2045
maximum: 100,
2046
minimum: 0,
2047
},
2048
},
2049
},
2050
rgb: {
2051
-
type: "object",
2052
-
required: ["r", "g", "b"],
2053
properties: {
2054
r: {
2055
-
type: "integer",
2056
maximum: 255,
2057
minimum: 0,
2058
},
2059
g: {
2060
-
type: "integer",
2061
maximum: 255,
2062
minimum: 0,
2063
},
2064
b: {
2065
-
type: "integer",
2066
maximum: 255,
2067
minimum: 0,
2068
},
···
2070
},
2071
},
2072
},
2073
-
} as const satisfies Record<string, LexiconDoc>;
2074
-
export const schemas = Object.values(schemaDict) satisfies LexiconDoc[];
2075
-
export const lexicons: Lexicons = new Lexicons(schemas);
2076
2077
export function validate<T extends { $type: string }>(
2078
v: unknown,
2079
id: string,
2080
hash: string,
2081
requiredType: true,
2082
-
): ValidationResult<T>;
2083
export function validate<T extends { $type?: string }>(
2084
v: unknown,
2085
id: string,
2086
hash: string,
2087
requiredType?: false,
2088
-
): ValidationResult<T>;
2089
export function validate(
2090
v: unknown,
2091
id: string,
···
2097
: {
2098
success: false,
2099
error: new ValidationError(
2100
-
`Must be an object with "${hash === "main" ? id : `${id}#${hash}`}" $type property`,
2101
),
2102
-
};
2103
}
2104
2105
export const ids = {
2106
-
AppBskyActorProfile: "app.bsky.actor.profile",
2107
-
ComAtprotoLabelDefs: "com.atproto.label.defs",
2108
-
ComAtprotoRepoApplyWrites: "com.atproto.repo.applyWrites",
2109
-
ComAtprotoRepoCreateRecord: "com.atproto.repo.createRecord",
2110
-
ComAtprotoRepoDefs: "com.atproto.repo.defs",
2111
-
ComAtprotoRepoDeleteRecord: "com.atproto.repo.deleteRecord",
2112
-
ComAtprotoRepoDescribeRepo: "com.atproto.repo.describeRepo",
2113
-
ComAtprotoRepoGetRecord: "com.atproto.repo.getRecord",
2114
-
ComAtprotoRepoImportRepo: "com.atproto.repo.importRepo",
2115
-
ComAtprotoRepoListMissingBlobs: "com.atproto.repo.listMissingBlobs",
2116
-
ComAtprotoRepoListRecords: "com.atproto.repo.listRecords",
2117
-
ComAtprotoRepoPutRecord: "com.atproto.repo.putRecord",
2118
-
ComAtprotoRepoStrongRef: "com.atproto.repo.strongRef",
2119
-
ComAtprotoRepoUploadBlob: "com.atproto.repo.uploadBlob",
2120
-
PubLeafletBlocksBlockquote: "pub.leaflet.blocks.blockquote",
2121
-
PubLeafletBlocksBskyPost: "pub.leaflet.blocks.bskyPost",
2122
-
PubLeafletBlocksButton: "pub.leaflet.blocks.button",
2123
-
PubLeafletBlocksCode: "pub.leaflet.blocks.code",
2124
-
PubLeafletBlocksHeader: "pub.leaflet.blocks.header",
2125
-
PubLeafletBlocksHorizontalRule: "pub.leaflet.blocks.horizontalRule",
2126
-
PubLeafletBlocksIframe: "pub.leaflet.blocks.iframe",
2127
-
PubLeafletBlocksImage: "pub.leaflet.blocks.image",
2128
-
PubLeafletBlocksMath: "pub.leaflet.blocks.math",
2129
-
PubLeafletBlocksPage: "pub.leaflet.blocks.page",
2130
-
PubLeafletBlocksPoll: "pub.leaflet.blocks.poll",
2131
-
PubLeafletBlocksText: "pub.leaflet.blocks.text",
2132
-
PubLeafletBlocksUnorderedList: "pub.leaflet.blocks.unorderedList",
2133
-
PubLeafletBlocksWebsite: "pub.leaflet.blocks.website",
2134
-
PubLeafletComment: "pub.leaflet.comment",
2135
-
PubLeafletDocument: "pub.leaflet.document",
2136
-
PubLeafletGraphSubscription: "pub.leaflet.graph.subscription",
2137
-
PubLeafletPagesCanvas: "pub.leaflet.pages.canvas",
2138
-
PubLeafletPagesLinearDocument: "pub.leaflet.pages.linearDocument",
2139
-
PubLeafletPollDefinition: "pub.leaflet.poll.definition",
2140
-
PubLeafletPollVote: "pub.leaflet.poll.vote",
2141
-
PubLeafletPublication: "pub.leaflet.publication",
2142
-
PubLeafletRichtextFacet: "pub.leaflet.richtext.facet",
2143
-
PubLeafletThemeBackgroundImage: "pub.leaflet.theme.backgroundImage",
2144
-
PubLeafletThemeColor: "pub.leaflet.theme.color",
2145
-
} as const;
···
6
Lexicons,
7
ValidationError,
8
type ValidationResult,
9
+
} from '@atproto/lexicon'
10
+
import { type $Typed, is$typed, maybe$typed } from './util'
11
12
export const schemaDict = {
13
AppBskyActorProfile: {
14
lexicon: 1,
15
+
id: 'app.bsky.actor.profile',
16
defs: {
17
main: {
18
+
type: 'record',
19
+
description: 'A declaration of a Bluesky account profile.',
20
+
key: 'literal:self',
21
record: {
22
+
type: 'object',
23
properties: {
24
displayName: {
25
+
type: 'string',
26
maxGraphemes: 64,
27
maxLength: 640,
28
},
29
description: {
30
+
type: 'string',
31
+
description: 'Free-form profile description text.',
32
maxGraphemes: 256,
33
maxLength: 2560,
34
},
35
avatar: {
36
+
type: 'blob',
37
description:
38
"Small image to be displayed next to posts from account. AKA, 'profile picture'",
39
+
accept: ['image/png', 'image/jpeg'],
40
maxSize: 1000000,
41
},
42
banner: {
43
+
type: 'blob',
44
description:
45
+
'Larger horizontal image to display behind profile view.',
46
+
accept: ['image/png', 'image/jpeg'],
47
maxSize: 1000000,
48
},
49
labels: {
50
+
type: 'union',
51
description:
52
+
'Self-label values, specific to the Bluesky application, on the overall account.',
53
+
refs: ['lex:com.atproto.label.defs#selfLabels'],
54
},
55
joinedViaStarterPack: {
56
+
type: 'ref',
57
+
ref: 'lex:com.atproto.repo.strongRef',
58
},
59
pinnedPost: {
60
+
type: 'ref',
61
+
ref: 'lex:com.atproto.repo.strongRef',
62
},
63
createdAt: {
64
+
type: 'string',
65
+
format: 'datetime',
66
},
67
},
68
},
···
71
},
72
ComAtprotoLabelDefs: {
73
lexicon: 1,
74
+
id: 'com.atproto.label.defs',
75
defs: {
76
label: {
77
+
type: 'object',
78
description:
79
+
'Metadata tag on an atproto resource (eg, repo or record).',
80
+
required: ['src', 'uri', 'val', 'cts'],
81
properties: {
82
ver: {
83
+
type: 'integer',
84
+
description: 'The AT Protocol version of the label object.',
85
},
86
src: {
87
+
type: 'string',
88
+
format: 'did',
89
+
description: 'DID of the actor who created this label.',
90
},
91
uri: {
92
+
type: 'string',
93
+
format: 'uri',
94
description:
95
+
'AT URI of the record, repository (account), or other resource that this label applies to.',
96
},
97
cid: {
98
+
type: 'string',
99
+
format: 'cid',
100
description:
101
"Optionally, CID specifying the specific version of 'uri' resource this label applies to.",
102
},
103
val: {
104
+
type: 'string',
105
maxLength: 128,
106
description:
107
+
'The short string name of the value or type of this label.',
108
},
109
neg: {
110
+
type: 'boolean',
111
description:
112
+
'If true, this is a negation label, overwriting a previous label.',
113
},
114
cts: {
115
+
type: 'string',
116
+
format: 'datetime',
117
+
description: 'Timestamp when this label was created.',
118
},
119
exp: {
120
+
type: 'string',
121
+
format: 'datetime',
122
description:
123
+
'Timestamp at which this label expires (no longer applies).',
124
},
125
sig: {
126
+
type: 'bytes',
127
+
description: 'Signature of dag-cbor encoded label.',
128
},
129
},
130
},
131
selfLabels: {
132
+
type: 'object',
133
description:
134
+
'Metadata tags on an atproto record, published by the author within the record.',
135
+
required: ['values'],
136
properties: {
137
values: {
138
+
type: 'array',
139
items: {
140
+
type: 'ref',
141
+
ref: 'lex:com.atproto.label.defs#selfLabel',
142
},
143
maxLength: 10,
144
},
145
},
146
},
147
selfLabel: {
148
+
type: 'object',
149
description:
150
+
'Metadata tag on an atproto record, published by the author within the record. Note that schemas should use #selfLabels, not #selfLabel.',
151
+
required: ['val'],
152
properties: {
153
val: {
154
+
type: 'string',
155
maxLength: 128,
156
description:
157
+
'The short string name of the value or type of this label.',
158
},
159
},
160
},
161
labelValueDefinition: {
162
+
type: 'object',
163
description:
164
+
'Declares a label value and its expected interpretations and behaviors.',
165
+
required: ['identifier', 'severity', 'blurs', 'locales'],
166
properties: {
167
identifier: {
168
+
type: 'string',
169
description:
170
"The value of the label being defined. Must only include lowercase ascii and the '-' character ([a-z-]+).",
171
maxLength: 100,
172
maxGraphemes: 100,
173
},
174
severity: {
175
+
type: 'string',
176
description:
177
"How should a client visually convey this label? 'inform' means neutral and informational; 'alert' means negative and warning; 'none' means show nothing.",
178
+
knownValues: ['inform', 'alert', 'none'],
179
},
180
blurs: {
181
+
type: 'string',
182
description:
183
"What should this label hide in the UI, if applied? 'content' hides all of the target; 'media' hides the images/video/audio; 'none' hides nothing.",
184
+
knownValues: ['content', 'media', 'none'],
185
},
186
defaultSetting: {
187
+
type: 'string',
188
+
description: 'The default setting for this label.',
189
+
knownValues: ['ignore', 'warn', 'hide'],
190
+
default: 'warn',
191
},
192
adultOnly: {
193
+
type: 'boolean',
194
description:
195
+
'Does the user need to have adult content enabled in order to configure this label?',
196
},
197
locales: {
198
+
type: 'array',
199
items: {
200
+
type: 'ref',
201
+
ref: 'lex:com.atproto.label.defs#labelValueDefinitionStrings',
202
},
203
},
204
},
205
},
206
labelValueDefinitionStrings: {
207
+
type: 'object',
208
description:
209
+
'Strings which describe the label in the UI, localized into a specific language.',
210
+
required: ['lang', 'name', 'description'],
211
properties: {
212
lang: {
213
+
type: 'string',
214
description:
215
+
'The code of the language these strings are written in.',
216
+
format: 'language',
217
},
218
name: {
219
+
type: 'string',
220
+
description: 'A short human-readable name for the label.',
221
maxGraphemes: 64,
222
maxLength: 640,
223
},
224
description: {
225
+
type: 'string',
226
description:
227
+
'A longer description of what the label means and why it might be applied.',
228
maxGraphemes: 10000,
229
maxLength: 100000,
230
},
231
},
232
},
233
labelValue: {
234
+
type: 'string',
235
knownValues: [
236
+
'!hide',
237
+
'!no-promote',
238
+
'!warn',
239
+
'!no-unauthenticated',
240
+
'dmca-violation',
241
+
'doxxing',
242
+
'porn',
243
+
'sexual',
244
+
'nudity',
245
+
'nsfl',
246
+
'gore',
247
],
248
},
249
},
250
},
251
ComAtprotoRepoApplyWrites: {
252
lexicon: 1,
253
+
id: 'com.atproto.repo.applyWrites',
254
defs: {
255
main: {
256
+
type: 'procedure',
257
description:
258
+
'Apply a batch transaction of repository creates, updates, and deletes. Requires auth, implemented by PDS.',
259
input: {
260
+
encoding: 'application/json',
261
schema: {
262
+
type: 'object',
263
+
required: ['repo', 'writes'],
264
properties: {
265
repo: {
266
+
type: 'string',
267
+
format: 'at-identifier',
268
description:
269
+
'The handle or DID of the repo (aka, current account).',
270
},
271
validate: {
272
+
type: 'boolean',
273
description:
274
"Can be set to 'false' to skip Lexicon schema validation of record data across all operations, 'true' to require it, or leave unset to validate only for known Lexicons.",
275
},
276
writes: {
277
+
type: 'array',
278
items: {
279
+
type: 'union',
280
refs: [
281
+
'lex:com.atproto.repo.applyWrites#create',
282
+
'lex:com.atproto.repo.applyWrites#update',
283
+
'lex:com.atproto.repo.applyWrites#delete',
284
],
285
closed: true,
286
},
287
},
288
swapCommit: {
289
+
type: 'string',
290
description:
291
+
'If provided, the entire operation will fail if the current repo commit CID does not match this value. Used to prevent conflicting repo mutations.',
292
+
format: 'cid',
293
},
294
},
295
},
296
},
297
output: {
298
+
encoding: 'application/json',
299
schema: {
300
+
type: 'object',
301
required: [],
302
properties: {
303
commit: {
304
+
type: 'ref',
305
+
ref: 'lex:com.atproto.repo.defs#commitMeta',
306
},
307
results: {
308
+
type: 'array',
309
items: {
310
+
type: 'union',
311
refs: [
312
+
'lex:com.atproto.repo.applyWrites#createResult',
313
+
'lex:com.atproto.repo.applyWrites#updateResult',
314
+
'lex:com.atproto.repo.applyWrites#deleteResult',
315
],
316
closed: true,
317
},
···
321
},
322
errors: [
323
{
324
+
name: 'InvalidSwap',
325
description:
326
"Indicates that the 'swapCommit' parameter did not match current commit.",
327
},
328
],
329
},
330
create: {
331
+
type: 'object',
332
+
description: 'Operation which creates a new record.',
333
+
required: ['collection', 'value'],
334
properties: {
335
collection: {
336
+
type: 'string',
337
+
format: 'nsid',
338
},
339
rkey: {
340
+
type: 'string',
341
maxLength: 512,
342
+
format: 'record-key',
343
description:
344
+
'NOTE: maxLength is redundant with record-key format. Keeping it temporarily to ensure backwards compatibility.',
345
},
346
value: {
347
+
type: 'unknown',
348
},
349
},
350
},
351
update: {
352
+
type: 'object',
353
+
description: 'Operation which updates an existing record.',
354
+
required: ['collection', 'rkey', 'value'],
355
properties: {
356
collection: {
357
+
type: 'string',
358
+
format: 'nsid',
359
},
360
rkey: {
361
+
type: 'string',
362
+
format: 'record-key',
363
},
364
value: {
365
+
type: 'unknown',
366
},
367
},
368
},
369
delete: {
370
+
type: 'object',
371
+
description: 'Operation which deletes an existing record.',
372
+
required: ['collection', 'rkey'],
373
properties: {
374
collection: {
375
+
type: 'string',
376
+
format: 'nsid',
377
},
378
rkey: {
379
+
type: 'string',
380
+
format: 'record-key',
381
},
382
},
383
},
384
createResult: {
385
+
type: 'object',
386
+
required: ['uri', 'cid'],
387
properties: {
388
uri: {
389
+
type: 'string',
390
+
format: 'at-uri',
391
},
392
cid: {
393
+
type: 'string',
394
+
format: 'cid',
395
},
396
validationStatus: {
397
+
type: 'string',
398
+
knownValues: ['valid', 'unknown'],
399
},
400
},
401
},
402
updateResult: {
403
+
type: 'object',
404
+
required: ['uri', 'cid'],
405
properties: {
406
uri: {
407
+
type: 'string',
408
+
format: 'at-uri',
409
},
410
cid: {
411
+
type: 'string',
412
+
format: 'cid',
413
},
414
validationStatus: {
415
+
type: 'string',
416
+
knownValues: ['valid', 'unknown'],
417
},
418
},
419
},
420
deleteResult: {
421
+
type: 'object',
422
required: [],
423
properties: {},
424
},
···
426
},
427
ComAtprotoRepoCreateRecord: {
428
lexicon: 1,
429
+
id: 'com.atproto.repo.createRecord',
430
defs: {
431
main: {
432
+
type: 'procedure',
433
description:
434
+
'Create a single new repository record. Requires auth, implemented by PDS.',
435
input: {
436
+
encoding: 'application/json',
437
schema: {
438
+
type: 'object',
439
+
required: ['repo', 'collection', 'record'],
440
properties: {
441
repo: {
442
+
type: 'string',
443
+
format: 'at-identifier',
444
description:
445
+
'The handle or DID of the repo (aka, current account).',
446
},
447
collection: {
448
+
type: 'string',
449
+
format: 'nsid',
450
+
description: 'The NSID of the record collection.',
451
},
452
rkey: {
453
+
type: 'string',
454
+
format: 'record-key',
455
+
description: 'The Record Key.',
456
maxLength: 512,
457
},
458
validate: {
459
+
type: 'boolean',
460
description:
461
"Can be set to 'false' to skip Lexicon schema validation of record data, 'true' to require it, or leave unset to validate only for known Lexicons.",
462
},
463
record: {
464
+
type: 'unknown',
465
+
description: 'The record itself. Must contain a $type field.',
466
},
467
swapCommit: {
468
+
type: 'string',
469
+
format: 'cid',
470
description:
471
+
'Compare and swap with the previous commit by CID.',
472
},
473
},
474
},
475
},
476
output: {
477
+
encoding: 'application/json',
478
schema: {
479
+
type: 'object',
480
+
required: ['uri', 'cid'],
481
properties: {
482
uri: {
483
+
type: 'string',
484
+
format: 'at-uri',
485
},
486
cid: {
487
+
type: 'string',
488
+
format: 'cid',
489
},
490
commit: {
491
+
type: 'ref',
492
+
ref: 'lex:com.atproto.repo.defs#commitMeta',
493
},
494
validationStatus: {
495
+
type: 'string',
496
+
knownValues: ['valid', 'unknown'],
497
},
498
},
499
},
500
},
501
errors: [
502
{
503
+
name: 'InvalidSwap',
504
description:
505
"Indicates that 'swapCommit' didn't match current repo commit.",
506
},
···
510
},
511
ComAtprotoRepoDefs: {
512
lexicon: 1,
513
+
id: 'com.atproto.repo.defs',
514
defs: {
515
commitMeta: {
516
+
type: 'object',
517
+
required: ['cid', 'rev'],
518
properties: {
519
cid: {
520
+
type: 'string',
521
+
format: 'cid',
522
},
523
rev: {
524
+
type: 'string',
525
+
format: 'tid',
526
},
527
},
528
},
···
530
},
531
ComAtprotoRepoDeleteRecord: {
532
lexicon: 1,
533
+
id: 'com.atproto.repo.deleteRecord',
534
defs: {
535
main: {
536
+
type: 'procedure',
537
description:
538
"Delete a repository record, or ensure it doesn't exist. Requires auth, implemented by PDS.",
539
input: {
540
+
encoding: 'application/json',
541
schema: {
542
+
type: 'object',
543
+
required: ['repo', 'collection', 'rkey'],
544
properties: {
545
repo: {
546
+
type: 'string',
547
+
format: 'at-identifier',
548
description:
549
+
'The handle or DID of the repo (aka, current account).',
550
},
551
collection: {
552
+
type: 'string',
553
+
format: 'nsid',
554
+
description: 'The NSID of the record collection.',
555
},
556
rkey: {
557
+
type: 'string',
558
+
format: 'record-key',
559
+
description: 'The Record Key.',
560
},
561
swapRecord: {
562
+
type: 'string',
563
+
format: 'cid',
564
description:
565
+
'Compare and swap with the previous record by CID.',
566
},
567
swapCommit: {
568
+
type: 'string',
569
+
format: 'cid',
570
description:
571
+
'Compare and swap with the previous commit by CID.',
572
},
573
},
574
},
575
},
576
output: {
577
+
encoding: 'application/json',
578
schema: {
579
+
type: 'object',
580
properties: {
581
commit: {
582
+
type: 'ref',
583
+
ref: 'lex:com.atproto.repo.defs#commitMeta',
584
},
585
},
586
},
587
},
588
errors: [
589
{
590
+
name: 'InvalidSwap',
591
},
592
],
593
},
···
595
},
596
ComAtprotoRepoDescribeRepo: {
597
lexicon: 1,
598
+
id: 'com.atproto.repo.describeRepo',
599
defs: {
600
main: {
601
+
type: 'query',
602
description:
603
+
'Get information about an account and repository, including the list of collections. Does not require auth.',
604
parameters: {
605
+
type: 'params',
606
+
required: ['repo'],
607
properties: {
608
repo: {
609
+
type: 'string',
610
+
format: 'at-identifier',
611
+
description: 'The handle or DID of the repo.',
612
},
613
},
614
},
615
output: {
616
+
encoding: 'application/json',
617
schema: {
618
+
type: 'object',
619
required: [
620
+
'handle',
621
+
'did',
622
+
'didDoc',
623
+
'collections',
624
+
'handleIsCorrect',
625
],
626
properties: {
627
handle: {
628
+
type: 'string',
629
+
format: 'handle',
630
},
631
did: {
632
+
type: 'string',
633
+
format: 'did',
634
},
635
didDoc: {
636
+
type: 'unknown',
637
+
description: 'The complete DID document for this account.',
638
},
639
collections: {
640
+
type: 'array',
641
description:
642
+
'List of all the collections (NSIDs) for which this repo contains at least one record.',
643
items: {
644
+
type: 'string',
645
+
format: 'nsid',
646
},
647
},
648
handleIsCorrect: {
649
+
type: 'boolean',
650
description:
651
+
'Indicates if handle is currently valid (resolves bi-directionally)',
652
},
653
},
654
},
···
658
},
659
ComAtprotoRepoGetRecord: {
660
lexicon: 1,
661
+
id: 'com.atproto.repo.getRecord',
662
defs: {
663
main: {
664
+
type: 'query',
665
description:
666
+
'Get a single record from a repository. Does not require auth.',
667
parameters: {
668
+
type: 'params',
669
+
required: ['repo', 'collection', 'rkey'],
670
properties: {
671
repo: {
672
+
type: 'string',
673
+
format: 'at-identifier',
674
+
description: 'The handle or DID of the repo.',
675
},
676
collection: {
677
+
type: 'string',
678
+
format: 'nsid',
679
+
description: 'The NSID of the record collection.',
680
},
681
rkey: {
682
+
type: 'string',
683
+
description: 'The Record Key.',
684
+
format: 'record-key',
685
},
686
cid: {
687
+
type: 'string',
688
+
format: 'cid',
689
description:
690
+
'The CID of the version of the record. If not specified, then return the most recent version.',
691
},
692
},
693
},
694
output: {
695
+
encoding: 'application/json',
696
schema: {
697
+
type: 'object',
698
+
required: ['uri', 'value'],
699
properties: {
700
uri: {
701
+
type: 'string',
702
+
format: 'at-uri',
703
},
704
cid: {
705
+
type: 'string',
706
+
format: 'cid',
707
},
708
value: {
709
+
type: 'unknown',
710
},
711
},
712
},
713
},
714
errors: [
715
{
716
+
name: 'RecordNotFound',
717
},
718
],
719
},
···
721
},
722
ComAtprotoRepoImportRepo: {
723
lexicon: 1,
724
+
id: 'com.atproto.repo.importRepo',
725
defs: {
726
main: {
727
+
type: 'procedure',
728
description:
729
+
'Import a repo in the form of a CAR file. Requires Content-Length HTTP header to be set.',
730
input: {
731
+
encoding: 'application/vnd.ipld.car',
732
},
733
},
734
},
735
},
736
ComAtprotoRepoListMissingBlobs: {
737
lexicon: 1,
738
+
id: 'com.atproto.repo.listMissingBlobs',
739
defs: {
740
main: {
741
+
type: 'query',
742
description:
743
+
'Returns a list of missing blobs for the requesting account. Intended to be used in the account migration flow.',
744
parameters: {
745
+
type: 'params',
746
properties: {
747
limit: {
748
+
type: 'integer',
749
minimum: 1,
750
maximum: 1000,
751
default: 500,
752
},
753
cursor: {
754
+
type: 'string',
755
},
756
},
757
},
758
output: {
759
+
encoding: 'application/json',
760
schema: {
761
+
type: 'object',
762
+
required: ['blobs'],
763
properties: {
764
cursor: {
765
+
type: 'string',
766
},
767
blobs: {
768
+
type: 'array',
769
items: {
770
+
type: 'ref',
771
+
ref: 'lex:com.atproto.repo.listMissingBlobs#recordBlob',
772
},
773
},
774
},
···
776
},
777
},
778
recordBlob: {
779
+
type: 'object',
780
+
required: ['cid', 'recordUri'],
781
properties: {
782
cid: {
783
+
type: 'string',
784
+
format: 'cid',
785
},
786
recordUri: {
787
+
type: 'string',
788
+
format: 'at-uri',
789
},
790
},
791
},
···
793
},
794
ComAtprotoRepoListRecords: {
795
lexicon: 1,
796
+
id: 'com.atproto.repo.listRecords',
797
defs: {
798
main: {
799
+
type: 'query',
800
description:
801
+
'List a range of records in a repository, matching a specific collection. Does not require auth.',
802
parameters: {
803
+
type: 'params',
804
+
required: ['repo', 'collection'],
805
properties: {
806
repo: {
807
+
type: 'string',
808
+
format: 'at-identifier',
809
+
description: 'The handle or DID of the repo.',
810
},
811
collection: {
812
+
type: 'string',
813
+
format: 'nsid',
814
+
description: 'The NSID of the record type.',
815
},
816
limit: {
817
+
type: 'integer',
818
minimum: 1,
819
maximum: 100,
820
default: 50,
821
+
description: 'The number of records to return.',
822
},
823
cursor: {
824
+
type: 'string',
825
},
826
rkeyStart: {
827
+
type: 'string',
828
description:
829
+
'DEPRECATED: The lowest sort-ordered rkey to start from (exclusive)',
830
},
831
rkeyEnd: {
832
+
type: 'string',
833
description:
834
+
'DEPRECATED: The highest sort-ordered rkey to stop at (exclusive)',
835
},
836
reverse: {
837
+
type: 'boolean',
838
+
description: 'Flag to reverse the order of the returned records.',
839
},
840
},
841
},
842
output: {
843
+
encoding: 'application/json',
844
schema: {
845
+
type: 'object',
846
+
required: ['records'],
847
properties: {
848
cursor: {
849
+
type: 'string',
850
},
851
records: {
852
+
type: 'array',
853
items: {
854
+
type: 'ref',
855
+
ref: 'lex:com.atproto.repo.listRecords#record',
856
},
857
},
858
},
···
860
},
861
},
862
record: {
863
+
type: 'object',
864
+
required: ['uri', 'cid', 'value'],
865
properties: {
866
uri: {
867
+
type: 'string',
868
+
format: 'at-uri',
869
},
870
cid: {
871
+
type: 'string',
872
+
format: 'cid',
873
},
874
value: {
875
+
type: 'unknown',
876
},
877
},
878
},
···
880
},
881
ComAtprotoRepoPutRecord: {
882
lexicon: 1,
883
+
id: 'com.atproto.repo.putRecord',
884
defs: {
885
main: {
886
+
type: 'procedure',
887
description:
888
+
'Write a repository record, creating or updating it as needed. Requires auth, implemented by PDS.',
889
input: {
890
+
encoding: 'application/json',
891
schema: {
892
+
type: 'object',
893
+
required: ['repo', 'collection', 'rkey', 'record'],
894
+
nullable: ['swapRecord'],
895
properties: {
896
repo: {
897
+
type: 'string',
898
+
format: 'at-identifier',
899
description:
900
+
'The handle or DID of the repo (aka, current account).',
901
},
902
collection: {
903
+
type: 'string',
904
+
format: 'nsid',
905
+
description: 'The NSID of the record collection.',
906
},
907
rkey: {
908
+
type: 'string',
909
+
format: 'record-key',
910
+
description: 'The Record Key.',
911
maxLength: 512,
912
},
913
validate: {
914
+
type: 'boolean',
915
description:
916
"Can be set to 'false' to skip Lexicon schema validation of record data, 'true' to require it, or leave unset to validate only for known Lexicons.",
917
},
918
record: {
919
+
type: 'unknown',
920
+
description: 'The record to write.',
921
},
922
swapRecord: {
923
+
type: 'string',
924
+
format: 'cid',
925
description:
926
+
'Compare and swap with the previous record by CID. WARNING: nullable and optional field; may cause problems with golang implementation',
927
},
928
swapCommit: {
929
+
type: 'string',
930
+
format: 'cid',
931
description:
932
+
'Compare and swap with the previous commit by CID.',
933
},
934
},
935
},
936
},
937
output: {
938
+
encoding: 'application/json',
939
schema: {
940
+
type: 'object',
941
+
required: ['uri', 'cid'],
942
properties: {
943
uri: {
944
+
type: 'string',
945
+
format: 'at-uri',
946
},
947
cid: {
948
+
type: 'string',
949
+
format: 'cid',
950
},
951
commit: {
952
+
type: 'ref',
953
+
ref: 'lex:com.atproto.repo.defs#commitMeta',
954
},
955
validationStatus: {
956
+
type: 'string',
957
+
knownValues: ['valid', 'unknown'],
958
},
959
},
960
},
961
},
962
errors: [
963
{
964
+
name: 'InvalidSwap',
965
},
966
],
967
},
···
969
},
970
ComAtprotoRepoStrongRef: {
971
lexicon: 1,
972
+
id: 'com.atproto.repo.strongRef',
973
+
description: 'A URI with a content-hash fingerprint.',
974
defs: {
975
main: {
976
+
type: 'object',
977
+
required: ['uri', 'cid'],
978
properties: {
979
uri: {
980
+
type: 'string',
981
+
format: 'at-uri',
982
},
983
cid: {
984
+
type: 'string',
985
+
format: 'cid',
986
},
987
},
988
},
···
990
},
991
ComAtprotoRepoUploadBlob: {
992
lexicon: 1,
993
+
id: 'com.atproto.repo.uploadBlob',
994
defs: {
995
main: {
996
+
type: 'procedure',
997
description:
998
+
'Upload a new blob, to be referenced from a repository record. The blob will be deleted if it is not referenced within a time window (eg, minutes). Blob restrictions (mimetype, size, etc) are enforced when the reference is created. Requires auth, implemented by PDS.',
999
input: {
1000
+
encoding: '*/*',
1001
},
1002
output: {
1003
+
encoding: 'application/json',
1004
schema: {
1005
+
type: 'object',
1006
+
required: ['blob'],
1007
properties: {
1008
blob: {
1009
+
type: 'blob',
1010
},
1011
},
1012
},
···
1016
},
1017
PubLeafletBlocksBlockquote: {
1018
lexicon: 1,
1019
+
id: 'pub.leaflet.blocks.blockquote',
1020
defs: {
1021
main: {
1022
+
type: 'object',
1023
+
required: ['plaintext'],
1024
properties: {
1025
plaintext: {
1026
+
type: 'string',
1027
},
1028
facets: {
1029
+
type: 'array',
1030
items: {
1031
+
type: 'ref',
1032
+
ref: 'lex:pub.leaflet.richtext.facet',
1033
},
1034
},
1035
},
···
1038
},
1039
PubLeafletBlocksBskyPost: {
1040
lexicon: 1,
1041
+
id: 'pub.leaflet.blocks.bskyPost',
1042
defs: {
1043
main: {
1044
+
type: 'object',
1045
+
required: ['postRef'],
1046
properties: {
1047
postRef: {
1048
+
type: 'ref',
1049
+
ref: 'lex:com.atproto.repo.strongRef',
1050
},
1051
},
1052
},
···
1054
},
1055
PubLeafletBlocksButton: {
1056
lexicon: 1,
1057
+
id: 'pub.leaflet.blocks.button',
1058
defs: {
1059
main: {
1060
+
type: 'object',
1061
+
required: ['text', 'url'],
1062
properties: {
1063
text: {
1064
+
type: 'string',
1065
},
1066
url: {
1067
+
type: 'string',
1068
+
format: 'uri',
1069
},
1070
},
1071
},
···
1073
},
1074
PubLeafletBlocksCode: {
1075
lexicon: 1,
1076
+
id: 'pub.leaflet.blocks.code',
1077
defs: {
1078
main: {
1079
+
type: 'object',
1080
+
required: ['plaintext'],
1081
properties: {
1082
plaintext: {
1083
+
type: 'string',
1084
},
1085
language: {
1086
+
type: 'string',
1087
},
1088
syntaxHighlightingTheme: {
1089
+
type: 'string',
1090
},
1091
},
1092
},
···
1094
},
1095
PubLeafletBlocksHeader: {
1096
lexicon: 1,
1097
+
id: 'pub.leaflet.blocks.header',
1098
defs: {
1099
main: {
1100
+
type: 'object',
1101
+
required: ['plaintext'],
1102
properties: {
1103
level: {
1104
+
type: 'integer',
1105
minimum: 1,
1106
maximum: 6,
1107
},
1108
plaintext: {
1109
+
type: 'string',
1110
},
1111
facets: {
1112
+
type: 'array',
1113
items: {
1114
+
type: 'ref',
1115
+
ref: 'lex:pub.leaflet.richtext.facet',
1116
},
1117
},
1118
},
···
1121
},
1122
PubLeafletBlocksHorizontalRule: {
1123
lexicon: 1,
1124
+
id: 'pub.leaflet.blocks.horizontalRule',
1125
defs: {
1126
main: {
1127
+
type: 'object',
1128
required: [],
1129
properties: {},
1130
},
···
1132
},
1133
PubLeafletBlocksIframe: {
1134
lexicon: 1,
1135
+
id: 'pub.leaflet.blocks.iframe',
1136
defs: {
1137
main: {
1138
+
type: 'object',
1139
+
required: ['url'],
1140
properties: {
1141
url: {
1142
+
type: 'string',
1143
+
format: 'uri',
1144
},
1145
height: {
1146
+
type: 'integer',
1147
minimum: 16,
1148
maximum: 1600,
1149
},
···
1153
},
1154
PubLeafletBlocksImage: {
1155
lexicon: 1,
1156
+
id: 'pub.leaflet.blocks.image',
1157
defs: {
1158
main: {
1159
+
type: 'object',
1160
+
required: ['image', 'aspectRatio'],
1161
properties: {
1162
image: {
1163
+
type: 'blob',
1164
+
accept: ['image/*'],
1165
maxSize: 1000000,
1166
},
1167
alt: {
1168
+
type: 'string',
1169
description:
1170
+
'Alt text description of the image, for accessibility.',
1171
},
1172
aspectRatio: {
1173
+
type: 'ref',
1174
+
ref: 'lex:pub.leaflet.blocks.image#aspectRatio',
1175
},
1176
},
1177
},
1178
aspectRatio: {
1179
+
type: 'object',
1180
+
required: ['width', 'height'],
1181
properties: {
1182
width: {
1183
+
type: 'integer',
1184
},
1185
height: {
1186
+
type: 'integer',
1187
},
1188
},
1189
},
···
1191
},
1192
PubLeafletBlocksMath: {
1193
lexicon: 1,
1194
+
id: 'pub.leaflet.blocks.math',
1195
defs: {
1196
main: {
1197
+
type: 'object',
1198
+
required: ['tex'],
1199
properties: {
1200
tex: {
1201
+
type: 'string',
1202
},
1203
},
1204
},
···
1206
},
1207
PubLeafletBlocksPage: {
1208
lexicon: 1,
1209
+
id: 'pub.leaflet.blocks.page',
1210
defs: {
1211
main: {
1212
+
type: 'object',
1213
+
required: ['id'],
1214
properties: {
1215
id: {
1216
+
type: 'string',
1217
},
1218
},
1219
},
···
1221
},
1222
PubLeafletBlocksPoll: {
1223
lexicon: 1,
1224
+
id: 'pub.leaflet.blocks.poll',
1225
defs: {
1226
main: {
1227
+
type: 'object',
1228
+
required: ['pollRef'],
1229
properties: {
1230
pollRef: {
1231
+
type: 'ref',
1232
+
ref: 'lex:com.atproto.repo.strongRef',
1233
},
1234
},
1235
},
···
1237
},
1238
PubLeafletBlocksText: {
1239
lexicon: 1,
1240
+
id: 'pub.leaflet.blocks.text',
1241
defs: {
1242
main: {
1243
+
type: 'object',
1244
+
required: ['plaintext'],
1245
properties: {
1246
plaintext: {
1247
+
type: 'string',
1248
},
1249
facets: {
1250
+
type: 'array',
1251
items: {
1252
+
type: 'ref',
1253
+
ref: 'lex:pub.leaflet.richtext.facet',
1254
},
1255
},
1256
},
···
1259
},
1260
PubLeafletBlocksUnorderedList: {
1261
lexicon: 1,
1262
+
id: 'pub.leaflet.blocks.unorderedList',
1263
defs: {
1264
main: {
1265
+
type: 'object',
1266
+
required: ['children'],
1267
properties: {
1268
children: {
1269
+
type: 'array',
1270
items: {
1271
+
type: 'ref',
1272
+
ref: 'lex:pub.leaflet.blocks.unorderedList#listItem',
1273
},
1274
},
1275
},
1276
},
1277
listItem: {
1278
+
type: 'object',
1279
+
required: ['content'],
1280
properties: {
1281
content: {
1282
+
type: 'union',
1283
refs: [
1284
+
'lex:pub.leaflet.blocks.text',
1285
+
'lex:pub.leaflet.blocks.header',
1286
+
'lex:pub.leaflet.blocks.image',
1287
],
1288
},
1289
children: {
1290
+
type: 'array',
1291
items: {
1292
+
type: 'ref',
1293
+
ref: 'lex:pub.leaflet.blocks.unorderedList#listItem',
1294
},
1295
},
1296
},
···
1299
},
1300
PubLeafletBlocksWebsite: {
1301
lexicon: 1,
1302
+
id: 'pub.leaflet.blocks.website',
1303
defs: {
1304
main: {
1305
+
type: 'object',
1306
+
required: ['src'],
1307
properties: {
1308
previewImage: {
1309
+
type: 'blob',
1310
+
accept: ['image/*'],
1311
maxSize: 1000000,
1312
},
1313
title: {
1314
+
type: 'string',
1315
},
1316
description: {
1317
+
type: 'string',
1318
},
1319
src: {
1320
+
type: 'string',
1321
+
format: 'uri',
1322
},
1323
},
1324
},
···
1326
},
1327
PubLeafletComment: {
1328
lexicon: 1,
1329
+
id: 'pub.leaflet.comment',
1330
revision: 1,
1331
+
description: 'A lexicon for comments on documents',
1332
defs: {
1333
main: {
1334
+
type: 'record',
1335
+
key: 'tid',
1336
+
description: 'Record containing a comment',
1337
record: {
1338
+
type: 'object',
1339
+
required: ['subject', 'plaintext', 'createdAt'],
1340
properties: {
1341
subject: {
1342
+
type: 'string',
1343
+
format: 'at-uri',
1344
},
1345
createdAt: {
1346
+
type: 'string',
1347
+
format: 'datetime',
1348
},
1349
reply: {
1350
+
type: 'ref',
1351
+
ref: 'lex:pub.leaflet.comment#replyRef',
1352
},
1353
plaintext: {
1354
+
type: 'string',
1355
},
1356
facets: {
1357
+
type: 'array',
1358
items: {
1359
+
type: 'ref',
1360
+
ref: 'lex:pub.leaflet.richtext.facet',
1361
},
1362
},
1363
onPage: {
1364
+
type: 'string',
1365
},
1366
attachment: {
1367
+
type: 'union',
1368
+
refs: ['lex:pub.leaflet.comment#linearDocumentQuote'],
1369
},
1370
},
1371
},
1372
},
1373
linearDocumentQuote: {
1374
+
type: 'object',
1375
+
required: ['document', 'quote'],
1376
properties: {
1377
document: {
1378
+
type: 'string',
1379
+
format: 'at-uri',
1380
},
1381
quote: {
1382
+
type: 'ref',
1383
+
ref: 'lex:pub.leaflet.pages.linearDocument#quote',
1384
},
1385
},
1386
},
1387
replyRef: {
1388
+
type: 'object',
1389
+
required: ['parent'],
1390
properties: {
1391
parent: {
1392
+
type: 'string',
1393
+
format: 'at-uri',
1394
},
1395
},
1396
},
···
1398
},
1399
PubLeafletDocument: {
1400
lexicon: 1,
1401
+
id: 'pub.leaflet.document',
1402
revision: 1,
1403
+
description: 'A lexicon for long form rich media documents',
1404
defs: {
1405
main: {
1406
+
type: 'record',
1407
+
key: 'tid',
1408
+
description: 'Record containing a document',
1409
record: {
1410
+
type: 'object',
1411
+
required: ['pages', 'author', 'title'],
1412
properties: {
1413
title: {
1414
+
type: 'string',
1415
maxLength: 1280,
1416
maxGraphemes: 128,
1417
},
1418
postRef: {
1419
+
type: 'ref',
1420
+
ref: 'lex:com.atproto.repo.strongRef',
1421
},
1422
description: {
1423
+
type: 'string',
1424
maxLength: 3000,
1425
maxGraphemes: 300,
1426
},
1427
publishedAt: {
1428
+
type: 'string',
1429
+
format: 'datetime',
1430
},
1431
publication: {
1432
+
type: 'string',
1433
+
format: 'at-uri',
1434
},
1435
author: {
1436
+
type: 'string',
1437
+
format: 'at-identifier',
1438
},
1439
theme: {
1440
+
type: 'ref',
1441
+
ref: 'lex:pub.leaflet.publication#theme',
1442
},
1443
tags: {
1444
+
type: 'array',
1445
items: {
1446
+
type: 'string',
1447
maxLength: 50,
1448
},
1449
},
1450
coverImage: {
1451
+
type: 'blob',
1452
+
accept: ['image/png', 'image/jpeg', 'image/webp'],
1453
maxSize: 1000000,
1454
},
1455
pages: {
1456
+
type: 'array',
1457
items: {
1458
+
type: 'union',
1459
refs: [
1460
+
'lex:pub.leaflet.pages.linearDocument',
1461
+
'lex:pub.leaflet.pages.canvas',
1462
],
1463
},
1464
},
···
1469
},
1470
PubLeafletGraphSubscription: {
1471
lexicon: 1,
1472
+
id: 'pub.leaflet.graph.subscription',
1473
defs: {
1474
main: {
1475
+
type: 'record',
1476
+
key: 'tid',
1477
+
description: 'Record declaring a subscription to a publication',
1478
record: {
1479
+
type: 'object',
1480
+
required: ['publication'],
1481
properties: {
1482
publication: {
1483
+
type: 'string',
1484
+
format: 'at-uri',
1485
},
1486
},
1487
},
···
1490
},
1491
PubLeafletPagesCanvas: {
1492
lexicon: 1,
1493
+
id: 'pub.leaflet.pages.canvas',
1494
defs: {
1495
main: {
1496
+
type: 'object',
1497
+
required: ['blocks'],
1498
properties: {
1499
id: {
1500
+
type: 'string',
1501
},
1502
blocks: {
1503
+
type: 'array',
1504
items: {
1505
+
type: 'ref',
1506
+
ref: 'lex:pub.leaflet.pages.canvas#block',
1507
},
1508
},
1509
},
1510
},
1511
block: {
1512
+
type: 'object',
1513
+
required: ['block', 'x', 'y', 'width'],
1514
properties: {
1515
block: {
1516
+
type: 'union',
1517
refs: [
1518
+
'lex:pub.leaflet.blocks.iframe',
1519
+
'lex:pub.leaflet.blocks.text',
1520
+
'lex:pub.leaflet.blocks.blockquote',
1521
+
'lex:pub.leaflet.blocks.header',
1522
+
'lex:pub.leaflet.blocks.image',
1523
+
'lex:pub.leaflet.blocks.unorderedList',
1524
+
'lex:pub.leaflet.blocks.website',
1525
+
'lex:pub.leaflet.blocks.math',
1526
+
'lex:pub.leaflet.blocks.code',
1527
+
'lex:pub.leaflet.blocks.horizontalRule',
1528
+
'lex:pub.leaflet.blocks.bskyPost',
1529
+
'lex:pub.leaflet.blocks.page',
1530
+
'lex:pub.leaflet.blocks.poll',
1531
+
'lex:pub.leaflet.blocks.button',
1532
],
1533
},
1534
x: {
1535
+
type: 'integer',
1536
},
1537
y: {
1538
+
type: 'integer',
1539
},
1540
width: {
1541
+
type: 'integer',
1542
},
1543
height: {
1544
+
type: 'integer',
1545
},
1546
rotation: {
1547
+
type: 'integer',
1548
+
description: 'The rotation of the block in degrees',
1549
},
1550
},
1551
},
1552
textAlignLeft: {
1553
+
type: 'token',
1554
},
1555
textAlignCenter: {
1556
+
type: 'token',
1557
},
1558
textAlignRight: {
1559
+
type: 'token',
1560
},
1561
quote: {
1562
+
type: 'object',
1563
+
required: ['start', 'end'],
1564
properties: {
1565
start: {
1566
+
type: 'ref',
1567
+
ref: 'lex:pub.leaflet.pages.canvas#position',
1568
},
1569
end: {
1570
+
type: 'ref',
1571
+
ref: 'lex:pub.leaflet.pages.canvas#position',
1572
},
1573
},
1574
},
1575
position: {
1576
+
type: 'object',
1577
+
required: ['block', 'offset'],
1578
properties: {
1579
block: {
1580
+
type: 'array',
1581
items: {
1582
+
type: 'integer',
1583
},
1584
},
1585
offset: {
1586
+
type: 'integer',
1587
},
1588
},
1589
},
···
1591
},
1592
PubLeafletPagesLinearDocument: {
1593
lexicon: 1,
1594
+
id: 'pub.leaflet.pages.linearDocument',
1595
defs: {
1596
main: {
1597
+
type: 'object',
1598
+
required: ['blocks'],
1599
properties: {
1600
id: {
1601
+
type: 'string',
1602
},
1603
blocks: {
1604
+
type: 'array',
1605
items: {
1606
+
type: 'ref',
1607
+
ref: 'lex:pub.leaflet.pages.linearDocument#block',
1608
},
1609
},
1610
},
1611
},
1612
block: {
1613
+
type: 'object',
1614
+
required: ['block'],
1615
properties: {
1616
block: {
1617
+
type: 'union',
1618
refs: [
1619
+
'lex:pub.leaflet.blocks.iframe',
1620
+
'lex:pub.leaflet.blocks.text',
1621
+
'lex:pub.leaflet.blocks.blockquote',
1622
+
'lex:pub.leaflet.blocks.header',
1623
+
'lex:pub.leaflet.blocks.image',
1624
+
'lex:pub.leaflet.blocks.unorderedList',
1625
+
'lex:pub.leaflet.blocks.website',
1626
+
'lex:pub.leaflet.blocks.math',
1627
+
'lex:pub.leaflet.blocks.code',
1628
+
'lex:pub.leaflet.blocks.horizontalRule',
1629
+
'lex:pub.leaflet.blocks.bskyPost',
1630
+
'lex:pub.leaflet.blocks.page',
1631
+
'lex:pub.leaflet.blocks.poll',
1632
+
'lex:pub.leaflet.blocks.button',
1633
],
1634
},
1635
alignment: {
1636
+
type: 'string',
1637
knownValues: [
1638
+
'lex:pub.leaflet.pages.linearDocument#textAlignLeft',
1639
+
'lex:pub.leaflet.pages.linearDocument#textAlignCenter',
1640
+
'lex:pub.leaflet.pages.linearDocument#textAlignRight',
1641
+
'lex:pub.leaflet.pages.linearDocument#textAlignJustify',
1642
],
1643
},
1644
},
1645
},
1646
textAlignLeft: {
1647
+
type: 'token',
1648
},
1649
textAlignCenter: {
1650
+
type: 'token',
1651
},
1652
textAlignRight: {
1653
+
type: 'token',
1654
},
1655
textAlignJustify: {
1656
+
type: 'token',
1657
},
1658
quote: {
1659
+
type: 'object',
1660
+
required: ['start', 'end'],
1661
properties: {
1662
start: {
1663
+
type: 'ref',
1664
+
ref: 'lex:pub.leaflet.pages.linearDocument#position',
1665
},
1666
end: {
1667
+
type: 'ref',
1668
+
ref: 'lex:pub.leaflet.pages.linearDocument#position',
1669
},
1670
},
1671
},
1672
position: {
1673
+
type: 'object',
1674
+
required: ['block', 'offset'],
1675
properties: {
1676
block: {
1677
+
type: 'array',
1678
items: {
1679
+
type: 'integer',
1680
},
1681
},
1682
offset: {
1683
+
type: 'integer',
1684
},
1685
},
1686
},
···
1688
},
1689
PubLeafletPollDefinition: {
1690
lexicon: 1,
1691
+
id: 'pub.leaflet.poll.definition',
1692
defs: {
1693
main: {
1694
+
type: 'record',
1695
+
key: 'tid',
1696
+
description: 'Record declaring a poll',
1697
record: {
1698
+
type: 'object',
1699
+
required: ['name', 'options'],
1700
properties: {
1701
name: {
1702
+
type: 'string',
1703
maxLength: 500,
1704
maxGraphemes: 100,
1705
},
1706
options: {
1707
+
type: 'array',
1708
items: {
1709
+
type: 'ref',
1710
+
ref: 'lex:pub.leaflet.poll.definition#option',
1711
},
1712
},
1713
endDate: {
1714
+
type: 'string',
1715
+
format: 'datetime',
1716
},
1717
},
1718
},
1719
},
1720
option: {
1721
+
type: 'object',
1722
properties: {
1723
text: {
1724
+
type: 'string',
1725
maxLength: 500,
1726
maxGraphemes: 50,
1727
},
···
1731
},
1732
PubLeafletPollVote: {
1733
lexicon: 1,
1734
+
id: 'pub.leaflet.poll.vote',
1735
defs: {
1736
main: {
1737
+
type: 'record',
1738
+
key: 'tid',
1739
+
description: 'Record declaring a vote on a poll',
1740
record: {
1741
+
type: 'object',
1742
+
required: ['poll', 'option'],
1743
properties: {
1744
poll: {
1745
+
type: 'ref',
1746
+
ref: 'lex:com.atproto.repo.strongRef',
1747
},
1748
option: {
1749
+
type: 'array',
1750
items: {
1751
+
type: 'string',
1752
},
1753
},
1754
},
···
1758
},
1759
PubLeafletPublication: {
1760
lexicon: 1,
1761
+
id: 'pub.leaflet.publication',
1762
defs: {
1763
main: {
1764
+
type: 'record',
1765
+
key: 'tid',
1766
+
description: 'Record declaring a publication',
1767
record: {
1768
+
type: 'object',
1769
+
required: ['name'],
1770
properties: {
1771
name: {
1772
+
type: 'string',
1773
maxLength: 2000,
1774
},
1775
base_path: {
1776
+
type: 'string',
1777
},
1778
description: {
1779
+
type: 'string',
1780
maxLength: 2000,
1781
},
1782
icon: {
1783
+
type: 'blob',
1784
+
accept: ['image/*'],
1785
maxSize: 1000000,
1786
},
1787
theme: {
1788
+
type: 'ref',
1789
+
ref: 'lex:pub.leaflet.publication#theme',
1790
},
1791
preferences: {
1792
+
type: 'ref',
1793
+
ref: 'lex:pub.leaflet.publication#preferences',
1794
},
1795
},
1796
},
1797
},
1798
preferences: {
1799
+
type: 'object',
1800
properties: {
1801
showInDiscover: {
1802
+
type: 'boolean',
1803
default: true,
1804
},
1805
showComments: {
1806
+
type: 'boolean',
1807
+
default: true,
1808
+
},
1809
+
showMentions: {
1810
+
type: 'boolean',
1811
+
default: true,
1812
+
},
1813
+
showPrevNext: {
1814
+
type: 'boolean',
1815
default: true,
1816
},
1817
},
1818
},
1819
theme: {
1820
+
type: 'object',
1821
properties: {
1822
backgroundColor: {
1823
+
type: 'union',
1824
refs: [
1825
+
'lex:pub.leaflet.theme.color#rgba',
1826
+
'lex:pub.leaflet.theme.color#rgb',
1827
],
1828
},
1829
backgroundImage: {
1830
+
type: 'ref',
1831
+
ref: 'lex:pub.leaflet.theme.backgroundImage',
1832
},
1833
pageWidth: {
1834
+
type: 'integer',
1835
+
minimum: 0,
1836
+
maximum: 1600,
1837
},
1838
primary: {
1839
+
type: 'union',
1840
refs: [
1841
+
'lex:pub.leaflet.theme.color#rgba',
1842
+
'lex:pub.leaflet.theme.color#rgb',
1843
],
1844
},
1845
pageBackground: {
1846
+
type: 'union',
1847
refs: [
1848
+
'lex:pub.leaflet.theme.color#rgba',
1849
+
'lex:pub.leaflet.theme.color#rgb',
1850
],
1851
},
1852
showPageBackground: {
1853
+
type: 'boolean',
1854
default: false,
1855
},
1856
accentBackground: {
1857
+
type: 'union',
1858
refs: [
1859
+
'lex:pub.leaflet.theme.color#rgba',
1860
+
'lex:pub.leaflet.theme.color#rgb',
1861
],
1862
},
1863
accentText: {
1864
+
type: 'union',
1865
refs: [
1866
+
'lex:pub.leaflet.theme.color#rgba',
1867
+
'lex:pub.leaflet.theme.color#rgb',
1868
],
1869
},
1870
},
···
1873
},
1874
PubLeafletRichtextFacet: {
1875
lexicon: 1,
1876
+
id: 'pub.leaflet.richtext.facet',
1877
defs: {
1878
main: {
1879
+
type: 'object',
1880
+
description: 'Annotation of a sub-string within rich text.',
1881
+
required: ['index', 'features'],
1882
properties: {
1883
index: {
1884
+
type: 'ref',
1885
+
ref: 'lex:pub.leaflet.richtext.facet#byteSlice',
1886
},
1887
features: {
1888
+
type: 'array',
1889
items: {
1890
+
type: 'union',
1891
refs: [
1892
+
'lex:pub.leaflet.richtext.facet#link',
1893
+
'lex:pub.leaflet.richtext.facet#didMention',
1894
+
'lex:pub.leaflet.richtext.facet#atMention',
1895
+
'lex:pub.leaflet.richtext.facet#code',
1896
+
'lex:pub.leaflet.richtext.facet#highlight',
1897
+
'lex:pub.leaflet.richtext.facet#underline',
1898
+
'lex:pub.leaflet.richtext.facet#strikethrough',
1899
+
'lex:pub.leaflet.richtext.facet#id',
1900
+
'lex:pub.leaflet.richtext.facet#bold',
1901
+
'lex:pub.leaflet.richtext.facet#italic',
1902
],
1903
},
1904
},
1905
},
1906
},
1907
byteSlice: {
1908
+
type: 'object',
1909
description:
1910
+
'Specifies the sub-string range a facet feature applies to. Start index is inclusive, end index is exclusive. Indices are zero-indexed, counting bytes of the UTF-8 encoded text. NOTE: some languages, like Javascript, use UTF-16 or Unicode codepoints for string slice indexing; in these languages, convert to byte arrays before working with facets.',
1911
+
required: ['byteStart', 'byteEnd'],
1912
properties: {
1913
byteStart: {
1914
+
type: 'integer',
1915
minimum: 0,
1916
},
1917
byteEnd: {
1918
+
type: 'integer',
1919
minimum: 0,
1920
},
1921
},
1922
},
1923
link: {
1924
+
type: 'object',
1925
description:
1926
+
'Facet feature for a URL. The text URL may have been simplified or truncated, but the facet reference should be a complete URL.',
1927
+
required: ['uri'],
1928
properties: {
1929
uri: {
1930
+
type: 'string',
1931
},
1932
},
1933
},
1934
didMention: {
1935
+
type: 'object',
1936
+
description: 'Facet feature for mentioning a did.',
1937
+
required: ['did'],
1938
properties: {
1939
did: {
1940
+
type: 'string',
1941
+
format: 'did',
1942
},
1943
},
1944
},
1945
atMention: {
1946
+
type: 'object',
1947
+
description: 'Facet feature for mentioning an AT URI.',
1948
+
required: ['atURI'],
1949
properties: {
1950
atURI: {
1951
+
type: 'string',
1952
+
format: 'uri',
1953
},
1954
},
1955
},
1956
code: {
1957
+
type: 'object',
1958
+
description: 'Facet feature for inline code.',
1959
required: [],
1960
properties: {},
1961
},
1962
highlight: {
1963
+
type: 'object',
1964
+
description: 'Facet feature for highlighted text.',
1965
required: [],
1966
properties: {},
1967
},
1968
underline: {
1969
+
type: 'object',
1970
+
description: 'Facet feature for underline markup',
1971
required: [],
1972
properties: {},
1973
},
1974
strikethrough: {
1975
+
type: 'object',
1976
+
description: 'Facet feature for strikethrough markup',
1977
required: [],
1978
properties: {},
1979
},
1980
id: {
1981
+
type: 'object',
1982
description:
1983
+
'Facet feature for an identifier. Used for linking to a segment',
1984
required: [],
1985
properties: {
1986
id: {
1987
+
type: 'string',
1988
},
1989
},
1990
},
1991
bold: {
1992
+
type: 'object',
1993
+
description: 'Facet feature for bold text',
1994
required: [],
1995
properties: {},
1996
},
1997
italic: {
1998
+
type: 'object',
1999
+
description: 'Facet feature for italic text',
2000
required: [],
2001
properties: {},
2002
},
···
2004
},
2005
PubLeafletThemeBackgroundImage: {
2006
lexicon: 1,
2007
+
id: 'pub.leaflet.theme.backgroundImage',
2008
defs: {
2009
main: {
2010
+
type: 'object',
2011
+
required: ['image'],
2012
properties: {
2013
image: {
2014
+
type: 'blob',
2015
+
accept: ['image/*'],
2016
maxSize: 1000000,
2017
},
2018
width: {
2019
+
type: 'integer',
2020
},
2021
repeat: {
2022
+
type: 'boolean',
2023
},
2024
},
2025
},
···
2027
},
2028
PubLeafletThemeColor: {
2029
lexicon: 1,
2030
+
id: 'pub.leaflet.theme.color',
2031
defs: {
2032
rgba: {
2033
+
type: 'object',
2034
+
required: ['r', 'g', 'b', 'a'],
2035
properties: {
2036
r: {
2037
+
type: 'integer',
2038
maximum: 255,
2039
minimum: 0,
2040
},
2041
g: {
2042
+
type: 'integer',
2043
maximum: 255,
2044
minimum: 0,
2045
},
2046
b: {
2047
+
type: 'integer',
2048
maximum: 255,
2049
minimum: 0,
2050
},
2051
a: {
2052
+
type: 'integer',
2053
maximum: 100,
2054
minimum: 0,
2055
},
2056
},
2057
},
2058
rgb: {
2059
+
type: 'object',
2060
+
required: ['r', 'g', 'b'],
2061
properties: {
2062
r: {
2063
+
type: 'integer',
2064
maximum: 255,
2065
minimum: 0,
2066
},
2067
g: {
2068
+
type: 'integer',
2069
maximum: 255,
2070
minimum: 0,
2071
},
2072
b: {
2073
+
type: 'integer',
2074
maximum: 255,
2075
minimum: 0,
2076
},
···
2078
},
2079
},
2080
},
2081
+
} as const satisfies Record<string, LexiconDoc>
2082
+
export const schemas = Object.values(schemaDict) satisfies LexiconDoc[]
2083
+
export const lexicons: Lexicons = new Lexicons(schemas)
2084
2085
export function validate<T extends { $type: string }>(
2086
v: unknown,
2087
id: string,
2088
hash: string,
2089
requiredType: true,
2090
+
): ValidationResult<T>
2091
export function validate<T extends { $type?: string }>(
2092
v: unknown,
2093
id: string,
2094
hash: string,
2095
requiredType?: false,
2096
+
): ValidationResult<T>
2097
export function validate(
2098
v: unknown,
2099
id: string,
···
2105
: {
2106
success: false,
2107
error: new ValidationError(
2108
+
`Must be an object with "${hash === 'main' ? id : `${id}#${hash}`}" $type property`,
2109
),
2110
+
}
2111
}
2112
2113
export const ids = {
2114
+
AppBskyActorProfile: 'app.bsky.actor.profile',
2115
+
ComAtprotoLabelDefs: 'com.atproto.label.defs',
2116
+
ComAtprotoRepoApplyWrites: 'com.atproto.repo.applyWrites',
2117
+
ComAtprotoRepoCreateRecord: 'com.atproto.repo.createRecord',
2118
+
ComAtprotoRepoDefs: 'com.atproto.repo.defs',
2119
+
ComAtprotoRepoDeleteRecord: 'com.atproto.repo.deleteRecord',
2120
+
ComAtprotoRepoDescribeRepo: 'com.atproto.repo.describeRepo',
2121
+
ComAtprotoRepoGetRecord: 'com.atproto.repo.getRecord',
2122
+
ComAtprotoRepoImportRepo: 'com.atproto.repo.importRepo',
2123
+
ComAtprotoRepoListMissingBlobs: 'com.atproto.repo.listMissingBlobs',
2124
+
ComAtprotoRepoListRecords: 'com.atproto.repo.listRecords',
2125
+
ComAtprotoRepoPutRecord: 'com.atproto.repo.putRecord',
2126
+
ComAtprotoRepoStrongRef: 'com.atproto.repo.strongRef',
2127
+
ComAtprotoRepoUploadBlob: 'com.atproto.repo.uploadBlob',
2128
+
PubLeafletBlocksBlockquote: 'pub.leaflet.blocks.blockquote',
2129
+
PubLeafletBlocksBskyPost: 'pub.leaflet.blocks.bskyPost',
2130
+
PubLeafletBlocksButton: 'pub.leaflet.blocks.button',
2131
+
PubLeafletBlocksCode: 'pub.leaflet.blocks.code',
2132
+
PubLeafletBlocksHeader: 'pub.leaflet.blocks.header',
2133
+
PubLeafletBlocksHorizontalRule: 'pub.leaflet.blocks.horizontalRule',
2134
+
PubLeafletBlocksIframe: 'pub.leaflet.blocks.iframe',
2135
+
PubLeafletBlocksImage: 'pub.leaflet.blocks.image',
2136
+
PubLeafletBlocksMath: 'pub.leaflet.blocks.math',
2137
+
PubLeafletBlocksPage: 'pub.leaflet.blocks.page',
2138
+
PubLeafletBlocksPoll: 'pub.leaflet.blocks.poll',
2139
+
PubLeafletBlocksText: 'pub.leaflet.blocks.text',
2140
+
PubLeafletBlocksUnorderedList: 'pub.leaflet.blocks.unorderedList',
2141
+
PubLeafletBlocksWebsite: 'pub.leaflet.blocks.website',
2142
+
PubLeafletComment: 'pub.leaflet.comment',
2143
+
PubLeafletDocument: 'pub.leaflet.document',
2144
+
PubLeafletGraphSubscription: 'pub.leaflet.graph.subscription',
2145
+
PubLeafletPagesCanvas: 'pub.leaflet.pages.canvas',
2146
+
PubLeafletPagesLinearDocument: 'pub.leaflet.pages.linearDocument',
2147
+
PubLeafletPollDefinition: 'pub.leaflet.poll.definition',
2148
+
PubLeafletPollVote: 'pub.leaflet.poll.vote',
2149
+
PubLeafletPublication: 'pub.leaflet.publication',
2150
+
PubLeafletRichtextFacet: 'pub.leaflet.richtext.facet',
2151
+
PubLeafletThemeBackgroundImage: 'pub.leaflet.theme.backgroundImage',
2152
+
PubLeafletThemeColor: 'pub.leaflet.theme.color',
2153
+
} as const
+39
-41
lexicons/api/types/pub/leaflet/publication.ts
+39
-41
lexicons/api/types/pub/leaflet/publication.ts
···
1
/**
2
* GENERATED CODE - DO NOT MODIFY
3
*/
4
-
import { type ValidationResult, BlobRef } from "@atproto/lexicon";
5
-
import { CID } from "multiformats/cid";
6
-
import { validate as _validate } from "../../../lexicons";
7
-
import {
8
-
type $Typed,
9
-
is$typed as _is$typed,
10
-
type OmitKey,
11
-
} from "../../../util";
12
-
import type * as PubLeafletThemeColor from "./theme/color";
13
-
import type * as PubLeafletThemeBackgroundImage from "./theme/backgroundImage";
14
15
const is$typed = _is$typed,
16
-
validate = _validate;
17
-
const id = "pub.leaflet.publication";
18
19
export interface Record {
20
-
$type: "pub.leaflet.publication";
21
-
name: string;
22
-
base_path?: string;
23
-
description?: string;
24
-
icon?: BlobRef;
25
-
theme?: Theme;
26
-
preferences?: Preferences;
27
-
[k: string]: unknown;
28
}
29
30
-
const hashRecord = "main";
31
32
export function isRecord<V>(v: V) {
33
-
return is$typed(v, id, hashRecord);
34
}
35
36
export function validateRecord<V>(v: V) {
37
-
return validate<Record & V>(v, id, hashRecord, true);
38
}
39
40
export interface Preferences {
41
-
$type?: "pub.leaflet.publication#preferences";
42
-
showInDiscover: boolean;
43
-
showComments: boolean;
44
}
45
46
-
const hashPreferences = "preferences";
47
48
export function isPreferences<V>(v: V) {
49
-
return is$typed(v, id, hashPreferences);
50
}
51
52
export function validatePreferences<V>(v: V) {
53
-
return validate<Preferences & V>(v, id, hashPreferences);
54
}
55
56
export interface Theme {
57
-
$type?: "pub.leaflet.publication#theme";
58
backgroundColor?:
59
| $Typed<PubLeafletThemeColor.Rgba>
60
| $Typed<PubLeafletThemeColor.Rgb>
61
-
| { $type: string };
62
-
backgroundImage?: PubLeafletThemeBackgroundImage.Main;
63
-
pageWidth?: number;
64
primary?:
65
| $Typed<PubLeafletThemeColor.Rgba>
66
| $Typed<PubLeafletThemeColor.Rgb>
67
-
| { $type: string };
68
pageBackground?:
69
| $Typed<PubLeafletThemeColor.Rgba>
70
| $Typed<PubLeafletThemeColor.Rgb>
71
-
| { $type: string };
72
-
showPageBackground: boolean;
73
accentBackground?:
74
| $Typed<PubLeafletThemeColor.Rgba>
75
| $Typed<PubLeafletThemeColor.Rgb>
76
-
| { $type: string };
77
accentText?:
78
| $Typed<PubLeafletThemeColor.Rgba>
79
| $Typed<PubLeafletThemeColor.Rgb>
80
-
| { $type: string };
81
}
82
83
-
const hashTheme = "theme";
84
85
export function isTheme<V>(v: V) {
86
-
return is$typed(v, id, hashTheme);
87
}
88
89
export function validateTheme<V>(v: V) {
90
-
return validate<Theme & V>(v, id, hashTheme);
91
}
···
1
/**
2
* GENERATED CODE - DO NOT MODIFY
3
*/
4
+
import { type ValidationResult, BlobRef } from '@atproto/lexicon'
5
+
import { CID } from 'multiformats/cid'
6
+
import { validate as _validate } from '../../../lexicons'
7
+
import { type $Typed, is$typed as _is$typed, type OmitKey } from '../../../util'
8
+
import type * as PubLeafletThemeColor from './theme/color'
9
+
import type * as PubLeafletThemeBackgroundImage from './theme/backgroundImage'
10
11
const is$typed = _is$typed,
12
+
validate = _validate
13
+
const id = 'pub.leaflet.publication'
14
15
export interface Record {
16
+
$type: 'pub.leaflet.publication'
17
+
name: string
18
+
base_path?: string
19
+
description?: string
20
+
icon?: BlobRef
21
+
theme?: Theme
22
+
preferences?: Preferences
23
+
[k: string]: unknown
24
}
25
26
+
const hashRecord = 'main'
27
28
export function isRecord<V>(v: V) {
29
+
return is$typed(v, id, hashRecord)
30
}
31
32
export function validateRecord<V>(v: V) {
33
+
return validate<Record & V>(v, id, hashRecord, true)
34
}
35
36
export interface Preferences {
37
+
$type?: 'pub.leaflet.publication#preferences'
38
+
showInDiscover: boolean
39
+
showComments: boolean
40
+
showMentions: boolean
41
+
showPrevNext: boolean
42
}
43
44
+
const hashPreferences = 'preferences'
45
46
export function isPreferences<V>(v: V) {
47
+
return is$typed(v, id, hashPreferences)
48
}
49
50
export function validatePreferences<V>(v: V) {
51
+
return validate<Preferences & V>(v, id, hashPreferences)
52
}
53
54
export interface Theme {
55
+
$type?: 'pub.leaflet.publication#theme'
56
backgroundColor?:
57
| $Typed<PubLeafletThemeColor.Rgba>
58
| $Typed<PubLeafletThemeColor.Rgb>
59
+
| { $type: string }
60
+
backgroundImage?: PubLeafletThemeBackgroundImage.Main
61
+
pageWidth?: number
62
primary?:
63
| $Typed<PubLeafletThemeColor.Rgba>
64
| $Typed<PubLeafletThemeColor.Rgb>
65
+
| { $type: string }
66
pageBackground?:
67
| $Typed<PubLeafletThemeColor.Rgba>
68
| $Typed<PubLeafletThemeColor.Rgb>
69
+
| { $type: string }
70
+
showPageBackground: boolean
71
accentBackground?:
72
| $Typed<PubLeafletThemeColor.Rgba>
73
| $Typed<PubLeafletThemeColor.Rgb>
74
+
| { $type: string }
75
accentText?:
76
| $Typed<PubLeafletThemeColor.Rgba>
77
| $Typed<PubLeafletThemeColor.Rgb>
78
+
| { $type: string }
79
}
80
81
+
const hashTheme = 'theme'
82
83
export function isTheme<V>(v: V) {
84
+
return is$typed(v, id, hashTheme)
85
}
86
87
export function validateTheme<V>(v: V) {
88
+
return validate<Theme & V>(v, id, hashTheme)
89
}
+15
-3
lexicons/pub/leaflet/publication.json
+15
-3
lexicons/pub/leaflet/publication.json
···
8
"description": "Record declaring a publication",
9
"record": {
10
"type": "object",
11
-
"required": ["name"],
12
"properties": {
13
"name": {
14
"type": "string",
···
23
},
24
"icon": {
25
"type": "blob",
26
-
"accept": ["image/*"],
27
"maxSize": 1000000
28
},
29
"theme": {
···
45
"default": true
46
},
47
"showComments": {
48
"type": "boolean",
49
"default": true
50
}
···
104
}
105
}
106
}
107
-
}
···
8
"description": "Record declaring a publication",
9
"record": {
10
"type": "object",
11
+
"required": [
12
+
"name"
13
+
],
14
"properties": {
15
"name": {
16
"type": "string",
···
25
},
26
"icon": {
27
"type": "blob",
28
+
"accept": [
29
+
"image/*"
30
+
],
31
"maxSize": 1000000
32
},
33
"theme": {
···
49
"default": true
50
},
51
"showComments": {
52
+
"type": "boolean",
53
+
"default": true
54
+
},
55
+
"showMentions": {
56
+
"type": "boolean",
57
+
"default": true
58
+
},
59
+
"showPrevNext": {
60
"type": "boolean",
61
"default": true
62
}
···
116
}
117
}
118
}
119
+
}
+2
lexicons/src/publication.ts
+2
lexicons/src/publication.ts