@atproto/api 0.6.10 → 0.6.11

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022-2023 Bluesky PBLLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -34,16 +34,16 @@ import { BskyAgent, AtpSessionEvent, AtpSessionData } from '@atproto/api'
 const agent = new BskyAgent({
   service: 'https://example.com',
   persistSession: (evt: AtpSessionEvent, sess?: AtpSessionData) => {
-    // store the session-data for reuse 
-  }
+    // store the session-data for reuse
+  },
 })
 
-await agent.login({identifier: 'alice@mail.com', password: 'hunter2'})
+await agent.login({ identifier: 'alice@mail.com', password: 'hunter2' })
 await agent.resumeSession(savedSessionData)
 await agent.createAccount({
   email: 'alice@mail.com',
   password: 'hunter2',
-  handle: 'alice.example.com'
+  handle: 'alice.example.com',
 })
 ```
 
@@ -127,16 +127,18 @@ Some records (ie posts) use the `app.bsky.richtext` lexicon. At the moment richt
 ℹ️ It is **strongly** recommended to use this package's `RichText` library. Javascript encodes strings in utf16 while the protocol (and most other programming environments) use utf8. Converting between the two is challenging, but `RichText` handles that for you.
 
 ```typescript
-import {RichText} from '@atproto/api'
+import { RichText } from '@atproto/api'
 
 // creating richtext
-const rt = new RichText({text: 'Hello @alice.com, check out this link: https://example.com'})
+const rt = new RichText({
+  text: 'Hello @alice.com, check out this link: https://example.com',
+})
 await rt.detectFacets(agent) // automatically detects mentions and links
 const postRecord = {
   $type: 'app.bsky.feed.post',
   text: rt.text,
   facets: rt.facets,
-  createdAt: new Date().toISOString()
+  createdAt: new Date().toISOString(),
 }
 
 // rendering as markdown
@@ -152,10 +154,10 @@ for (const segment of rt.segments()) {
 }
 
 // calculating string lengths
-const rt2 = new RichText({text: 'Hello'})
+const rt2 = new RichText({ text: 'Hello' })
 console.log(rt2.length) // => 5
 console.log(rt2.graphemeLength) // => 5
-const rt3 = new RichText({text: '👨‍👩‍👧‍👧'})
+const rt3 = new RichText({ text: '👨‍👩‍👧‍👧' })
 console.log(rt3.length) // => 25
 console.log(rt3.graphemeLength) // => 1
 ```
@@ -171,12 +173,12 @@ Applying the moderation system is a challenging task, but we've done our best to
 For more information, see the [Moderation Documentation](./docs/moderation.md) or the associated [Labels Reference](./docs/labels.md).
 
 ```typescript
-import {moderatePost, moderateProfile} from '@atproto/api'
+import { moderatePost, moderateProfile } from '@atproto/api'
 
 // We call the appropriate moderation function for the content
 // =
 
-const postMod    = moderatePost(postView, getOpts())
+const postMod = moderatePost(postView, getOpts())
 const profileMod = moderateProfile(profileView, getOpts())
 
 // We then use the output to decide how to affect rendering
@@ -235,16 +237,16 @@ function getOpts() {
       {
         labeler: {
           did: '...',
-          displayName: 'My mod service'
+          displayName: 'My mod service',
         },
         labels: {
           porn: 'hide',
           sexual: 'warn',
           nudity: 'ignore',
           // ...
-        }
-      }
-    ]
+        },
+      },
+    ],
   }
 }
 ```
@@ -258,24 +260,28 @@ The methods above are convenience wrappers. It covers most but not all available
 The AT Protocol identifies methods and records with reverse-DNS names. You can use them on the agent as well:
 
 ```typescript
-const res1 = await agent.com.atproto.repo.createRecord(
+const res1 = await agent.com.atproto.repo.createRecord({
+  did: alice.did,
+  collection: 'app.bsky.feed.post',
+  record: {
+    $type: 'app.bsky.feed.post',
+    text: 'Hello, world!',
+    createdAt: new Date().toISOString(),
+  },
+})
+const res2 = await agent.com.atproto.repo.listRecords({
+  repo: alice.did,
+  collection: 'app.bsky.feed.post',
+})
+
+const res3 = await agent.app.bsky.feed.post.create(
+  { repo: alice.did },
   {
-    did: alice.did,
-    collection: 'app.bsky.feed.post',
-    record: {
-      $type: 'app.bsky.feed.post',
-      text: 'Hello, world!',
-      createdAt: new Date().toISOString()
-    }
-  }
+    text: 'Hello, world!',
+    createdAt: new Date().toISOString(),
+  },
 )
-const res2 = await agent.com.atproto.repo.listRecords({repo: alice.did, collection: 'app.bsky.feed.post'})
-
-const res3 = await agent.app.bsky.feed.post.create({repo: alice.did}, {
-  text: 'Hello, world!',
-  createdAt: new Date().toISOString()
-})
-const res4 = await agent.app.bsky.feed.post.list({repo: alice.did})
+const res4 = await agent.app.bsky.feed.post.list({ repo: alice.did })
 ```
 
 ### Generic agent
@@ -285,7 +291,7 @@ If you want a generic AT Protocol agent without methods related to the Bluesky s
 ```typescript
 import { AtpAgent } from '@atproto/api'
 
-const agent = new AtpAgent({service: 'https://example.com'})
+const agent = new AtpAgent({ service: 'https://example.com' })
 ```
 
 ### Non-browser configuration
@@ -295,10 +301,13 @@ In non-browser environments you'll need to specify a fetch polyfill. [See the ex
 ```typescript
 import { BskyAgent } from '@atproto/api'
 
-const agent = new BskyAgent({service: 'https://example.com'})
+const agent = new BskyAgent({ service: 'https://example.com' })
 
 // provide a custom fetch implementation (shouldnt be needed in node or the browser)
-import {AtpAgentFetchHeaders, AtpAgentFetchHandlerResponse} from '@atproto/api'
+import {
+  AtpAgentFetchHeaders,
+  AtpAgentFetchHandlerResponse,
+} from '@atproto/api'
 BskyAgent.configure({
   async fetch(
     httpUri: string,
@@ -307,8 +316,8 @@ BskyAgent.configure({
     httpReqBody: any,
   ): Promise<AtpAgentFetchHandlerResponse> {
     // insert definition here...
-    return {status: 200, /*...*/}
-  }
+    return { status: 200 /*...*/ }
+  },
 })
 ```
 

package/bench/agent.bench.ts

@@ -1,9 +1,9 @@
-import { BskyAgent } from "@atproto/api";
+import { BskyAgent } from '@atproto/api'
 
 describe('Agent Benchmarks', () => {
   it('Creates new Agent instance 10 times', () => {
     for (let i = 0; i < 10; i++) {
-      new BskyAgent({ service: 'https://bsky.social' });
+      new BskyAgent({ service: 'https://bsky.social' })
     }
   })
 })

package/build.js

@@ -1,16 +1,8 @@
-const pkgJson = require('@npmcli/package-json')
 const { nodeExternalsPlugin } = require('esbuild-node-externals')
 
 const buildShallow =
   process.argv.includes('--shallow') || process.env.ATP_BUILD_SHALLOW === 'true'
 
-if (process.argv.includes('--update-main-to-dist')) {
-  return pkgJson
-    .load(__dirname)
-    .then((pkg) => pkg.update({ main: 'dist/index.js' }))
-    .then((pkg) => pkg.save())
-}
-
 require('esbuild').build({
   logLevel: 'info',
   entryPoints: ['src/index.ts'],

package/definitions/labels.json

@@ -206,7 +206,13 @@
         "preferences": ["ignore", "warn", "hide"],
         "flags": [],
         "onwarn": "alert"
+      },
+      {
+        "id": "misleading",
+        "preferences": ["ignore", "warn", "hide"],
+        "flags": [],
+        "onwarn": "alert"
       }
     ]
   }
-]
+]

package/definitions/locale/en/label-groups.json

@@ -35,4 +35,4 @@
     "name": "Misinformation",
     "description": "Content which misleads or defrauds users."
   }
-}
+}

package/definitions/locale/en/labels.json

@@ -362,5 +362,19 @@
       "name": "Scam Warning",
       "description": "The moderators believe this is fraudulent content."
     }
+  },
+  "misleading": {
+    "settings": {
+      "name": "Misleading",
+      "description": "Accounts which share misleading information."
+    },
+    "account": {
+      "name": "Misleading",
+      "description": "The moderators believe this account is spreading misleading information."
+    },
+    "content": {
+      "name": "Misleading",
+      "description": "The moderators believe this account is spreading misleading information."
+    }
   }
-}
+}

package/definitions/locale/en/proposed-label-groups.json

@@ -35,4 +35,4 @@
     "name": "Misinformation",
     "description": "Content which misleads or defrauds users."
   }
-}
+}

package/definitions/locale/en/proposed-labels.json

@@ -629,4 +629,4 @@
       "description": "The moderators believe this content includes statements which are not technically wrong or lying, but are misleading through omission or re-contextualization."
     }
   }
-}
+}