@workers-community/workers-types 4.20251113.0 → 4.20251115.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +44 -37
  2. package/index.ts +44 -37
  3. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -7443,24 +7443,12 @@ declare abstract class Ai<AiModelList extends AiModelListType = AiModels> {
7443
7443
  models(params?: AiModelsSearchParams): Promise<AiModelsSearchObject[]>;
7444
7444
  toMarkdown(): ToMarkdownService;
7445
7445
  toMarkdown(
7446
- files: {
7447
- name: string;
7448
- blob: Blob;
7449
- }[],
7450
- options?: {
7451
- gateway?: GatewayOptions;
7452
- extraHeaders?: object;
7453
- },
7446
+ files: MarkdownDocument[],
7447
+ options?: ConversionRequestOptions,
7454
7448
  ): Promise<ConversionResponse[]>;
7455
7449
  toMarkdown(
7456
- files: {
7457
- name: string;
7458
- blob: Blob;
7459
- },
7460
- options?: {
7461
- gateway?: GatewayOptions;
7462
- extraHeaders?: object;
7463
- },
7450
+ files: MarkdownDocument,
7451
+ options?: ConversionRequestOptions,
7464
7452
  ): Promise<ConversionResponse>;
7465
7453
  }
7466
7454
  type GatewayRetries = {
@@ -9671,44 +9659,63 @@ declare module "cloudflare:sockets" {
9671
9659
  ): Socket;
9672
9660
  export { _connect as connect };
9673
9661
  }
9674
- type ConversionResponse = {
9662
+ type MarkdownDocument = {
9675
9663
  name: string;
9676
- mimeType: string;
9677
- } & (
9664
+ blob: Blob;
9665
+ };
9666
+ type ConversionResponse =
9678
9667
  | {
9668
+ name: string;
9669
+ mimeType: string;
9679
9670
  format: "markdown";
9680
9671
  tokens: number;
9681
9672
  data: string;
9682
9673
  }
9683
9674
  | {
9675
+ name: string;
9676
+ mimeType: string;
9684
9677
  format: "error";
9685
9678
  error: string;
9686
- }
9687
- );
9679
+ };
9680
+ type ImageConversionOptions = {
9681
+ descriptionLanguage?: "en" | "es" | "fr" | "it" | "pt" | "de";
9682
+ };
9683
+ type EmbeddedImageConversionOptions = ImageConversionOptions & {
9684
+ convert?: boolean;
9685
+ maxConvertedImages?: number;
9686
+ };
9687
+ type ConversionOptions = {
9688
+ html?: {
9689
+ images?: EmbeddedImageConversionOptions & {
9690
+ convertOGImage?: boolean;
9691
+ };
9692
+ };
9693
+ docx?: {
9694
+ images?: EmbeddedImageConversionOptions;
9695
+ };
9696
+ image?: ImageConversionOptions;
9697
+ pdf?: {
9698
+ images?: EmbeddedImageConversionOptions;
9699
+ metadata?: boolean;
9700
+ };
9701
+ };
9702
+ type ConversionRequestOptions = {
9703
+ gateway?: GatewayOptions;
9704
+ extraHeaders?: object;
9705
+ conversionOptions?: ConversionOptions;
9706
+ };
9688
9707
  type SupportedFileFormat = {
9689
9708
  mimeType: string;
9690
9709
  extension: string;
9691
9710
  };
9692
9711
  declare abstract class ToMarkdownService {
9693
9712
  transform(
9694
- files: {
9695
- name: string;
9696
- blob: Blob;
9697
- }[],
9698
- options?: {
9699
- gateway?: GatewayOptions;
9700
- extraHeaders?: object;
9701
- },
9713
+ files: MarkdownDocument[],
9714
+ options?: ConversionRequestOptions,
9702
9715
  ): Promise<ConversionResponse[]>;
9703
9716
  transform(
9704
- files: {
9705
- name: string;
9706
- blob: Blob;
9707
- },
9708
- options?: {
9709
- gateway?: GatewayOptions;
9710
- extraHeaders?: object;
9711
- },
9717
+ files: MarkdownDocument,
9718
+ options?: ConversionRequestOptions,
9712
9719
  ): Promise<ConversionResponse>;
9713
9720
  supported(): Promise<SupportedFileFormat[]>;
9714
9721
  }
package/index.ts CHANGED
@@ -7462,24 +7462,12 @@ export declare abstract class Ai<
7462
7462
  models(params?: AiModelsSearchParams): Promise<AiModelsSearchObject[]>;
7463
7463
  toMarkdown(): ToMarkdownService;
7464
7464
  toMarkdown(
7465
- files: {
7466
- name: string;
7467
- blob: Blob;
7468
- }[],
7469
- options?: {
7470
- gateway?: GatewayOptions;
7471
- extraHeaders?: object;
7472
- },
7465
+ files: MarkdownDocument[],
7466
+ options?: ConversionRequestOptions,
7473
7467
  ): Promise<ConversionResponse[]>;
7474
7468
  toMarkdown(
7475
- files: {
7476
- name: string;
7477
- blob: Blob;
7478
- },
7479
- options?: {
7480
- gateway?: GatewayOptions;
7481
- extraHeaders?: object;
7482
- },
7469
+ files: MarkdownDocument,
7470
+ options?: ConversionRequestOptions,
7483
7471
  ): Promise<ConversionResponse>;
7484
7472
  }
7485
7473
  export type GatewayRetries = {
@@ -9636,44 +9624,63 @@ export interface SecretsStoreSecret {
9636
9624
  */
9637
9625
  get(): Promise<string>;
9638
9626
  }
9639
- export type ConversionResponse = {
9627
+ export type MarkdownDocument = {
9640
9628
  name: string;
9641
- mimeType: string;
9642
- } & (
9629
+ blob: Blob;
9630
+ };
9631
+ export type ConversionResponse =
9643
9632
  | {
9633
+ name: string;
9634
+ mimeType: string;
9644
9635
  format: "markdown";
9645
9636
  tokens: number;
9646
9637
  data: string;
9647
9638
  }
9648
9639
  | {
9640
+ name: string;
9641
+ mimeType: string;
9649
9642
  format: "error";
9650
9643
  error: string;
9651
- }
9652
- );
9644
+ };
9645
+ export type ImageConversionOptions = {
9646
+ descriptionLanguage?: "en" | "es" | "fr" | "it" | "pt" | "de";
9647
+ };
9648
+ export type EmbeddedImageConversionOptions = ImageConversionOptions & {
9649
+ convert?: boolean;
9650
+ maxConvertedImages?: number;
9651
+ };
9652
+ export type ConversionOptions = {
9653
+ html?: {
9654
+ images?: EmbeddedImageConversionOptions & {
9655
+ convertOGImage?: boolean;
9656
+ };
9657
+ };
9658
+ docx?: {
9659
+ images?: EmbeddedImageConversionOptions;
9660
+ };
9661
+ image?: ImageConversionOptions;
9662
+ pdf?: {
9663
+ images?: EmbeddedImageConversionOptions;
9664
+ metadata?: boolean;
9665
+ };
9666
+ };
9667
+ export type ConversionRequestOptions = {
9668
+ gateway?: GatewayOptions;
9669
+ extraHeaders?: object;
9670
+ conversionOptions?: ConversionOptions;
9671
+ };
9653
9672
  export type SupportedFileFormat = {
9654
9673
  mimeType: string;
9655
9674
  extension: string;
9656
9675
  };
9657
9676
  export declare abstract class ToMarkdownService {
9658
9677
  transform(
9659
- files: {
9660
- name: string;
9661
- blob: Blob;
9662
- }[],
9663
- options?: {
9664
- gateway?: GatewayOptions;
9665
- extraHeaders?: object;
9666
- },
9678
+ files: MarkdownDocument[],
9679
+ options?: ConversionRequestOptions,
9667
9680
  ): Promise<ConversionResponse[]>;
9668
9681
  transform(
9669
- files: {
9670
- name: string;
9671
- blob: Blob;
9672
- },
9673
- options?: {
9674
- gateway?: GatewayOptions;
9675
- extraHeaders?: object;
9676
- },
9682
+ files: MarkdownDocument,
9683
+ options?: ConversionRequestOptions,
9677
9684
  ): Promise<ConversionResponse>;
9678
9685
  supported(): Promise<SupportedFileFormat[]>;
9679
9686
  }
package/package.json CHANGED
@@ -7,7 +7,7 @@
7
7
  },
8
8
  "author": "Workers Community",
9
9
  "license": "MIT OR Apache-2.0",
10
- "version": "4.20251113.0",
10
+ "version": "4.20251115.0",
11
11
  "exports": {
12
12
  ".": {
13
13
  "types": "./index.d.ts",