@kentcdodds/onepassword

Resolve 1Password Connect item fields for secret-aware fetch with website host allowlisting.

connect/source.d.ts

23 lines · 678 B · TypeScript

export type ConnectSourceResult = {
	name: string
	description: string
	files: Record<string, string>
	env: {
		required: string[]
		optional: string[]
		kodySecrets: string[]
	}
	deployNotes: string[]
}

/**
 * Retrieve deployable Fly/Docker source files for 1Password Connect Server.
 *
 * @returns Bundle with docker-compose, machine-config.json, fly.toml, and notes.
 *
 * @example
 * import getSource from 'kody:@kentcdodds/onepassword/connect/source'
 * const bundle = await getSource()
 * // => { name: 'kody-onepassword-connect', files: { 'docker-compose.yaml': '...', ... }, ... }
 */
export default function getOnepasswordConnectSource(): Promise<ConnectSourceResult>