Repo write commit metadata (bluesky-social#2745)

* schemas & codegen * impl * bundle commit & rev
porkytheblack · Aug 30, 2024 · bfbac24 · bfbac24
1 parent befebc0
commit bfbac24
Show file tree

Hide file tree

Showing 34 changed files with 411 additions and 3 deletions.
diff --git a/lexicons/com/atproto/repo/applyWrites.json b/lexicons/com/atproto/repo/applyWrites.json
@@ -42,6 +42,10 @@
           "type": "object",
           "required": [],
           "properties": {
+            "commit": {
+              "type": "ref",
+              "ref": "com.atproto.repo.defs#commitMeta"
+            },
             "results": {
               "type": "array",
               "items": {

diff --git a/lexicons/com/atproto/repo/createRecord.json b/lexicons/com/atproto/repo/createRecord.json
@@ -50,6 +50,10 @@
           "properties": {
             "uri": { "type": "string", "format": "at-uri" },
             "cid": { "type": "string", "format": "cid" },
+            "commit": {
+              "type": "ref",
+              "ref": "com.atproto.repo.defs#commitMeta"
+            },
             "validationStatus": {
               "type": "string",
               "knownValues": ["valid", "unknown"]

diff --git a/lexicons/com/atproto/repo/defs.json b/lexicons/com/atproto/repo/defs.json
@@ -0,0 +1,14 @@
+{
+  "lexicon": 1,
+  "id": "com.atproto.repo.defs",
+  "defs": {
+    "commitMeta": {
+      "type": "object",
+      "required": ["cid", "rev"],
+      "properties": {
+        "cid": { "type": "string", "format": "cid" },
+        "rev": { "type": "string" }
+      }
+    }
+  }
+}
diff --git a/lexicons/com/atproto/repo/deleteRecord.json b/lexicons/com/atproto/repo/deleteRecord.json
@@ -38,6 +38,18 @@
           }
         }
       },
+      "output": {
+        "encoding": "application/json",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "commit": {
+              "type": "ref",
+              "ref": "com.atproto.repo.defs#commitMeta"
+            }
+          }
+        }
+      },
       "errors": [{ "name": "InvalidSwap" }]
     }
   }

diff --git a/lexicons/com/atproto/repo/putRecord.json b/lexicons/com/atproto/repo/putRecord.json
@@ -56,6 +56,10 @@
           "properties": {
             "uri": { "type": "string", "format": "at-uri" },
             "cid": { "type": "string", "format": "cid" },
+            "commit": {
+              "type": "ref",
+              "ref": "com.atproto.repo.defs#commitMeta"
+            },
             "validationStatus": {
               "type": "string",
               "knownValues": ["valid", "unknown"]

diff --git a/packages/api/src/client/index.ts b/packages/api/src/client/index.ts
@@ -32,6 +32,7 @@ import * as ComAtprotoModerationCreateReport from './types/com/atproto/moderatio
 import * as ComAtprotoModerationDefs from './types/com/atproto/moderation/defs'
 import * as ComAtprotoRepoApplyWrites from './types/com/atproto/repo/applyWrites'
 import * as ComAtprotoRepoCreateRecord from './types/com/atproto/repo/createRecord'
+import * as ComAtprotoRepoDefs from './types/com/atproto/repo/defs'
 import * as ComAtprotoRepoDeleteRecord from './types/com/atproto/repo/deleteRecord'
 import * as ComAtprotoRepoDescribeRepo from './types/com/atproto/repo/describeRepo'
 import * as ComAtprotoRepoGetRecord from './types/com/atproto/repo/getRecord'
@@ -237,6 +238,7 @@ export * as ComAtprotoModerationCreateReport from './types/com/atproto/moderatio
 export * as ComAtprotoModerationDefs from './types/com/atproto/moderation/defs'
 export * as ComAtprotoRepoApplyWrites from './types/com/atproto/repo/applyWrites'
 export * as ComAtprotoRepoCreateRecord from './types/com/atproto/repo/createRecord'
+export * as ComAtprotoRepoDefs from './types/com/atproto/repo/defs'
 export * as ComAtprotoRepoDeleteRecord from './types/com/atproto/repo/deleteRecord'
 export * as ComAtprotoRepoDescribeRepo from './types/com/atproto/repo/describeRepo'
 export * as ComAtprotoRepoGetRecord from './types/com/atproto/repo/getRecord'

diff --git a/packages/api/src/client/lexicons.ts b/packages/api/src/client/lexicons.ts
@@ -1284,6 +1284,10 @@ export const schemaDict = {
             type: 'object',
             required: [],
             properties: {
+              commit: {
+                type: 'ref',
+                ref: 'lex:com.atproto.repo.defs#commitMeta',
+              },
               results: {
                 type: 'array',
                 items: {
@@ -1461,6 +1465,10 @@ export const schemaDict = {
                 type: 'string',
                 format: 'cid',
               },
+              commit: {
+                type: 'ref',
+                ref: 'lex:com.atproto.repo.defs#commitMeta',
+              },
               validationStatus: {
                 type: 'string',
                 knownValues: ['valid', 'unknown'],
@@ -1478,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',
@@ -1522,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',
@@ -1878,6 +1917,10 @@ export const schemaDict = {
                 type: 'string',
                 format: 'cid',
               },
+              commit: {
+                type: 'ref',
+                ref: 'lex:com.atproto.repo.defs#commitMeta',
+              },
               validationStatus: {
                 type: 'string',
                 knownValues: ['valid', 'unknown'],
@@ -12151,6 +12194,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',

diff --git a/packages/api/src/client/types/com/atproto/repo/applyWrites.ts b/packages/api/src/client/types/com/atproto/repo/applyWrites.ts
@@ -6,6 +6,7 @@ import { ValidationResult, BlobRef } from '@atproto/lexicon'
 import { isObj, hasProp } from '../../../../util'
 import { lexicons } from '../../../../lexicons'
 import { CID } from 'multiformats/cid'
+import * as ComAtprotoRepoDefs from './defs'
 
 export interface QueryParams {}
 
@@ -21,6 +22,7 @@ export interface InputSchema {
 }
 
 export interface OutputSchema {
+  commit?: ComAtprotoRepoDefs.CommitMeta
   results?: (CreateResult | UpdateResult | DeleteResult)[]
   [k: string]: unknown
 }

diff --git a/packages/api/src/client/types/com/atproto/repo/createRecord.ts b/packages/api/src/client/types/com/atproto/repo/createRecord.ts
@@ -6,6 +6,7 @@ import { ValidationResult, BlobRef } from '@atproto/lexicon'
 import { isObj, hasProp } from '../../../../util'
 import { lexicons } from '../../../../lexicons'
 import { CID } from 'multiformats/cid'
+import * as ComAtprotoRepoDefs from './defs'
 
 export interface QueryParams {}
 
@@ -28,6 +29,7 @@ export interface InputSchema {
 export interface OutputSchema {
   uri: string
   cid: string
+  commit?: ComAtprotoRepoDefs.CommitMeta
   validationStatus?: 'valid' | 'unknown' | (string & {})
   [k: string]: unknown
 }

diff --git a/packages/api/src/client/types/com/atproto/repo/defs.ts b/packages/api/src/client/types/com/atproto/repo/defs.ts
@@ -0,0 +1,25 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { ValidationResult, BlobRef } from '@atproto/lexicon'
+import { isObj, hasProp } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
+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)
+}
diff --git a/packages/api/src/client/types/com/atproto/repo/deleteRecord.ts b/packages/api/src/client/types/com/atproto/repo/deleteRecord.ts
@@ -6,6 +6,7 @@ import { ValidationResult, BlobRef } from '@atproto/lexicon'
 import { isObj, hasProp } from '../../../../util'
 import { lexicons } from '../../../../lexicons'
 import { CID } from 'multiformats/cid'
+import * as ComAtprotoRepoDefs from './defs'
 
 export interface QueryParams {}
 
@@ -23,6 +24,11 @@ export interface InputSchema {
   [k: string]: unknown
 }
 
+export interface OutputSchema {
+  commit?: ComAtprotoRepoDefs.CommitMeta
+  [k: string]: unknown
+}
+
 export interface CallOptions {
   signal?: AbortSignal
   headers?: HeadersMap
@@ -33,6 +39,7 @@ export interface CallOptions {
 export interface Response {
   success: boolean
   headers: HeadersMap
+  data: OutputSchema
 }
 
 export class InvalidSwapError extends XRPCError {

diff --git a/packages/api/src/client/types/com/atproto/repo/putRecord.ts b/packages/api/src/client/types/com/atproto/repo/putRecord.ts
@@ -6,6 +6,7 @@ import { ValidationResult, BlobRef } from '@atproto/lexicon'
 import { isObj, hasProp } from '../../../../util'
 import { lexicons } from '../../../../lexicons'
 import { CID } from 'multiformats/cid'
+import * as ComAtprotoRepoDefs from './defs'
 
 export interface QueryParams {}
 
@@ -30,6 +31,7 @@ export interface InputSchema {
 export interface OutputSchema {
   uri: string
   cid: string
+  commit?: ComAtprotoRepoDefs.CommitMeta
   validationStatus?: 'valid' | 'unknown' | (string & {})
   [k: string]: unknown
 }

diff --git a/packages/bsky/src/lexicon/lexicons.ts b/packages/bsky/src/lexicon/lexicons.ts
@@ -1284,6 +1284,10 @@ export const schemaDict = {
             type: 'object',
             required: [],
             properties: {
+              commit: {
+                type: 'ref',
+                ref: 'lex:com.atproto.repo.defs#commitMeta',
+              },
               results: {
                 type: 'array',
                 items: {
@@ -1461,6 +1465,10 @@ export const schemaDict = {
                 type: 'string',
                 format: 'cid',
               },
+              commit: {
+                type: 'ref',
+                ref: 'lex:com.atproto.repo.defs#commitMeta',
+              },
               validationStatus: {
                 type: 'string',
                 knownValues: ['valid', 'unknown'],
@@ -1478,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',
@@ -1522,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',
@@ -1878,6 +1917,10 @@ export const schemaDict = {
                 type: 'string',
                 format: 'cid',
               },
+              commit: {
+                type: 'ref',
+                ref: 'lex:com.atproto.repo.defs#commitMeta',
+              },
               validationStatus: {
                 type: 'string',
                 knownValues: ['valid', 'unknown'],
@@ -10433,6 +10476,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',

diff --git a/packages/bsky/src/lexicon/types/com/atproto/repo/applyWrites.ts b/packages/bsky/src/lexicon/types/com/atproto/repo/applyWrites.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 {}
 
@@ -22,6 +23,7 @@ export interface InputSchema {
 }
 
 export interface OutputSchema {
+  commit?: ComAtprotoRepoDefs.CommitMeta
   results?: (CreateResult | UpdateResult | DeleteResult)[]
   [k: string]: unknown
 }

diff --git a/packages/bsky/src/lexicon/types/com/atproto/repo/createRecord.ts b/packages/bsky/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 {}
 
@@ -29,6 +30,7 @@ export interface InputSchema {
 export interface OutputSchema {
   uri: string
   cid: string
+  commit?: ComAtprotoRepoDefs.CommitMeta
   validationStatus?: 'valid' | 'unknown' | (string & {})
   [k: string]: unknown
 }