@or-sdk/markdowner 0.2.0 → 0.2.1-beta.3611.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 (5) hide show
  1. package/dist/cjs/Markdowner.js.map +1 -1
  2. package/dist/esm/Markdowner.js.map +1 -1
  3. package/dist/types/Markdowner.d.ts.map +1 -1
  4. package/package.json +3 -4
  5. package/src/Markdowner.ts +21 -22
package/dist/cjs/Markdowner.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Markdowner.js","sourceRoot":"","sources":["../../src/Markdowner.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAkD;AAElD,yCAA0C;AAC1C,+CAA+D;AAI/D,IAAM,WAAW,GAAG,IAAA,gCAAiB,EAAC,yBAAU,CAAC,KAAK,CAAC,CAAC;AAiCxD;IAAgC,8BAAI;IAClC,oBAAY,MAAc;QAChB,IAAA,KAAK,GAA+B,MAAM,MAArC,EAAE,YAAY,GAAiB,MAAM,aAAvB,EAAE,UAAU,GAAK,MAAM,WAAX,CAAY;QAEnD,OAAA,MAAK,YAAC;YACJ,KAAK,OAAA;YACL,YAAY,cAAA;YACZ,UAAU,EAAE,uBAAW;YACvB,UAAU,YAAA;YACV,oBAAoB,EAAE,IAAI;SAC3B,CAAC,SAAC;IACL,CAAC;IAEa,gCAAW,GAAzB,UAA6B,MAAoB;;;gBAC/C,WAAO,IAAI,CAAC,SAAS,CAAI,MAAM,CAAC,EAAC;;;KAClC;IAED,+BAAU,GAAV,UAAW,GAAY;QACrB,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IAoBD,kCAAa,GAAb,UACE,EAA+F,EAC/F,OAAyB;QADvB,IAAA,QAAQ,cAAA,EAAK,IAAI,cAAnB,YAAqB,CAAF;QACnB,wBAAA,EAAA,YAAyB;QAYzB,OAAO,IAAI,CAAC,WAAW,YACrB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,UAAG,QAAQ,SAAM,EACxB,IAAI,MAAA,IACD,OAAO,EACV,CAAC;IACL,CAAC;IAaD,qCAAgB,GAAhB,UACE,IAAoF,EACpF,OAAyB;QAAzB,wBAAA,EAAA,YAAyB;QAIzB,OAAO,IAAI,CAAC,WAAW,YACrB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,8BAA8B,EACrC,IAAI,MAAA,IACD,OAAO,EACV,CAAC;IACL,CAAC;IACH,iBAAC;AAAD,CAAC,AArFD,CAAgC,WAAI,GAqFnC;AArFY,gCAAU"}
1
+ {"version":3,"file":"Markdowner.js","sourceRoot":"","sources":["../../src/Markdowner.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAkD;AAElD,yCAA0C;AAC1C,+CAA+D;AAI/D,IAAM,WAAW,GAAG,IAAA,gCAAiB,EAAC,yBAAU,CAAC,KAAK,CAAC,CAAC;AAiCxD;IAAgC,8BAAI;IAClC,oBAAY,MAAc;QAChB,IAAA,KAAK,GAA+B,MAAM,MAArC,EAAE,YAAY,GAAiB,MAAM,aAAvB,EAAE,UAAU,GAAK,MAAM,WAAX,CAAY;QAEnD,OAAA,MAAK,YAAC;YACJ,KAAK,OAAA;YACL,YAAY,cAAA;YACZ,UAAU,EAAE,uBAAW;YACvB,UAAU,YAAA;YACV,oBAAoB,EAAE,IAAI;SAC3B,CAAC,SAAC;IACL,CAAC;IAEa,gCAAW,GAAzB,UAA6B,MAAoB;;;gBAC/C,WAAO,IAAI,CAAC,SAAS,CAAI,MAAM,CAAC,EAAC;;;KAClC;IAED,+BAAU,GAAV,UAAW,GAAY;QACrB,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IAKD,kCAAa,GAAb,UACE,EAOC,EAED,OAAyB;QATvB,IAAA,QAAQ,cAAA,EAAK,IAAI,cAAnB,YAAqB,CAAF;QASnB,wBAAA,EAAA,YAAyB;QAkBzB,OAAO,IAAI,CAAC,WAAW,YACrB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,UAAG,QAAQ,SAAM,EACxB,IAAI,MAAA,IACD,OAAO,EACV,CAAC;IACL,CAAC;IAaD,qCAAgB,GAAhB,UACE,IAAoF,EACpF,OAAyB;QAAzB,wBAAA,EAAA,YAAyB;QAIzB,OAAO,IAAI,CAAC,WAAW,YACrB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,8BAA8B,EACrC,IAAI,MAAA,IACD,OAAO,EACV,CAAC;IACL,CAAC;IACH,iBAAC;AAAD,CAAC,AApFD,CAAgC,WAAI,GAoFnC;AApFY,gCAAU"}
package/dist/esm/Markdowner.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Markdowner.js","sourceRoot":"","sources":["../../src/Markdowner.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,IAAI,EAAgB,MAAM,cAAc,CAAC;AAElD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAI/D,MAAM,WAAW,GAAG,iBAAiB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;AAiCxD,MAAM,OAAO,UAAW,SAAQ,IAAI;IAClC,YAAY,MAAc;QACxB,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAEnD,KAAK,CAAC;YACJ,KAAK;YACL,YAAY;YACZ,UAAU,EAAE,WAAW;YACvB,UAAU;YACV,oBAAoB,EAAE,IAAI;SAC3B,CAAC,CAAC;IACL,CAAC;IAEa,WAAW,CAAI,MAAoB;;YAC/C,OAAO,IAAI,CAAC,SAAS,CAAI,MAAM,CAAC,CAAC;QACnC,CAAC;KAAA;IAED,UAAU,CAAC,GAAY;QACrB,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IAoBD,aAAa,CACX,EAA+F,EAC/F,OAAyB;YADzB,EAAE,QAAQ,OAAqF,EAAhF,IAAI,cAAnB,YAAqB,CAAF;QACnB,wBAAA,EAAA,YAAyB;QAYzB,OAAO,IAAI,CAAC,WAAW,iBACrB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,GAAG,QAAQ,MAAM,EACxB,IAAI,IACD,OAAO,EACV,CAAC;IACL,CAAC;IAaD,gBAAgB,CACd,IAAoF,EACpF,UAAuB,EAAE;QAIzB,OAAO,IAAI,CAAC,WAAW,iBACrB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,8BAA8B,EACrC,IAAI,IACD,OAAO,EACV,CAAC;IACL,CAAC;CACF"}
1
+ {"version":3,"file":"Markdowner.js","sourceRoot":"","sources":["../../src/Markdowner.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,IAAI,EAAgB,MAAM,cAAc,CAAC;AAElD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAI/D,MAAM,WAAW,GAAG,iBAAiB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;AAiCxD,MAAM,OAAO,UAAW,SAAQ,IAAI;IAClC,YAAY,MAAc;QACxB,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAEnD,KAAK,CAAC;YACJ,KAAK;YACL,YAAY;YACZ,UAAU,EAAE,WAAW;YACvB,UAAU;YACV,oBAAoB,EAAE,IAAI;SAC3B,CAAC,CAAC;IACL,CAAC;IAEa,WAAW,CAAI,MAAoB;;YAC/C,OAAO,IAAI,CAAC,SAAS,CAAI,MAAM,CAAC,CAAC;QACnC,CAAC;KAAA;IAED,UAAU,CAAC,GAAY;QACrB,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IAKD,aAAa,CACX,EAOC,EAED,OAAyB;YATzB,EAAE,QAAQ,OAOT,EAPc,IAAI,cAAnB,YAAqB,CAAF;QASnB,wBAAA,EAAA,YAAyB;QAkBzB,OAAO,IAAI,CAAC,WAAW,iBACrB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,GAAG,QAAQ,MAAM,EACxB,IAAI,IACD,OAAO,EACV,CAAC;IACL,CAAC;IAaD,gBAAgB,CACd,IAAoF,EACpF,UAAuB,EAAE;QAIzB,OAAO,IAAI,CAAC,WAAW,iBACrB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,8BAA8B,EACrC,IAAI,IACD,OAAO,EACV,CAAC;IACL,CAAC;CACF"}
package/dist/types/Markdowner.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Markdowner.d.ts","sourceRoot":"","sources":["../../src/Markdowner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAgB,MAAM,cAAc,CAAC;AAIlD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAmC/C,qBAAa,UAAW,SAAQ,IAAI;gBACtB,MAAM,EAAE,MAAM;YAYZ,WAAW;IAIzB,UAAU,CAAC,GAAG,EAAE,OAAO;IAsBvB,aAAa,CACX,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,oBAAoB,CAAC,EAAE,OAAO,CAAC;QAAC,QAAQ,EAAE,YAAY,CAAC;KAAE,EAC/F,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC;QACP,KAAK,EAAE;YACL,MAAM,EAAE,MAAM,EAAE,CAAC;YACjB,KAAK,EAAE,MAAM,CAAC;YACd,QAAQ,EAAE,MAAM,CAAC;SAClB,EAAE,CAAC;QACJ,UAAU,EAAE;YACV,cAAc,EAAE,MAAM,CAAC;YACvB,eAAe,EAAE,MAAM,CAAC;SACzB,CAAC;KACH,CAAC;IAoBJ,gBAAgB,CACd,IAAI,EAAE,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;KAAE,GAAG;QAAE,MAAM,EAAE,MAAM,CAAC;KAAE,CAAC,GAAG;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;KAAE,EACpF,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC;QACP,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CAQL"}
1
+ {"version":3,"file":"Markdowner.d.ts","sourceRoot":"","sources":["../../src/Markdowner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAgB,MAAM,cAAc,CAAC;AAIlD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAmC/C,qBAAa,UAAW,SAAQ,IAAI;gBACtB,MAAM,EAAE,MAAM;YAYZ,WAAW;IAIzB,UAAU,CAAC,GAAG,EAAE,OAAO;IAOvB,aAAa,CACX,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,EAAE;QAErB,GAAG,EAAE,MAAM,CAAC;QAEZ,oBAAoB,CAAC,EAAE,OAAO,CAAC;QAE/B,QAAQ,EAAE,YAAY,CAAC;KACxB,EAED,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC;QAEP,KAAK,EAAE;YAEL,MAAM,EAAE,MAAM,EAAE,CAAC;YAEjB,KAAK,EAAE,MAAM,CAAC;YAEd,QAAQ,EAAE,MAAM,CAAC;SAClB,EAAE,CAAC;QACJ,UAAU,EAAE;YAEV,cAAc,EAAE,MAAM,CAAC;YAEvB,eAAe,EAAE,MAAM,CAAC;SACzB,CAAC;KACH,CAAC;IAoBJ,gBAAgB,CACd,IAAI,EAAE,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;KAAE,GAAG;QAAE,MAAM,EAAE,MAAM,CAAC;KAAE,CAAC,GAAG;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;KAAE,EACpF,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC;QACP,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CAQL"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@or-sdk/markdowner",
3
- "version": "0.2.0",
3
+ "version": "0.2.1-beta.3611.0",
4
4
  "description": "",
5
5
  "license": "Apache-2.0",
6
6
  "author": "",
@@ -21,7 +21,7 @@
21
21
  "dev": "pnpm build:watch:esm"
22
22
  },
23
23
  "dependencies": {
24
- "@or-sdk/base": "^0.40.0"
24
+ "@or-sdk/base": "^0.41.0-beta.3611.0"
25
25
  },
26
26
  "devDependencies": {
27
27
  "@vitest/coverage-c8": "^0.31.1",
@@ -32,6 +32,5 @@
32
32
  },
33
33
  "publishConfig": {
34
34
  "access": "public"
35
- },
36
- "gitHead": "dc7e7b42f34b285922a4768b7d051b1055999fb6"
35
+ }
37
36
  }
package/src/Markdowner.ts CHANGED
@@ -61,34 +61,33 @@ export class Markdowner extends Base {
61
61
 
62
62
  /**
63
63
  * Converts a PDF document to Markdown format.
64
- *
65
- * @param {Object} params - The parameters for the conversion.
66
- * @param {string} params.url - The URL of the PDF document to be converted.
67
- * @param {boolean} [params.include_image_base64] - Optional flag to include images as base64 strings in the output.
68
- * @param {PDFProviders} params.provider - The provider to use for the PDF processing.
69
- * @param {CallOptions} [options] - Optional call options for the request.
70
- *
71
- * @returns {Promise<Object>} A promise that resolves to an object containing the converted Markdown content and usage information.
72
- * @returns {Object[]} return.pages - An array of pages in the document.
73
- * @returns {string[]} return.pages[].images - An array of image URLs or paths for the page.
74
- * @returns {number} return.pages[].index - The index of the page.
75
- * @returns {string} return.pages[].markdown - The Markdown content of the page.
76
- * @returns {Object} return.usage_info - Information about the document processing.
77
- * @returns {number} return.usage_info.doc_size_bytes - The size of the document in bytes.
78
- * @returns {number} return.usage_info.pages_processed - The number of pages processed.
79
64
  */
80
65
  pdfToMarkdown(
81
- { provider, ...data }: { url: string; include_image_base64?: boolean; provider: PDFProviders; },
66
+ { provider, ...data }: {
67
+ /** The URL of the PDF document to be converted */
68
+ url: string;
69
+ /** Optional flag to include images as base64 strings in the output */
70
+ include_image_base64?: boolean;
71
+ /** The provider to use for the PDF processing */
72
+ provider: PDFProviders;
73
+ },
74
+ /** Optional call options for the request */
82
75
  options: CallOptions = {}
83
76
  ): Promise<{
77
+ /** Array of pages in the document */
84
78
  pages: {
85
- images: string[]; // Array of image URLs or paths
86
- index: number; // Page index
87
- markdown: string; // Markdown content of the page
88
- }[]; // Array of pages in the document
79
+ /** Array of image URLs or paths */
80
+ images: string[];
81
+ /** Page index */
82
+ index: number;
83
+ /** Markdown content of the page */
84
+ markdown: string;
85
+ }[];
89
86
  usage_info: {
90
- doc_size_bytes: number; // Size of the document in bytes
91
- pages_processed: number; // Number of pages processed
87
+ /** Size of the document in bytes */
88
+ doc_size_bytes: number;
89
+ /** Number of pages processed */
90
+ pages_processed: number;
92
91
  };
93
92
  }> {
94
93
  return this.makeRequest({