Schema keyed hint (bluesky-social#243)

* update schemas for keyed * codegen dict * codgen record ids * determine key type from schema * allow non-tid keys * rm tids from batch write schema * use schema ids record in db layouts * standardize on rkey * doc update * crud test * repo tests for custom rkeys
rcg4u · Oct 18, 2022 · fd18da2 · fd18da2
1 parent 0820013
commit fd18da2
Show file tree

Hide file tree

Showing 35 changed files with 348 additions and 189 deletions.
diff --git a/docs/specs/lexicon.md b/docs/specs/lexicon.md
@@ -14,6 +14,7 @@ interface LexiconDoc {
 }
 
 interface RecordLexiconDoc extends LexiconDoc {
+  key?: string
   record: JSONSchema
 }
 
@@ -99,6 +100,7 @@ interface XrpcError {
   "lexicon": 1,
   "id": "todo.social.repost",
   "type": "record",
+  "key": "tid",
   "record": {
     "type": "object",
     "required": ["subject", "createdAt"],

diff --git a/lexicons/atproto.com/repoBatchWrite.json b/lexicons/atproto.com/repoBatchWrite.json
@@ -23,26 +23,27 @@
                 "properties": {
                   "action": {"type": "string", "const": "create"},
                   "collection": {"type": "string"},
+                  "rkey": {"type": "string"},
                   "value": {}
                 }
               },
               {
                 "type": "object",
-                "required": ["action", "collection", "tid", "value"],
+                "required": ["action", "collection", "rkey", "value"],
                 "properties": {
                   "action": {"type": "string", "const": "update"},
                   "collection": {"type": "string"},
-                  "tid": {"type": "string"},
+                  "rkey": {"type": "string"},
                   "value": {}
                 }
               },
               {
                 "type": "object",
-                "required": ["action", "collection", "tid"],
+                "required": ["action", "collection", "rkey"],
                 "properties": {
                   "action": {"type": "string", "const": "delete"},
                   "collection": {"type": "string"},
-                  "tid": {"type": "string"}
+                  "rkey": {"type": "string"}
                 }
               }
             ]

diff --git a/lexicons/bsky.app/badge.json b/lexicons/bsky.app/badge.json
@@ -3,6 +3,7 @@
   "id": "app.bsky.badge",
   "type": "record",
   "description": "An assertion about the subject by this user.",
+  "key": "tid",
   "record": {
     "type": "object",
     "required": ["assertion", "createdAt"],

diff --git a/lexicons/bsky.app/badgeAccept.json b/lexicons/bsky.app/badgeAccept.json
@@ -2,6 +2,7 @@
   "lexicon": 1,
   "id": "app.bsky.badgeAccept",
   "type": "record",
+  "key": "tid",
   "record": {
     "type": "object",
     "required": ["badge", "offer", "createdAt"],

diff --git a/lexicons/bsky.app/badgeOffer.json b/lexicons/bsky.app/badgeOffer.json
@@ -2,6 +2,7 @@
   "lexicon": 1,
   "id": "app.bsky.badgeOffer",
   "type": "record",
+  "key": "tid",
   "record": {
     "type": "object",
     "required": ["badge", "subject", "createdAt"],

diff --git a/lexicons/bsky.app/follow.json b/lexicons/bsky.app/follow.json
@@ -3,6 +3,7 @@
   "id": "app.bsky.follow",
   "type": "record",
   "description": "A social follow",
+  "key": "tid",
   "record": {
     "type": "object",
     "required": ["subject", "createdAt"],

diff --git a/lexicons/bsky.app/like.json b/lexicons/bsky.app/like.json
@@ -2,6 +2,7 @@
   "lexicon": 1,
   "id": "app.bsky.like",
   "type": "record",
+  "key": "tid",
   "record": {
     "type": "object",
     "required": ["subject", "createdAt"],

diff --git a/lexicons/bsky.app/mediaEmbed.json b/lexicons/bsky.app/mediaEmbed.json
@@ -3,6 +3,7 @@
   "id": "app.bsky.mediaEmbed",
   "type": "record",
   "description": "A list of media embedded in a post or document.",
+  "key": "tid",
   "record": {
     "type": "object",
     "required": ["media"],

diff --git a/lexicons/bsky.app/post.json b/lexicons/bsky.app/post.json
@@ -2,6 +2,7 @@
   "lexicon": 1,
   "id": "app.bsky.post",
   "type": "record",
+  "key": "tid",
   "record": {
     "type": "object",
     "required": ["text", "createdAt"],

diff --git a/lexicons/bsky.app/profile.json b/lexicons/bsky.app/profile.json
@@ -2,6 +2,7 @@
   "lexicon": 1,
   "id": "app.bsky.profile",
   "type": "record",
+  "key": "literal:self",
   "record": {
     "type": "object",
     "required": ["displayName"],

diff --git a/lexicons/bsky.app/repost.json b/lexicons/bsky.app/repost.json
@@ -2,6 +2,7 @@
   "lexicon": 1,
   "id": "app.bsky.repost",
   "type": "record",
+  "key": "tid",
   "record": {
     "type": "object",
     "required": ["subject", "createdAt"],