@ryangarber/markitdown-ts 0.1.5 → 0.2.0

package/dist/index.d.cts

@@ -1,10 +1,3 @@
-//#region src/types.d.ts
-type ConverterResult = {
-  title: string | null;
-  markdown: string;
-  /** @deprecated Use `markdown` instead. */
-  text_content: string;
-} | null;
 /**
  * In-memory inputs supported by the conversion API.
  *
@@ -12,46 +5,38 @@ type ConverterResult = {
  * array buffers, shared array buffers, blobs, and files are normalized to it.
  */
 type ByteSource = Uint8Array | ArrayBufferLike | ArrayBufferView | Blob;
-type ConverterOptions = {
-  /** Required for byte sources unless the source MIME type identifies the format. */
-  file_extension?: string;
+/**
+ * All supported input types for the conversion API.
+ */
+type ConverterSource = ByteSource | Response | URL | string;
+type ConverterOptions<Options = unknown> = Options & {
+  /** Original file extension, with or without a leading dot. */
+  extension?: string;
   /** Original URL, used by site-specific HTML converters. */
   url?: string;
   /** Override the global fetch implementation. */
   fetch?: typeof fetch;
-  /** Mammoth style mapping used by the DOCX converter. */
-  styleMap?: string | string[];
-  includeEmbeddedStyleMap?: boolean;
-  includeDefaultStyleMap?: boolean;
-  ignoreEmptyParagraphs?: boolean;
-  idPrefix?: string;
-  transformDocument?: (element: unknown) => unknown;
-  _parent_converters?: DocumentConverter[];
+  /** Enable debug logging. */
   debug?: boolean;
+  /** @internal Parent converters. */
+  _converters?: Converter[];
 };
-interface DocumentConverter {
-  convert(source: Uint8Array, options: ConverterOptions): Promise<ConverterResult>;
+type ConverterResult = {
+  title: string | null;
+  markdown: string;
+} | null;
+interface Converter<Options = unknown> {
+  convert(source: Uint8Array, options: ConverterOptions<Options>): Promise<ConverterResult>;
 }
-//#endregion
-//#region src/markitdown.d.ts
-type ConversionSource = ByteSource | Response | URL | string;
-declare class MarkItDown {
+export declare class MarkItDown {
   private readonly converters;
   constructor();
   /** Convert a URL, response, blob, array buffer, data view, or typed array. */
-  convert(source: ConversionSource, options?: ConverterOptions): Promise<ConverterResult>;
-  /**
-   * @deprecated Pass the byte source directly to `convert`.
-   */
-  convertBuffer(source: ByteSource, options: ConverterOptions & {
-    file_extension: string;
-  }): Promise<ConverterResult>;
+  convert(source: ConverterSource, options?: ConverterOptions): Promise<ConverterResult>;
   private convertUrl;
   private convertResponse;
   private convertBytes;
-  private addExtension;
   private registerConverter;
 }
-//#endregion
-export { type ByteSource, type ConversionSource, type ConverterOptions, type ConverterResult, type DocumentConverter, MarkItDown };
+export type { ByteSource, Converter, ConverterOptions, ConverterResult, ConverterSource };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -1,10 +1,3 @@
-//#region src/types.d.ts
-type ConverterResult = {
-  title: string | null;
-  markdown: string;
-  /** @deprecated Use `markdown` instead. */
-  text_content: string;
-} | null;
 /**
  * In-memory inputs supported by the conversion API.
  *
@@ -12,46 +5,38 @@ type ConverterResult = {
  * array buffers, shared array buffers, blobs, and files are normalized to it.
  */
 type ByteSource = Uint8Array | ArrayBufferLike | ArrayBufferView | Blob;
-type ConverterOptions = {
-  /** Required for byte sources unless the source MIME type identifies the format. */
-  file_extension?: string;
+/**
+ * All supported input types for the conversion API.
+ */
+type ConverterSource = ByteSource | Response | URL | string;
+type ConverterOptions<Options = unknown> = Options & {
+  /** Original file extension, with or without a leading dot. */
+  extension?: string;
   /** Original URL, used by site-specific HTML converters. */
   url?: string;
   /** Override the global fetch implementation. */
   fetch?: typeof fetch;
-  /** Mammoth style mapping used by the DOCX converter. */
-  styleMap?: string | string[];
-  includeEmbeddedStyleMap?: boolean;
-  includeDefaultStyleMap?: boolean;
-  ignoreEmptyParagraphs?: boolean;
-  idPrefix?: string;
-  transformDocument?: (element: unknown) => unknown;
-  _parent_converters?: DocumentConverter[];
+  /** Enable debug logging. */
   debug?: boolean;
+  /** @internal Parent converters. */
+  _converters?: Converter[];
 };
-interface DocumentConverter {
-  convert(source: Uint8Array, options: ConverterOptions): Promise<ConverterResult>;
+type ConverterResult = {
+  title: string | null;
+  markdown: string;
+} | null;
+interface Converter<Options = unknown> {
+  convert(source: Uint8Array, options: ConverterOptions<Options>): Promise<ConverterResult>;
 }
-//#endregion
-//#region src/markitdown.d.ts
-type ConversionSource = ByteSource | Response | URL | string;
-declare class MarkItDown {
+export declare class MarkItDown {
   private readonly converters;
   constructor();
   /** Convert a URL, response, blob, array buffer, data view, or typed array. */
-  convert(source: ConversionSource, options?: ConverterOptions): Promise<ConverterResult>;
-  /**
-   * @deprecated Pass the byte source directly to `convert`.
-   */
-  convertBuffer(source: ByteSource, options: ConverterOptions & {
-    file_extension: string;
-  }): Promise<ConverterResult>;
+  convert(source: ConverterSource, options?: ConverterOptions): Promise<ConverterResult>;
   private convertUrl;
   private convertResponse;
   private convertBytes;
-  private addExtension;
   private registerConverter;
 }
-//#endregion
-export { type ByteSource, type ConversionSource, type ConverterOptions, type ConverterResult, type DocumentConverter, MarkItDown };
+export type { ByteSource, Converter, ConverterOptions, ConverterResult, ConverterSource };
 //# sourceMappingURL=index.d.ts.map