@atproto/api 0.6.15 → 0.6.17

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atproto/api
 
+## 0.6.17
+
+### Patch Changes
+
+- [#1637](https://github.com/bluesky-social/atproto/pull/1637) [`d96f7d9b`](https://github.com/bluesky-social/atproto/commit/d96f7d9b84c6fbab9711059c8584a77d892dcedd) Thanks [@estrattonbailey](https://github.com/estrattonbailey)! - Introduce general support for tags on posts
+
+## 0.6.16
+
+### Patch Changes
+
+- [#1653](https://github.com/bluesky-social/atproto/pull/1653) [`56e2cf89`](https://github.com/bluesky-social/atproto/commit/56e2cf8999f6d7522529a9be8652c47545f82242) Thanks [@pfrazee](https://github.com/pfrazee)! - Improve the types of the thread and feed preferences APIs
+
 ## 0.6.15
 
 ### Patch Changes

package/README.md

@@ -31,6 +31,8 @@ Log into a server or create accounts using these APIs. You'll need an active ses
 
 ```typescript
 import { BskyAgent, AtpSessionEvent, AtpSessionData } from '@atproto/api'
+
+// configure connection to the server, without account authentication
 const agent = new BskyAgent({
   service: 'https://example.com',
   persistSession: (evt: AtpSessionEvent, sess?: AtpSessionData) => {
@@ -38,13 +40,19 @@ const agent = new BskyAgent({
   },
 })
 
-await agent.login({ identifier: 'alice@mail.com', password: 'hunter2' })
-await agent.resumeSession(savedSessionData)
+// create a new account on the server
 await agent.createAccount({
   email: 'alice@mail.com',
   password: 'hunter2',
   handle: 'alice.example.com',
+  inviteCode: 'some-code-12345-abcde',
 })
+
+// if an existing session (accessed with 'agent.session') was securely stored previously, then reuse that
+await agent.resumeSession(savedSessionData)
+
+// if no old session was available, create a new one by logging in with password (App Password)
+await agent.login({ identifier: 'alice@mail.com', password: 'hunter2' })
 ```
 
 ### API calls

package/dist/bsky-agent.d.ts

@@ -1,6 +1,6 @@
 import { AtpAgent } from './agent';
-import { AppBskyFeedPost, AppBskyActorProfile, AppBskyActorDefs } from './client';
-import { BskyPreferences, BskyLabelPreference } from './types';
+import { AppBskyFeedPost, AppBskyActorProfile } from './client';
+import { BskyPreferences, BskyLabelPreference, BskyFeedViewPreference, BskyThreadViewPreference } from './types';
 declare global {
     interface Array<T> {
         findLast(predicate: (value: T, index: number, obj: T[]) => unknown, thisArg?: any): T;
@@ -75,6 +75,6 @@ export declare class BskyAgent extends AtpAgent {
     setPersonalDetails({ birthDate, }: {
         birthDate: string | Date | undefined;
     }): Promise<void>;
-    setFeedViewPrefs(feed: string, pref: Omit<AppBskyActorDefs.FeedViewPref, '$type' | 'feed'>): Promise<void>;
-    setThreadViewPrefs(pref: Omit<AppBskyActorDefs.ThreadViewPref, '$type'>): Promise<void>;
+    setFeedViewPrefs(feed: string, pref: Partial<BskyFeedViewPreference>): Promise<void>;
+    setThreadViewPrefs(pref: Partial<BskyThreadViewPreference>): Promise<void>;
 }

package/dist/client/lexicons.d.ts

@@ -5272,6 +5272,16 @@ export declare const schemaDict: {
                             type: string;
                             refs: string[];
                         };
+                        tags: {
+                            type: string;
+                            maxLength: number;
+                            items: {
+                                type: string;
+                                maxLength: number;
+                                maxGraphemes: number;
+                            };
+                            description: string;
+                        };
                         createdAt: {
                             type: string;
                             format: string;
@@ -6408,6 +6418,18 @@ export declare const schemaDict: {
                     };
                 };
             };
+            tag: {
+                type: string;
+                description: string;
+                required: string[];
+                properties: {
+                    tag: {
+                        type: string;
+                        maxLength: number;
+                        maxGraphemes: number;
+                    };
+                };
+            };
             byteSlice: {
                 type: string;
                 description: string;

package/dist/client/types/app/bsky/feed/post.d.ts

@@ -20,6 +20,7 @@ export interface Record {
         $type: string;
         [k: string]: unknown;
     };
+    tags?: string[];
     createdAt: string;
     [k: string]: unknown;
 }

package/dist/client/types/app/bsky/richtext/facet.d.ts

@@ -1,7 +1,7 @@
 import { ValidationResult } from '@atproto/lexicon';
 export interface Main {
     index: ByteSlice;
-    features: (Mention | Link | {
+    features: (Mention | Link | Tag | {
         $type: string;
         [k: string]: unknown;
     })[];
@@ -21,6 +21,12 @@ export interface Link {
 }
 export declare function isLink(v: unknown): v is Link;
 export declare function validateLink(v: unknown): ValidationResult;
+export interface Tag {
+    tag: string;
+    [k: string]: unknown;
+}
+export declare function isTag(v: unknown): v is Tag;
+export declare function validateTag(v: unknown): ValidationResult;
 export interface ByteSlice {
     byteStart: number;
     byteEnd: number;

package/dist/index.js

@@ -21172,6 +21172,16 @@ var schemaDict = {
               type: "union",
               refs: ["lex:com.atproto.label.defs#selfLabels"]
             },
+            tags: {
+              type: "array",
+              maxLength: 8,
+              items: {
+                type: "string",
+                maxLength: 640,
+                maxGraphemes: 64
+              },
+              description: "Additional non-inline tags describing this post."
+            },
             createdAt: {
               type: "string",
               format: "datetime"
@@ -22305,7 +22315,8 @@ var schemaDict = {
               type: "union",
               refs: [
                 "lex:app.bsky.richtext.facet#mention",
-                "lex:app.bsky.richtext.facet#link"
+                "lex:app.bsky.richtext.facet#link",
+                "lex:app.bsky.richtext.facet#tag"
               ]
             }
           }
@@ -22333,6 +22344,18 @@ var schemaDict = {
           }
         }
       },
+      tag: {
+        type: "object",
+        description: "A hashtag.",
+        required: ["tag"],
+        properties: {
+          tag: {
+            type: "string",
+            maxLength: 640,
+            maxGraphemes: 64
+          }
+        }
+      },
       byteSlice: {
         type: "object",
         description: "A text segment. Start is inclusive, end is exclusive. Indices are for utf8-encoded strings.",
@@ -22382,7 +22405,7 @@ var schemaDict = {
     defs: {
       main: {
         type: "query",
-        description: "An unspecced view of globally popular items",
+        description: "DEPRECATED: will be removed soon, please find a feed generator alternative",
         parameters: {
           type: "params",
           properties: {
@@ -24904,10 +24927,12 @@ __export(facet_exports, {
   isLink: () => isLink,
   isMain: () => isMain6,
   isMention: () => isMention,
+  isTag: () => isTag,
   validateByteSlice: () => validateByteSlice,
   validateLink: () => validateLink,
   validateMain: () => validateMain6,
-  validateMention: () => validateMention
+  validateMention: () => validateMention,
+  validateTag: () => validateTag
 });
 function isMain6(v) {
   return isObj2(v) && hasProp2(v, "$type") && (v.$type === "app.bsky.richtext.facet#main" || v.$type === "app.bsky.richtext.facet");
@@ -24927,6 +24952,12 @@ function isLink(v) {
 function validateLink(v) {
   return lexicons.validate("app.bsky.richtext.facet#link", v);
 }
+function isTag(v) {
+  return isObj2(v) && hasProp2(v, "$type") && v.$type === "app.bsky.richtext.facet#tag";
+}
+function validateTag(v) {
+  return lexicons.validate("app.bsky.richtext.facet#tag", v);
+}
 function isByteSlice(v) {
   return isObj2(v) && hasProp2(v, "$type") && v.$type === "app.bsky.richtext.facet#byteSlice";
 }
@@ -28892,12 +28923,12 @@ function decideQuotedPostWithMediaAccount(subject, opts) {
 }
 
 // src/moderation/subjects/feed-generator.ts
-function decideFeedGenerator(subject, opts) {
+function decideFeedGenerator(_subject, _opts) {
   return ModerationDecision.noop();
 }
 
 // src/moderation/subjects/user-list.ts
-function decideUserList(subject, opts) {
+function decideUserList(_subject, _opts) {
   return ModerationDecision.noop();
 }