bluesky-social · bnewbold · May 21, 2024 · May 21, 2024 · May 21, 2024 · May 21, 2024
diff --git a/.changeset/tidy-shoes-fail.md b/.changeset/tidy-shoes-fail.md
@@ -0,0 +1,7 @@
+---
+"@atproto/bsky": patch
+"@atproto/api": patch
+"@atproto/pds": patch
+---
+
+remove deprecated search 'term' param
diff --git a/lexicons/app/bsky/actor/searchActors.json b/lexicons/app/bsky/actor/searchActors.json
@@ -8,10 +8,6 @@
       "parameters": {
         "type": "params",
         "properties": {
-          "term": {
-            "type": "string",
-            "description": "DEPRECATED: use 'q' instead."
-          },
           "q": {
             "type": "string",
             "description": "Search query string. Syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended."

diff --git a/lexicons/app/bsky/actor/searchActorsTypeahead.json b/lexicons/app/bsky/actor/searchActorsTypeahead.json
@@ -8,10 +8,6 @@
       "parameters": {
         "type": "params",
         "properties": {
-          "term": {
-            "type": "string",
-            "description": "DEPRECATED: use 'q' instead."
-          },
           "q": {
             "type": "string",
             "description": "Search query prefix; not a full query string."

diff --git a/lexicons/tools/ozone/moderation/searchRepos.json b/lexicons/tools/ozone/moderation/searchRepos.json
@@ -8,10 +8,6 @@
       "parameters": {
         "type": "params",
         "properties": {
-          "term": {
-            "type": "string",
-            "description": "DEPRECATED: use 'q' instead"
-          },
           "q": { "type": "string" },
           "limit": {
             "type": "integer",

diff --git a/packages/api/src/client/lexicons.ts b/packages/api/src/client/lexicons.ts
@@ -4308,10 +4308,6 @@ export const schemaDict = {
         parameters: {
           type: 'params',
           properties: {
-            term: {
-              type: 'string',
-              description: "DEPRECATED: use 'q' instead.",
-            },
             q: {
               type: 'string',
               description:
@@ -4361,10 +4357,6 @@ export const schemaDict = {
         parameters: {
           type: 'params',
           properties: {
-            term: {
-              type: 'string',
-              description: "DEPRECATED: use 'q' instead.",
-            },
             q: {
               type: 'string',
               description: 'Search query prefix; not a full query string.',
@@ -10491,10 +10483,6 @@ export const schemaDict = {
         parameters: {
           type: 'params',
           properties: {
-            term: {
-              type: 'string',
-              description: "DEPRECATED: use 'q' instead",
-            },
             q: {
               type: 'string',
             },

diff --git a/packages/api/src/client/types/app/bsky/actor/searchActors.ts b/packages/api/src/client/types/app/bsky/actor/searchActors.ts
@@ -9,8 +9,6 @@ import { CID } from 'multiformats/cid'
 import * as AppBskyActorDefs from './defs'
 
 export interface QueryParams {
-  /** DEPRECATED: use 'q' instead. */
-  term?: string
   /** Search query string. Syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. */
   q?: string
   limit?: number

diff --git a/packages/api/src/client/types/app/bsky/actor/searchActorsTypeahead.ts b/packages/api/src/client/types/app/bsky/actor/searchActorsTypeahead.ts
@@ -9,8 +9,6 @@ import { CID } from 'multiformats/cid'
 import * as AppBskyActorDefs from './defs'
 
 export interface QueryParams {
-  /** DEPRECATED: use 'q' instead. */
-  term?: string
   /** Search query prefix; not a full query string. */
   q?: string
   limit?: number

diff --git a/packages/api/src/client/types/tools/ozone/moderation/searchRepos.ts b/packages/api/src/client/types/tools/ozone/moderation/searchRepos.ts
@@ -9,8 +9,6 @@ import { CID } from 'multiformats/cid'
 import * as ToolsOzoneModerationDefs from './defs'
 
 export interface QueryParams {
-  /** DEPRECATED: use 'q' instead */
-  term?: string
   q?: string
   limit?: number
   cursor?: string

diff --git a/packages/bsky/src/api/app/bsky/actor/searchActors.ts b/packages/bsky/src/api/app/bsky/actor/searchActors.ts
@@ -45,7 +45,7 @@ export default function (server: Server, ctx: AppContext) {
 
 const skeleton = async (inputs: SkeletonFnInput<Context, Params>) => {
   const { ctx, params } = inputs
-  const term = params.q ?? params.term ?? ''
+  const term = params.q ?? ''
 
   // @TODO
   // add hits total

diff --git a/packages/bsky/src/api/app/bsky/actor/searchActorsTypeahead.ts b/packages/bsky/src/api/app/bsky/actor/searchActorsTypeahead.ts
@@ -44,7 +44,7 @@ export default function (server: Server, ctx: AppContext) {
 
 const skeleton = async (inputs: SkeletonFnInput<Context, Params>) => {
   const { ctx, params } = inputs
-  const term = params.q ?? params.term ?? ''
+  const term = params.q ?? ''
 
   // @TODO
   // add typeahead option

diff --git a/packages/bsky/src/lexicon/lexicons.ts b/packages/bsky/src/lexicon/lexicons.ts
@@ -4308,10 +4308,6 @@ export const schemaDict = {
         parameters: {
           type: 'params',
           properties: {
-            term: {
-              type: 'string',
-              description: "DEPRECATED: use 'q' instead.",
-            },
             q: {
               type: 'string',
               description:
@@ -4361,10 +4357,6 @@ export const schemaDict = {
         parameters: {
           type: 'params',
           properties: {
-            term: {
-              type: 'string',
-              description: "DEPRECATED: use 'q' instead.",
-            },
             q: {
               type: 'string',
               description: 'Search query prefix; not a full query string.',

diff --git a/packages/bsky/src/lexicon/types/app/bsky/actor/searchActors.ts b/packages/bsky/src/lexicon/types/app/bsky/actor/searchActors.ts
@@ -10,8 +10,6 @@ import { HandlerAuth, HandlerPipeThrough } from '@atproto/xrpc-server'
 import * as AppBskyActorDefs from './defs'
 
 export interface QueryParams {
-  /** DEPRECATED: use 'q' instead. */
-  term?: string
   /** Search query string. Syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. */
   q?: string
   limit: number

diff --git a/packages/bsky/src/lexicon/types/app/bsky/actor/searchActorsTypeahead.ts b/packages/bsky/src/lexicon/types/app/bsky/actor/searchActorsTypeahead.ts
@@ -10,8 +10,6 @@ import { HandlerAuth, HandlerPipeThrough } from '@atproto/xrpc-server'
 import * as AppBskyActorDefs from './defs'
 
 export interface QueryParams {
-  /** DEPRECATED: use 'q' instead. */
-  term?: string
   /** Search query prefix; not a full query string. */
   q?: string
   limit: number

diff --git a/packages/bsky/tests/views/actor-search.test.ts b/packages/bsky/tests/views/actor-search.test.ts
@@ -49,7 +49,7 @@ describe.skip('pds actor search views', () => {
 
   it('typeahead gives relevant results', async () => {
     const result = await agent.api.app.bsky.actor.searchActorsTypeahead(
-      { term: 'car' },
+      { q: 'car' },
       { headers },
     )
 
@@ -85,9 +85,9 @@ describe.skip('pds actor search views', () => {
     expect(forSnapshot(sorted)).toMatchSnapshot()
   })
 
-  it('typeahead gives empty result set when provided empty term', async () => {
+  it('typeahead gives empty result set when provided empty q', async () => {
     const result = await agent.api.app.bsky.actor.searchActorsTypeahead(
-      { term: '' },
+      { q: '' },
       { headers },
     )
 
@@ -96,14 +96,14 @@ describe.skip('pds actor search views', () => {
 
   it('typeahead applies limit', async () => {
     const full = await agent.api.app.bsky.actor.searchActorsTypeahead(
-      { term: 'p' },
+      { q: 'p' },
       { headers },
     )
 
     expect(full.data.actors.length).toBeGreaterThan(5)
 
     const limited = await agent.api.app.bsky.actor.searchActorsTypeahead(
-      { term: 'p', limit: 5 },
+      { q: 'p', limit: 5 },
       { headers },
     )
 
@@ -125,20 +125,20 @@ describe.skip('pds actor search views', () => {
   it('typeahead gives results unauthed', async () => {
     const { data: authed } =
       await agent.api.app.bsky.actor.searchActorsTypeahead(
-        { term: 'car' },
+        { q: 'car' },
         { headers },
       )
     const { data: unauthed } =
       await agent.api.app.bsky.actor.searchActorsTypeahead({
-        term: 'car',
+        q: 'car',
       })
     expect(unauthed.actors.length).toBeGreaterThan(0)
     expect(unauthed.actors).toEqual(authed.actors.map(stripViewer))
   })
 
   it('search gives relevant results', async () => {
     const result = await agent.api.app.bsky.actor.searchActors(
-      { term: 'car' },
+      { q: 'car' },
       { headers },
     )
 
@@ -174,9 +174,9 @@ describe.skip('pds actor search views', () => {
     expect(forSnapshot(sorted)).toMatchSnapshot()
   })
 
-  it('search gives empty result set when provided empty term', async () => {
+  it('search gives empty result set when provided empty q', async () => {
     const result = await agent.api.app.bsky.actor.searchActors(
-      { term: '' },
+      { q: '' },
       { headers },
     )
 
@@ -187,7 +187,7 @@ describe.skip('pds actor search views', () => {
     const results = (results) => results.flatMap((res) => res.users)
     const paginator = async (cursor?: string) => {
       const res = await agent.api.app.bsky.actor.searchActors(
-        { term: 'p', cursor, limit: 3 },
+        { q: 'p', cursor, limit: 3 },
         { headers },
       )
       return res.data
@@ -199,7 +199,7 @@ describe.skip('pds actor search views', () => {
     )
 
     const full = await agent.api.app.bsky.actor.searchActors(
-      { term: 'p' },
+      { q: 'p' },
       { headers },
     )
 
@@ -217,7 +217,7 @@ describe.skip('pds actor search views', () => {
     // Mostly for sqlite's benefit, since it uses LIKE and these are special characters that will
     // get stripped. This input triggers a special case where there are no "safe" words for sqlite to search on.
     const result = await agent.api.app.bsky.actor.searchActors(
-      { term: ' % _ ' },
+      { q: ' % _ ' },
       { headers },
     )
 
@@ -226,11 +226,11 @@ describe.skip('pds actor search views', () => {
 
   it('search gives results unauthed', async () => {
     const { data: authed } = await agent.api.app.bsky.actor.searchActors(
-      { term: 'car' },
+      { q: 'car' },
       { headers },
     )
     const { data: unauthed } = await agent.api.app.bsky.actor.searchActors({
-      term: 'car',
+      q: 'car',
     })
     expect(unauthed.actors.length).toBeGreaterThan(0)
     expect(unauthed.actors).toEqual(authed.actors.map(stripViewer))
@@ -241,7 +241,7 @@ describe.skip('pds actor search views', () => {
       did: sc.dids['cara-wiegand69.test'],
     })
     const result = await agent.api.app.bsky.actor.searchActorsTypeahead(
-      { term: 'car' },
+      { q: 'car' },
       { headers },
     )
     const handles = result.data.actors.map((u) => u.handle)

diff --git a/packages/bsky/tests/views/block-lists.test.ts b/packages/bsky/tests/views/block-lists.test.ts
@@ -277,15 +277,15 @@ describe('pds views with blocking from block lists', () => {
   it('does not return blocked accounts in actor search', async () => {
     const resCarol = await agent.api.app.bsky.actor.searchActors(
       {
-        term: 'dan.test',
+        q: 'dan.test',
       },
       { headers: await network.serviceHeaders(carol) },
     )
     expect(resCarol.data.actors.some((actor) => actor.did === dan)).toBeFalsy()
 
     const resDan = await agent.api.app.bsky.actor.searchActors(
       {
-        term: 'carol.test',
+        q: 'carol.test',
       },
       { headers: await network.serviceHeaders(dan) },
     )
@@ -295,15 +295,15 @@ describe('pds views with blocking from block lists', () => {
   it('does not return blocked accounts in actor search typeahead', async () => {
     const resCarol = await agent.api.app.bsky.actor.searchActorsTypeahead(
       {
-        term: 'dan.test',
+        q: 'dan.test',
       },
       { headers: await network.serviceHeaders(carol) },
     )
     expect(resCarol.data.actors.some((actor) => actor.did === dan)).toBeFalsy()
 
     const resDan = await agent.api.app.bsky.actor.searchActorsTypeahead(
       {
-        term: 'carol.test',
+        q: 'carol.test',
       },
       { headers: await network.serviceHeaders(dan) },
     )

diff --git a/packages/bsky/tests/views/blocks.test.ts b/packages/bsky/tests/views/blocks.test.ts
@@ -347,15 +347,15 @@ describe('pds views with blocking', () => {
   it('does not return blocked accounts in actor search', async () => {
     const resCarol = await agent.api.app.bsky.actor.searchActors(
       {
-        term: 'dan.test',
+        q: 'dan.test',
       },
       { headers: await network.serviceHeaders(carol) },
     )
     expect(resCarol.data.actors.some((actor) => actor.did === dan)).toBeFalsy()
 
     const resDan = await agent.api.app.bsky.actor.searchActors(
       {
-        term: 'carol.test',
+        q: 'carol.test',
       },
       { headers: await network.serviceHeaders(dan) },
     )
@@ -365,15 +365,15 @@ describe('pds views with blocking', () => {
   it('does not return blocked accounts in actor search typeahead', async () => {
     const resCarol = await agent.api.app.bsky.actor.searchActorsTypeahead(
       {
-        term: 'dan.test',
+        q: 'dan.test',
       },
       { headers: await network.serviceHeaders(carol) },
     )
     expect(resCarol.data.actors.some((actor) => actor.did === dan)).toBeFalsy()
 
     const resDan = await agent.api.app.bsky.actor.searchActorsTypeahead(
       {
-        term: 'carol.test',
+        q: 'carol.test',
       },
       { headers: await network.serviceHeaders(dan) },
     )

diff --git a/packages/ozone/src/api/moderation/searchRepos.ts b/packages/ozone/src/api/moderation/searchRepos.ts
@@ -7,9 +7,7 @@ export default function (server: Server, ctx: AppContext) {
     auth: ctx.authVerifier.modOrAdminToken,
     handler: async ({ params }) => {
       const modService = ctx.modService(ctx.db)
-
-      // prefer new 'q' query param over deprecated 'term'
-      const query = params.q ?? params.term
+      const query = params.q ?? ''
 
       // special case for did searches - do exact match
       if (query?.startsWith('did:')) {

diff --git a/packages/ozone/src/lexicon/lexicons.ts b/packages/ozone/src/lexicon/lexicons.ts
@@ -4308,10 +4308,6 @@ export const schemaDict = {
         parameters: {
           type: 'params',
           properties: {
-            term: {
-              type: 'string',
-              description: "DEPRECATED: use 'q' instead.",
-            },
             q: {
               type: 'string',
               description:
@@ -4361,10 +4357,6 @@ export const schemaDict = {
         parameters: {
           type: 'params',
           properties: {
-            term: {
-              type: 'string',
-              description: "DEPRECATED: use 'q' instead.",
-            },
             q: {
               type: 'string',
               description: 'Search query prefix; not a full query string.',
@@ -10491,10 +10483,6 @@ export const schemaDict = {
         parameters: {
           type: 'params',
           properties: {
-            term: {
-              type: 'string',
-              description: "DEPRECATED: use 'q' instead",
-            },
             q: {
               type: 'string',
             },