@atcute/atproto 3.1.6 → 3.1.8

package/lib/lexicons/types/com/atproto/identity/defs.ts

@@ -4,7 +4,13 @@ import * as v from '@atcute/lexicons/validations';
 const _identityInfoSchema = /*#__PURE__*/ v.object({
 	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('com.atproto.identity.defs#identityInfo')),
 	did: /*#__PURE__*/ v.didString(),
+	/**
+	 * The complete DID document for the identity.
+	 */
 	didDoc: /*#__PURE__*/ v.unknown(),
+	/**
+	 * The validated handle of the account; or 'handle.invalid' if the handle did not bi-directionally match the DID document.
+	 */
 	handle: /*#__PURE__*/ v.handleString(),
 });
 

package/lib/lexicons/types/com/atproto/identity/getRecommendedDidCredentials.ts

@@ -8,6 +8,9 @@ const _mainSchema = /*#__PURE__*/ v.query('com.atproto.identity.getRecommendedDi
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
 			alsoKnownAs: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.array(/*#__PURE__*/ v.string())),
+			/**
+			 * Recommended rotation keys for PLC dids. Should be undefined (or ignored) for did:webs.
+			 */
 			rotationKeys: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.array(/*#__PURE__*/ v.string())),
 			services: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.unknown()),
 			verificationMethods: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.unknown()),

package/lib/lexicons/types/com/atproto/identity/resolveDid.ts

@@ -4,11 +4,17 @@ import type {} from '@atcute/lexicons/ambient';
 
 const _mainSchema = /*#__PURE__*/ v.query('com.atproto.identity.resolveDid', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * DID to resolve.
+		 */
 		did: /*#__PURE__*/ v.didString(),
 	}),
 	output: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * The complete DID document for the identity.
+			 */
 			didDoc: /*#__PURE__*/ v.unknown(),
 		}),
 	},

package/lib/lexicons/types/com/atproto/identity/resolveHandle.ts

@@ -4,6 +4,9 @@ import type {} from '@atcute/lexicons/ambient';
 
 const _mainSchema = /*#__PURE__*/ v.query('com.atproto.identity.resolveHandle', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * The handle to resolve.
+		 */
 		handle: /*#__PURE__*/ v.handleString(),
 	}),
 	output: {

package/lib/lexicons/types/com/atproto/identity/resolveIdentity.ts

@@ -5,6 +5,9 @@ import * as ComAtprotoIdentityDefs from './defs.js';
 
 const _mainSchema = /*#__PURE__*/ v.query('com.atproto.identity.resolveIdentity', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * Handle or DID to resolve.
+		 */
 		identifier: /*#__PURE__*/ v.actorIdentifierString(),
 	}),
 	output: {

package/lib/lexicons/types/com/atproto/identity/signPlcOperation.ts

@@ -10,6 +10,9 @@ const _mainSchema = /*#__PURE__*/ v.procedure('com.atproto.identity.signPlcOpera
 			alsoKnownAs: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.array(/*#__PURE__*/ v.string())),
 			rotationKeys: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.array(/*#__PURE__*/ v.string())),
 			services: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.unknown()),
+			/**
+			 * A token received through com.atproto.identity.requestPlcOperationSignature
+			 */
 			token: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
 			verificationMethods: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.unknown()),
 		}),
@@ -17,6 +20,9 @@ const _mainSchema = /*#__PURE__*/ v.procedure('com.atproto.identity.signPlcOpera
 	output: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * A signed DID PLC operation.
+			 */
 			operation: /*#__PURE__*/ v.unknown(),
 		}),
 	},

package/lib/lexicons/types/com/atproto/identity/updateHandle.ts

@@ -7,6 +7,9 @@ const _mainSchema = /*#__PURE__*/ v.procedure('com.atproto.identity.updateHandle
 	input: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * The new handle.
+			 */
 			handle: /*#__PURE__*/ v.handleString(),
 		}),
 	},

package/lib/lexicons/types/com/atproto/label/defs.ts

@@ -3,14 +3,42 @@ import * as v from '@atcute/lexicons/validations';
 
 const _labelSchema = /*#__PURE__*/ v.object({
 	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('com.atproto.label.defs#label')),
+	/**
+	 * Optionally, CID specifying the specific version of 'uri' resource this label applies to.
+	 */
 	cid: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.cidString()),
+	/**
+	 * Timestamp when this label was created.
+	 */
 	cts: /*#__PURE__*/ v.datetimeString(),
+	/**
+	 * Timestamp at which this label expires (no longer applies).
+	 */
 	exp: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.datetimeString()),
+	/**
+	 * If true, this is a negation label, overwriting a previous label.
+	 */
 	neg: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.boolean()),
+	/**
+	 * Signature of dag-cbor encoded label.
+	 */
 	sig: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.bytes()),
+	/**
+	 * DID of the actor who created this label.
+	 */
 	src: /*#__PURE__*/ v.didString(),
+	/**
+	 * AT URI of the record, repository (account), or other resource that this label applies to.
+	 */
 	uri: /*#__PURE__*/ v.genericUriString(),
+	/**
+	 * The short string name of the value or type of this label.
+	 * @maxLength 128
+	 */
 	val: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [/*#__PURE__*/ v.stringLength(0, 128)]),
+	/**
+	 * The AT Protocol version of the label object.
+	 */
 	ver: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.integer()),
 });
 const _labelValueSchema = /*#__PURE__*/ v.string<
@@ -29,12 +57,27 @@ const _labelValueSchema = /*#__PURE__*/ v.string<
 >();
 const _labelValueDefinitionSchema = /*#__PURE__*/ v.object({
 	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('com.atproto.label.defs#labelValueDefinition')),
+	/**
+	 * Does the user need to have adult content enabled in order to configure this label?
+	 */
 	adultOnly: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.boolean()),
+	/**
+	 * What should this label hide in the UI, if applied? 'content' hides all of the target; 'media' hides the images/video/audio; 'none' hides nothing.
+	 */
 	blurs: /*#__PURE__*/ v.string<'content' | 'media' | 'none' | (string & {})>(),
+	/**
+	 * The default setting for this label.
+	 * @default "warn"
+	 */
 	defaultSetting: /*#__PURE__*/ v.optional(
 		/*#__PURE__*/ v.string<'hide' | 'ignore' | 'warn' | (string & {})>(),
 		'warn',
 	),
+	/**
+	 * The value of the label being defined. Must only include lowercase ascii and the '-' character ([a-z-]+).
+	 * @maxLength 100
+	 * @maxGraphemes 100
+	 */
 	identifier: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [
 		/*#__PURE__*/ v.stringLength(0, 100),
 		/*#__PURE__*/ v.stringGraphemes(0, 100),
@@ -42,17 +85,33 @@ const _labelValueDefinitionSchema = /*#__PURE__*/ v.object({
 	get locales() {
 		return /*#__PURE__*/ v.array(labelValueDefinitionStringsSchema);
 	},
+	/**
+	 * How should a client visually convey this label? 'inform' means neutral and informational; 'alert' means negative and warning; 'none' means show nothing.
+	 */
 	severity: /*#__PURE__*/ v.string<'alert' | 'inform' | 'none' | (string & {})>(),
 });
 const _labelValueDefinitionStringsSchema = /*#__PURE__*/ v.object({
 	$type: /*#__PURE__*/ v.optional(
 		/*#__PURE__*/ v.literal('com.atproto.label.defs#labelValueDefinitionStrings'),
 	),
+	/**
+	 * A longer description of what the label means and why it might be applied.
+	 * @maxLength 100000
+	 * @maxGraphemes 10000
+	 */
 	description: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [
 		/*#__PURE__*/ v.stringLength(0, 100000),
 		/*#__PURE__*/ v.stringGraphemes(0, 10000),
 	]),
+	/**
+	 * The code of the language these strings are written in.
+	 */
 	lang: /*#__PURE__*/ v.languageCodeString(),
+	/**
+	 * A short human-readable name for the label.
+	 * @maxLength 640
+	 * @maxGraphemes 64
+	 */
 	name: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [
 		/*#__PURE__*/ v.stringLength(0, 640),
 		/*#__PURE__*/ v.stringGraphemes(0, 64),
@@ -60,10 +119,17 @@ const _labelValueDefinitionStringsSchema = /*#__PURE__*/ v.object({
 });
 const _selfLabelSchema = /*#__PURE__*/ v.object({
 	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('com.atproto.label.defs#selfLabel')),
+	/**
+	 * The short string name of the value or type of this label.
+	 * @maxLength 128
+	 */
 	val: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [/*#__PURE__*/ v.stringLength(0, 128)]),
 });
 const _selfLabelsSchema = /*#__PURE__*/ v.object({
 	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('com.atproto.label.defs#selfLabels')),
+	/**
+	 * @maxLength 10
+	 */
 	get values() {
 		return /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.array(selfLabelSchema), [
 			/*#__PURE__*/ v.arrayLength(0, 10),

package/lib/lexicons/types/com/atproto/label/queryLabels.ts

@@ -6,11 +6,23 @@ import * as ComAtprotoLabelDefs from './defs.js';
 const _mainSchema = /*#__PURE__*/ v.query('com.atproto.label.queryLabels', {
 	params: /*#__PURE__*/ v.object({
 		cursor: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
+		/**
+		 * @minimum 1
+		 * @maximum 250
+		 * @default 50
+		 */
 		limit: /*#__PURE__*/ v.optional(
 			/*#__PURE__*/ v.constrain(/*#__PURE__*/ v.integer(), [/*#__PURE__*/ v.integerRange(1, 250)]),
 			50,
 		),
+		/**
+		 * Optional list of label sources (DIDs) to filter on.
+		 */
 		sources: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.array(/*#__PURE__*/ v.didString())),
+		/**
+		 * List of AT URI patterns to match (boolean 'OR'). Each may be a prefix (ending with '*'; will match inclusive of the string leading to '*'), or a full URI.
+		 * @minLength 1
+		 */
 		uriPatterns: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.array(/*#__PURE__*/ v.string()), [
 			/*#__PURE__*/ v.arrayLength(1),
 		]),

package/lib/lexicons/types/com/atproto/label/subscribeLabels.ts

@@ -17,6 +17,9 @@ const _labelsSchema = /*#__PURE__*/ v.object({
 });
 const _mainSchema = /*#__PURE__*/ v.subscription('com.atproto.label.subscribeLabels', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * The last known event seq number to backfill from.
+		 */
 		cursor: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.integer()),
 	}),
 	get message() {

package/lib/lexicons/types/com/atproto/lexicon/schema.ts

@@ -6,6 +6,9 @@ const _mainSchema = /*#__PURE__*/ v.record(
 	/*#__PURE__*/ v.nsidString(),
 	/*#__PURE__*/ v.object({
 		$type: /*#__PURE__*/ v.literal('com.atproto.lexicon.schema'),
+		/**
+		 * Indicates the 'version' of the Lexicon language. Must be '1' for the current atproto/Lexicon schema system.
+		 */
 		lexicon: /*#__PURE__*/ v.integer(),
 	}),
 );

package/lib/lexicons/types/com/atproto/moderation/createReport.ts

@@ -13,12 +13,20 @@ const _mainSchema = /*#__PURE__*/ v.procedure('com.atproto.moderation.createRepo
 			get modTool() {
 				return /*#__PURE__*/ v.optional(modToolSchema);
 			},
+			/**
+			 * Additional context about the content and violation.
+			 * @maxLength 20000
+			 * @maxGraphemes 2000
+			 */
 			reason: /*#__PURE__*/ v.optional(
 				/*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [
 					/*#__PURE__*/ v.stringLength(0, 20000),
 					/*#__PURE__*/ v.stringGraphemes(0, 2000),
 				]),
 			),
+			/**
+			 * Indicates the broad category of violation the report is for.
+			 */
 			get reasonType() {
 				return ComAtprotoModerationDefs.reasonTypeSchema;
 			},
@@ -35,6 +43,10 @@ const _mainSchema = /*#__PURE__*/ v.procedure('com.atproto.moderation.createRepo
 		schema: /*#__PURE__*/ v.object({
 			createdAt: /*#__PURE__*/ v.datetimeString(),
 			id: /*#__PURE__*/ v.integer(),
+			/**
+			 * @maxLength 20000
+			 * @maxGraphemes 2000
+			 */
 			reason: /*#__PURE__*/ v.optional(
 				/*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [
 					/*#__PURE__*/ v.stringLength(0, 20000),
@@ -56,7 +68,13 @@ const _mainSchema = /*#__PURE__*/ v.procedure('com.atproto.moderation.createRepo
 });
 const _modToolSchema = /*#__PURE__*/ v.object({
 	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('com.atproto.moderation.createReport#modTool')),
+	/**
+	 * Additional arbitrary metadata about the source
+	 */
 	meta: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.unknown()),
+	/**
+	 * Name/identifier of the source (e.g., 'bsky-app/android', 'bsky-web/chrome')
+	 */
 	name: /*#__PURE__*/ v.string(),
 });
 

package/lib/lexicons/types/com/atproto/repo/applyWrites.ts

@@ -6,6 +6,10 @@ import * as ComAtprotoRepoDefs from './defs.js';
 const _createSchema = /*#__PURE__*/ v.object({
 	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('com.atproto.repo.applyWrites#create')),
 	collection: /*#__PURE__*/ v.nsidString(),
+	/**
+	 * NOTE: maxLength is redundant with record-key format. Keeping it temporarily to ensure backwards compatibility.
+	 * @maxLength 512
+	 */
 	rkey: /*#__PURE__*/ v.optional(
 		/*#__PURE__*/ v.constrain(/*#__PURE__*/ v.recordKeyString(), [/*#__PURE__*/ v.stringLength(0, 512)]),
 	),
@@ -30,8 +34,17 @@ const _mainSchema = /*#__PURE__*/ v.procedure('com.atproto.repo.applyWrites', {
 	input: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * The handle or DID of the repo (aka, current account).
+			 */
 			repo: /*#__PURE__*/ v.actorIdentifierString(),
+			/**
+			 * 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: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.cidString()),
+			/**
+			 * 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: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.boolean()),
 			get writes() {
 				return /*#__PURE__*/ v.array(

package/lib/lexicons/types/com/atproto/repo/createRecord.ts

@@ -8,13 +8,32 @@ const _mainSchema = /*#__PURE__*/ v.procedure('com.atproto.repo.createRecord', {
 	input: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * The NSID of the record collection.
+			 */
 			collection: /*#__PURE__*/ v.nsidString(),
+			/**
+			 * The record itself. Must contain a $type field.
+			 */
 			record: /*#__PURE__*/ v.unknown(),
+			/**
+			 * The handle or DID of the repo (aka, current account).
+			 */
 			repo: /*#__PURE__*/ v.actorIdentifierString(),
+			/**
+			 * The Record Key.
+			 * @maxLength 512
+			 */
 			rkey: /*#__PURE__*/ v.optional(
 				/*#__PURE__*/ v.constrain(/*#__PURE__*/ v.recordKeyString(), [/*#__PURE__*/ v.stringLength(0, 512)]),
 			),
+			/**
+			 * Compare and swap with the previous commit by CID.
+			 */
 			swapCommit: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.cidString()),
+			/**
+			 * 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: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.boolean()),
 		}),
 	},

package/lib/lexicons/types/com/atproto/repo/deleteRecord.ts

@@ -8,10 +8,25 @@ const _mainSchema = /*#__PURE__*/ v.procedure('com.atproto.repo.deleteRecord', {
 	input: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * The NSID of the record collection.
+			 */
 			collection: /*#__PURE__*/ v.nsidString(),
+			/**
+			 * The handle or DID of the repo (aka, current account).
+			 */
 			repo: /*#__PURE__*/ v.actorIdentifierString(),
+			/**
+			 * The Record Key.
+			 */
 			rkey: /*#__PURE__*/ v.recordKeyString(),
+			/**
+			 * Compare and swap with the previous commit by CID.
+			 */
 			swapCommit: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.cidString()),
+			/**
+			 * Compare and swap with the previous record by CID.
+			 */
 			swapRecord: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.cidString()),
 		}),
 	},

package/lib/lexicons/types/com/atproto/repo/describeRepo.ts

@@ -4,15 +4,27 @@ import type {} from '@atcute/lexicons/ambient';
 
 const _mainSchema = /*#__PURE__*/ v.query('com.atproto.repo.describeRepo', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * The handle or DID of the repo.
+		 */
 		repo: /*#__PURE__*/ v.actorIdentifierString(),
 	}),
 	output: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * List of all the collections (NSIDs) for which this repo contains at least one record.
+			 */
 			collections: /*#__PURE__*/ v.array(/*#__PURE__*/ v.nsidString()),
 			did: /*#__PURE__*/ v.didString(),
+			/**
+			 * The complete DID document for this account.
+			 */
 			didDoc: /*#__PURE__*/ v.unknown(),
 			handle: /*#__PURE__*/ v.handleString(),
+			/**
+			 * Indicates if handle is currently valid (resolves bi-directionally)
+			 */
 			handleIsCorrect: /*#__PURE__*/ v.boolean(),
 		}),
 	},

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

@@ -4,9 +4,21 @@ import type {} from '@atcute/lexicons/ambient';
 
 const _mainSchema = /*#__PURE__*/ v.query('com.atproto.repo.getRecord', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * The CID of the version of the record. If not specified, then return the most recent version.
+		 */
 		cid: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.cidString()),
+		/**
+		 * The NSID of the record collection.
+		 */
 		collection: /*#__PURE__*/ v.nsidString(),
+		/**
+		 * The handle or DID of the repo.
+		 */
 		repo: /*#__PURE__*/ v.actorIdentifierString(),
+		/**
+		 * The Record Key.
+		 */
 		rkey: /*#__PURE__*/ v.recordKeyString(),
 	}),
 	output: {

package/lib/lexicons/types/com/atproto/repo/listMissingBlobs.ts

@@ -5,6 +5,11 @@ import type {} from '@atcute/lexicons/ambient';
 const _mainSchema = /*#__PURE__*/ v.query('com.atproto.repo.listMissingBlobs', {
 	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,

package/lib/lexicons/types/com/atproto/repo/listRecords.ts

@@ -4,13 +4,28 @@ import type {} from '@atcute/lexicons/ambient';
 
 const _mainSchema = /*#__PURE__*/ v.query('com.atproto.repo.listRecords', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * The NSID of the record type.
+		 */
 		collection: /*#__PURE__*/ v.nsidString(),
 		cursor: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
+		/**
+		 * The number of records to return.
+		 * @minimum 1
+		 * @maximum 100
+		 * @default 50
+		 */
 		limit: /*#__PURE__*/ v.optional(
 			/*#__PURE__*/ v.constrain(/*#__PURE__*/ v.integer(), [/*#__PURE__*/ v.integerRange(1, 100)]),
 			50,
 		),
+		/**
+		 * The handle or DID of the repo.
+		 */
 		repo: /*#__PURE__*/ v.actorIdentifierString(),
+		/**
+		 * Flag to reverse the order of the returned records.
+		 */
 		reverse: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.boolean()),
 	}),
 	output: {

package/lib/lexicons/types/com/atproto/repo/putRecord.ts

@@ -8,14 +8,36 @@ const _mainSchema = /*#__PURE__*/ v.procedure('com.atproto.repo.putRecord', {
 	input: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * The NSID of the record collection.
+			 */
 			collection: /*#__PURE__*/ v.nsidString(),
+			/**
+			 * The record to write.
+			 */
 			record: /*#__PURE__*/ v.unknown(),
+			/**
+			 * The handle or DID of the repo (aka, current account).
+			 */
 			repo: /*#__PURE__*/ v.actorIdentifierString(),
+			/**
+			 * The Record Key.
+			 * @maxLength 512
+			 */
 			rkey: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.recordKeyString(), [
 				/*#__PURE__*/ v.stringLength(0, 512),
 			]),
+			/**
+			 * Compare and swap with the previous commit by CID.
+			 */
 			swapCommit: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.cidString()),
+			/**
+			 * Compare and swap with the previous record by CID. WARNING: nullable and optional field; may cause problems with golang implementation
+			 */
 			swapRecord: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.nullable(/*#__PURE__*/ v.cidString())),
+			/**
+			 * 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: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.boolean()),
 		}),
 	},

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

@@ -7,12 +7,27 @@ const _mainSchema = /*#__PURE__*/ v.procedure('com.atproto.server.createAccount'
 	input: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * Pre-existing atproto DID, being imported to a new account.
+			 */
 			did: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.didString()),
 			email: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
+			/**
+			 * Requested handle for the account.
+			 */
 			handle: /*#__PURE__*/ v.handleString(),
 			inviteCode: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
+			/**
+			 * Initial account password. May need to meet instance-specific password strength requirements.
+			 */
 			password: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
+			/**
+			 * A signed DID PLC operation to be submitted as part of importing an existing account to this instance. NOTE: this optional field may be updated when full account migration is implemented.
+			 */
 			plcOp: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.unknown()),
+			/**
+			 * DID PLC rotation key (aka, recovery key) to be included in PLC creation operation.
+			 */
 			recoveryKey: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
 			verificationCode: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
 			verificationPhone: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
@@ -22,7 +37,13 @@ const _mainSchema = /*#__PURE__*/ v.procedure('com.atproto.server.createAccount'
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
 			accessJwt: /*#__PURE__*/ v.string(),
+			/**
+			 * The DID of the new account.
+			 */
 			did: /*#__PURE__*/ v.didString(),
+			/**
+			 * Complete DID document.
+			 */
 			didDoc: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.unknown()),
 			handle: /*#__PURE__*/ v.handleString(),
 			refreshJwt: /*#__PURE__*/ v.string(),

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

@@ -16,7 +16,13 @@ const _mainSchema = /*#__PURE__*/ v.procedure('com.atproto.server.createAppPassw
 	input: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * A short name for the App Password, to help distinguish them.
+			 */
 			name: /*#__PURE__*/ v.string(),
+			/**
+			 * If an app password has 'privileged' access to possibly sensitive account state. Meant for use with trusted clients.
+			 */
 			privileged: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.boolean()),
 		}),
 	},

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

@@ -14,6 +14,9 @@ const _mainSchema = /*#__PURE__*/ v.procedure('com.atproto.server.createInviteCo
 	input: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * @default 1
+			 */
 			codeCount: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.integer(), 1),
 			forAccounts: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.array(/*#__PURE__*/ v.didString())),
 			useCount: /*#__PURE__*/ v.integer(),

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

@@ -7,8 +7,14 @@ const _mainSchema = /*#__PURE__*/ v.procedure('com.atproto.server.createSession'
 	input: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * When true, instead of throwing error for takendown accounts, a valid response with a narrow scoped token will be returned
+			 */
 			allowTakendown: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.boolean()),
 			authFactorToken: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
+			/**
+			 * Handle or other identifier supported by the server for the authenticating user.
+			 */
 			identifier: /*#__PURE__*/ v.string(),
 			password: /*#__PURE__*/ v.string(),
 		}),
@@ -25,6 +31,9 @@ const _mainSchema = /*#__PURE__*/ v.procedure('com.atproto.server.createSession'
 			emailConfirmed: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.boolean()),
 			handle: /*#__PURE__*/ v.handleString(),
 			refreshJwt: /*#__PURE__*/ v.string(),
+			/**
+			 * 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/deactivateAccount.ts

@@ -7,6 +7,9 @@ const _mainSchema = /*#__PURE__*/ v.procedure('com.atproto.server.deactivateAcco
 	input: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * A recommendation to server as to how long they should hold onto the deactivated account before deleting.
+			 */
 			deleteAfter: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.datetimeString()),
 		}),
 	},