@atcute/bluesky 1.0.5 → 1.0.7

package/dist/lexicons.d.ts

@@ -20,6 +20,11 @@ declare module '@atcute/client/lexicons' {
         interface BskyAppStatePref {
             [Brand.Type]?: 'app.bsky.actor.defs#bskyAppStatePref';
             activeProgressGuide?: BskyAppProgressGuide;
+            /**
+             * Storage for NUXs the user has encountered. \
+             * Maximum array length: 100
+             */
+            nuxs?: AppBskyActorDefs.Nux[];
             /**
              * An array of tokens which identify nudges (modals, popups, tours, highlight dots) that should be shown to the user. \
              * Maximum array length: 1000 \
@@ -115,6 +120,22 @@ declare module '@atcute/client/lexicons' {
          * Maximum grapheme length: 64
          */
         type MutedWordTarget = 'content' | 'tag' | (string & {});
+        /** A new user experiences (NUX) storage object */
+        interface Nux {
+            [Brand.Type]?: 'app.bsky.actor.defs#nux';
+            /** @default false */
+            completed: boolean;
+            /** Maximum string length: 100 */
+            id: string;
+            /**
+             * Arbitrary data for the NUX. The structure is defined by the NUX itself. Limited to 300 characters. \
+             * Maximum string length: 3000 \
+             * Maximum grapheme length: 300
+             */
+            data?: string;
+            /** The date and time at which the NUX will expire and should be considered completed. */
+            expiresAt?: string;
+        }
         interface PersonalDetailsPref {
             [Brand.Type]?: 'app.bsky.actor.defs#personalDetailsPref';
             /** The birth date of account owner. */
@@ -192,6 +213,7 @@ declare module '@atcute/client/lexicons' {
             indexedAt?: string;
             joinedViaStarterPack?: AppBskyGraphDefs.StarterPackViewBasic;
             labels?: ComAtprotoLabelDefs.Label[];
+            pinnedPost?: ComAtprotoRepoStrongRef.Main;
             postsCount?: number;
             viewer?: ViewerState;
         }
@@ -277,7 +299,9 @@ declare module '@atcute/client/lexicons' {
         }
     }
     namespace AppBskyActorProfile {
+        /** A declaration of a Bluesky account profile. */
         interface Record {
+            $type: 'app.bsky.actor.profile';
             /** Small image to be displayed next to posts from account. AKA, 'profile picture' */
             avatar?: At.Blob;
             /** Larger horizontal image to display behind profile view. */
@@ -297,6 +321,7 @@ declare module '@atcute/client/lexicons' {
             joinedViaStarterPack?: ComAtprotoRepoStrongRef.Main;
             /** Self-label values, specific to the Bluesky application, on the overall account. */
             labels?: Brand.Union<ComAtprotoLabelDefs.SelfLabels>;
+            pinnedPost?: ComAtprotoRepoStrongRef.Main;
         }
     }
     /** Set the private preferences attached to the account. */
@@ -527,7 +552,7 @@ declare module '@atcute/client/lexicons' {
              * Maximum string length: 2000
              */
             feedContext?: string;
-            reason?: Brand.Union<ReasonRepost>;
+            reason?: Brand.Union<ReasonPin | ReasonRepost>;
             reply?: ReplyRef;
         }
         interface GeneratorView {
@@ -592,6 +617,9 @@ declare module '@atcute/client/lexicons' {
             threadgate?: ThreadgateView;
             viewer?: ViewerState;
         }
+        interface ReasonPin {
+            [Brand.Type]?: 'app.bsky.feed.defs#reasonPin';
+        }
         interface ReasonRepost {
             [Brand.Type]?: 'app.bsky.feed.defs#reasonRepost';
             by: AppBskyActorDefs.ProfileViewBasic;
@@ -614,7 +642,10 @@ declare module '@atcute/client/lexicons' {
              * Maximum string length: 2000
              */
             feedContext?: string;
-            reason?: Brand.Union<SkeletonReasonRepost>;
+            reason?: Brand.Union<SkeletonReasonPin | SkeletonReasonRepost>;
+        }
+        interface SkeletonReasonPin {
+            [Brand.Type]?: 'app.bsky.feed.defs#skeletonReasonPin';
         }
         interface SkeletonReasonRepost {
             [Brand.Type]?: 'app.bsky.feed.defs#skeletonReasonRepost';
@@ -638,6 +669,7 @@ declare module '@atcute/client/lexicons' {
             [Brand.Type]?: 'app.bsky.feed.defs#viewerState';
             embeddingDisabled?: boolean;
             like?: At.Uri;
+            pinned?: boolean;
             replyDisabled?: boolean;
             repost?: At.Uri;
             threadMuted?: boolean;
@@ -664,7 +696,9 @@ declare module '@atcute/client/lexicons' {
         }
     }
     namespace AppBskyFeedGenerator {
+        /** Record declaring of the existence of a feed generator, and containing metadata about it. The record can exist in any repository. */
         interface Record {
+            $type: 'app.bsky.feed.generator';
             createdAt: string;
             did: At.DID;
             /**
@@ -735,6 +769,8 @@ declare module '@atcute/client/lexicons' {
              * @default "posts_with_replies"
              */
             filter?: 'posts_and_author_threads' | 'posts_no_replies' | 'posts_with_media' | 'posts_with_replies' | (string & {});
+            /** @default false */
+            includePins?: boolean;
             /**
              * Minimum: 1 \
              * Maximum: 100
@@ -997,13 +1033,17 @@ declare module '@atcute/client/lexicons' {
         }
     }
     namespace AppBskyFeedLike {
+        /** Record declaring a 'like' of a piece of subject content. */
         interface Record {
+            $type: 'app.bsky.feed.like';
             createdAt: string;
             subject: ComAtprotoRepoStrongRef.Main;
         }
     }
     namespace AppBskyFeedPost {
+        /** Record containing a Bluesky post. */
         interface Record {
+            $type: 'app.bsky.feed.post';
             /** Client-declared timestamp when this post was originally created. */
             createdAt: string;
             /**
@@ -1065,7 +1105,9 @@ declare module '@atcute/client/lexicons' {
         }
     }
     namespace AppBskyFeedPostgate {
+        /** Record defining interaction rules for a post. The record key (rkey) of the postgate record must match the record key of the post, and that record must be in the same repository. */
         interface Record {
+            $type: 'app.bsky.feed.postgate';
             createdAt: string;
             /** Reference (AT-URI) to the post record. */
             post: At.Uri;
@@ -1083,7 +1125,9 @@ declare module '@atcute/client/lexicons' {
         }
     }
     namespace AppBskyFeedRepost {
+        /** Record representing a 'repost' of an existing Bluesky post. */
         interface Record {
+            $type: 'app.bsky.feed.repost';
             createdAt: string;
             subject: ComAtprotoRepoStrongRef.Main;
         }
@@ -1149,7 +1193,9 @@ declare module '@atcute/client/lexicons' {
         }
     }
     namespace AppBskyFeedThreadgate {
+        /** Record defining interaction gating rules for a thread (aka, reply controls). The record key (rkey) of the threadgate record must match the record key of the thread's root post, and that record must be in the same repository. */
         interface Record {
+            $type: 'app.bsky.feed.threadgate';
             createdAt: string;
             /** Reference (AT-URI) to the post record. */
             post: At.Uri;
@@ -1176,7 +1222,9 @@ declare module '@atcute/client/lexicons' {
         }
     }
     namespace AppBskyGraphBlock {
+        /** Record declaring a 'block' relationship against another account. NOTE: blocks are public in Bluesky; see blog posts for details. */
         interface Record {
+            $type: 'app.bsky.graph.block';
             createdAt: string;
             /** DID of the account to be blocked. */
             subject: At.DID;
@@ -1288,7 +1336,9 @@ declare module '@atcute/client/lexicons' {
         }
     }
     namespace AppBskyGraphFollow {
+        /** Record declaring a social 'follow' relationship of another account. Duplicate follows will be ignored by the AppView. */
         interface Record {
+            $type: 'app.bsky.graph.follow';
             createdAt: string;
             subject: At.DID;
         }
@@ -1525,10 +1575,17 @@ declare module '@atcute/client/lexicons' {
         type Input = undefined;
         interface Output {
             suggestions: AppBskyActorDefs.ProfileView[];
+            /**
+             * If true, response has fallen-back to generic results, and is not scoped using relativeToDid
+             * @default false
+             */
+            isFallback?: boolean;
         }
     }
     namespace AppBskyGraphList {
+        /** Record representing a list of accounts (actors). Scope includes both moderation-oriented lists and curration-oriented lists. */
         interface Record {
+            $type: 'app.bsky.graph.list';
             createdAt: string;
             /**
              * Display name for list; can not be empty. \
@@ -1549,14 +1606,18 @@ declare module '@atcute/client/lexicons' {
         }
     }
     namespace AppBskyGraphListblock {
+        /** Record representing a block relationship against an entire an entire list of accounts (actors). */
         interface Record {
+            $type: 'app.bsky.graph.listblock';
             createdAt: string;
             /** Reference (AT-URI) to the mod list record. */
             subject: At.Uri;
         }
     }
     namespace AppBskyGraphListitem {
+        /** Record representing an account's inclusion on a specific list. The AppView will ignore duplicate listitem records. */
         interface Record {
+            $type: 'app.bsky.graph.listitem';
             createdAt: string;
             /** Reference (AT-URI) to the list record (app.bsky.graph.list). */
             list: At.Uri;
@@ -1592,7 +1653,9 @@ declare module '@atcute/client/lexicons' {
         type Output = undefined;
     }
     namespace AppBskyGraphStarterpack {
+        /** Record defining a starter pack of actors and feeds for new users. */
         interface Record {
+            $type: 'app.bsky.graph.starterpack';
             createdAt: string;
             /** Reference (AT-URI) to the list record. */
             list: At.Uri;
@@ -1693,7 +1756,9 @@ declare module '@atcute/client/lexicons' {
         }
     }
     namespace AppBskyLabelerService {
+        /** A declaration of the existence of labeler service. */
         interface Record {
+            $type: 'app.bsky.labeler.service';
             createdAt: string;
             policies: AppBskyLabelerDefs.LabelerPolicies;
             labels?: Brand.Union<ComAtprotoLabelDefs.SelfLabels>;
@@ -1856,6 +1921,8 @@ declare module '@atcute/client/lexicons' {
         interface Output {
             actors: AppBskyUnspeccedDefs.SkeletonSearchActor[];
             cursor?: string;
+            /** DID of the account these suggestions are relative to. If this is returned undefined, suggestions are based on the viewer. */
+            relativeToDid?: At.DID;
         }
     }
     /** Get a list of suggestions (feeds and users) tagged with categories */
@@ -2003,7 +2070,9 @@ declare module '@atcute/client/lexicons' {
         }
     }
     namespace ChatBskyActorDeclaration {
+        /** A declaration of a Bluesky chat account. */
         interface Record {
+            $type: 'chat.bsky.actor.declaration';
             allowIncoming: 'all' | 'following' | 'none' | (string & {});
         }
     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@atcute/bluesky",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "Bluesky type definitions for atcute",
   "license": "MIT",
   "repository": {
@@ -17,8 +17,8 @@
     "@atcute/client": "^1.0.0 || ^2.0.0"
   },
   "devDependencies": {
-    "@atcute/client": "^2.0.0",
-    "@atcute/lex-cli": "^1.0.0"
+    "@atcute/client": "^2.0.1",
+    "@atcute/lex-cli": "^1.0.2"
   },
   "scripts": {
     "build": "tsc",