@atproto/api 0.18.19 → 0.18.21

package/dist/client/lexicons.js

@@ -2231,11 +2231,12 @@ exports.schemaDict = {
                     deviceId: {
                         type: 'string',
                         description: 'UUIDv4 identifier of the device that created this draft.',
+                        maxLength: 100,
                     },
-                    platform: {
+                    deviceName: {
                         type: 'string',
-                        knownValues: ['web', 'ios', 'android'],
-                        description: 'Platform on which the draft was created.',
+                        description: 'The device and/or platform on which the draft was created.',
+                        maxLength: 100,
                     },
                     posts: {
                         description: 'Array of draft posts that compose this draft.',
@@ -2288,9 +2289,9 @@ exports.schemaDict = {
                 properties: {
                     text: {
                         type: 'string',
-                        maxLength: 3000,
-                        maxGraphemes: 300,
-                        description: 'The primary post content.',
+                        maxLength: 10000,
+                        maxGraphemes: 1000,
+                        description: 'The primary post content. It has a higher limit than post contents to allow storing a larger text that can later be refined into smaller posts.',
                     },
                     labels: {
                         type: 'union',
@@ -8065,6 +8066,101 @@ exports.schemaDict = {
             },
         },
     },
+    AppBskyUnspeccedGetSuggestedOnboardingUsers: {
+        lexicon: 1,
+        id: 'app.bsky.unspecced.getSuggestedOnboardingUsers',
+        defs: {
+            main: {
+                type: 'query',
+                description: 'Get a list of suggested users for onboarding',
+                parameters: {
+                    type: 'params',
+                    properties: {
+                        category: {
+                            type: 'string',
+                            description: 'Category of users to get suggestions for.',
+                        },
+                        limit: {
+                            type: 'integer',
+                            minimum: 1,
+                            maximum: 50,
+                            default: 25,
+                        },
+                    },
+                },
+                output: {
+                    encoding: 'application/json',
+                    schema: {
+                        type: 'object',
+                        required: ['actors'],
+                        properties: {
+                            actors: {
+                                type: 'array',
+                                items: {
+                                    type: 'ref',
+                                    ref: 'lex:app.bsky.actor.defs#profileView',
+                                },
+                            },
+                            recId: {
+                                type: 'string',
+                                description: 'Snowflake for this recommendation, use when submitting recommendation events.',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+    AppBskyUnspeccedGetSuggestedOnboardingUsersSkeleton: {
+        lexicon: 1,
+        id: 'app.bsky.unspecced.getSuggestedOnboardingUsersSkeleton',
+        defs: {
+            main: {
+                type: 'query',
+                description: 'Get a skeleton of suggested users for onboarding. Intended to be called and hydrated by app.bsky.unspecced.getSuggestedOnboardingUsers',
+                parameters: {
+                    type: 'params',
+                    properties: {
+                        viewer: {
+                            type: 'string',
+                            format: 'did',
+                            description: 'DID of the account making the request (not included for public/unauthenticated queries).',
+                        },
+                        category: {
+                            type: 'string',
+                            description: 'Category of users to get suggestions for.',
+                        },
+                        limit: {
+                            type: 'integer',
+                            minimum: 1,
+                            maximum: 50,
+                            default: 25,
+                        },
+                    },
+                },
+                output: {
+                    encoding: 'application/json',
+                    schema: {
+                        type: 'object',
+                        required: ['dids'],
+                        properties: {
+                            dids: {
+                                type: 'array',
+                                items: {
+                                    type: 'string',
+                                    format: 'did',
+                                },
+                            },
+                            recId: {
+                                type: 'string',
+                                description: 'Snowflake for this recommendation, use when submitting recommendation events.',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
     AppBskyUnspeccedGetSuggestedStarterPacks: {
         lexicon: 1,
         id: 'app.bsky.unspecced.getSuggestedStarterPacks',
@@ -14828,7 +14924,7 @@ exports.schemaDict = {
         defs: {
             main: {
                 type: 'record',
-                description: 'A delegate messaging id',
+                description: 'A declaration of a Germ Network account',
                 key: 'literal:self',
                 record: {
                     type: 'object',
@@ -14836,22 +14932,30 @@ exports.schemaDict = {
                     properties: {
                         version: {
                             type: 'string',
+                            description: 'Semver version number, without pre-release or build information, for the format of opaque content',
+                            minLength: 5,
+                            maxLength: 14,
                         },
                         currentKey: {
                             type: 'bytes',
+                            description: 'Opaque value, an ed25519 public key prefixed with a byte enum',
                         },
                         messageMe: {
                             type: 'ref',
+                            description: 'Controls who can message this account',
                             ref: 'lex:com.germnetwork.declaration#messageMe',
                         },
                         keyPackage: {
                             type: 'bytes',
+                            description: 'Opaque value, contains MLS KeyPackage(s), and other signature data, and is signed by the currentKey',
                         },
                         continuityProofs: {
                             type: 'array',
+                            description: 'Array of opaque values to allow for key rolling',
                             items: {
                                 type: 'bytes',
                             },
+                            maxLength: 1000,
                         },
                     },
                 },
@@ -14862,11 +14966,17 @@ exports.schemaDict = {
                 properties: {
                     messageMeUrl: {
                         type: 'string',
+                        description: 'A URL to present to an account that does not have its own com.germnetwork.declaration record, must have an empty fragment component, where the app should fill in the fragment component with the DIDs of the two accounts who wish to message each other',
                         format: 'uri',
+                        minLength: 1,
+                        maxLength: 2047,
                     },
                     showButtonTo: {
                         type: 'string',
-                        knownValues: ['usersIFollow', 'everyone'],
+                        knownValues: ['none', 'usersIFollow', 'everyone'],
+                        description: "The policy of who can message the account, this value is included in the keyPackage, but is duplicated here to allow applications to decide if they should show a 'Message on Germ' button to the viewer.",
+                        minLength: 1,
+                        maxLength: 100,
                     },
                 },
             },
@@ -19991,6 +20101,8 @@ exports.ids = {
     AppBskyUnspeccedGetPostThreadV2: 'app.bsky.unspecced.getPostThreadV2',
     AppBskyUnspeccedGetSuggestedFeeds: 'app.bsky.unspecced.getSuggestedFeeds',
     AppBskyUnspeccedGetSuggestedFeedsSkeleton: 'app.bsky.unspecced.getSuggestedFeedsSkeleton',
+    AppBskyUnspeccedGetSuggestedOnboardingUsers: 'app.bsky.unspecced.getSuggestedOnboardingUsers',
+    AppBskyUnspeccedGetSuggestedOnboardingUsersSkeleton: 'app.bsky.unspecced.getSuggestedOnboardingUsersSkeleton',
     AppBskyUnspeccedGetSuggestedStarterPacks: 'app.bsky.unspecced.getSuggestedStarterPacks',
     AppBskyUnspeccedGetSuggestedStarterPacksSkeleton: 'app.bsky.unspecced.getSuggestedStarterPacksSkeleton',
     AppBskyUnspeccedGetSuggestedUsers: 'app.bsky.unspecced.getSuggestedUsers',