@crawlee/utils 3.0.0-alpha.0 → 3.0.0-alpha.3

package/dist/LICENSE.md

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018 Apify Technologies s.r.o.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export * from './internals/cheerio';
+export * from './internals/extract-urls';
+export * from './internals/general';
+export * from './internals/memory-info';
+export * as social from './internals/social';
+export * from './internals/typedefs';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,OAAO,KAAK,MAAM,MAAM,oBAAoB,CAAC;AAC7C,cAAc,sBAAsB,CAAC"}

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,8DAAoC;AACpC,mEAAyC;AACzC,8DAAoC;AACpC,kEAAwC;AACxC,qEAA6C;AAC7C,+DAAqC"}

package/dist/index.mjs

@@ -0,0 +1,18 @@
+import mod from "./index.js";
+
+export default mod;
+export const URL_NO_COMMAS_REGEX = mod.URL_NO_COMMAS_REGEX;
+export const URL_WITH_COMMAS_REGEX = mod.URL_WITH_COMMAS_REGEX;
+export const downloadListOfUrls = mod.downloadListOfUrls;
+export const entries = mod.entries;
+export const extractUrls = mod.extractUrls;
+export const getMemoryInfo = mod.getMemoryInfo;
+export const htmlToText = mod.htmlToText;
+export const isDocker = mod.isDocker;
+export const keys = mod.keys;
+export const parseContentTypeFromResponse = mod.parseContentTypeFromResponse;
+export const purgeLocalStorage = mod.purgeLocalStorage;
+export const sleep = mod.sleep;
+export const snakeCaseToCamelCase = mod.snakeCaseToCamelCase;
+export const social = mod.social;
+export const weightedAvg = mod.weightedAvg;

package/dist/internals/cheerio.d.ts

@@ -0,0 +1,32 @@
+import { load } from 'cheerio';
+export declare type CheerioRoot = ReturnType<typeof load>;
+/**
+ * The function converts a HTML document to a plain text.
+ *
+ * The plain text generated by the function is similar to a text captured
+ * by pressing Ctrl+A and Ctrl+C on a page when loaded in a web browser.
+ * The function doesn't aspire to preserve the formatting or to be perfectly correct with respect to HTML specifications.
+ * However, it attempts to generate newlines and whitespaces in and around HTML elements
+ * to avoid merging distinct parts of text and thus enable extraction of data from the text (e.g. phone numbers).
+ *
+ * **Example usage**
+ * ```javascript
+ * const text = htmlToText('<html><body>Some text</body></html>');
+ * console.log(text);
+ * ```
+ *
+ * Note that the function uses [cheerio](https://www.npmjs.com/package/cheerio) to parse the HTML.
+ * Optionally, to avoid duplicate parsing of HTML and thus improve performance, you can pass
+ * an existing Cheerio object to the function instead of the HTML text. The HTML should be parsed
+ * with the `decodeEntities` option set to `true`. For example:
+ *
+ * ```javascript
+ * const cheerio = require('cheerio');
+ * const html = '<html><body>Some text</body></html>';
+ * const text = htmlToText(cheerio.load(html, { decodeEntities: true }));
+ * ```
+ * @param htmlOrCheerioElement HTML text or parsed HTML represented using a [cheerio](https://www.npmjs.com/package/cheerio) function.
+ * @return Plain text
+ */
+export declare function htmlToText(htmlOrCheerioElement: string | CheerioRoot): string;
+//# sourceMappingURL=cheerio.d.ts.map

package/dist/internals/cheerio.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cheerio.d.ts","sourceRoot":"","sources":["../../src/internals/cheerio.ts"],"names":[],"mappings":"AAAA,OAAgB,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAExC,oBAAY,WAAW,GAAG,UAAU,CAAC,OAAO,IAAI,CAAC,CAAC;AAMlD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,UAAU,CAAC,oBAAoB,EAAE,MAAM,GAAG,WAAW,GAAG,MAAM,CAiD7E"}

package/dist/internals/cheerio.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.htmlToText = void 0;
+const tslib_1 = require("tslib");
+const cheerio_1 = tslib_1.__importDefault(require("cheerio"));
+// NOTE: We are skipping 'noscript' since it's content is evaluated as text, instead of HTML elements. That damages the results.
+const SKIP_TAGS_REGEX = /^(script|style|canvas|svg|noscript)$/i;
+const BLOCK_TAGS_REGEX = /^(p|h1|h2|h3|h4|h5|h6|ol|ul|li|pre|address|blockquote|dl|div|fieldset|form|table|tr|select|option)$/i;
+/**
+ * The function converts a HTML document to a plain text.
+ *
+ * The plain text generated by the function is similar to a text captured
+ * by pressing Ctrl+A and Ctrl+C on a page when loaded in a web browser.
+ * The function doesn't aspire to preserve the formatting or to be perfectly correct with respect to HTML specifications.
+ * However, it attempts to generate newlines and whitespaces in and around HTML elements
+ * to avoid merging distinct parts of text and thus enable extraction of data from the text (e.g. phone numbers).
+ *
+ * **Example usage**
+ * ```javascript
+ * const text = htmlToText('<html><body>Some text</body></html>');
+ * console.log(text);
+ * ```
+ *
+ * Note that the function uses [cheerio](https://www.npmjs.com/package/cheerio) to parse the HTML.
+ * Optionally, to avoid duplicate parsing of HTML and thus improve performance, you can pass
+ * an existing Cheerio object to the function instead of the HTML text. The HTML should be parsed
+ * with the `decodeEntities` option set to `true`. For example:
+ *
+ * ```javascript
+ * const cheerio = require('cheerio');
+ * const html = '<html><body>Some text</body></html>';
+ * const text = htmlToText(cheerio.load(html, { decodeEntities: true }));
+ * ```
+ * @param htmlOrCheerioElement HTML text or parsed HTML represented using a [cheerio](https://www.npmjs.com/package/cheerio) function.
+ * @return Plain text
+ */
+function htmlToText(htmlOrCheerioElement) {
+    if (!htmlOrCheerioElement)
+        return '';
+    // TODO: Add support for "html" being a Cheerio element, otherwise the only way
+    //  to use it is e.g. htmlToText($('p').html())) which is inefficient
+    //  Also, it seems this doesn't work well in CheerioScraper, e.g. htmlToText($)
+    //  produces really text with a lot of HTML elements in it. Let's just deprecate this sort of usage,
+    //  and make the parameter "htmlOrCheerioElement"
+    const $ = typeof htmlOrCheerioElement === 'function' ? htmlOrCheerioElement : cheerio_1.default.load(htmlOrCheerioElement, { decodeEntities: true });
+    let text = '';
+    // TODO: the type for elems is very annoying to work with.
+    //  The correct type is Node[] from cheerio but it needs a lot more casting in each branch, or alternatively,
+    //  use the is* methods from domhandler (isText, isTag, isComment, etc.)
+    // @ts-expect-error
+    const process = (elems) => {
+        const len = elems ? elems.length : 0;
+        for (let i = 0; i < len; i++) {
+            const elem = elems[i];
+            if (elem.type === 'text') {
+                // Compress spaces, unless we're inside <pre> element
+                let compr;
+                if (elem.parent && elem.parent.tagName === 'pre')
+                    compr = elem.data;
+                else
+                    compr = elem.data.replace(/\s+/g, ' ');
+                // If text is empty or ends with a whitespace, don't add the leading whitepsace
+                if (compr.startsWith(' ') && /(^|\s)$/.test(text))
+                    compr = compr.substr(1);
+                text += compr;
+            }
+            else if (elem.type === 'comment' || SKIP_TAGS_REGEX.test(elem.tagName)) {
+                // Skip comments and special elements
+            }
+            else if (elem.tagName === 'br') {
+                text += '\n';
+            }
+            else if (elem.tagName === 'td') {
+                process(elem.children);
+                text += '\t';
+            }
+            else {
+                // Block elements must be surrounded by newlines (unless beginning of text)
+                const isBlockTag = BLOCK_TAGS_REGEX.test(elem.tagName);
+                if (isBlockTag && !/(^|\n)$/.test(text))
+                    text += '\n';
+                process(elem.children);
+                if (isBlockTag && !text.endsWith('\n'))
+                    text += '\n';
+            }
+        }
+    };
+    // If HTML document has body, only convert that, otherwise convert the entire HTML
+    const $body = $('body');
+    process($body.length > 0 ? $body : $.root());
+    return text.trim();
+}
+exports.htmlToText = htmlToText;
+//# sourceMappingURL=cheerio.js.map

package/dist/internals/cheerio.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cheerio.js","sourceRoot":"","sources":["../../src/internals/cheerio.ts"],"names":[],"mappings":";;;;AAAA,8DAAwC;AAIxC,gIAAgI;AAChI,MAAM,eAAe,GAAG,uCAAuC,CAAC;AAChE,MAAM,gBAAgB,GAAG,sGAAsG,CAAC;AAEhI;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,SAAgB,UAAU,CAAC,oBAA0C;IACjE,IAAI,CAAC,oBAAoB;QAAE,OAAO,EAAE,CAAC;IAErC,+EAA+E;IAC/E,qEAAqE;IACrE,+EAA+E;IAC/E,oGAAoG;IACpG,iDAAiD;IACjD,MAAM,CAAC,GAAG,OAAO,oBAAoB,KAAK,UAAU,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,iBAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3I,IAAI,IAAI,GAAG,EAAE,CAAC;IAEd,0DAA0D;IAC1D,6GAA6G;IAC7G,wEAAwE;IACxE,mBAAmB;IACnB,MAAM,OAAO,GAAG,CAAC,KAAK,EAAE,EAAE;QACtB,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACrC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE;YAC1B,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACtB,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE;gBACtB,qDAAqD;gBACrD,IAAI,KAAK,CAAC;gBACV,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,KAAK,KAAK;oBAAE,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC;;oBAC/D,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;gBAC5C,+EAA+E;gBAC/E,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC;oBAAE,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBAC3E,IAAI,IAAI,KAAK,CAAC;aACjB;iBAAM,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;gBACtE,qCAAqC;aACxC;iBAAM,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,EAAE;gBAC9B,IAAI,IAAI,IAAI,CAAC;aAChB;iBAAM,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,EAAE;gBAC9B,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACvB,IAAI,IAAI,IAAI,CAAC;aAChB;iBAAM;gBACH,2EAA2E;gBAC3E,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACvD,IAAI,UAAU,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC;oBAAE,IAAI,IAAI,IAAI,CAAC;gBACtD,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACvB,IAAI,UAAU,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;oBAAE,IAAI,IAAI,IAAI,CAAC;aACxD;SACJ;IACL,CAAC,CAAC;IAEF,kFAAkF;IAClF,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC;IACxB,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAE7C,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;AACvB,CAAC;AAjDD,gCAiDC"}

package/dist/internals/extract-urls.d.ts

@@ -0,0 +1,39 @@
+/// <reference types="node" />
+export interface DownloadListOfUrlsOptions {
+    /**
+     * URL to the file
+     */
+    url: string;
+    /**
+     * The encoding of the file.
+     * @default 'utf8'
+     */
+    encoding?: BufferEncoding;
+    /**
+     * Custom regular expression to identify the URLs in the file to extract.
+     * The regular expression should be case-insensitive and have global flag set (i.e. `/something/gi`).
+     * @default Actor.utils.URL_NO_COMMAS_REGEX
+     */
+    urlRegExp?: RegExp;
+}
+/**
+ * Returns a promise that resolves to an array of urls parsed from the resource available at the provided url.
+ * Optionally, custom regular expression and encoding may be provided.
+ */
+export declare function downloadListOfUrls(options: DownloadListOfUrlsOptions): Promise<string[]>;
+export interface ExtractUrlsOptions {
+    /**
+     * The string to extract URLs from.
+     */
+    string: string;
+    /**
+     * Custom regular expression
+     * @default URL_NO_COMMAS_REGEX
+     */
+    urlRegExp?: RegExp;
+}
+/**
+ * Collects all URLs in an arbitrary string to an array, optionally using a custom regular expression.
+ */
+export declare function extractUrls(options: ExtractUrlsOptions): string[];
+//# sourceMappingURL=extract-urls.d.ts.map

package/dist/internals/extract-urls.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extract-urls.d.ts","sourceRoot":"","sources":["../../src/internals/extract-urls.ts"],"names":[],"mappings":";AAIA,MAAM,WAAW,yBAAyB;IACtC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAC;IAE1B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,wBAAsB,kBAAkB,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAkB9F;AAED,MAAM,WAAW,kBAAkB;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,MAAM,EAAE,CAOjE"}

package/dist/internals/extract-urls.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractUrls = exports.downloadListOfUrls = void 0;
+const tslib_1 = require("tslib");
+const ow_1 = tslib_1.__importDefault(require("ow"));
+const got_scraping_1 = require("got-scraping");
+const general_1 = require("./general");
+/**
+ * Returns a promise that resolves to an array of urls parsed from the resource available at the provided url.
+ * Optionally, custom regular expression and encoding may be provided.
+ */
+async function downloadListOfUrls(options) {
+    (0, ow_1.default)(options, ow_1.default.object.exactShape({
+        url: ow_1.default.string.url,
+        encoding: ow_1.default.optional.string,
+        urlRegExp: ow_1.default.optional.regExp,
+    }));
+    const { url, encoding = 'utf8', urlRegExp = general_1.URL_NO_COMMAS_REGEX } = options;
+    // Try to detect wrong urls and fix them. Currently, detects only sharing url instead of csv download one.
+    const match = url.match(/^(https:\/\/docs\.google\.com\/spreadsheets\/d\/(?:\w|-)+)\/?/);
+    let fixedUrl = url;
+    if (match) {
+        fixedUrl = `${match[1]}/gviz/tq?tqx=out:csv`;
+    }
+    const { body: string } = await (0, got_scraping_1.gotScraping)({ url: fixedUrl, encoding });
+    return extractUrls({ string, urlRegExp });
+}
+exports.downloadListOfUrls = downloadListOfUrls;
+/**
+ * Collects all URLs in an arbitrary string to an array, optionally using a custom regular expression.
+ */
+function extractUrls(options) {
+    (0, ow_1.default)(options, ow_1.default.object.exactShape({
+        string: ow_1.default.string,
+        urlRegExp: ow_1.default.optional.regExp,
+    }));
+    const { string, urlRegExp = general_1.URL_NO_COMMAS_REGEX } = options;
+    return string.match(urlRegExp) || [];
+}
+exports.extractUrls = extractUrls;
+//# sourceMappingURL=extract-urls.js.map

package/dist/internals/extract-urls.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extract-urls.js","sourceRoot":"","sources":["../../src/internals/extract-urls.ts"],"names":[],"mappings":";;;;AAAA,oDAAoB;AACpB,+CAA2C;AAC3C,uCAAgD;AAsBhD;;;GAGG;AACI,KAAK,UAAU,kBAAkB,CAAC,OAAkC;IACvE,IAAA,YAAE,EAAC,OAAO,EAAE,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;QAC7B,GAAG,EAAE,YAAE,CAAC,MAAM,CAAC,GAAG;QAClB,QAAQ,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;QAC5B,SAAS,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;KAChC,CAAC,CAAC,CAAC;IACJ,MAAM,EAAE,GAAG,EAAE,QAAQ,GAAG,MAAM,EAAE,SAAS,GAAG,6BAAmB,EAAE,GAAG,OAAO,CAAC;IAE5E,0GAA0G;IAC1G,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,+DAA+D,CAAC,CAAC;IACzF,IAAI,QAAQ,GAAG,GAAG,CAAC;IAEnB,IAAI,KAAK,EAAE;QACP,QAAQ,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,sBAAsB,CAAC;KAChD;IAED,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,IAAA,0BAAW,EAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;IACxE,OAAO,WAAW,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;AAC9C,CAAC;AAlBD,gDAkBC;AAeD;;GAEG;AACH,SAAgB,WAAW,CAAC,OAA2B;IACnD,IAAA,YAAE,EAAC,OAAO,EAAE,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;QAC7B,MAAM,EAAE,YAAE,CAAC,MAAM;QACjB,SAAS,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;KAChC,CAAC,CAAC,CAAC;IACJ,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,6BAAmB,EAAE,GAAG,OAAO,CAAC;IAC5D,OAAO,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;AACzC,CAAC;AAPD,kCAOC"}

package/dist/internals/general.d.ts

@@ -0,0 +1,62 @@
+/// <reference types="node" />
+import type { IncomingMessage } from 'node:http';
+/**
+ * Default regular expression to match URLs in a string that may be plain text, JSON, CSV or other. It supports common URL characters
+ * and does not support URLs containing commas or spaces. The URLs also may contain Unicode letters (not symbols).
+ */
+export declare const URL_NO_COMMAS_REGEX: RegExp;
+/**
+ * Regular expression that, in addition to the default regular expression `URL_NO_COMMAS_REGEX`, supports matching commas in URL path and query.
+ * Note, however, that this may prevent parsing URLs from comma delimited lists, or the URLs may become malformed.
+ */
+export declare const URL_WITH_COMMAS_REGEX: RegExp;
+/**
+ * Returns a `Promise` that resolves to true if the code is running in a Docker container.
+ */
+export declare function isDocker(forceReset?: boolean): Promise<boolean>;
+/**
+ * Computes a weighted average of an array of numbers, complemented by an array of weights.
+ * @ignore
+ */
+export declare function weightedAvg(arrValues: number[], arrWeights: number[]): number;
+/**
+ * Returns a `Promise` that resolves after a specific period of time. This is useful to implement waiting
+ * in your code, e.g. to prevent overloading of target website or to avoid bot detection.
+ *
+ * **Example usage:**
+ *
+ * ```
+ * const { sleep } = require('@crawlee/utils');
+ *
+ * ...
+ *
+ * // Sleep 1.5 seconds
+ * await sleep(1500);
+ * ```
+ * @param millis Period of time to sleep, in milliseconds. If not a positive number, the returned promise resolves immediately.
+ */
+export declare function sleep(millis?: number): Promise<void>;
+/**
+ * Converts SNAKE_CASE to camelCase.
+ * @ignore
+ */
+export declare function snakeCaseToCamelCase(snakeCaseStr: string): string;
+/**
+ * Cleans up the local storage folder created when testing locally.
+ * This is useful in the event you are debugging your code locally.
+ *
+ * Be careful as this will remove the folder you provide and everything in it!
+ *
+ * @param [folder] The folder to clean up
+ */
+export declare function purgeLocalStorage(folder?: string): Promise<void>;
+/**
+ * Gets parsed content type from response object
+ * @param response HTTP response object
+ * @ignore
+ */
+export declare function parseContentTypeFromResponse(response: IncomingMessage): {
+    type: string;
+    charset: BufferEncoding;
+};
+//# sourceMappingURL=general.d.ts.map

package/dist/internals/general.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"general.d.ts","sourceRoot":"","sources":["../../src/internals/general.ts"],"names":[],"mappings":";AAIA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAMjD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,QAA0J,CAAC;AAE3L;;;GAGG;AACH,eAAO,MAAM,qBAAqB,QAA2J,CAAC;AAkB9L;;GAEG;AACH,wBAAgB,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAK/D;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,MAAM,CAS7E;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,KAAK,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAEpD;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAUjE;AAED;;;;;;;GAOG;AACH,wBAAsB,iBAAiB,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAQtE;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,QAAQ,EAAE,eAAe,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,cAAc,CAAA;CAAE,CA6BjH"}