[SDK] Migrate the gate records to raw repo calls on the pds client (#11378)
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
@@ -1,26 +1,34 @@
|
||||
import {type AppBskyFeedDefs, AppBskyFeedThreadgate} from '@atproto/api'
|
||||
import {type AppBskyFeedDefs} from '@atproto/api'
|
||||
import {type AtUriString, toDatetimeString} from '@atproto/syntax'
|
||||
|
||||
import {type ThreadgateAllowUISetting} from '#/state/queries/threadgate/types'
|
||||
import {app} from '#/lexicons'
|
||||
import * as bsky from '#/types/bsky'
|
||||
|
||||
/*
|
||||
* Threadgate VIEWS stay on the legacy client types: they are read-only inputs
|
||||
* from the appview, and branding them here would ripple through every post
|
||||
* component. Only the threadgate RECORD is migrated, because it is written
|
||||
* through `com.atproto.repo.putRecord`, whose body is typed as a lex `LexMap`.
|
||||
*/
|
||||
export function threadgateViewToAllowUISetting(
|
||||
threadgateView: AppBskyFeedDefs.ThreadgateView | undefined,
|
||||
): ThreadgateAllowUISetting[] {
|
||||
// Validate the record for clarity, since backwards compat code is a little confusing
|
||||
const threadgate =
|
||||
threadgateView &&
|
||||
bsky.validate(threadgateView.record, AppBskyFeedThreadgate.validateRecord)
|
||||
bsky.matches(app.bsky.feed.threadgate, threadgateView.record)
|
||||
? threadgateView.record
|
||||
: undefined
|
||||
return threadgateRecordToAllowUISetting(threadgate)
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts a full {@link AppBskyFeedThreadgate.Record} to a list of
|
||||
* Converts a full {@link app.bsky.feed.threadgate.Main} to a list of
|
||||
* {@link ThreadgateAllowUISetting}, for use by app UI.
|
||||
*/
|
||||
export function threadgateRecordToAllowUISetting(
|
||||
threadgate: AppBskyFeedThreadgate.Record | undefined,
|
||||
threadgate: app.bsky.feed.threadgate.Main | undefined,
|
||||
): ThreadgateAllowUISetting[] {
|
||||
/*
|
||||
* If `threadgate` doesn't exist (default), or if `threadgate.allow === undefined`, it means
|
||||
@@ -40,13 +48,13 @@ export function threadgateRecordToAllowUISetting(
|
||||
const settings: ThreadgateAllowUISetting[] = threadgate.allow
|
||||
.map(allow => {
|
||||
let setting: ThreadgateAllowUISetting | undefined
|
||||
if (AppBskyFeedThreadgate.isMentionRule(allow)) {
|
||||
if (bsky.isType(app.bsky.feed.threadgate.mentionRule, allow)) {
|
||||
setting = {type: 'mention'}
|
||||
} else if (AppBskyFeedThreadgate.isFollowingRule(allow)) {
|
||||
} else if (bsky.isType(app.bsky.feed.threadgate.followingRule, allow)) {
|
||||
setting = {type: 'following'}
|
||||
} else if (AppBskyFeedThreadgate.isListRule(allow)) {
|
||||
} else if (bsky.isType(app.bsky.feed.threadgate.listRule, allow)) {
|
||||
setting = {type: 'list', list: allow.list}
|
||||
} else if (AppBskyFeedThreadgate.isFollowerRule(allow)) {
|
||||
} else if (bsky.isType(app.bsky.feed.threadgate.followerRule, allow)) {
|
||||
setting = {type: 'followers'}
|
||||
}
|
||||
return setting
|
||||
@@ -57,7 +65,7 @@ export function threadgateRecordToAllowUISetting(
|
||||
|
||||
/**
|
||||
* Converts an array of {@link ThreadgateAllowUISetting} to the `allow` prop on
|
||||
* {@link AppBskyFeedThreadgate.Record}.
|
||||
* {@link app.bsky.feed.threadgate.Main}.
|
||||
*
|
||||
* If the `allow` property on the record is undefined, we infer that to mean
|
||||
* that everyone can reply. If it's an empty array, we infer that to mean that
|
||||
@@ -65,12 +73,12 @@ export function threadgateRecordToAllowUISetting(
|
||||
*/
|
||||
export function threadgateAllowUISettingToAllowRecordValue(
|
||||
threadgate: ThreadgateAllowUISetting[],
|
||||
): AppBskyFeedThreadgate.Record['allow'] {
|
||||
): app.bsky.feed.threadgate.Main['allow'] {
|
||||
if (threadgate.find(v => v.type === 'everybody')) {
|
||||
return undefined
|
||||
}
|
||||
|
||||
let allow: Exclude<AppBskyFeedThreadgate.Record['allow'], undefined> = []
|
||||
let allow: Exclude<app.bsky.feed.threadgate.Main['allow'], undefined> = []
|
||||
|
||||
if (!threadgate.find(v => v.type === 'nobody')) {
|
||||
for (const rule of threadgate) {
|
||||
@@ -83,7 +91,7 @@ export function threadgateAllowUISettingToAllowRecordValue(
|
||||
} else if (rule.type === 'list') {
|
||||
allow.push({
|
||||
$type: 'app.bsky.feed.threadgate#listRule',
|
||||
list: rule.list,
|
||||
list: rule.list as AtUriString,
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -93,18 +101,20 @@ export function threadgateAllowUISettingToAllowRecordValue(
|
||||
}
|
||||
|
||||
/**
|
||||
* Merges two {@link AppBskyFeedThreadgate.Record} objects, combining their
|
||||
* Merges two {@link app.bsky.feed.threadgate.Main} objects, combining their
|
||||
* `allow` and `hiddenReplies` arrays and de-deduplicating them.
|
||||
*
|
||||
* Note: `allow` can be undefined here, be sure you don't accidentally set it
|
||||
* to an empty array. See other comments in this file.
|
||||
*/
|
||||
export function mergeThreadgateRecords(
|
||||
prev: AppBskyFeedThreadgate.Record,
|
||||
next: Partial<AppBskyFeedThreadgate.Record>,
|
||||
): AppBskyFeedThreadgate.Record {
|
||||
prev: app.bsky.feed.threadgate.Main,
|
||||
next: Omit<Partial<app.bsky.feed.threadgate.Main>, 'hiddenReplies'> & {
|
||||
hiddenReplies?: string[]
|
||||
},
|
||||
): app.bsky.feed.threadgate.Main {
|
||||
// can be undefined if everyone can reply!
|
||||
const allow: AppBskyFeedThreadgate.Record['allow'] | undefined =
|
||||
const allow: app.bsky.feed.threadgate.Main['allow'] | undefined =
|
||||
prev.allow || next.allow
|
||||
? [...(prev.allow || []), ...(next.allow || [])].filter(
|
||||
(v, i, a) => a.findIndex(t => t.$type === v.$type) === i,
|
||||
@@ -112,7 +122,7 @@ export function mergeThreadgateRecords(
|
||||
: undefined
|
||||
const hiddenReplies = Array.from(
|
||||
new Set([...(prev.hiddenReplies || []), ...(next.hiddenReplies || [])]),
|
||||
)
|
||||
) as AtUriString[]
|
||||
|
||||
return createThreadgateRecord({
|
||||
post: prev.post,
|
||||
@@ -122,21 +132,28 @@ export function mergeThreadgateRecords(
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a new {@link AppBskyFeedThreadgate.Record} object with the given
|
||||
* properties.
|
||||
* Create a new {@link app.bsky.feed.threadgate.Main} object with the given
|
||||
* properties. `post` is accepted as a plain string (callers hold raw AT-URIs)
|
||||
* and asserted to the branded `AtUriString` here.
|
||||
*/
|
||||
export function createThreadgateRecord(
|
||||
threadgate: Partial<AppBskyFeedThreadgate.Record>,
|
||||
): AppBskyFeedThreadgate.Record {
|
||||
threadgate: Omit<
|
||||
Partial<app.bsky.feed.threadgate.Main>,
|
||||
'post' | 'hiddenReplies'
|
||||
> & {
|
||||
post?: string
|
||||
hiddenReplies?: string[]
|
||||
},
|
||||
): app.bsky.feed.threadgate.Main {
|
||||
if (!threadgate.post) {
|
||||
throw new Error('Cannot create a threadgate record without a post URI')
|
||||
}
|
||||
|
||||
return {
|
||||
$type: 'app.bsky.feed.threadgate',
|
||||
post: threadgate.post,
|
||||
createdAt: new Date().toISOString(),
|
||||
post: threadgate.post as AtUriString,
|
||||
createdAt: toDatetimeString(new Date()),
|
||||
allow: threadgate.allow, // can be undefined!
|
||||
hiddenReplies: threadgate.hiddenReplies || [],
|
||||
hiddenReplies: (threadgate.hiddenReplies || []) as AtUriString[],
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user