@atcute/atproto 3.1.6 → 3.1.7

package/lib/lexicons/types/com/atproto/server/describeServer.ts

@@ -16,15 +16,30 @@ const _mainSchema = /*#__PURE__*/ v.query('com.atproto.server.describeServer', {
 	output: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * List of domain suffixes that can be used in account handles.
+			 */
 			availableUserDomains: /*#__PURE__*/ v.array(/*#__PURE__*/ v.string()),
+			/**
+			 * Contact information
+			 */
 			get contact() {
 				return /*#__PURE__*/ v.optional(contactSchema);
 			},
 			did: /*#__PURE__*/ v.didString(),
+			/**
+			 * If true, an invite code must be supplied to create an account on this instance.
+			 */
 			inviteCodeRequired: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.boolean()),
+			/**
+			 * URLs of service policy documents.
+			 */
 			get links() {
 				return /*#__PURE__*/ v.optional(linksSchema);
 			},
+			/**
+			 * If true, a phone verification token must be supplied to create an account on this instance.
+			 */
 			phoneVerificationRequired: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.boolean()),
 		}),
 	},

package/lib/lexicons/types/com/atproto/server/getAccountInviteCodes.ts

@@ -5,7 +5,14 @@ import * as ComAtprotoServerDefs from './defs.js';
 
 const _mainSchema = /*#__PURE__*/ v.query('com.atproto.server.getAccountInviteCodes', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * Controls whether any new 'earned' but not 'created' invites should be created.
+		 * @default true
+		 */
 		createAvailable: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.boolean(), true),
+		/**
+		 * @default true
+		 */
 		includeUsed: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.boolean(), true),
 	}),
 	output: {

package/lib/lexicons/types/com/atproto/server/getServiceAuth.ts

@@ -4,8 +4,17 @@ import type {} from '@atcute/lexicons/ambient';
 
 const _mainSchema = /*#__PURE__*/ v.query('com.atproto.server.getServiceAuth', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * The DID of the service that the token will be used to authenticate with
+		 */
 		aud: /*#__PURE__*/ v.didString(),
+		/**
+		 * The time in Unix Epoch seconds that the JWT expires. Defaults to 60 seconds in the future. The service may enforce certain time bounds on tokens depending on the requested scope.
+		 */
 		exp: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.integer()),
+		/**
+		 * Lexicon (XRPC) method to bind the requested token to
+		 */
 		lxm: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.nsidString()),
 	}),
 	output: {

package/lib/lexicons/types/com/atproto/server/getSession.ts

@@ -14,6 +14,9 @@ const _mainSchema = /*#__PURE__*/ v.query('com.atproto.server.getSession', {
 			emailAuthFactor: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.boolean()),
 			emailConfirmed: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.boolean()),
 			handle: /*#__PURE__*/ v.handleString(),
+			/**
+			 * If active=false, this optional field indicates a possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted.
+			 */
 			status: /*#__PURE__*/ v.optional(
 				/*#__PURE__*/ v.string<'deactivated' | 'suspended' | 'takendown' | (string & {})>(),
 			),

package/lib/lexicons/types/com/atproto/server/refreshSession.ts

@@ -14,6 +14,9 @@ const _mainSchema = /*#__PURE__*/ v.procedure('com.atproto.server.refreshSession
 			didDoc: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.unknown()),
 			handle: /*#__PURE__*/ v.handleString(),
 			refreshJwt: /*#__PURE__*/ v.string(),
+			/**
+			 * Hosting status of the account. If not specified, then assume 'active'.
+			 */
 			status: /*#__PURE__*/ v.optional(
 				/*#__PURE__*/ v.string<'deactivated' | 'suspended' | 'takendown' | (string & {})>(),
 			),

package/lib/lexicons/types/com/atproto/server/reserveSigningKey.ts

@@ -7,12 +7,18 @@ const _mainSchema = /*#__PURE__*/ v.procedure('com.atproto.server.reserveSigning
 	input: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * The DID to reserve a key for.
+			 */
 			did: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.didString()),
 		}),
 	},
 	output: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * The public key for the reserved signing key, in did:key serialization.
+			 */
 			signingKey: /*#__PURE__*/ v.string(),
 		}),
 	},

package/lib/lexicons/types/com/atproto/server/updateEmail.ts

@@ -9,6 +9,9 @@ const _mainSchema = /*#__PURE__*/ v.procedure('com.atproto.server.updateEmail',
 		schema: /*#__PURE__*/ v.object({
 			email: /*#__PURE__*/ v.string(),
 			emailAuthFactor: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.boolean()),
+			/**
+			 * Requires a token from com.atproto.sever.requestEmailUpdate if the account's email has been confirmed.
+			 */
 			token: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
 		}),
 	},

package/lib/lexicons/types/com/atproto/sync/getBlob.ts

@@ -4,7 +4,13 @@ import type {} from '@atcute/lexicons/ambient';
 
 const _mainSchema = /*#__PURE__*/ v.query('com.atproto.sync.getBlob', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * The CID of the blob to fetch
+		 */
 		cid: /*#__PURE__*/ v.cidString(),
+		/**
+		 * The DID of the account.
+		 */
 		did: /*#__PURE__*/ v.didString(),
 	}),
 	output: {

package/lib/lexicons/types/com/atproto/sync/getBlocks.ts

@@ -4,9 +4,15 @@ import type {} from '@atcute/lexicons/ambient';
 
 const _mainSchema = /*#__PURE__*/ v.query('com.atproto.sync.getBlocks', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * @minLength 1
+		 */
 		cids: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.array(/*#__PURE__*/ v.cidString()), [
 			/*#__PURE__*/ v.arrayLength(1),
 		]),
+		/**
+		 * The DID of the repo.
+		 */
 		did: /*#__PURE__*/ v.didString(),
 	}),
 	output: {

package/lib/lexicons/types/com/atproto/sync/getCheckout.ts

@@ -4,6 +4,9 @@ import type {} from '@atcute/lexicons/ambient';
 
 const _mainSchema = /*#__PURE__*/ v.query('com.atproto.sync.getCheckout', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * The DID of the repo.
+		 */
 		did: /*#__PURE__*/ v.didString(),
 	}),
 	output: {

package/lib/lexicons/types/com/atproto/sync/getHead.ts

@@ -4,6 +4,9 @@ import type {} from '@atcute/lexicons/ambient';
 
 const _mainSchema = /*#__PURE__*/ v.query('com.atproto.sync.getHead', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * The DID of the repo.
+		 */
 		did: /*#__PURE__*/ v.didString(),
 	}),
 	output: {

package/lib/lexicons/types/com/atproto/sync/getHostStatus.ts

@@ -5,13 +5,22 @@ import * as ComAtprotoSyncDefs from './defs.js';
 
 const _mainSchema = /*#__PURE__*/ v.query('com.atproto.sync.getHostStatus', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * Hostname of the host (eg, PDS or relay) being queried.
+		 */
 		hostname: /*#__PURE__*/ v.string(),
 	}),
 	output: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * Number of accounts on the server which are associated with the upstream host. Note that the upstream may actually have more accounts.
+			 */
 			accountCount: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.integer()),
 			hostname: /*#__PURE__*/ v.string(),
+			/**
+			 * Recent repo stream event sequence number. May be delayed from actual stream processing (eg, persisted cursor not in-memory cursor).
+			 */
 			seq: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.integer()),
 			get status() {
 				return /*#__PURE__*/ v.optional(ComAtprotoSyncDefs.hostStatusSchema);

package/lib/lexicons/types/com/atproto/sync/getLatestCommit.ts

@@ -4,6 +4,9 @@ import type {} from '@atcute/lexicons/ambient';
 
 const _mainSchema = /*#__PURE__*/ v.query('com.atproto.sync.getLatestCommit', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * The DID of the repo.
+		 */
 		did: /*#__PURE__*/ v.didString(),
 	}),
 	output: {

package/lib/lexicons/types/com/atproto/sync/getRecord.ts

@@ -5,7 +5,13 @@ import type {} from '@atcute/lexicons/ambient';
 const _mainSchema = /*#__PURE__*/ v.query('com.atproto.sync.getRecord', {
 	params: /*#__PURE__*/ v.object({
 		collection: /*#__PURE__*/ v.nsidString(),
+		/**
+		 * The DID of the repo.
+		 */
 		did: /*#__PURE__*/ v.didString(),
+		/**
+		 * Record Key
+		 */
 		rkey: /*#__PURE__*/ v.recordKeyString(),
 	}),
 	output: {

package/lib/lexicons/types/com/atproto/sync/getRepo.ts

@@ -4,7 +4,13 @@ import type {} from '@atcute/lexicons/ambient';
 
 const _mainSchema = /*#__PURE__*/ v.query('com.atproto.sync.getRepo', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * The DID of the repo.
+		 */
 		did: /*#__PURE__*/ v.didString(),
+		/**
+		 * The revision ('rev') of the repo to create a diff from.
+		 */
 		since: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.tidString()),
 	}),
 	output: {

package/lib/lexicons/types/com/atproto/sync/getRepoStatus.ts

@@ -4,6 +4,9 @@ import type {} from '@atcute/lexicons/ambient';
 
 const _mainSchema = /*#__PURE__*/ v.query('com.atproto.sync.getRepoStatus', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * The DID of the repo.
+		 */
 		did: /*#__PURE__*/ v.didString(),
 	}),
 	output: {
@@ -11,7 +14,13 @@ const _mainSchema = /*#__PURE__*/ v.query('com.atproto.sync.getRepoStatus', {
 		schema: /*#__PURE__*/ v.object({
 			active: /*#__PURE__*/ v.boolean(),
 			did: /*#__PURE__*/ v.didString(),
+			/**
+			 * Optional field, the current rev of the repo, if active=true
+			 */
 			rev: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.tidString()),
+			/**
+			 * If active=false, this optional field indicates a possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted.
+			 */
 			status: /*#__PURE__*/ v.optional(
 				/*#__PURE__*/ v.string<
 					| 'deactivated'

package/lib/lexicons/types/com/atproto/sync/listBlobs.ts

@@ -5,11 +5,22 @@ import type {} from '@atcute/lexicons/ambient';
 const _mainSchema = /*#__PURE__*/ v.query('com.atproto.sync.listBlobs', {
 	params: /*#__PURE__*/ v.object({
 		cursor: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
+		/**
+		 * The DID of the repo.
+		 */
 		did: /*#__PURE__*/ v.didString(),
+		/**
+		 * @minimum 1
+		 * @maximum 1000
+		 * @default 500
+		 */
 		limit: /*#__PURE__*/ v.optional(
 			/*#__PURE__*/ v.constrain(/*#__PURE__*/ v.integer(), [/*#__PURE__*/ v.integerRange(1, 1000)]),
 			500,
 		),
+		/**
+		 * Optional revision of the repo to list blobs since.
+		 */
 		since: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.tidString()),
 	}),
 	output: {

package/lib/lexicons/types/com/atproto/sync/listHosts.ts

@@ -6,7 +6,13 @@ import * as ComAtprotoSyncDefs from './defs.js';
 const _hostSchema = /*#__PURE__*/ v.object({
 	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('com.atproto.sync.listHosts#host')),
 	accountCount: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.integer()),
+	/**
+	 * hostname of server; not a URL (no scheme)
+	 */
 	hostname: /*#__PURE__*/ v.string(),
+	/**
+	 * Recent repo stream event sequence number. May be delayed from actual stream processing (eg, persisted cursor not in-memory cursor).
+	 */
 	seq: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.integer()),
 	get status() {
 		return /*#__PURE__*/ v.optional(ComAtprotoSyncDefs.hostStatusSchema);
@@ -15,6 +21,11 @@ const _hostSchema = /*#__PURE__*/ v.object({
 const _mainSchema = /*#__PURE__*/ v.query('com.atproto.sync.listHosts', {
 	params: /*#__PURE__*/ v.object({
 		cursor: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
+		/**
+		 * @minimum 1
+		 * @maximum 1000
+		 * @default 200
+		 */
 		limit: /*#__PURE__*/ v.optional(
 			/*#__PURE__*/ v.constrain(/*#__PURE__*/ v.integer(), [/*#__PURE__*/ v.integerRange(1, 1000)]),
 			200,
@@ -24,6 +35,9 @@ const _mainSchema = /*#__PURE__*/ v.query('com.atproto.sync.listHosts', {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
 			cursor: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
+			/**
+			 * Sort order is not formally specified. Recommended order is by time host was first seen by the server, with oldest first.
+			 */
 			get hosts() {
 				return /*#__PURE__*/ v.array(hostSchema);
 			},

package/lib/lexicons/types/com/atproto/sync/listRepos.ts

@@ -5,6 +5,11 @@ import type {} from '@atcute/lexicons/ambient';
 const _mainSchema = /*#__PURE__*/ v.query('com.atproto.sync.listRepos', {
 	params: /*#__PURE__*/ v.object({
 		cursor: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
+		/**
+		 * @minimum 1
+		 * @maximum 1000
+		 * @default 500
+		 */
 		limit: /*#__PURE__*/ v.optional(
 			/*#__PURE__*/ v.constrain(/*#__PURE__*/ v.integer(), [/*#__PURE__*/ v.integerRange(1, 1000)]),
 			500,
@@ -24,8 +29,14 @@ const _repoSchema = /*#__PURE__*/ v.object({
 	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('com.atproto.sync.listRepos#repo')),
 	active: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.boolean()),
 	did: /*#__PURE__*/ v.didString(),
+	/**
+	 * Current repo commit CID
+	 */
 	head: /*#__PURE__*/ v.cidString(),
 	rev: /*#__PURE__*/ v.tidString(),
+	/**
+	 * If active=false, this optional field indicates a possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted.
+	 */
 	status: /*#__PURE__*/ v.optional(
 		/*#__PURE__*/ v.string<
 			'deactivated' | 'deleted' | 'desynchronized' | 'suspended' | 'takendown' | 'throttled' | (string & {})

package/lib/lexicons/types/com/atproto/sync/listReposByCollection.ts

@@ -6,6 +6,12 @@ const _mainSchema = /*#__PURE__*/ v.query('com.atproto.sync.listReposByCollectio
 	params: /*#__PURE__*/ v.object({
 		collection: /*#__PURE__*/ v.nsidString(),
 		cursor: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
+		/**
+		 * Maximum size of response set. Recommend setting a large maximum (1000+) when enumerating large DID lists.
+		 * @minimum 1
+		 * @maximum 2000
+		 * @default 500
+		 */
 		limit: /*#__PURE__*/ v.optional(
 			/*#__PURE__*/ v.constrain(/*#__PURE__*/ v.integer(), [/*#__PURE__*/ v.integerRange(1, 2000)]),
 			500,

package/lib/lexicons/types/com/atproto/sync/notifyOfUpdate.ts

@@ -7,6 +7,9 @@ const _mainSchema = /*#__PURE__*/ v.procedure('com.atproto.sync.notifyOfUpdate',
 	input: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * Hostname of the current service (usually a PDS) that is notifying of update.
+			 */
 			hostname: /*#__PURE__*/ v.string(),
 		}),
 	},

package/lib/lexicons/types/com/atproto/sync/requestCrawl.ts

@@ -7,6 +7,9 @@ const _mainSchema = /*#__PURE__*/ v.procedure('com.atproto.sync.requestCrawl', {
 	input: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * Hostname of the current service (eg, PDS) that is requesting to be crawled.
+			 */
 			hostname: /*#__PURE__*/ v.string(),
 		}),
 	},

package/lib/lexicons/types/com/atproto/sync/subscribeRepos.ts

@@ -4,9 +4,15 @@ import type {} from '@atcute/lexicons/ambient';
 
 const _accountSchema = /*#__PURE__*/ v.object({
 	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('com.atproto.sync.subscribeRepos#account')),
+	/**
+	 * Indicates that the account has a repository which can be fetched from the host that emitted this event.
+	 */
 	active: /*#__PURE__*/ v.boolean(),
 	did: /*#__PURE__*/ v.didString(),
 	seq: /*#__PURE__*/ v.integer(),
+	/**
+	 * If active=false, this optional field indicates a reason for why the account is not active.
+	 */
 	status: /*#__PURE__*/ v.optional(
 		/*#__PURE__*/ v.string<
 			'deactivated' | 'deleted' | 'desynchronized' | 'suspended' | 'takendown' | 'throttled' | (string & {})
@@ -17,25 +23,62 @@ const _accountSchema = /*#__PURE__*/ v.object({
 const _commitSchema = /*#__PURE__*/ v.object({
 	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('com.atproto.sync.subscribeRepos#commit')),
 	blobs: /*#__PURE__*/ v.array(/*#__PURE__*/ v.cidLink()),
+	/**
+	 * CAR file containing relevant blocks, as a diff since the previous repo state. The commit must be included as a block, and the commit block CID must be the first entry in the CAR header 'roots' list.
+	 * @maxLength 2000000
+	 */
 	blocks: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.bytes(), [/*#__PURE__*/ v.bytesSize(0, 2000000)]),
+	/**
+	 * Repo commit object CID.
+	 */
 	commit: /*#__PURE__*/ v.cidLink(),
+	/**
+	 * @maxLength 200
+	 */
 	get ops() {
 		return /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.array(repoOpSchema), [
 			/*#__PURE__*/ v.arrayLength(0, 200),
 		]);
 	},
+	/**
+	 * The root CID of the MST tree for the previous commit from this repo (indicated by the 'since' revision field in this message). Corresponds to the 'data' field in the repo commit object. NOTE: this field is effectively required for the 'inductive' version of firehose.
+	 */
 	prevData: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.cidLink()),
+	/**
+	 * DEPRECATED -- unused
+	 */
 	rebase: /*#__PURE__*/ v.boolean(),
+	/**
+	 * The repo this event comes from. Note that all other message types name this field 'did'.
+	 */
 	repo: /*#__PURE__*/ v.didString(),
+	/**
+	 * The rev of the emitted commit. Note that this information is also in the commit object included in blocks, unless this is a tooBig event.
+	 */
 	rev: /*#__PURE__*/ v.tidString(),
+	/**
+	 * The stream sequence number of this message.
+	 */
 	seq: /*#__PURE__*/ v.integer(),
+	/**
+	 * The rev of the last emitted commit from this repo (if any).
+	 */
 	since: /*#__PURE__*/ v.nullable(/*#__PURE__*/ v.tidString()),
+	/**
+	 * Timestamp of when this message was originally broadcast.
+	 */
 	time: /*#__PURE__*/ v.datetimeString(),
+	/**
+	 * DEPRECATED -- replaced by #sync event and data limits. Indicates that this commit contained too many ops, or data size was too large. Consumers will need to make a separate request to get missing data.
+	 */
 	tooBig: /*#__PURE__*/ v.boolean(),
 });
 const _identitySchema = /*#__PURE__*/ v.object({
 	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('com.atproto.sync.subscribeRepos#identity')),
 	did: /*#__PURE__*/ v.didString(),
+	/**
+	 * The current handle for the account, or 'handle.invalid' if validation fails. This field is optional, might have been validated or passed-through from an upstream source. Semantics and behaviors for PDS vs Relay may evolve in the future; see atproto specs for more details.
+	 */
 	handle: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.handleString()),
 	seq: /*#__PURE__*/ v.integer(),
 	time: /*#__PURE__*/ v.datetimeString(),
@@ -47,6 +90,9 @@ const _infoSchema = /*#__PURE__*/ v.object({
 });
 const _mainSchema = /*#__PURE__*/ v.subscription('com.atproto.sync.subscribeRepos', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * The last known event seq number to backfill from.
+		 */
 		cursor: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.integer()),
 	}),
 	get message() {
@@ -56,16 +102,38 @@ const _mainSchema = /*#__PURE__*/ v.subscription('com.atproto.sync.subscribeRepo
 const _repoOpSchema = /*#__PURE__*/ v.object({
 	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('com.atproto.sync.subscribeRepos#repoOp')),
 	action: /*#__PURE__*/ v.string<'create' | 'delete' | 'update' | (string & {})>(),
+	/**
+	 * For creates and updates, the new record CID. For deletions, null.
+	 */
 	cid: /*#__PURE__*/ v.nullable(/*#__PURE__*/ v.cidLink()),
 	path: /*#__PURE__*/ v.string(),
+	/**
+	 * For updates and deletes, the previous record CID (required for inductive firehose). For creations, field should not be defined.
+	 */
 	prev: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.cidLink()),
 });
 const _syncSchema = /*#__PURE__*/ v.object({
 	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('com.atproto.sync.subscribeRepos#sync')),
+	/**
+	 * CAR file containing the commit, as a block. The CAR header must include the commit block CID as the first 'root'.
+	 * @maxLength 10000
+	 */
 	blocks: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.bytes(), [/*#__PURE__*/ v.bytesSize(0, 10000)]),
+	/**
+	 * The account this repo event corresponds to. Must match that in the commit object.
+	 */
 	did: /*#__PURE__*/ v.didString(),
+	/**
+	 * The rev of the commit. This value must match that in the commit object.
+	 */
 	rev: /*#__PURE__*/ v.string(),
+	/**
+	 * The stream sequence number of this message.
+	 */
 	seq: /*#__PURE__*/ v.integer(),
+	/**
+	 * Timestamp of when this message was originally broadcast.
+	 */
 	time: /*#__PURE__*/ v.datetimeString(),
 });
 

package/lib/lexicons/types/com/atproto/temp/checkHandleAvailability.ts

@@ -4,13 +4,25 @@ import type {} from '@atcute/lexicons/ambient';
 
 const _mainSchema = /*#__PURE__*/ v.query('com.atproto.temp.checkHandleAvailability', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * User-provided birth date. Might be used to build handle suggestions.
+		 */
 		birthDate: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.datetimeString()),
+		/**
+		 * User-provided email. Might be used to build handle suggestions.
+		 */
 		email: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
+		/**
+		 * Tentative handle. Will be checked for availability or used to build handle suggestions.
+		 */
 		handle: /*#__PURE__*/ v.handleString(),
 	}),
 	output: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * Echo of the input handle.
+			 */
 			handle: /*#__PURE__*/ v.handleString(),
 			get result() {
 				return /*#__PURE__*/ v.variant([resultAvailableSchema, resultUnavailableSchema]);
@@ -27,6 +39,9 @@ const _resultUnavailableSchema = /*#__PURE__*/ v.object({
 	$type: /*#__PURE__*/ v.optional(
 		/*#__PURE__*/ v.literal('com.atproto.temp.checkHandleAvailability#resultUnavailable'),
 	),
+	/**
+	 * List of suggested handles based on the provided inputs.
+	 */
 	get suggestions() {
 		return /*#__PURE__*/ v.array(suggestionSchema);
 	},
@@ -36,6 +51,9 @@ const _suggestionSchema = /*#__PURE__*/ v.object({
 		/*#__PURE__*/ v.literal('com.atproto.temp.checkHandleAvailability#suggestion'),
 	),
 	handle: /*#__PURE__*/ v.handleString(),
+	/**
+	 * Method used to build this suggestion. Should be considered opaque to clients. Can be used for metrics.
+	 */
 	method: /*#__PURE__*/ v.string(),
 });
 

package/lib/lexicons/types/com/atproto/temp/dereferenceScope.ts

@@ -4,11 +4,17 @@ import type {} from '@atcute/lexicons/ambient';
 
 const _mainSchema = /*#__PURE__*/ v.query('com.atproto.temp.dereferenceScope', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * The scope reference (starts with 'ref:')
+		 */
 		scope: /*#__PURE__*/ v.string(),
 	}),
 	output: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * The full oauth permission scope
+			 */
 			scope: /*#__PURE__*/ v.string(),
 		}),
 	},

package/lib/lexicons/types/com/atproto/temp/fetchLabels.ts

@@ -5,6 +5,11 @@ import * as ComAtprotoLabelDefs from '../label/defs.js';
 
 const _mainSchema = /*#__PURE__*/ v.query('com.atproto.temp.fetchLabels', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * @minimum 1
+		 * @maximum 250
+		 * @default 50
+		 */
 		limit: /*#__PURE__*/ v.optional(
 			/*#__PURE__*/ v.constrain(/*#__PURE__*/ v.integer(), [/*#__PURE__*/ v.integerRange(1, 250)]),
 			50,

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@atcute/atproto",
-  "version": "3.1.6",
+  "version": "3.1.7",
   "description": "AT Protocol (com.atproto.*) schema definitions",
   "keywords": [
     "atcute",
@@ -27,7 +27,7 @@
   },
   "devDependencies": {
     "@atcute/atproto": "file:",
-    "@atcute/lex-cli": "^2.2.1"
+    "@atcute/lex-cli": "^2.2.2"
   },
   "scripts": {
     "build": "tsc",