@atcute/bluesky 1.0.6 → 1.0.8

package/README.md

@@ -1,9 +1,70 @@
 # @atcute/bluesky
 
-[Bluesky](https://bsky.app) type definitions for `@atcute/client`, a lightweight and cute API client for AT Protocol.
+[Bluesky](https://bsky.app) type definitions for `@atcute/client`, a lightweight and cute API client
+for AT Protocol.
 
-import the lexicons module to start using it.
+## usage
+
+you'd need to import `@atcute/bluesky/lexicons` into your project, either by adding it into the
+`types` field in `tsconfig.json` or by importing it on your source code.
+
+```jsonc
+// tsconfig.json
+{
+	"compilerOptions": {
+		"types": ["@atcute/bluesky/lexicons"],
+	},
+}
+```
+
+```ts
+// env.d.ts
+/// <reference types="@atcute/bluesky/lexicons" />
+```
 
 ```ts
+// index.ts
 import '@atcute/bluesky/lexicons';
 ```
+
+newly added lexicons are augmented to `@atcute/client/lexicons` module
+
+```ts
+import type { AppBskyFeedPost, AppBskyRichtextFacet, Brand } from '@atcute/client/lexicons';
+
+type Facet = AppBskyRichtextFacet.Main;
+type MentionFeature = Brand.Union<AppBskyRichtextFacet.Mention>;
+
+const mention: MentionFeature = {
+	$type: 'app.bsky.richtext.facet#mention',
+	did: 'did:plc:z72i7hdynmk6r22z27h6tvur',
+};
+
+const facet: Facet = {
+	index: {
+		byteStart: 6,
+		byteEnd: 15,
+	},
+	features: [mention],
+};
+
+const record: AppBskyFeedPost.Record = {
+	$type: 'app.bsky.feed.post',
+	text: `hello @bsky.app!`,
+	facets: [facet],
+	createdAt: new Date().toISOString(),
+};
+```
+
+```ts
+const rpc = new XRPC({ handle: simpleFetchHandler({ service: 'https://api.bsky.app' }) });
+
+const { data } = await rpc.get('app.bsky.actor.getProfile', {
+	params: {
+		actor: 'did:plc:z72i7hdynmk6r22z27h6tvur',
+	},
+});
+
+data;
+// -> { handle: 'bsky.app', displayName: 'Bluesky', ... }
+```

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;
         }
@@ -299,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. */
@@ -529,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 {
@@ -594,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;
@@ -616,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';
@@ -640,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;
@@ -739,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
@@ -1161,7 +1193,7 @@ 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.. */
+        /** 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;
@@ -1543,6 +1575,11 @@ 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 {
@@ -1884,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 */