@atcute/bluesky 1.0.7 → 1.0.9

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({ handler: 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

@@ -239,7 +239,7 @@ declare module '@atcute/client/lexicons' {
             /** Show followed users at the top of all replies. */
             prioritizeFollowedUsers?: boolean;
             /** Sorting mode for threads. */
-            sort?: 'most-likes' | 'newest' | 'oldest' | 'random' | (string & {});
+            sort?: 'hotness' | 'most-likes' | 'newest' | 'oldest' | 'random' | (string & {});
         }
         /** Metadata about the requesting account's relationship with the subject account. Only has meaningful content for authed requests. */
         interface ViewerState {
@@ -1652,6 +1652,25 @@ declare module '@atcute/client/lexicons' {
         }
         type Output = undefined;
     }
+    /** Find starter packs matching search criteria. Does not require auth. */
+    namespace AppBskyGraphSearchStarterPacks {
+        interface Params {
+            /** Search query string. Syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. */
+            q: string;
+            cursor?: string;
+            /**
+             * Minimum: 1 \
+             * Maximum: 100
+             * @default 25
+             */
+            limit?: number;
+        }
+        type Input = undefined;
+        interface Output {
+            starterPacks: AppBskyGraphDefs.StarterPackViewBasic[];
+            cursor?: string;
+        }
+    }
     namespace AppBskyGraphStarterpack {
         /** Record defining a starter pack of actors and feeds for new users. */
         interface Record {
@@ -1883,6 +1902,19 @@ declare module '@atcute/client/lexicons' {
             [Brand.Type]?: 'app.bsky.unspecced.defs#skeletonSearchPost';
             uri: At.Uri;
         }
+        interface SkeletonSearchStarterPack {
+            [Brand.Type]?: 'app.bsky.unspecced.defs#skeletonSearchStarterPack';
+            uri: At.Uri;
+        }
+    }
+    /** Get miscellaneous runtime configuration. */
+    namespace AppBskyUnspeccedGetConfig {
+        interface Params {
+        }
+        type Input = undefined;
+        interface Output {
+            checkEmailConfirmed?: boolean;
+        }
     }
     /** An unspecced view of globally popular feed generators. */
     namespace AppBskyUnspeccedGetPopularFeedGenerators {
@@ -2019,6 +2051,33 @@ declare module '@atcute/client/lexicons' {
             BadQueryString: {};
         }
     }
+    /** Backend Starter Pack search, returns only skeleton. */
+    namespace AppBskyUnspeccedSearchStarterPacksSkeleton {
+        interface Params {
+            /** Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. */
+            q: string;
+            /** Optional pagination mechanism; may not necessarily allow scrolling through entire result set. */
+            cursor?: string;
+            /**
+             * Minimum: 1 \
+             * Maximum: 100
+             * @default 25
+             */
+            limit?: number;
+            /** DID of the account making the request (not included for public/unauthenticated queries). */
+            viewer?: At.DID;
+        }
+        type Input = undefined;
+        interface Output {
+            starterPacks: AppBskyUnspeccedDefs.SkeletonSearchStarterPack[];
+            cursor?: string;
+            /** Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits. */
+            hitsTotal?: number;
+        }
+        interface Errors {
+            BadQueryString: {};
+        }
+    }
     namespace AppBskyVideoDefs {
         interface JobStatus {
             [Brand.Type]?: 'app.bsky.video.defs#jobStatus';
@@ -2116,6 +2175,7 @@ declare module '@atcute/client/lexicons' {
             rev: string;
             unreadCount: number;
             lastMessage?: Brand.Union<DeletedMessageView | MessageView>;
+            opened?: boolean;
         }
         interface DeletedMessageView {
             [Brand.Type]?: 'chat.bsky.convo.defs#deletedMessageView';
@@ -2531,6 +2591,10 @@ declare module '@atcute/client/lexicons' {
             params: AppBskyGraphGetSuggestedFollowsByActor.Params;
             output: AppBskyGraphGetSuggestedFollowsByActor.Output;
         };
+        'app.bsky.graph.searchStarterPacks': {
+            params: AppBskyGraphSearchStarterPacks.Params;
+            output: AppBskyGraphSearchStarterPacks.Output;
+        };
         'app.bsky.labeler.getServices': {
             params: AppBskyLabelerGetServices.Params;
             output: AppBskyLabelerGetServices.Output;
@@ -2543,6 +2607,9 @@ declare module '@atcute/client/lexicons' {
             params: AppBskyNotificationListNotifications.Params;
             output: AppBskyNotificationListNotifications.Output;
         };
+        'app.bsky.unspecced.getConfig': {
+            output: AppBskyUnspeccedGetConfig.Output;
+        };
         'app.bsky.unspecced.getPopularFeedGenerators': {
             params: AppBskyUnspeccedGetPopularFeedGenerators.Params;
             output: AppBskyUnspeccedGetPopularFeedGenerators.Output;
@@ -2562,6 +2629,10 @@ declare module '@atcute/client/lexicons' {
             params: AppBskyUnspeccedSearchPostsSkeleton.Params;
             output: AppBskyUnspeccedSearchPostsSkeleton.Output;
         };
+        'app.bsky.unspecced.searchStarterPacksSkeleton': {
+            params: AppBskyUnspeccedSearchStarterPacksSkeleton.Params;
+            output: AppBskyUnspeccedSearchStarterPacksSkeleton.Output;
+        };
         'app.bsky.video.getJobStatus': {
             params: AppBskyVideoGetJobStatus.Params;
             output: AppBskyVideoGetJobStatus.Output;