@atproto/api 0.13.6 → 0.13.7

package/src/client/types/tools/ozone/moderation/queryStatuses.ts

@@ -9,6 +9,9 @@ import { CID } from 'multiformats/cid'
 import * as ToolsOzoneModerationDefs from './defs'
 
 export interface QueryParams {
+  /** All subjects belonging to the account specified in the 'subject' param will be returned. */
+  includeAllUserRecords?: boolean
+  /** The subject to get the status for. */
   subject?: string
   /** Search subjects by keyword from comments */
   comment?: string

package/src/types.ts

@@ -106,5 +106,6 @@ export interface BskyPreferences {
   bskyAppState: {
     queuedNudges: string[]
     activeProgressGuide: AppBskyActorDefs.BskyAppProgressGuide | undefined
+    nuxs: AppBskyActorDefs.Nux[]
   }
 }

package/src/util.ts

@@ -1,6 +1,8 @@
 import { AtUri } from '@atproto/syntax'
 import { TID } from '@atproto/common-web'
+import zod from 'zod'
 
+import { Nux } from './client/types/app/bsky/actor/defs'
 import { AppBskyActorDefs } from './client'
 
 export function sanitizeMutedWordValue(value: string) {
@@ -94,3 +96,16 @@ export const asDid = (value: string): Did => {
   if (isDid(value)) return value
   throw new TypeError(`Invalid DID: ${value}`)
 }
+
+export const nuxSchema = zod
+  .object({
+    id: zod.string().max(64),
+    completed: zod.boolean(),
+    data: zod.string().max(300).optional(),
+    expiresAt: zod.string().datetime().optional(),
+  })
+  .strict()
+
+export function validateNux(nux: Nux) {
+  nuxSchema.parse(nux)
+}

package/tests/bsky-agent.test.ts

@@ -276,6 +276,7 @@ describe('agent', () => {
         bskyAppState: {
           activeProgressGuide: undefined,
           queuedNudges: [],
+          nuxs: [],
         },
       })
 
@@ -317,6 +318,7 @@ describe('agent', () => {
         bskyAppState: {
           activeProgressGuide: undefined,
           queuedNudges: [],
+          nuxs: [],
         },
       })
 
@@ -358,6 +360,7 @@ describe('agent', () => {
         bskyAppState: {
           activeProgressGuide: undefined,
           queuedNudges: [],
+          nuxs: [],
         },
       })
 
@@ -399,6 +402,7 @@ describe('agent', () => {
         bskyAppState: {
           activeProgressGuide: undefined,
           queuedNudges: [],
+          nuxs: [],
         },
       })
 
@@ -444,6 +448,7 @@ describe('agent', () => {
         bskyAppState: {
           activeProgressGuide: undefined,
           queuedNudges: [],
+          nuxs: [],
         },
       })
 
@@ -492,6 +497,7 @@ describe('agent', () => {
         bskyAppState: {
           activeProgressGuide: undefined,
           queuedNudges: [],
+          nuxs: [],
         },
       })
 
@@ -540,6 +546,7 @@ describe('agent', () => {
         bskyAppState: {
           activeProgressGuide: undefined,
           queuedNudges: [],
+          nuxs: [],
         },
       })
 
@@ -588,6 +595,7 @@ describe('agent', () => {
         bskyAppState: {
           activeProgressGuide: undefined,
           queuedNudges: [],
+          nuxs: [],
         },
       })
 
@@ -636,6 +644,7 @@ describe('agent', () => {
         bskyAppState: {
           activeProgressGuide: undefined,
           queuedNudges: [],
+          nuxs: [],
         },
       })
 
@@ -684,6 +693,7 @@ describe('agent', () => {
         bskyAppState: {
           activeProgressGuide: undefined,
           queuedNudges: [],
+          nuxs: [],
         },
       })
 
@@ -738,6 +748,7 @@ describe('agent', () => {
         bskyAppState: {
           activeProgressGuide: undefined,
           queuedNudges: [],
+          nuxs: [],
         },
       })
 
@@ -786,6 +797,7 @@ describe('agent', () => {
         bskyAppState: {
           activeProgressGuide: undefined,
           queuedNudges: [],
+          nuxs: [],
         },
       })
 
@@ -834,6 +846,7 @@ describe('agent', () => {
         bskyAppState: {
           activeProgressGuide: undefined,
           queuedNudges: [],
+          nuxs: [],
         },
       })
 
@@ -882,6 +895,7 @@ describe('agent', () => {
         bskyAppState: {
           activeProgressGuide: undefined,
           queuedNudges: [],
+          nuxs: [],
         },
       })
 
@@ -930,6 +944,7 @@ describe('agent', () => {
         bskyAppState: {
           activeProgressGuide: undefined,
           queuedNudges: [],
+          nuxs: [],
         },
       })
 
@@ -985,6 +1000,7 @@ describe('agent', () => {
         bskyAppState: {
           activeProgressGuide: undefined,
           queuedNudges: [],
+          nuxs: [],
         },
       })
 
@@ -1040,6 +1056,7 @@ describe('agent', () => {
         bskyAppState: {
           activeProgressGuide: undefined,
           queuedNudges: [],
+          nuxs: [],
         },
       })
 
@@ -1095,6 +1112,7 @@ describe('agent', () => {
         bskyAppState: {
           activeProgressGuide: undefined,
           queuedNudges: [],
+          nuxs: [],
         },
       })
 
@@ -1150,6 +1168,7 @@ describe('agent', () => {
         bskyAppState: {
           activeProgressGuide: undefined,
           queuedNudges: [],
+          nuxs: [],
         },
       })
     })
@@ -1332,6 +1351,7 @@ describe('agent', () => {
         bskyAppState: {
           activeProgressGuide: undefined,
           queuedNudges: ['two'],
+          nuxs: [],
         },
       })
 
@@ -1389,6 +1409,7 @@ describe('agent', () => {
         bskyAppState: {
           activeProgressGuide: undefined,
           queuedNudges: ['two'],
+          nuxs: [],
         },
       })
 
@@ -1447,6 +1468,7 @@ describe('agent', () => {
         bskyAppState: {
           activeProgressGuide: undefined,
           queuedNudges: ['two'],
+          nuxs: [],
         },
       })
 
@@ -1501,6 +1523,7 @@ describe('agent', () => {
         bskyAppState: {
           activeProgressGuide: undefined,
           queuedNudges: ['two'],
+          nuxs: [],
         },
       })
 
@@ -1555,6 +1578,7 @@ describe('agent', () => {
         bskyAppState: {
           activeProgressGuide: undefined,
           queuedNudges: ['two'],
+          nuxs: [],
         },
       })
 
@@ -1609,6 +1633,7 @@ describe('agent', () => {
         bskyAppState: {
           activeProgressGuide: undefined,
           queuedNudges: ['two'],
+          nuxs: [],
         },
       })
 
@@ -1675,6 +1700,7 @@ describe('agent', () => {
         bskyAppState: {
           activeProgressGuide: undefined,
           queuedNudges: ['two', 'three'],
+          nuxs: [],
         },
       })
 
@@ -3246,6 +3272,71 @@ describe('agent', () => {
       })
     })
 
+    describe('nuxs', () => {
+      let agent: BskyAgent
+
+      const nux = {
+        id: 'a',
+        completed: false,
+        data: '{}',
+        expiresAt: new Date(Date.now() + 6e3).toISOString(),
+      }
+
+      beforeAll(async () => {
+        agent = new BskyAgent({ service: network.pds.url })
+
+        await agent.createAccount({
+          handle: 'nuxs.test',
+          email: 'nuxs@test.com',
+          password: 'password',
+        })
+      })
+
+      it('bskyAppUpsertNux', async () => {
+        // never duplicates
+        await agent.bskyAppUpsertNux(nux)
+        await agent.bskyAppUpsertNux(nux)
+        await agent.bskyAppUpsertNux(nux)
+
+        const prefs = await agent.getPreferences()
+        const nuxs = prefs.bskyAppState.nuxs
+
+        expect(nuxs.length).toEqual(1)
+        expect(nuxs.find((n) => n.id === nux.id)).toEqual(nux)
+      })
+
+      it('bskyAppUpsertNux completed', async () => {
+        // never duplicates
+        await agent.bskyAppUpsertNux({
+          ...nux,
+          completed: true,
+        })
+
+        const prefs = await agent.getPreferences()
+        const nuxs = prefs.bskyAppState.nuxs
+
+        expect(nuxs.length).toEqual(1)
+        expect(nuxs.find((n) => n.id === nux.id)?.completed).toEqual(true)
+      })
+
+      it('bskyAppRemoveNuxs', async () => {
+        await agent.bskyAppRemoveNuxs([nux.id])
+
+        const prefs = await agent.getPreferences()
+        const nuxs = prefs.bskyAppState.nuxs
+
+        expect(nuxs.length).toEqual(0)
+      })
+
+      it('bskyAppUpsertNux validates nux', async () => {
+        // @ts-expect-error
+        expect(() => agent.bskyAppUpsertNux({ name: 'a' })).rejects.toThrow()
+        expect(() =>
+          agent.bskyAppUpsertNux({ id: 'a', completed: false, foo: 'bar' }),
+        ).rejects.toThrow()
+      })
+    })
+
     // end
   })
 })

package/tests/moderation-prefs.test.ts

@@ -84,6 +84,7 @@ describe('agent', () => {
       bskyAppState: {
         activeProgressGuide: undefined,
         queuedNudges: [],
+        nuxs: [],
       },
     })
   })
@@ -133,6 +134,7 @@ describe('agent', () => {
       bskyAppState: {
         activeProgressGuide: undefined,
         queuedNudges: [],
+        nuxs: [],
       },
     })
     expect(agent.labelers).toStrictEqual(['did:plc:other'])
@@ -167,6 +169,7 @@ describe('agent', () => {
       bskyAppState: {
         activeProgressGuide: undefined,
         queuedNudges: [],
+        nuxs: [],
       },
     })
     expect(agent.labelers).toStrictEqual([])
@@ -223,6 +226,7 @@ describe('agent', () => {
       bskyAppState: {
         activeProgressGuide: undefined,
         queuedNudges: [],
+        nuxs: [],
       },
     })
   })