@atproto/pds 0.4.56 → 0.4.57

package/dist/sequencer/events.d.ts

@@ -48,8 +48,8 @@ export declare const commitEvt: z.ZodObject<{
     blobs: z.ZodArray<z.ZodEffects<z.ZodEffects<z.ZodAny, any, any>, CID, any>, "many">;
 }, "strip", z.ZodTypeAny, {
     repo: string;
-    blobs: CID[];
     rev: string;
+    blobs: CID[];
     rebase: boolean;
     tooBig: boolean;
     commit: CID;
@@ -63,8 +63,8 @@ export declare const commitEvt: z.ZodObject<{
     prev: CID | null;
 }, {
     repo: string;
-    blobs: any[];
     rev: string;
+    blobs: any[];
     rebase: boolean;
     tooBig: boolean;
     since: string | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/pds",
-  "version": "0.4.56",
+  "version": "0.4.57",
   "license": "MIT",
   "description": "Reference implementation of atproto Personal Data Server (PDS)",
   "keywords": [
@@ -44,7 +44,7 @@
     "uint8arrays": "3.0.0",
     "zod": "^3.23.8",
     "@atproto-labs/fetch-node": "0.1.0",
-    "@atproto/api": "^0.13.5",
+    "@atproto/api": "^0.13.6",
     "@atproto/aws": "^0.2.3",
     "@atproto/common": "^0.4.1",
     "@atproto/crypto": "^0.4.1",
@@ -72,8 +72,8 @@
     "jest": "^28.1.2",
     "ts-node": "^10.8.2",
     "ws": "^8.12.0",
-    "@atproto/api": "^0.13.5",
-    "@atproto/bsky": "^0.0.80",
+    "@atproto/api": "^0.13.6",
+    "@atproto/bsky": "^0.0.81",
     "@atproto/lex-cli": "^0.5.0"
   },
   "scripts": {

package/src/api/com/atproto/repo/applyWrites.ts

@@ -1,5 +1,6 @@
 import { CID } from 'multiformats/cid'
 import { InvalidRequestError, AuthRequiredError } from '@atproto/xrpc-server'
+import { WriteOpAction } from '@atproto/repo'
 import { prepareCreate, prepareDelete, prepareUpdate } from '../../../../repo'
 import { Server } from '../../../../lexicon'
 import {
@@ -7,6 +8,9 @@ import {
   isCreate,
   isUpdate,
   isDelete,
+  CreateResult,
+  UpdateResult,
+  DeleteResult,
 } from '../../../../lexicon/types/com/atproto/repo/applyWrites'
 import {
   BadCommitSwapError,
@@ -69,6 +73,7 @@ export default function (server: Server, ctx: AppContext) {
         throw new InvalidRequestError('Too many writes. Max: 200')
       }
 
+      // @NOTE should preserve order of ts.writes for final use in response
       let writes: PreparedWrite[]
       try {
         writes = await Promise.all(
@@ -125,6 +130,42 @@ export default function (server: Server, ctx: AppContext) {
 
       await ctx.sequencer.sequenceCommit(did, commit, writes)
       await ctx.accountManager.updateRepoRoot(did, commit.cid, commit.rev)
+
+      return {
+        encoding: 'application/json',
+        body: {
+          commit: {
+            cid: commit.cid.toString(),
+            rev: commit.rev,
+          },
+          results: writes.map(writeToOutputResult),
+        },
+      }
     },
   })
 }
+
+const writeToOutputResult = (write: PreparedWrite) => {
+  switch (write.action) {
+    case WriteOpAction.Create:
+      return {
+        $type: 'com.atproto.repo.applyWrites#createResult',
+        cid: write.cid.toString(),
+        uri: write.uri.toString(),
+        validationStatus: write.validationStatus,
+      } satisfies CreateResult
+    case WriteOpAction.Update:
+      return {
+        $type: 'com.atproto.repo.applyWrites#updateResult',
+        cid: write.cid.toString(),
+        uri: write.uri.toString(),
+        validationStatus: write.validationStatus,
+      } satisfies UpdateResult
+    case WriteOpAction.Delete:
+      return {
+        $type: 'com.atproto.repo.applyWrites#deleteResult',
+      } satisfies DeleteResult
+    default:
+      throw new Error(`Unrecognized action: ${write}`)
+  }
+}

package/src/api/com/atproto/repo/createRecord.ts

@@ -68,12 +68,13 @@ export default function (server: Server, ctx: AppContext) {
       const { commit, writes } = await ctx.actorStore.transact(
         did,
         async (actorTxn) => {
-          const backlinkConflicts = validate
-            ? await actorTxn.record.getBacklinkConflicts(
-                write.uri,
-                write.record,
-              )
-            : []
+          const backlinkConflicts =
+            validate !== false
+              ? await actorTxn.record.getBacklinkConflicts(
+                  write.uri,
+                  write.record,
+                )
+              : []
           const backlinkDeletions = backlinkConflicts.map((uri) =>
             prepareDelete({
               did: uri.hostname,
@@ -102,7 +103,15 @@ export default function (server: Server, ctx: AppContext) {
 
       return {
         encoding: 'application/json',
-        body: { uri: write.uri.toString(), cid: write.cid.toString() },
+        body: {
+          uri: write.uri.toString(),
+          cid: write.cid.toString(),
+          commit: {
+            cid: commit.cid.toString(),
+            rev: commit.rev,
+          },
+          validationStatus: write.validationStatus,
+        },
       }
     },
   })

package/src/api/com/atproto/repo/deleteRecord.ts

@@ -71,6 +71,17 @@ export default function (server: Server, ctx: AppContext) {
         await ctx.sequencer.sequenceCommit(did, commit, [write])
         await ctx.accountManager.updateRepoRoot(did, commit.cid, commit.rev)
       }
+      return {
+        encoding: 'application/json',
+        body: {
+          commit: commit
+            ? {
+                cid: commit.cid.toString(),
+                rev: commit.rev,
+              }
+            : undefined,
+        },
+      }
     },
   })
 }

package/src/api/com/atproto/repo/putRecord.ts

@@ -130,6 +130,13 @@ export default function (server: Server, ctx: AppContext) {
         body: {
           uri: write.uri.toString(),
           cid: write.cid.toString(),
+          commit: commit
+            ? {
+                cid: commit.cid.toString(),
+                rev: commit.rev,
+              }
+            : undefined,
+          validationStatus: write.validationStatus,
         },
       }
     },

package/src/lexicon/lexicons.ts

@@ -1254,9 +1254,8 @@ export const schemaDict = {
               },
               validate: {
                 type: 'boolean',
-                default: true,
                 description:
-                  "Can be set to 'false' to skip Lexicon schema validation of record data, for all operations.",
+                  "Can be set to 'false' to skip Lexicon schema validation of record data across all operations, 'true' to require it, or leave unset to validate only for known Lexicons.",
               },
               writes: {
                 type: 'array',
@@ -1279,6 +1278,31 @@ export const schemaDict = {
             },
           },
         },
+        output: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: [],
+            properties: {
+              commit: {
+                type: 'ref',
+                ref: 'lex:com.atproto.repo.defs#commitMeta',
+              },
+              results: {
+                type: 'array',
+                items: {
+                  type: 'union',
+                  refs: [
+                    'lex:com.atproto.repo.applyWrites#createResult',
+                    'lex:com.atproto.repo.applyWrites#updateResult',
+                    'lex:com.atproto.repo.applyWrites#deleteResult',
+                  ],
+                  closed: true,
+                },
+              },
+            },
+          },
+        },
         errors: [
           {
             name: 'InvalidSwap',
@@ -1336,6 +1360,47 @@ export const schemaDict = {
           },
         },
       },
+      createResult: {
+        type: 'object',
+        required: ['uri', 'cid'],
+        properties: {
+          uri: {
+            type: 'string',
+            format: 'at-uri',
+          },
+          cid: {
+            type: 'string',
+            format: 'cid',
+          },
+          validationStatus: {
+            type: 'string',
+            knownValues: ['valid', 'unknown'],
+          },
+        },
+      },
+      updateResult: {
+        type: 'object',
+        required: ['uri', 'cid'],
+        properties: {
+          uri: {
+            type: 'string',
+            format: 'at-uri',
+          },
+          cid: {
+            type: 'string',
+            format: 'cid',
+          },
+          validationStatus: {
+            type: 'string',
+            knownValues: ['valid', 'unknown'],
+          },
+        },
+      },
+      deleteResult: {
+        type: 'object',
+        required: [],
+        properties: {},
+      },
     },
   },
   ComAtprotoRepoCreateRecord: {
@@ -1370,9 +1435,8 @@ export const schemaDict = {
               },
               validate: {
                 type: 'boolean',
-                default: true,
                 description:
-                  "Can be set to 'false' to skip Lexicon schema validation of record data.",
+                  "Can be set to 'false' to skip Lexicon schema validation of record data, 'true' to require it, or leave unset to validate only for known Lexicons.",
               },
               record: {
                 type: 'unknown',
@@ -1401,6 +1465,14 @@ export const schemaDict = {
                 type: 'string',
                 format: 'cid',
               },
+              commit: {
+                type: 'ref',
+                ref: 'lex:com.atproto.repo.defs#commitMeta',
+              },
+              validationStatus: {
+                type: 'string',
+                knownValues: ['valid', 'unknown'],
+              },
             },
           },
         },
@@ -1414,6 +1486,25 @@ export const schemaDict = {
       },
     },
   },
+  ComAtprotoRepoDefs: {
+    lexicon: 1,
+    id: 'com.atproto.repo.defs',
+    defs: {
+      commitMeta: {
+        type: 'object',
+        required: ['cid', 'rev'],
+        properties: {
+          cid: {
+            type: 'string',
+            format: 'cid',
+          },
+          rev: {
+            type: 'string',
+          },
+        },
+      },
+    },
+  },
   ComAtprotoRepoDeleteRecord: {
     lexicon: 1,
     id: 'com.atproto.repo.deleteRecord',
@@ -1458,6 +1549,18 @@ export const schemaDict = {
             },
           },
         },
+        output: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            properties: {
+              commit: {
+                type: 'ref',
+                ref: 'lex:com.atproto.repo.defs#commitMeta',
+              },
+            },
+          },
+        },
         errors: [
           {
             name: 'InvalidSwap',
@@ -1778,9 +1881,8 @@ export const schemaDict = {
               },
               validate: {
                 type: 'boolean',
-                default: true,
                 description:
-                  "Can be set to 'false' to skip Lexicon schema validation of record data.",
+                  "Can be set to 'false' to skip Lexicon schema validation of record data, 'true' to require it, or leave unset to validate only for known Lexicons.",
               },
               record: {
                 type: 'unknown',
@@ -1815,6 +1917,14 @@ export const schemaDict = {
                 type: 'string',
                 format: 'cid',
               },
+              commit: {
+                type: 'ref',
+                ref: 'lex:com.atproto.repo.defs#commitMeta',
+              },
+              validationStatus: {
+                type: 'string',
+                knownValues: ['valid', 'unknown'],
+              },
             },
           },
         },
@@ -10356,6 +10466,11 @@ export const schemaDict = {
                 type: 'string',
                 description: 'Subject of the message, used in emails.',
               },
+              lang: {
+                type: 'string',
+                format: 'language',
+                description: 'Message language.',
+              },
               createdBy: {
                 type: 'string',
                 format: 'did',
@@ -10371,6 +10486,11 @@ export const schemaDict = {
             ref: 'lex:tools.ozone.communication.defs#templateView',
           },
         },
+        errors: [
+          {
+            name: 'DuplicateTemplateName',
+          },
+        ],
       },
     },
   },
@@ -10409,6 +10529,11 @@ export const schemaDict = {
           disabled: {
             type: 'boolean',
           },
+          lang: {
+            type: 'string',
+            format: 'language',
+            description: 'Message language.',
+          },
           lastUpdatedBy: {
             type: 'string',
             format: 'did',
@@ -10496,6 +10621,11 @@ export const schemaDict = {
                 type: 'string',
                 description: 'Name of the template.',
               },
+              lang: {
+                type: 'string',
+                format: 'language',
+                description: 'Message language.',
+              },
               contentMarkdown: {
                 type: 'string',
                 description:
@@ -10523,6 +10653,11 @@ export const schemaDict = {
             ref: 'lex:tools.ozone.communication.defs#templateView',
           },
         },
+        errors: [
+          {
+            name: 'DuplicateTemplateName',
+          },
+        ],
       },
     },
   },
@@ -11322,6 +11457,7 @@ export const schemaDict = {
                   'lex:tools.ozone.moderation.defs#modEventMuteReporter',
                   'lex:tools.ozone.moderation.defs#modEventUnmuteReporter',
                   'lex:tools.ozone.moderation.defs#modEventReverseTakedown',
+                  'lex:tools.ozone.moderation.defs#modEventResolveAppeal',
                   'lex:tools.ozone.moderation.defs#modEventEmail',
                   'lex:tools.ozone.moderation.defs#modEventTag',
                 ],
@@ -12084,6 +12220,7 @@ export const ids = {
   ComAtprotoModerationDefs: 'com.atproto.moderation.defs',
   ComAtprotoRepoApplyWrites: 'com.atproto.repo.applyWrites',
   ComAtprotoRepoCreateRecord: 'com.atproto.repo.createRecord',
+  ComAtprotoRepoDefs: 'com.atproto.repo.defs',
   ComAtprotoRepoDeleteRecord: 'com.atproto.repo.deleteRecord',
   ComAtprotoRepoDescribeRepo: 'com.atproto.repo.describeRepo',
   ComAtprotoRepoGetRecord: 'com.atproto.repo.getRecord',

package/src/lexicon/types/com/atproto/repo/applyWrites.ts

@@ -7,32 +7,45 @@ import { lexicons } from '../../../../lexicons'
 import { isObj, hasProp } from '../../../../util'
 import { CID } from 'multiformats/cid'
 import { HandlerAuth, HandlerPipeThrough } from '@atproto/xrpc-server'
+import * as ComAtprotoRepoDefs from './defs'
 
 export interface QueryParams {}
 
 export interface InputSchema {
   /** The handle or DID of the repo (aka, current account). */
   repo: string
-  /** Can be set to 'false' to skip Lexicon schema validation of record data, for all operations. */
-  validate: boolean
+  /** Can be set to 'false' to skip Lexicon schema validation of record data across all operations, 'true' to require it, or leave unset to validate only for known Lexicons. */
+  validate?: boolean
   writes: (Create | Update | Delete)[]
   /** If provided, the entire operation will fail if the current repo commit CID does not match this value. Used to prevent conflicting repo mutations. */
   swapCommit?: string
   [k: string]: unknown
 }
 
+export interface OutputSchema {
+  commit?: ComAtprotoRepoDefs.CommitMeta
+  results?: (CreateResult | UpdateResult | DeleteResult)[]
+  [k: string]: unknown
+}
+
 export interface HandlerInput {
   encoding: 'application/json'
   body: InputSchema
 }
 
+export interface HandlerSuccess {
+  encoding: 'application/json'
+  body: OutputSchema
+  headers?: { [key: string]: string }
+}
+
 export interface HandlerError {
   status: number
   message?: string
   error?: 'InvalidSwap'
 }
 
-export type HandlerOutput = HandlerError | void
+export type HandlerOutput = HandlerError | HandlerSuccess | HandlerPipeThrough
 export type HandlerReqCtx<HA extends HandlerAuth = never> = {
   auth: HA
   params: QueryParams
@@ -102,3 +115,57 @@ export function isDelete(v: unknown): v is Delete {
 export function validateDelete(v: unknown): ValidationResult {
   return lexicons.validate('com.atproto.repo.applyWrites#delete', v)
 }
+
+export interface CreateResult {
+  uri: string
+  cid: string
+  validationStatus?: 'valid' | 'unknown' | (string & {})
+  [k: string]: unknown
+}
+
+export function isCreateResult(v: unknown): v is CreateResult {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'com.atproto.repo.applyWrites#createResult'
+  )
+}
+
+export function validateCreateResult(v: unknown): ValidationResult {
+  return lexicons.validate('com.atproto.repo.applyWrites#createResult', v)
+}
+
+export interface UpdateResult {
+  uri: string
+  cid: string
+  validationStatus?: 'valid' | 'unknown' | (string & {})
+  [k: string]: unknown
+}
+
+export function isUpdateResult(v: unknown): v is UpdateResult {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'com.atproto.repo.applyWrites#updateResult'
+  )
+}
+
+export function validateUpdateResult(v: unknown): ValidationResult {
+  return lexicons.validate('com.atproto.repo.applyWrites#updateResult', v)
+}
+
+export interface DeleteResult {
+  [k: string]: unknown
+}
+
+export function isDeleteResult(v: unknown): v is DeleteResult {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'com.atproto.repo.applyWrites#deleteResult'
+  )
+}
+
+export function validateDeleteResult(v: unknown): ValidationResult {
+  return lexicons.validate('com.atproto.repo.applyWrites#deleteResult', v)
+}

package/src/lexicon/types/com/atproto/repo/createRecord.ts

@@ -7,6 +7,7 @@ import { lexicons } from '../../../../lexicons'
 import { isObj, hasProp } from '../../../../util'
 import { CID } from 'multiformats/cid'
 import { HandlerAuth, HandlerPipeThrough } from '@atproto/xrpc-server'
+import * as ComAtprotoRepoDefs from './defs'
 
 export interface QueryParams {}
 
@@ -17,8 +18,8 @@ export interface InputSchema {
   collection: string
   /** The Record Key. */
   rkey?: string
-  /** Can be set to 'false' to skip Lexicon schema validation of record data. */
-  validate: boolean
+  /** Can be set to 'false' to skip Lexicon schema validation of record data, 'true' to require it, or leave unset to validate only for known Lexicons. */
+  validate?: boolean
   /** The record itself. Must contain a $type field. */
   record: {}
   /** Compare and swap with the previous commit by CID. */
@@ -29,6 +30,8 @@ export interface InputSchema {
 export interface OutputSchema {
   uri: string
   cid: string
+  commit?: ComAtprotoRepoDefs.CommitMeta
+  validationStatus?: 'valid' | 'unknown' | (string & {})
   [k: string]: unknown
 }
 

package/src/lexicon/types/com/atproto/repo/defs.ts

@@ -0,0 +1,25 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { ValidationResult, BlobRef } from '@atproto/lexicon'
+import { lexicons } from '../../../../lexicons'
+import { isObj, hasProp } from '../../../../util'
+import { CID } from 'multiformats/cid'
+
+export interface CommitMeta {
+  cid: string
+  rev: string
+  [k: string]: unknown
+}
+
+export function isCommitMeta(v: unknown): v is CommitMeta {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'com.atproto.repo.defs#commitMeta'
+  )
+}
+
+export function validateCommitMeta(v: unknown): ValidationResult {
+  return lexicons.validate('com.atproto.repo.defs#commitMeta', v)
+}

package/src/lexicon/types/com/atproto/repo/deleteRecord.ts

@@ -7,6 +7,7 @@ import { lexicons } from '../../../../lexicons'
 import { isObj, hasProp } from '../../../../util'
 import { CID } from 'multiformats/cid'
 import { HandlerAuth, HandlerPipeThrough } from '@atproto/xrpc-server'
+import * as ComAtprotoRepoDefs from './defs'
 
 export interface QueryParams {}
 
@@ -24,18 +25,29 @@ export interface InputSchema {
   [k: string]: unknown
 }
 
+export interface OutputSchema {
+  commit?: ComAtprotoRepoDefs.CommitMeta
+  [k: string]: unknown
+}
+
 export interface HandlerInput {
   encoding: 'application/json'
   body: InputSchema
 }
 
+export interface HandlerSuccess {
+  encoding: 'application/json'
+  body: OutputSchema
+  headers?: { [key: string]: string }
+}
+
 export interface HandlerError {
   status: number
   message?: string
   error?: 'InvalidSwap'
 }
 
-export type HandlerOutput = HandlerError | void
+export type HandlerOutput = HandlerError | HandlerSuccess | HandlerPipeThrough
 export type HandlerReqCtx<HA extends HandlerAuth = never> = {
   auth: HA
   params: QueryParams

package/src/lexicon/types/com/atproto/repo/putRecord.ts

@@ -7,6 +7,7 @@ import { lexicons } from '../../../../lexicons'
 import { isObj, hasProp } from '../../../../util'
 import { CID } from 'multiformats/cid'
 import { HandlerAuth, HandlerPipeThrough } from '@atproto/xrpc-server'
+import * as ComAtprotoRepoDefs from './defs'
 
 export interface QueryParams {}
 
@@ -17,8 +18,8 @@ export interface InputSchema {
   collection: string
   /** The Record Key. */
   rkey: string
-  /** Can be set to 'false' to skip Lexicon schema validation of record data. */
-  validate: boolean
+  /** Can be set to 'false' to skip Lexicon schema validation of record data, 'true' to require it, or leave unset to validate only for known Lexicons. */
+  validate?: boolean
   /** The record to write. */
   record: {}
   /** Compare and swap with the previous record by CID. WARNING: nullable and optional field; may cause problems with golang implementation */
@@ -31,6 +32,8 @@ export interface InputSchema {
 export interface OutputSchema {
   uri: string
   cid: string
+  commit?: ComAtprotoRepoDefs.CommitMeta
+  validationStatus?: 'valid' | 'unknown' | (string & {})
   [k: string]: unknown
 }
 

package/src/lexicon/types/tools/ozone/communication/createTemplate.ts

@@ -18,6 +18,8 @@ export interface InputSchema {
   contentMarkdown: string
   /** Subject of the message, used in emails. */
   subject: string
+  /** Message language. */
+  lang?: string
   /** DID of the user who is creating the template. */
   createdBy?: string
   [k: string]: unknown
@@ -39,6 +41,7 @@ export interface HandlerSuccess {
 export interface HandlerError {
   status: number
   message?: string
+  error?: 'DuplicateTemplateName'
 }
 
 export type HandlerOutput = HandlerError | HandlerSuccess | HandlerPipeThrough