@pdfme/cli 5.5.10-dev.125

package/dist/cjk-detect.d.ts

@@ -0,0 +1,5 @@
+export declare function containsCJK(text: string): boolean;
+export declare function detectCJKInTemplate(template: {
+    schemas?: unknown;
+}): boolean;
+export declare function detectCJKInInputs(inputs: unknown): boolean;

package/dist/commands/doctor.d.ts

@@ -0,0 +1,50 @@
+declare const _default: import("citty").CommandDef<{
+    target: {
+        type: "positional";
+        description: string;
+        required: boolean;
+    };
+    file: {
+        type: "positional";
+        description: string;
+        required: boolean;
+    };
+    verbose: {
+        type: "boolean";
+        alias: string;
+        description: string;
+        default: boolean;
+    };
+    json: {
+        type: "boolean";
+        description: string;
+        default: boolean;
+    };
+    noAutoFont: {
+        type: "boolean";
+        description: string;
+        default: boolean;
+    };
+    output: {
+        type: "string";
+        alias: string;
+        description: string;
+        default: string;
+    };
+    force: {
+        type: "boolean";
+        description: string;
+        default: boolean;
+    };
+    image: {
+        type: "boolean";
+        description: string;
+        default: boolean;
+    };
+    imageFormat: {
+        type: "string";
+        description: string;
+        default: string;
+    };
+}>;
+export default _default;

package/dist/commands/examples.d.ts

@@ -0,0 +1,35 @@
+declare const _default: import("citty").CommandDef<{
+    name: {
+        type: "positional";
+        description: string;
+        required: boolean;
+    };
+    list: {
+        type: "boolean";
+        description: string;
+        default: boolean;
+    };
+    output: {
+        type: "string";
+        alias: string;
+        description: string;
+    };
+    withInputs: {
+        type: "boolean";
+        alias: string;
+        description: string;
+        default: boolean;
+    };
+    verbose: {
+        type: "boolean";
+        alias: string;
+        description: string;
+        default: boolean;
+    };
+    json: {
+        type: "boolean";
+        description: string;
+        default: boolean;
+    };
+}>;
+export default _default;

package/dist/commands/generate.d.ts

@@ -0,0 +1,78 @@
+declare const _default: import("citty").CommandDef<{
+    file: {
+        type: "positional";
+        description: string;
+        required: boolean;
+    };
+    template: {
+        type: "string";
+        alias: string;
+        description: string;
+    };
+    inputs: {
+        type: "string";
+        alias: string;
+        description: string;
+    };
+    output: {
+        type: "string";
+        alias: string;
+        description: string;
+        default: string;
+    };
+    force: {
+        type: "boolean";
+        description: string;
+        default: boolean;
+    };
+    image: {
+        type: "boolean";
+        description: string;
+        default: boolean;
+    };
+    imageFormat: {
+        type: "string";
+        description: string;
+        default: string;
+    };
+    scale: {
+        type: "string";
+        description: string;
+        default: string;
+    };
+    grid: {
+        type: "boolean";
+        description: string;
+        default: boolean;
+    };
+    gridSize: {
+        type: "string";
+        description: string;
+        default: string;
+    };
+    font: {
+        type: "string";
+        description: string;
+    };
+    basePdf: {
+        type: "string";
+        description: string;
+    };
+    noAutoFont: {
+        type: "boolean";
+        description: string;
+        default: boolean;
+    };
+    verbose: {
+        type: "boolean";
+        alias: string;
+        description: string;
+        default: boolean;
+    };
+    json: {
+        type: "boolean";
+        description: string;
+        default: boolean;
+    };
+}>;
+export default _default;

package/dist/commands/pdf2img.d.ts

@@ -0,0 +1,48 @@
+declare const _default: import("citty").CommandDef<{
+    file: {
+        type: "positional";
+        description: string;
+        required: boolean;
+    };
+    output: {
+        type: "string";
+        alias: string;
+        description: string;
+    };
+    grid: {
+        type: "boolean";
+        description: string;
+        default: boolean;
+    };
+    gridSize: {
+        type: "string";
+        description: string;
+        default: string;
+    };
+    scale: {
+        type: "string";
+        description: string;
+        default: string;
+    };
+    imageFormat: {
+        type: "string";
+        description: string;
+        default: string;
+    };
+    pages: {
+        type: "string";
+        description: string;
+    };
+    verbose: {
+        type: "boolean";
+        alias: string;
+        description: string;
+        default: boolean;
+    };
+    json: {
+        type: "boolean";
+        description: string;
+        default: boolean;
+    };
+}>;
+export default _default;

package/dist/commands/pdf2size.d.ts

@@ -0,0 +1,19 @@
+declare const _default: import("citty").CommandDef<{
+    file: {
+        type: "positional";
+        description: string;
+        required: boolean;
+    };
+    verbose: {
+        type: "boolean";
+        alias: string;
+        description: string;
+        default: boolean;
+    };
+    json: {
+        type: "boolean";
+        description: string;
+        default: boolean;
+    };
+}>;
+export default _default;

package/dist/commands/validate.d.ts

@@ -0,0 +1,24 @@
+declare const _default: import("citty").CommandDef<{
+    file: {
+        type: "positional";
+        description: string;
+        required: boolean;
+    };
+    verbose: {
+        type: "boolean";
+        alias: string;
+        description: string;
+        default: boolean;
+    };
+    json: {
+        type: "boolean";
+        description: string;
+        default: boolean;
+    };
+    strict: {
+        type: "boolean";
+        description: string;
+        default: boolean;
+    };
+}>;
+export default _default;

package/dist/contract.d.ts

@@ -0,0 +1,30 @@
+interface CliErrorOptions {
+    code?: string;
+    exitCode?: number;
+    details?: unknown;
+    cause?: unknown;
+}
+export interface CliArgDefinition {
+    type: 'positional' | 'string' | 'boolean';
+    alias?: string | string[];
+    description?: string;
+    required?: boolean;
+    default?: unknown;
+}
+export declare class CliError extends Error {
+    readonly code: string;
+    readonly exitCode: number;
+    readonly details?: unknown;
+    constructor(message: string, options?: CliErrorOptions);
+}
+export declare function fail(message: string, options?: CliErrorOptions): never;
+export declare function printJson(value: Record<string, unknown>): void;
+export declare function runWithContract<T>(options: {
+    json: boolean;
+}, task: () => Promise<T> | T): Promise<T>;
+export declare function handleCommandError(error: unknown, json: boolean): never;
+export declare function assertNoUnknownFlags(rawArgs: string[], argsDefinition: Record<string, CliArgDefinition>): void;
+export declare function isOptionProvided(rawArgs: string[], name: string, alias?: string | string[]): boolean;
+export declare function parseEnumArg<T extends string>(optionName: string, value: unknown, allowedValues: readonly T[]): T;
+export declare function parsePositiveNumberArg(optionName: string, value: unknown): number;
+export {};

package/dist/diagnostics.d.ts

@@ -0,0 +1,62 @@
+export declare const KNOWN_TEMPLATE_KEYS: Set<string>;
+export declare const KNOWN_JOB_KEYS: Set<string>;
+export interface ValidationResult {
+    errors: string[];
+    warnings: string[];
+    pages: number;
+    fields: number;
+}
+export interface ValidationInspection {
+    schemaTypes: string[];
+    requiredPlugins: string[];
+    requiredFonts: string[];
+    basePdf: {
+        kind: string;
+        width?: number;
+        height?: number;
+        paperSize?: string | null;
+        path?: string;
+        resolvedPath?: string;
+    };
+}
+export interface FieldInputHint {
+    name: string;
+    type: string;
+    pages: number[];
+    required: boolean;
+    expectedInput: {
+        kind: 'string' | 'jsonStringObject' | 'enumString' | 'stringMatrix';
+        variableNames?: string[];
+        allowedValues?: string[];
+        example?: string | string[][];
+        format?: string;
+        canonicalFormat?: string;
+        contentKind?: string;
+        rule?: string;
+        groupName?: string;
+        groupMemberNames?: string[];
+        columnCount?: number;
+        columnHeaders?: string[];
+        acceptsJsonString?: boolean;
+    };
+}
+export interface ValidationSource {
+    mode: 'template' | 'job';
+    template: Record<string, unknown>;
+    inputs?: Record<string, unknown>[];
+    options?: unknown;
+    templateDir?: string;
+    jobWarnings: string[];
+}
+export declare function findClosestType(type: string): string | null;
+export declare function validateTemplate(template: Record<string, unknown>): ValidationResult;
+export declare function inspectTemplate(template: Record<string, unknown>, templateDir?: string): ValidationInspection;
+export declare function collectInputHints(template: Record<string, unknown>): FieldInputHint[];
+export declare function validateInputContracts(template: Record<string, unknown>, inputs: Record<string, unknown>[]): void;
+export declare function getInputContractIssues(template: Record<string, unknown>, inputs: Record<string, unknown>[]): string[];
+export declare function loadValidationSource(file: string | undefined, options: {
+    noInputMessage: string;
+}): Promise<ValidationSource>;
+export declare function normalizeSchemaPages(rawSchemas: unknown): Array<Array<Record<string, unknown>>>;
+export declare function getUniqueStringValues(values: unknown[]): string[];
+export declare function summarizeBasePdf(basePdf: unknown, templateDir: string | undefined): ValidationInspection['basePdf'];

package/dist/example-fonts.d.ts

@@ -0,0 +1,8 @@
+import type { Font } from '@pdfme/common';
+export declare const OFFICIAL_EXAMPLE_FONT_URLS: {
+    readonly NotoSansJP: "https://fonts.gstatic.com/s/notosansjp/v53/-F6jfjtqLzI2JPCgQBnw7HFyzSD-AsregP8VFBEj75vY0rw-oME.ttf";
+    readonly NotoSerifJP: "https://fonts.gstatic.com/s/notoserifjp/v30/xn71YHs72GKoTvER4Gn3b5eMRtWGkp6o7MjQ2bwxOubAILO5wBCU.ttf";
+    readonly 'PinyonScript-Regular': "https://fonts.gstatic.com/s/pinyonscript/v22/6xKpdSJbL9-e9LuoeQiDRQR8aOLQO4bhiDY.ttf";
+};
+export declare function collectTemplateFontNames(template: Record<string, unknown>): string[];
+export declare function getOfficialExampleFonts(template: Record<string, unknown>): Font | undefined;

package/dist/example-templates.d.ts

@@ -0,0 +1,36 @@
+export interface ExampleManifestEntry {
+    name: string;
+    author: string;
+    path: string;
+    thumbnailPath: string;
+    pageCount: number;
+    fieldCount: number;
+    schemaTypes: string[];
+    fontNames: string[];
+    hasCJK: boolean;
+    basePdfKind: string;
+}
+export interface ExampleManifest {
+    schemaVersion: number;
+    cliVersion: string;
+    templates: ExampleManifestEntry[];
+}
+export interface ExampleManifestLoadResult {
+    manifest: ExampleManifest;
+    source: 'remote';
+    url?: string;
+}
+export interface ExampleTemplateLoadResult {
+    template: Record<string, unknown>;
+    source: 'remote';
+    url?: string;
+}
+export declare function getExamplesBaseUrl(): string;
+export declare function getExampleManifest(): Promise<ExampleManifestLoadResult>;
+export declare function getExampleTemplateNames(): Promise<string[]>;
+export declare function fetchExampleTemplate(name: string, options?: {
+    manifest?: ExampleManifest;
+}): Promise<Record<string, unknown>>;
+export declare function fetchExampleTemplateWithSource(name: string, options?: {
+    manifest?: ExampleManifest;
+}): Promise<ExampleTemplateLoadResult>;

package/dist/fonts.d.ts

@@ -0,0 +1,35 @@
+import type { Font } from '@pdfme/common';
+export declare const NOTO_CACHE_FILE: string;
+export type ExplicitFontSourceKind = 'localPath' | 'url' | 'dataUri' | 'inlineBytes' | 'invalid';
+export type ExplicitFontRemoteProvider = 'genericPublic' | 'googleFontsAsset' | 'googleFontsStylesheet';
+export interface ExplicitFontSourceDiagnosis {
+    fontName: string;
+    kind: ExplicitFontSourceKind;
+    provider?: ExplicitFontRemoteProvider;
+    path?: string;
+    resolvedPath?: string;
+    exists?: boolean;
+    url?: string;
+    mediaType?: string;
+    formatHint?: string | null;
+    supportedFormat?: boolean;
+    needsNetwork: boolean;
+    dataType?: string;
+}
+interface ResolveFontOptions {
+    fontArgs?: string[];
+    hasCJK: boolean;
+    noAutoFont: boolean;
+    verbose: boolean;
+    hasExplicitFontConfig?: boolean;
+}
+export declare function downloadNotoSansJP(verbose: boolean): Promise<Uint8Array | null>;
+export declare function parseCustomFonts(fontArgs: string[]): Font;
+export declare function analyzeExplicitFontRecord(fontRecord: Record<string, unknown>, templateDir?: string): {
+    sources: ExplicitFontSourceDiagnosis[];
+    issues: string[];
+    warnings: string[];
+};
+export declare function normalizeExplicitFontOption(jobFont: unknown, templateDir?: string): Promise<Font | undefined>;
+export declare function resolveFont(options: ResolveFontOptions): Promise<Font>;
+export {};

package/dist/grid.d.ts

@@ -0,0 +1,23 @@
+interface Schema {
+    name: string;
+    type: string;
+    position: {
+        x: number;
+        y: number;
+    };
+    width: number;
+    height: number;
+    [key: string]: unknown;
+}
+type ImageFormat = 'png' | 'jpeg';
+/**
+ * Draw grid lines and schema boundary overlays on a generated PDF page image.
+ * Used by `pdfme generate --grid`.
+ */
+export declare function drawGridOnImage(imageBuffer: ArrayBuffer, schemas: Schema[], gridSizeMm: number, pageWidthMm: number, pageHeightMm: number, imageType: ImageFormat): Promise<ArrayBuffer>;
+/**
+ * Draw grid lines with mm coordinate labels on a plain PDF image.
+ * Used by `pdfme pdf2img --grid`.
+ */
+export declare function drawGridOnPdfImage(imageBuffer: ArrayBuffer, gridSizeMm: number, pageWidthMm: number, pageHeightMm: number, imageType: ImageFormat): Promise<ArrayBuffer>;
+export {};

package/dist/index.d.ts

@@ -0,0 +1 @@
+export {};