UNPKG

@capgo/cli

Version:
49 lines (48 loc) 2.38 kB
import type { OptionsBase } from '../schemas/base'; import { type PreviewWebEnv } from './web-url'; import { invokeCapgoCliApi } from '../utils'; export interface CapgoPreviewHttpOptions { apikey: string; supaHost?: string; supaAnon?: string; /** Injectable for unit tests; defaults to invokeCapgoCliApi. */ invoke?: typeof invokeCapgoCliApi; } export interface PreviewQrCommandOptions extends OptionsBase { bundle?: string; channel?: string; target?: string; type?: 'bundle' | 'channel'; png?: string; url?: boolean; webUrl?: boolean; previewEnv?: PreviewWebEnv; } export type PreviewQrTarget = { appId: string; bundleName: string; kind: 'bundle'; versionId: number; } | { appId: string; channelId: number; channelName: string; kind: 'channel'; }; export declare function buildPreviewQrUrl(target: PreviewQrTarget): string; export declare function renderTerminalQrCode(value: string): Promise<string>; export declare function renderQrCodePng(value: string, outputPath: string): Promise<string>; export declare function assertAppAllowsPreview(options: CapgoPreviewHttpOptions, appId: string): Promise<void>; export declare function resolveBundlePreviewTarget(options: CapgoPreviewHttpOptions, appId: string, bundleRef: string): Promise<PreviewQrTarget | null>; export declare function resolveChannelPreviewTarget(options: CapgoPreviewHttpOptions, appId: string, channelRef: string): Promise<PreviewQrTarget | null>; export declare function resolvePreviewQrTarget(http: CapgoPreviewHttpOptions, appId: string, options: Pick<PreviewQrCommandOptions, 'bundle' | 'channel' | 'target' | 'type'>): Promise<PreviewQrTarget>; export interface PreviewQrOutputOptions { png?: string; url?: boolean; webUrl?: boolean; previewEnv?: PreviewWebEnv; } export declare function resolvePreviewQrOutputValue(target: PreviewQrTarget, options?: PreviewQrOutputOptions): string; export declare function printPreviewQrCode(target: PreviewQrTarget, options?: PreviewQrOutputOptions): Promise<void>; export declare function printPreviewQrForResolvedTarget(http: CapgoPreviewHttpOptions, appId: string, target: PreviewQrTarget, output?: PreviewQrOutputOptions): Promise<void>; export declare function getPreviewQr(appId: string, target: string | undefined, options: PreviewQrCommandOptions): Promise<void>;