@atcute/tangled 1.0.7 → 1.0.8

package/lib/lexicons/types/sh/tangled/knot/member.ts

@@ -7,6 +7,9 @@ const _mainSchema = /*#__PURE__*/ v.record(
 	/*#__PURE__*/ v.object({
 		$type: /*#__PURE__*/ v.literal('sh.tangled.knot.member'),
 		createdAt: /*#__PURE__*/ v.datetimeString(),
+		/**
+		 * domain that this member now belongs to
+		 */
 		domain: /*#__PURE__*/ v.string(),
 		subject: /*#__PURE__*/ v.didString(),
 	}),

package/lib/lexicons/types/sh/tangled/label/definition.ts

@@ -6,11 +6,28 @@ const _mainSchema = /*#__PURE__*/ v.record(
 	/*#__PURE__*/ v.string(),
 	/*#__PURE__*/ v.object({
 		$type: /*#__PURE__*/ v.literal('sh.tangled.label.definition'),
+		/**
+		 * The hex value for the background color for the label. Appviews may choose to respect this.
+		 */
 		color: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
 		createdAt: /*#__PURE__*/ v.datetimeString(),
+		/**
+		 * Whether this label can be repeated for a given entity, eg.: [reviewer:foo, reviewer:bar]
+		 */
 		multiple: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.boolean()),
+		/**
+		 * The display name of this label.
+		 * @minGraphemes 1
+		 * @maxGraphemes 40
+		 */
 		name: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [/*#__PURE__*/ v.stringGraphemes(1, 40)]),
+		/**
+		 * The areas of the repo this label may apply to, eg.: sh.tangled.repo.issue. Appviews may choose to respect this.
+		 */
 		scope: /*#__PURE__*/ v.array(/*#__PURE__*/ v.nsidString()),
+		/**
+		 * The type definition of this label. Appviews may allow sorting for certain types.
+		 */
 		get valueType() {
 			return valueTypeSchema;
 		},
@@ -18,8 +35,17 @@ const _mainSchema = /*#__PURE__*/ v.record(
 );
 const _valueTypeSchema = /*#__PURE__*/ v.object({
 	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('sh.tangled.label.definition#valueType')),
+	/**
+	 * Closed set of values that this label can take.
+	 */
 	enum: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.array(/*#__PURE__*/ v.string())),
+	/**
+	 * An optional constraint that can be applied on string concrete types.
+	 */
 	format: /*#__PURE__*/ v.literalEnum(['any', 'did', 'nsid']),
+	/**
+	 * The concrete type of this label's value.
+	 */
 	type: /*#__PURE__*/ v.literalEnum(['boolean', 'integer', 'null', 'string']),
 });
 

package/lib/lexicons/types/sh/tangled/label/op.ts

@@ -13,12 +13,21 @@ const _mainSchema = /*#__PURE__*/ v.record(
 			return /*#__PURE__*/ v.array(operandSchema);
 		},
 		performedAt: /*#__PURE__*/ v.datetimeString(),
+		/**
+		 * The subject (task, pull or discussion) of this label. Appviews may apply a `scope` check and refuse this op.
+		 */
 		subject: /*#__PURE__*/ v.resourceUriString(),
 	}),
 );
 const _operandSchema = /*#__PURE__*/ v.object({
 	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('sh.tangled.label.op#operand')),
+	/**
+	 * ATURI to the label definition
+	 */
 	key: /*#__PURE__*/ v.resourceUriString(),
+	/**
+	 * Stringified value of the label. This is first unstringed by appviews and then interpreted as a concrete value.
+	 */
 	value: /*#__PURE__*/ v.string(),
 });
 

package/lib/lexicons/types/sh/tangled/pipeline/status.ts

@@ -6,11 +6,29 @@ const _mainSchema = /*#__PURE__*/ v.record(
 	/*#__PURE__*/ v.tidString(),
 	/*#__PURE__*/ v.object({
 		$type: /*#__PURE__*/ v.literal('sh.tangled.pipeline.status'),
+		/**
+		 * time of creation of this status update
+		 */
 		createdAt: /*#__PURE__*/ v.datetimeString(),
+		/**
+		 * error message if failed
+		 */
 		error: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
+		/**
+		 * exit code if failed
+		 */
 		exitCode: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.integer()),
+		/**
+		 * ATURI of the pipeline
+		 */
 		pipeline: /*#__PURE__*/ v.resourceUriString(),
+		/**
+		 * status of the workflow
+		 */
 		status: /*#__PURE__*/ v.literalEnum(['cancelled', 'failed', 'pending', 'running', 'success', 'timeout']),
+		/**
+		 * name of the workflow within this pipeline
+		 */
 		workflow: /*#__PURE__*/ v.resourceUriString(),
 	}),
 );

package/lib/lexicons/types/sh/tangled/pipeline.ts

@@ -35,12 +35,24 @@ const _pullRequestTriggerDataSchema = /*#__PURE__*/ v.object({
 	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('sh.tangled.pipeline#pullRequestTriggerData')),
 	action: /*#__PURE__*/ v.string(),
 	sourceBranch: /*#__PURE__*/ v.string(),
+	/**
+	 * @minLength 40
+	 * @maxLength 40
+	 */
 	sourceSha: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [/*#__PURE__*/ v.stringLength(40, 40)]),
 	targetBranch: /*#__PURE__*/ v.string(),
 });
 const _pushTriggerDataSchema = /*#__PURE__*/ v.object({
 	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('sh.tangled.pipeline#pushTriggerData')),
+	/**
+	 * @minLength 40
+	 * @maxLength 40
+	 */
 	newSha: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [/*#__PURE__*/ v.stringLength(40, 40)]),
+	/**
+	 * @minLength 40
+	 * @maxLength 40
+	 */
 	oldSha: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [/*#__PURE__*/ v.stringLength(40, 40)]),
 	ref: /*#__PURE__*/ v.string(),
 });

package/lib/lexicons/types/sh/tangled/publicKey.ts

@@ -6,8 +6,18 @@ const _mainSchema = /*#__PURE__*/ v.record(
 	/*#__PURE__*/ v.tidString(),
 	/*#__PURE__*/ v.object({
 		$type: /*#__PURE__*/ v.literal('sh.tangled.publicKey'),
+		/**
+		 * key upload timestamp
+		 */
 		createdAt: /*#__PURE__*/ v.datetimeString(),
+		/**
+		 * public key contents
+		 * @maxLength 4096
+		 */
 		key: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [/*#__PURE__*/ v.stringLength(0, 4096)]),
+		/**
+		 * human-readable name for this key
+		 */
 		name: /*#__PURE__*/ v.string(),
 	}),
 );

package/lib/lexicons/types/sh/tangled/repo/addSecret.ts

@@ -7,8 +7,16 @@ const _mainSchema = /*#__PURE__*/ v.procedure('sh.tangled.repo.addSecret', {
 	input: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * @minLength 1
+			 * @maxLength 50
+			 */
 			key: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [/*#__PURE__*/ v.stringLength(1, 50)]),
 			repo: /*#__PURE__*/ v.resourceUriString(),
+			/**
+			 * @minLength 1
+			 * @maxLength 200
+			 */
 			value: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.string(), [/*#__PURE__*/ v.stringLength(1, 200)]),
 		}),
 	},

package/lib/lexicons/types/sh/tangled/repo/archive.ts

@@ -4,9 +4,25 @@ import type {} from '@atcute/lexicons/ambient';
 
 const _mainSchema = /*#__PURE__*/ v.query('sh.tangled.repo.archive', {
 	params: /*#__PURE__*/ v.object({
-		format: /*#__PURE__*/ v.literalEnum(['tar', 'tar.bz2', 'tar.gz', 'tar.xz', 'zip']),
+		/**
+		 * Archive format
+		 * @default "tar.gz"
+		 */
+		format: /*#__PURE__*/ v.optional(
+			/*#__PURE__*/ v.literalEnum(['tar', 'tar.bz2', 'tar.gz', 'tar.xz', 'zip']),
+			'tar.gz',
+		),
+		/**
+		 * Prefix for files in the archive
+		 */
 		prefix: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
+		/**
+		 * Git reference (branch, tag, or commit SHA)
+		 */
 		ref: /*#__PURE__*/ v.string(),
+		/**
+		 * Repository identifier in format 'did:plc:.../repoName'
+		 */
 		repo: /*#__PURE__*/ v.string(),
 	}),
 	output: {

package/lib/lexicons/types/sh/tangled/repo/artifact.ts

@@ -6,10 +6,29 @@ const _mainSchema = /*#__PURE__*/ v.record(
 	/*#__PURE__*/ v.tidString(),
 	/*#__PURE__*/ v.object({
 		$type: /*#__PURE__*/ v.literal('sh.tangled.repo.artifact'),
+		/**
+		 * the artifact
+		 * @accept *\/*
+		 * @maxSize 52428800
+		 */
 		artifact: /*#__PURE__*/ v.blob(),
+		/**
+		 * time of creation of this artifact
+		 */
 		createdAt: /*#__PURE__*/ v.datetimeString(),
+		/**
+		 * name of the artifact
+		 */
 		name: /*#__PURE__*/ v.string(),
+		/**
+		 * repo that this artifact is being uploaded to
+		 */
 		repo: /*#__PURE__*/ v.resourceUriString(),
+		/**
+		 * hash of the tag object that this artifact is attached to (only annotated tags are supported)
+		 * @minLength 20
+		 * @maxLength 20
+		 */
 		tag: /*#__PURE__*/ v.constrain(/*#__PURE__*/ v.bytes(), [/*#__PURE__*/ v.bytesSize(20, 20)]),
 	}),
 );

package/lib/lexicons/types/sh/tangled/repo/blob.ts

@@ -7,38 +7,93 @@ const _lastCommitSchema = /*#__PURE__*/ v.object({
 	get author() {
 		return /*#__PURE__*/ v.optional(signatureSchema);
 	},
+	/**
+	 * Commit hash
+	 */
 	hash: /*#__PURE__*/ v.string(),
+	/**
+	 * Commit message
+	 */
 	message: /*#__PURE__*/ v.string(),
+	/**
+	 * Short commit hash
+	 */
 	shortHash: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
+	/**
+	 * Commit timestamp
+	 */
 	when: /*#__PURE__*/ v.datetimeString(),
 });
 const _mainSchema = /*#__PURE__*/ v.query('sh.tangled.repo.blob', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * Path to the file within the repository
+		 */
 		path: /*#__PURE__*/ v.string(),
+		/**
+		 * Return raw file content instead of JSON response
+		 * @default false
+		 */
 		raw: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.boolean(), false),
+		/**
+		 * Git reference (branch, tag, or commit SHA)
+		 */
 		ref: /*#__PURE__*/ v.string(),
+		/**
+		 * Repository identifier in format 'did:plc:.../repoName'
+		 */
 		repo: /*#__PURE__*/ v.string(),
 	}),
 	output: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * File content (base64 encoded for binary files)
+			 */
 			content: /*#__PURE__*/ v.string(),
+			/**
+			 * Content encoding
+			 */
 			encoding: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literalEnum(['base64', 'utf-8'])),
+			/**
+			 * Whether the file is binary
+			 */
 			isBinary: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.boolean()),
 			get lastCommit() {
 				return /*#__PURE__*/ v.optional(lastCommitSchema);
 			},
+			/**
+			 * MIME type of the file
+			 */
 			mimeType: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
+			/**
+			 * The file path
+			 */
 			path: /*#__PURE__*/ v.string(),
+			/**
+			 * The git reference used
+			 */
 			ref: /*#__PURE__*/ v.string(),
+			/**
+			 * File size in bytes
+			 */
 			size: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.integer()),
 		}),
 	},
 });
 const _signatureSchema = /*#__PURE__*/ v.object({
 	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('sh.tangled.repo.blob#signature')),
+	/**
+	 * Author email
+	 */
 	email: /*#__PURE__*/ v.string(),
+	/**
+	 * Author name
+	 */
 	name: /*#__PURE__*/ v.string(),
+	/**
+	 * Author timestamp
+	 */
 	when: /*#__PURE__*/ v.datetimeString(),
 });
 

package/lib/lexicons/types/sh/tangled/repo/branch.ts

@@ -4,7 +4,13 @@ import type {} from '@atcute/lexicons/ambient';
 
 const _mainSchema = /*#__PURE__*/ v.query('sh.tangled.repo.branch', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * Branch name to get information for
+		 */
 		name: /*#__PURE__*/ v.string(),
+		/**
+		 * Repository identifier in format 'did:plc:.../repoName'
+		 */
 		repo: /*#__PURE__*/ v.string(),
 	}),
 	output: {
@@ -13,19 +19,46 @@ const _mainSchema = /*#__PURE__*/ v.query('sh.tangled.repo.branch', {
 			get author() {
 				return /*#__PURE__*/ v.optional(signatureSchema);
 			},
+			/**
+			 * Latest commit hash on this branch
+			 */
 			hash: /*#__PURE__*/ v.string(),
+			/**
+			 * Whether this is the default branch
+			 */
 			isDefault: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.boolean()),
+			/**
+			 * Latest commit message
+			 */
 			message: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
+			/**
+			 * Branch name
+			 */
 			name: /*#__PURE__*/ v.string(),
+			/**
+			 * Short commit hash
+			 */
 			shortHash: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
+			/**
+			 * Timestamp of latest commit
+			 */
 			when: /*#__PURE__*/ v.datetimeString(),
 		}),
 	},
 });
 const _signatureSchema = /*#__PURE__*/ v.object({
 	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('sh.tangled.repo.branch#signature')),
+	/**
+	 * Author email
+	 */
 	email: /*#__PURE__*/ v.string(),
+	/**
+	 * Author name
+	 */
 	name: /*#__PURE__*/ v.string(),
+	/**
+	 * Author timestamp
+	 */
 	when: /*#__PURE__*/ v.datetimeString(),
 });
 

package/lib/lexicons/types/sh/tangled/repo/branches.ts

@@ -4,11 +4,23 @@ import type {} from '@atcute/lexicons/ambient';
 
 const _mainSchema = /*#__PURE__*/ v.query('sh.tangled.repo.branches', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * Pagination cursor
+		 */
 		cursor: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
+		/**
+		 * Maximum number of branches to return
+		 * @minimum 1
+		 * @maximum 100
+		 * @default 50
+		 */
 		limit: /*#__PURE__*/ v.optional(
 			/*#__PURE__*/ v.constrain(/*#__PURE__*/ v.integer(), [/*#__PURE__*/ v.integerRange(1, 100)]),
 			50,
 		),
+		/**
+		 * Repository identifier in format 'did:plc:.../repoName'
+		 */
 		repo: /*#__PURE__*/ v.string(),
 	}),
 	output: {

package/lib/lexicons/types/sh/tangled/repo/collaborator.ts

@@ -7,6 +7,9 @@ const _mainSchema = /*#__PURE__*/ v.record(
 	/*#__PURE__*/ v.object({
 		$type: /*#__PURE__*/ v.literal('sh.tangled.repo.collaborator'),
 		createdAt: /*#__PURE__*/ v.datetimeString(),
+		/**
+		 * repo to add this user to
+		 */
 		repo: /*#__PURE__*/ v.resourceUriString(),
 		subject: /*#__PURE__*/ v.didString(),
 	}),

package/lib/lexicons/types/sh/tangled/repo/compare.ts

@@ -4,8 +4,17 @@ import type {} from '@atcute/lexicons/ambient';
 
 const _mainSchema = /*#__PURE__*/ v.query('sh.tangled.repo.compare', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * Repository identifier in format 'did:plc:.../repoName'
+		 */
 		repo: /*#__PURE__*/ v.string(),
+		/**
+		 * First revision (commit, branch, or tag)
+		 */
 		rev1: /*#__PURE__*/ v.string(),
+		/**
+		 * Second revision (commit, branch, or tag)
+		 */
 		rev2: /*#__PURE__*/ v.string(),
 	}),
 	output: {

package/lib/lexicons/types/sh/tangled/repo/create.ts

@@ -7,8 +7,17 @@ const _mainSchema = /*#__PURE__*/ v.procedure('sh.tangled.repo.create', {
 	input: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * Default branch to push to
+			 */
 			defaultBranch: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
+			/**
+			 * Rkey of the repository record
+			 */
 			rkey: /*#__PURE__*/ v.string(),
+			/**
+			 * A source URL to clone from, populate this when forking or importing a repository.
+			 */
 			source: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
 		}),
 	},

package/lib/lexicons/types/sh/tangled/repo/delete.ts

@@ -7,8 +7,17 @@ const _mainSchema = /*#__PURE__*/ v.procedure('sh.tangled.repo.delete', {
 	input: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * DID of the repository owner
+			 */
 			did: /*#__PURE__*/ v.didString(),
+			/**
+			 * Name of the repository to delete
+			 */
 			name: /*#__PURE__*/ v.string(),
+			/**
+			 * Rkey of the repository record
+			 */
 			rkey: /*#__PURE__*/ v.string(),
 		}),
 	},

package/lib/lexicons/types/sh/tangled/repo/diff.ts

@@ -4,7 +4,13 @@ import type {} from '@atcute/lexicons/ambient';
 
 const _mainSchema = /*#__PURE__*/ v.query('sh.tangled.repo.diff', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * Git reference (branch, tag, or commit SHA)
+		 */
 		ref: /*#__PURE__*/ v.string(),
+		/**
+		 * Repository identifier in format 'did:plc:.../repoName'
+		 */
 		repo: /*#__PURE__*/ v.string(),
 	}),
 	output: {

package/lib/lexicons/types/sh/tangled/repo/forkStatus.ts

@@ -7,16 +7,34 @@ const _mainSchema = /*#__PURE__*/ v.procedure('sh.tangled.repo.forkStatus', {
 	input: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * Branch to check status for
+			 */
 			branch: /*#__PURE__*/ v.string(),
+			/**
+			 * DID of the fork owner
+			 */
 			did: /*#__PURE__*/ v.didString(),
+			/**
+			 * Hidden ref to use for comparison
+			 */
 			hiddenRef: /*#__PURE__*/ v.string(),
+			/**
+			 * Name of the forked repository
+			 */
 			name: /*#__PURE__*/ v.string(),
+			/**
+			 * Source repository URL
+			 */
 			source: /*#__PURE__*/ v.string(),
 		}),
 	},
 	output: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * Fork status: 0=UpToDate, 1=FastForwardable, 2=Conflict, 3=MissingBranch
+			 */
 			status: /*#__PURE__*/ v.integer(),
 		}),
 	},

package/lib/lexicons/types/sh/tangled/repo/forkSync.ts

@@ -7,9 +7,21 @@ const _mainSchema = /*#__PURE__*/ v.procedure('sh.tangled.repo.forkSync', {
 	input: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * Branch to sync
+			 */
 			branch: /*#__PURE__*/ v.string(),
+			/**
+			 * DID of the fork owner
+			 */
 			did: /*#__PURE__*/ v.didString(),
+			/**
+			 * Name of the forked repository
+			 */
 			name: /*#__PURE__*/ v.string(),
+			/**
+			 * AT-URI of the source repository
+			 */
 			source: /*#__PURE__*/ v.resourceUriString(),
 		}),
 	},

package/lib/lexicons/types/sh/tangled/repo/getDefaultBranch.ts

@@ -4,6 +4,9 @@ import type {} from '@atcute/lexicons/ambient';
 
 const _mainSchema = /*#__PURE__*/ v.query('sh.tangled.repo.getDefaultBranch', {
 	params: /*#__PURE__*/ v.object({
+		/**
+		 * Repository identifier in format 'did:plc:.../repoName'
+		 */
 		repo: /*#__PURE__*/ v.string(),
 	}),
 	output: {
@@ -12,18 +15,42 @@ const _mainSchema = /*#__PURE__*/ v.query('sh.tangled.repo.getDefaultBranch', {
 			get author() {
 				return /*#__PURE__*/ v.optional(signatureSchema);
 			},
+			/**
+			 * Latest commit hash on default branch
+			 */
 			hash: /*#__PURE__*/ v.string(),
+			/**
+			 * Latest commit message
+			 */
 			message: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
+			/**
+			 * Default branch name
+			 */
 			name: /*#__PURE__*/ v.string(),
+			/**
+			 * Short commit hash
+			 */
 			shortHash: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
+			/**
+			 * Timestamp of latest commit
+			 */
 			when: /*#__PURE__*/ v.datetimeString(),
 		}),
 	},
 });
 const _signatureSchema = /*#__PURE__*/ v.object({
 	$type: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.literal('sh.tangled.repo.getDefaultBranch#signature')),
+	/**
+	 * Author email
+	 */
 	email: /*#__PURE__*/ v.string(),
+	/**
+	 * Author name
+	 */
 	name: /*#__PURE__*/ v.string(),
+	/**
+	 * Author timestamp
+	 */
 	when: /*#__PURE__*/ v.datetimeString(),
 });
 

package/lib/lexicons/types/sh/tangled/repo/hiddenRef.ts

@@ -7,16 +7,34 @@ const _mainSchema = /*#__PURE__*/ v.procedure('sh.tangled.repo.hiddenRef', {
 	input: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * Fork reference name
+			 */
 			forkRef: /*#__PURE__*/ v.string(),
+			/**
+			 * Remote reference name
+			 */
 			remoteRef: /*#__PURE__*/ v.string(),
+			/**
+			 * AT-URI of the repository
+			 */
 			repo: /*#__PURE__*/ v.resourceUriString(),
 		}),
 	},
 	output: {
 		type: 'lex',
 		schema: /*#__PURE__*/ v.object({
+			/**
+			 * Error message if creation failed
+			 */
 			error: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
+			/**
+			 * The created hidden ref name
+			 */
 			ref: /*#__PURE__*/ v.optional(/*#__PURE__*/ v.string()),
+			/**
+			 * Whether the hidden ref was created successfully
+			 */
 			success: /*#__PURE__*/ v.boolean(),
 		}),
 	},

package/lib/lexicons/types/sh/tangled/repo/issue/state.ts

@@ -7,6 +7,10 @@ const _mainSchema = /*#__PURE__*/ v.record(
 	/*#__PURE__*/ v.object({
 		$type: /*#__PURE__*/ v.literal('sh.tangled.repo.issue.state'),
 		issue: /*#__PURE__*/ v.resourceUriString(),
+		/**
+		 * state of the issue
+		 * @default "sh.tangled.repo.issue.state.open"
+		 */
 		state: /*#__PURE__*/ v.optional(
 			/*#__PURE__*/ v.string<
 				'sh.tangled.repo.issue.state.closed' | 'sh.tangled.repo.issue.state.open' | (string & {})