firecrawl 4.22.1 → 4.22.2

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.
@@ -8,7 +8,7 @@ var require_package = __commonJS({
8
8
  "package.json"(exports, module) {
9
9
  module.exports = {
10
10
  name: "@mendable/firecrawl-js",
11
- version: "4.22.1",
11
+ version: "4.22.2",
12
12
  description: "JavaScript SDK for Firecrawl API",
13
13
  main: "dist/index.js",
14
14
  types: "dist/index.d.ts",
package/dist/index.cjs CHANGED
@@ -35,7 +35,7 @@ var require_package = __commonJS({
35
35
  "package.json"(exports2, module2) {
36
36
  module2.exports = {
37
37
  name: "@mendable/firecrawl-js",
38
- version: "4.22.1",
38
+ version: "4.22.2",
39
39
  description: "JavaScript SDK for Firecrawl API",
40
40
  main: "dist/index.js",
41
41
  types: "dist/index.d.ts",
@@ -2986,6 +2986,7 @@ var FirecrawlApp = class {
2986
2986
  * @param onActivity - Optional callback to receive activity updates in real-time.
2987
2987
  * @param onSource - Optional callback to receive source updates in real-time.
2988
2988
  * @returns The final research results.
2989
+ * @deprecated /v1/deep-research is deprecated. Use /v2/search instead.
2989
2990
  */
2990
2991
  async deepResearch(query, params, onActivity, onSource) {
2991
2992
  try {
@@ -3042,6 +3043,7 @@ var FirecrawlApp = class {
3042
3043
  * Initiates a deep research operation on a given query without polling.
3043
3044
  * @param params - Parameters for the deep research operation.
3044
3045
  * @returns The response containing the research job ID.
3046
+ * @deprecated /v1/deep-research is deprecated. Use /v2/search instead.
3045
3047
  */
3046
3048
  async asyncDeepResearch(query, params) {
3047
3049
  const headers = this.prepareHeaders();
@@ -3079,6 +3081,7 @@ var FirecrawlApp = class {
3079
3081
  * Checks the status of a deep research operation.
3080
3082
  * @param id - The ID of the deep research operation.
3081
3083
  * @returns The current status and results of the research operation.
3084
+ * @deprecated /v1/deep-research is deprecated. Use /v2/search instead.
3082
3085
  */
3083
3086
  async checkDeepResearchStatus(id) {
3084
3087
  const headers = this.prepareHeaders();
@@ -3217,6 +3220,7 @@ var FirecrawlApp = class {
3217
3220
  * @param url - The URL to generate LLMs.txt from.
3218
3221
  * @param params - Parameters for the LLMs.txt generation operation.
3219
3222
  * @returns The final generation results.
3223
+ * @deprecated /v1/llmstxt is deprecated and will not be replaced.
3220
3224
  */
3221
3225
  async generateLLMsText(url, params) {
3222
3226
  try {
@@ -3258,6 +3262,7 @@ var FirecrawlApp = class {
3258
3262
  * @param url - The URL to generate LLMs.txt from.
3259
3263
  * @param params - Parameters for the LLMs.txt generation operation.
3260
3264
  * @returns The response containing the generation job ID.
3265
+ * @deprecated /v1/llmstxt is deprecated and will not be replaced.
3261
3266
  */
3262
3267
  async asyncGenerateLLMsText(url, params) {
3263
3268
  const headers = this.prepareHeaders();
@@ -3286,6 +3291,7 @@ var FirecrawlApp = class {
3286
3291
  * Checks the status of a LLMs.txt generation operation.
3287
3292
  * @param id - The ID of the LLMs.txt generation operation.
3288
3293
  * @returns The current status and results of the generation operation.
3294
+ * @deprecated /v1/llmstxt is deprecated and will not be replaced.
3289
3295
  */
3290
3296
  async checkGenerateLLMsTextStatus(id) {
3291
3297
  const headers = this.prepareHeaders();
package/dist/index.d.cts CHANGED
@@ -621,6 +621,8 @@ interface ExtractResponse$1 {
621
621
  data?: unknown;
622
622
  error?: string;
623
623
  warning?: string;
624
+ warnings?: string[];
625
+ replacement?: string;
624
626
  sources?: Record<string, unknown>;
625
627
  expiresAt?: string;
626
628
  creditsUsed?: number;
@@ -1521,6 +1523,8 @@ interface ExtractResponse<LLMSchema extends zt.ZodSchema = any> {
1521
1523
  data: LLMSchema;
1522
1524
  error?: string;
1523
1525
  warning?: string;
1526
+ warnings?: string[];
1527
+ replacement?: string;
1524
1528
  sources?: string[];
1525
1529
  creditsUsed?: number;
1526
1530
  }
@@ -1623,6 +1627,8 @@ interface DeepResearchParams<LLMSchema extends zt.ZodSchema = any> {
1623
1627
  interface DeepResearchResponse {
1624
1628
  success: boolean;
1625
1629
  id: string;
1630
+ warnings?: string[];
1631
+ replacement?: string;
1626
1632
  }
1627
1633
  /**
1628
1634
  * Status response interface for deep research operations.
@@ -1662,6 +1668,8 @@ interface DeepResearchStatusResponse {
1662
1668
  description: string;
1663
1669
  }>;
1664
1670
  summaries: string[];
1671
+ warnings?: string[];
1672
+ replacement?: string;
1665
1673
  }
1666
1674
  /**
1667
1675
  * Parameters for LLMs.txt generation operations.
@@ -1693,6 +1701,8 @@ interface GenerateLLMsTextParams {
1693
1701
  interface GenerateLLMsTextResponse {
1694
1702
  success: boolean;
1695
1703
  id: string;
1704
+ warnings?: string[];
1705
+ replacement?: string;
1696
1706
  }
1697
1707
  /**
1698
1708
  * Status response interface for LLMs.txt generation operations.
@@ -1706,6 +1716,8 @@ interface GenerateLLMsTextStatusResponse {
1706
1716
  status: "processing" | "completed" | "failed";
1707
1717
  error?: string;
1708
1718
  expiresAt: string;
1719
+ warnings?: string[];
1720
+ replacement?: string;
1709
1721
  }
1710
1722
  /**
1711
1723
  * Response interface for queue status operations.
@@ -1955,6 +1967,7 @@ declare class FirecrawlApp {
1955
1967
  * @param onActivity - Optional callback to receive activity updates in real-time.
1956
1968
  * @param onSource - Optional callback to receive source updates in real-time.
1957
1969
  * @returns The final research results.
1970
+ * @deprecated /v1/deep-research is deprecated. Use /v2/search instead.
1958
1971
  */
1959
1972
  deepResearch(query: string, params: DeepResearchParams<zt.ZodSchema>, onActivity?: (activity: {
1960
1973
  type: string;
@@ -1972,12 +1985,14 @@ declare class FirecrawlApp {
1972
1985
  * Initiates a deep research operation on a given query without polling.
1973
1986
  * @param params - Parameters for the deep research operation.
1974
1987
  * @returns The response containing the research job ID.
1988
+ * @deprecated /v1/deep-research is deprecated. Use /v2/search instead.
1975
1989
  */
1976
1990
  asyncDeepResearch(query: string, params: DeepResearchParams<zt.ZodSchema>): Promise<DeepResearchResponse | ErrorResponse>;
1977
1991
  /**
1978
1992
  * Checks the status of a deep research operation.
1979
1993
  * @param id - The ID of the deep research operation.
1980
1994
  * @returns The current status and results of the research operation.
1995
+ * @deprecated /v1/deep-research is deprecated. Use /v2/search instead.
1981
1996
  */
1982
1997
  checkDeepResearchStatus(id: string): Promise<DeepResearchStatusResponse | ErrorResponse>;
1983
1998
  /**
@@ -2014,6 +2029,7 @@ declare class FirecrawlApp {
2014
2029
  * @param url - The URL to generate LLMs.txt from.
2015
2030
  * @param params - Parameters for the LLMs.txt generation operation.
2016
2031
  * @returns The final generation results.
2032
+ * @deprecated /v1/llmstxt is deprecated and will not be replaced.
2017
2033
  */
2018
2034
  generateLLMsText(url: string, params?: GenerateLLMsTextParams): Promise<GenerateLLMsTextStatusResponse | ErrorResponse>;
2019
2035
  /**
@@ -2021,12 +2037,14 @@ declare class FirecrawlApp {
2021
2037
  * @param url - The URL to generate LLMs.txt from.
2022
2038
  * @param params - Parameters for the LLMs.txt generation operation.
2023
2039
  * @returns The response containing the generation job ID.
2040
+ * @deprecated /v1/llmstxt is deprecated and will not be replaced.
2024
2041
  */
2025
2042
  asyncGenerateLLMsText(url: string, params?: GenerateLLMsTextParams): Promise<GenerateLLMsTextResponse | ErrorResponse>;
2026
2043
  /**
2027
2044
  * Checks the status of a LLMs.txt generation operation.
2028
2045
  * @param id - The ID of the LLMs.txt generation operation.
2029
2046
  * @returns The current status and results of the generation operation.
2047
+ * @deprecated /v1/llmstxt is deprecated and will not be replaced.
2030
2048
  */
2031
2049
  checkGenerateLLMsTextStatus(id: string): Promise<GenerateLLMsTextStatusResponse | ErrorResponse>;
2032
2050
  /**
package/dist/index.d.ts CHANGED
@@ -621,6 +621,8 @@ interface ExtractResponse$1 {
621
621
  data?: unknown;
622
622
  error?: string;
623
623
  warning?: string;
624
+ warnings?: string[];
625
+ replacement?: string;
624
626
  sources?: Record<string, unknown>;
625
627
  expiresAt?: string;
626
628
  creditsUsed?: number;
@@ -1521,6 +1523,8 @@ interface ExtractResponse<LLMSchema extends zt.ZodSchema = any> {
1521
1523
  data: LLMSchema;
1522
1524
  error?: string;
1523
1525
  warning?: string;
1526
+ warnings?: string[];
1527
+ replacement?: string;
1524
1528
  sources?: string[];
1525
1529
  creditsUsed?: number;
1526
1530
  }
@@ -1623,6 +1627,8 @@ interface DeepResearchParams<LLMSchema extends zt.ZodSchema = any> {
1623
1627
  interface DeepResearchResponse {
1624
1628
  success: boolean;
1625
1629
  id: string;
1630
+ warnings?: string[];
1631
+ replacement?: string;
1626
1632
  }
1627
1633
  /**
1628
1634
  * Status response interface for deep research operations.
@@ -1662,6 +1668,8 @@ interface DeepResearchStatusResponse {
1662
1668
  description: string;
1663
1669
  }>;
1664
1670
  summaries: string[];
1671
+ warnings?: string[];
1672
+ replacement?: string;
1665
1673
  }
1666
1674
  /**
1667
1675
  * Parameters for LLMs.txt generation operations.
@@ -1693,6 +1701,8 @@ interface GenerateLLMsTextParams {
1693
1701
  interface GenerateLLMsTextResponse {
1694
1702
  success: boolean;
1695
1703
  id: string;
1704
+ warnings?: string[];
1705
+ replacement?: string;
1696
1706
  }
1697
1707
  /**
1698
1708
  * Status response interface for LLMs.txt generation operations.
@@ -1706,6 +1716,8 @@ interface GenerateLLMsTextStatusResponse {
1706
1716
  status: "processing" | "completed" | "failed";
1707
1717
  error?: string;
1708
1718
  expiresAt: string;
1719
+ warnings?: string[];
1720
+ replacement?: string;
1709
1721
  }
1710
1722
  /**
1711
1723
  * Response interface for queue status operations.
@@ -1955,6 +1967,7 @@ declare class FirecrawlApp {
1955
1967
  * @param onActivity - Optional callback to receive activity updates in real-time.
1956
1968
  * @param onSource - Optional callback to receive source updates in real-time.
1957
1969
  * @returns The final research results.
1970
+ * @deprecated /v1/deep-research is deprecated. Use /v2/search instead.
1958
1971
  */
1959
1972
  deepResearch(query: string, params: DeepResearchParams<zt.ZodSchema>, onActivity?: (activity: {
1960
1973
  type: string;
@@ -1972,12 +1985,14 @@ declare class FirecrawlApp {
1972
1985
  * Initiates a deep research operation on a given query without polling.
1973
1986
  * @param params - Parameters for the deep research operation.
1974
1987
  * @returns The response containing the research job ID.
1988
+ * @deprecated /v1/deep-research is deprecated. Use /v2/search instead.
1975
1989
  */
1976
1990
  asyncDeepResearch(query: string, params: DeepResearchParams<zt.ZodSchema>): Promise<DeepResearchResponse | ErrorResponse>;
1977
1991
  /**
1978
1992
  * Checks the status of a deep research operation.
1979
1993
  * @param id - The ID of the deep research operation.
1980
1994
  * @returns The current status and results of the research operation.
1995
+ * @deprecated /v1/deep-research is deprecated. Use /v2/search instead.
1981
1996
  */
1982
1997
  checkDeepResearchStatus(id: string): Promise<DeepResearchStatusResponse | ErrorResponse>;
1983
1998
  /**
@@ -2014,6 +2029,7 @@ declare class FirecrawlApp {
2014
2029
  * @param url - The URL to generate LLMs.txt from.
2015
2030
  * @param params - Parameters for the LLMs.txt generation operation.
2016
2031
  * @returns The final generation results.
2032
+ * @deprecated /v1/llmstxt is deprecated and will not be replaced.
2017
2033
  */
2018
2034
  generateLLMsText(url: string, params?: GenerateLLMsTextParams): Promise<GenerateLLMsTextStatusResponse | ErrorResponse>;
2019
2035
  /**
@@ -2021,12 +2037,14 @@ declare class FirecrawlApp {
2021
2037
  * @param url - The URL to generate LLMs.txt from.
2022
2038
  * @param params - Parameters for the LLMs.txt generation operation.
2023
2039
  * @returns The response containing the generation job ID.
2040
+ * @deprecated /v1/llmstxt is deprecated and will not be replaced.
2024
2041
  */
2025
2042
  asyncGenerateLLMsText(url: string, params?: GenerateLLMsTextParams): Promise<GenerateLLMsTextResponse | ErrorResponse>;
2026
2043
  /**
2027
2044
  * Checks the status of a LLMs.txt generation operation.
2028
2045
  * @param id - The ID of the LLMs.txt generation operation.
2029
2046
  * @returns The current status and results of the generation operation.
2047
+ * @deprecated /v1/llmstxt is deprecated and will not be replaced.
2030
2048
  */
2031
2049
  checkGenerateLLMsTextStatus(id: string): Promise<GenerateLLMsTextStatusResponse | ErrorResponse>;
2032
2050
  /**
package/dist/index.js CHANGED
@@ -1,6 +1,6 @@
1
1
  import {
2
2
  require_package
3
- } from "./chunk-WTZQ5IMF.js";
3
+ } from "./chunk-HGRZHWZU.js";
4
4
 
5
5
  // src/v2/utils/httpClient.ts
6
6
  import axios from "axios";
@@ -2036,7 +2036,7 @@ var FirecrawlApp = class {
2036
2036
  if (typeof process !== "undefined" && process.env && process.env.npm_package_version) {
2037
2037
  return process.env.npm_package_version;
2038
2038
  }
2039
- const packageJson = await import("./package-YDTOLYXI.js");
2039
+ const packageJson = await import("./package-WSP46L7M.js");
2040
2040
  return packageJson.default.version;
2041
2041
  } catch (error) {
2042
2042
  const isTest = typeof process !== "undefined" && (process.env.JEST_WORKER_ID != null || false);
@@ -2862,6 +2862,7 @@ var FirecrawlApp = class {
2862
2862
  * @param onActivity - Optional callback to receive activity updates in real-time.
2863
2863
  * @param onSource - Optional callback to receive source updates in real-time.
2864
2864
  * @returns The final research results.
2865
+ * @deprecated /v1/deep-research is deprecated. Use /v2/search instead.
2865
2866
  */
2866
2867
  async deepResearch(query, params, onActivity, onSource) {
2867
2868
  try {
@@ -2918,6 +2919,7 @@ var FirecrawlApp = class {
2918
2919
  * Initiates a deep research operation on a given query without polling.
2919
2920
  * @param params - Parameters for the deep research operation.
2920
2921
  * @returns The response containing the research job ID.
2922
+ * @deprecated /v1/deep-research is deprecated. Use /v2/search instead.
2921
2923
  */
2922
2924
  async asyncDeepResearch(query, params) {
2923
2925
  const headers = this.prepareHeaders();
@@ -2955,6 +2957,7 @@ var FirecrawlApp = class {
2955
2957
  * Checks the status of a deep research operation.
2956
2958
  * @param id - The ID of the deep research operation.
2957
2959
  * @returns The current status and results of the research operation.
2960
+ * @deprecated /v1/deep-research is deprecated. Use /v2/search instead.
2958
2961
  */
2959
2962
  async checkDeepResearchStatus(id) {
2960
2963
  const headers = this.prepareHeaders();
@@ -3093,6 +3096,7 @@ var FirecrawlApp = class {
3093
3096
  * @param url - The URL to generate LLMs.txt from.
3094
3097
  * @param params - Parameters for the LLMs.txt generation operation.
3095
3098
  * @returns The final generation results.
3099
+ * @deprecated /v1/llmstxt is deprecated and will not be replaced.
3096
3100
  */
3097
3101
  async generateLLMsText(url, params) {
3098
3102
  try {
@@ -3134,6 +3138,7 @@ var FirecrawlApp = class {
3134
3138
  * @param url - The URL to generate LLMs.txt from.
3135
3139
  * @param params - Parameters for the LLMs.txt generation operation.
3136
3140
  * @returns The response containing the generation job ID.
3141
+ * @deprecated /v1/llmstxt is deprecated and will not be replaced.
3137
3142
  */
3138
3143
  async asyncGenerateLLMsText(url, params) {
3139
3144
  const headers = this.prepareHeaders();
@@ -3162,6 +3167,7 @@ var FirecrawlApp = class {
3162
3167
  * Checks the status of a LLMs.txt generation operation.
3163
3168
  * @param id - The ID of the LLMs.txt generation operation.
3164
3169
  * @returns The current status and results of the generation operation.
3170
+ * @deprecated /v1/llmstxt is deprecated and will not be replaced.
3165
3171
  */
3166
3172
  async checkGenerateLLMsTextStatus(id) {
3167
3173
  const headers = this.prepareHeaders();
@@ -1,4 +1,4 @@
1
1
  import {
2
2
  require_package
3
- } from "./chunk-WTZQ5IMF.js";
3
+ } from "./chunk-HGRZHWZU.js";
4
4
  export default require_package();
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "firecrawl",
3
- "version": "4.22.1",
3
+ "version": "4.22.2",
4
4
  "description": "JavaScript SDK for Firecrawl API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
package/src/v1/index.ts CHANGED
@@ -363,6 +363,8 @@ export interface ExtractResponse<LLMSchema extends zt.ZodSchema = any> {
363
363
  data: LLMSchema;
364
364
  error?: string;
365
365
  warning?: string;
366
+ warnings?: string[];
367
+ replacement?: string;
366
368
  sources?: string[];
367
369
  creditsUsed?: number;
368
370
  }
@@ -490,6 +492,8 @@ export interface DeepResearchParams<LLMSchema extends zt.ZodSchema = any> {
490
492
  export interface DeepResearchResponse {
491
493
  success: boolean;
492
494
  id: string;
495
+ warnings?: string[];
496
+ replacement?: string;
493
497
  }
494
498
 
495
499
  /**
@@ -530,6 +534,8 @@ export interface DeepResearchStatusResponse {
530
534
  description: string;
531
535
  }>;
532
536
  summaries: string[];
537
+ warnings?: string[];
538
+ replacement?: string;
533
539
  }
534
540
 
535
541
  /**
@@ -563,6 +569,8 @@ export interface GenerateLLMsTextParams {
563
569
  export interface GenerateLLMsTextResponse {
564
570
  success: boolean;
565
571
  id: string;
572
+ warnings?: string[];
573
+ replacement?: string;
566
574
  }
567
575
 
568
576
  /**
@@ -577,6 +585,8 @@ export interface GenerateLLMsTextStatusResponse {
577
585
  status: "processing" | "completed" | "failed";
578
586
  error?: string;
579
587
  expiresAt: string;
588
+ warnings?: string[];
589
+ replacement?: string;
580
590
  }
581
591
 
582
592
  /**
@@ -1626,6 +1636,7 @@ export default class FirecrawlApp {
1626
1636
  * @param onActivity - Optional callback to receive activity updates in real-time.
1627
1637
  * @param onSource - Optional callback to receive source updates in real-time.
1628
1638
  * @returns The final research results.
1639
+ * @deprecated /v1/deep-research is deprecated. Use /v2/search instead.
1629
1640
  */
1630
1641
  async deepResearch(
1631
1642
  query: string,
@@ -1713,6 +1724,7 @@ export default class FirecrawlApp {
1713
1724
  * Initiates a deep research operation on a given query without polling.
1714
1725
  * @param params - Parameters for the deep research operation.
1715
1726
  * @returns The response containing the research job ID.
1727
+ * @deprecated /v1/deep-research is deprecated. Use /v2/search instead.
1716
1728
  */
1717
1729
  async asyncDeepResearch(query: string, params: DeepResearchParams<zt.ZodSchema>): Promise<DeepResearchResponse | ErrorResponse> {
1718
1730
  const headers = this.prepareHeaders();
@@ -1754,6 +1766,7 @@ export default class FirecrawlApp {
1754
1766
  * Checks the status of a deep research operation.
1755
1767
  * @param id - The ID of the deep research operation.
1756
1768
  * @returns The current status and results of the research operation.
1769
+ * @deprecated /v1/deep-research is deprecated. Use /v2/search instead.
1757
1770
  */
1758
1771
  async checkDeepResearchStatus(id: string): Promise<DeepResearchStatusResponse | ErrorResponse> {
1759
1772
  const headers = this.prepareHeaders();
@@ -1921,6 +1934,7 @@ export default class FirecrawlApp {
1921
1934
  * @param url - The URL to generate LLMs.txt from.
1922
1935
  * @param params - Parameters for the LLMs.txt generation operation.
1923
1936
  * @returns The final generation results.
1937
+ * @deprecated /v1/llmstxt is deprecated and will not be replaced.
1924
1938
  */
1925
1939
  async generateLLMsText(url: string, params?: GenerateLLMsTextParams): Promise<GenerateLLMsTextStatusResponse | ErrorResponse> {
1926
1940
  try {
@@ -1973,6 +1987,7 @@ export default class FirecrawlApp {
1973
1987
  * @param url - The URL to generate LLMs.txt from.
1974
1988
  * @param params - Parameters for the LLMs.txt generation operation.
1975
1989
  * @returns The response containing the generation job ID.
1990
+ * @deprecated /v1/llmstxt is deprecated and will not be replaced.
1976
1991
  */
1977
1992
  async asyncGenerateLLMsText(url: string, params?: GenerateLLMsTextParams): Promise<GenerateLLMsTextResponse | ErrorResponse> {
1978
1993
  const headers = this.prepareHeaders();
@@ -2003,6 +2018,7 @@ export default class FirecrawlApp {
2003
2018
  * Checks the status of a LLMs.txt generation operation.
2004
2019
  * @param id - The ID of the LLMs.txt generation operation.
2005
2020
  * @returns The current status and results of the generation operation.
2021
+ * @deprecated /v1/llmstxt is deprecated and will not be replaced.
2006
2022
  */
2007
2023
  async checkGenerateLLMsTextStatus(id: string): Promise<GenerateLLMsTextStatusResponse | ErrorResponse> {
2008
2024
  const headers = this.prepareHeaders();
package/src/v2/types.ts CHANGED
@@ -777,6 +777,8 @@ export interface ExtractResponse {
777
777
  data?: unknown;
778
778
  error?: string;
779
779
  warning?: string;
780
+ warnings?: string[];
781
+ replacement?: string;
780
782
  sources?: Record<string, unknown>;
781
783
  expiresAt?: string;
782
784
  creditsUsed?: number;