Types

enum PdfFormat {
  /** @deprecated LibreOffice no longer supports PDF/A-1a since Gotenberg 7.6; kept for backward compatibility. */
  A_1a = "PDF/A-1a",
  A_1b = "PDF/A-1b",
  A_2b = "PDF/A-2b",
  A_3b = "PDF/A-3b",
}

type Split = {
  mode: "pages" | "intervals";
  span: string; // e.g. "1-2", "1,3,5"
  unify?: boolean; // only for mode 'pages'
  flatten?: boolean;
};

type Metadata = { [key: string]: boolean | number | string | string[] };

type DownloadFromEntry = {
  url: string;
  extraHttpHeaders?: Record<string, string>;
  embedded?: boolean;
  field?: "embedded" | "watermark" | "stamp" | "";
};

type DownloadFrom = DownloadFromEntry | DownloadFromEntry[];

type WebhookOptions = {
  webhookUrl?: string; // At least one of webhookUrl or webhookErrorUrl is required.
  /** @deprecated Use webhookEventsUrl instead, together with webhookUrl. */
  webhookErrorUrl?: string;
  webhookMethod?: "POST" | "PUT" | "PATCH";
  webhookErrorMethod?: "POST" | "PUT" | "PATCH";
  webhookExtraHttpHeaders?: Record<string, string>;
  webhookEventsUrl?: string;
};

type OutputOptions = {
  outputFilename?: string; // Custom filename for the resulting file; Gotenberg appends the extension.
  trace?: string; // Custom request id to identify the request in the logs, overriding the generated UUID.
};

type PdfEnginePermissions = {
  allowPrinting?: boolean; // default true
  allowCopying?: boolean; // default true
  allowModifying?: boolean; // default true
  allowAnnotating?: boolean; // default true
  allowFillingForms?: boolean; // default true
  allowAssembling?: boolean; // default true
};

type EmbedsMetadata = Record<
  string, // filename, matching an entry in `embeds`
  {
    mimeType?: string; // Written to the embedded file stream's /Subtype
    relationship?:
      | "Source"
      | "Data"
      | "Alternative"
      | "Supplement"
      | "Unspecified"; // The /AFRelationship value
  }
>;

type FacturXOptions = {
  facturxXml: PathLikeOrReadStream; // embedded as factur-x.xml regardless of the given filename
  facturxConformanceLevel:
    | "MINIMUM"
    | "BASIC WL"
    | "BASIC"
    | "EN 16931"
    | "EXTENDED"
    | "XRECHNUNG";
  facturxDocumentType?: "INVOICE" | "ORDER" | "ORDER_RESPONSE" | "ORDER_CHANGE"; // default 'INVOICE'
  facturxVersion?: string; // default '1.0'
  pdfa?: "PDF/A-3a" | "PDF/A-3b" | "PDF/A-3u";
  pdfUA?: boolean;
};

type Cookie = {
  name: string;
  value: string;
  domain: string;
  path?: string;
  secure?: boolean;
  httpOnly?: boolean;
  sameSite?: "Strict" | "Lax" | "None";
};

type PdfEngineRotate = {
  angle: 90 | 180 | 270;
  pages?: string; // e.g. "1-3", "5"; omit for all pages
};

type PdfEngineWatermark = {
  source?: "text" | "image" | "pdf";
  expression?: string;
  pages?: string;
  options?: Record<string, unknown>;
  file?: PathLikeOrReadStream | Buffer;
};

type PdfEngineStamp = {
  source?: "text" | "image" | "pdf";
  expression?: string;
  pages?: string;
  options?: Record<string, unknown>;
  file?: PathLikeOrReadStream | Buffer;
};

type Bookmark = {
  title: string;
  page: number;
  children?: Bookmark[];
};

type TemplateType =
  | "invoice_freelancer"
  | "invoice_saas"
  | "invoice_classic"
  | "invoice_minimal"
  | "invoice_modern";

type TemplateRequest<TType extends TemplateType> = {
  type: TType;
  data: TemplateDataByType[TType];
};