@kentcdodds/onepassword

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

connect/index.d.ts

23 lines · 662 B · TypeScript

export type ConnectDescribeResult = {
	packageId: string
	exports: string[]
	runtime: string
	defaultAppName: string
	defaultUrl: string
	images: string[]
	kodySecrets: string[]
	requiredFlyHosts?: string[]
	note: string
}

/**
 * Describe the 1Password Connect-on-Fly sub-exports.
 *
 * @returns Package metadata pointing to source, deployment-guide, and deploy-fly.
 *
 * @example
 * import describeConnect from 'kody:@kentcdodds/onepassword/connect'
 * const info = await describeConnect()
 * // => { packageId: 'onepassword', exports: ['source', 'deployment-guide', 'deploy-fly'], ... }
 */
export default function describe(): Promise<ConnectDescribeResult>