Skip to content

Commit 892e1c3

Browse files
sebastianqueksebastianquek
committed
Refine type exports
- Export engine params directly from `mod.ts` rather than in `engines/index.d.ts` - Rename `engines/index.d.ts` to `engines/engine_map.d.ts` since it only exports the EngineMap type
1 parent 90e1f80 commit 892e1c3

5 files changed

Lines changed: 56 additions & 109 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ and this project adheres to
1212

1313
### Changed
1414

15+
- Refine type exports.
16+
1517
### Fixed
1618

1719
### Removed

‎CONTRIBUTING.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ update the types.
8383
1. Run `bundle exec rails sdk:generate_ts_types` in the backend repository.
8484
2. Replace everything in `src/engines` with the generated files from
8585
`tmp/ts/engines`.
86+
3. Update `mod.ts` with the new engine exports from `tmp/ts/mod.ts`.
8687

8788
## Get approval
8889

‎mod.ts‎

Lines changed: 52 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -20,58 +20,55 @@ export {
2020
getLocations,
2121
} from "./src/serpapi.ts";
2222

23-
export type {
24-
AppleAppStoreParameters,
25-
AppleProductParameters,
26-
AppleReviewsParameters,
27-
BaiduNewsParameters,
28-
BaiduParameters,
29-
BingImagesParameters,
30-
BingNewsParameters,
31-
BingParameters,
32-
DuckduckgoParameters,
33-
EbayParameters,
34-
EngineMap,
35-
GoogleAboutThisResultParameters,
36-
GoogleAutocompleteParameters,
37-
GoogleEventsParameters,
38-
GoogleFinanceMarketsParameters,
39-
GoogleImmersiveProductParameters,
40-
GoogleJobsListingParameters,
41-
GoogleJobsParameters,
42-
GoogleLensParameters,
43-
GoogleLocalServicesParameters,
44-
GoogleMapsParameters,
45-
GoogleMapsPhotosParameters,
46-
GoogleMapsReviewsParameters,
47-
GoogleParameters,
48-
GooglePlayParameters,
49-
GooglePlayProductParameters,
50-
GoogleProductParameters,
51-
GoogleRelatedQuestionsParameters,
52-
GoogleReverseImageParameters,
53-
GoogleScholarAuthorParameters,
54-
GoogleScholarCiteParameters,
55-
GoogleScholarParameters,
56-
GoogleScholarProfilesParameters,
57-
GoogleTrendsAutocompleteParameters,
58-
GoogleTrendsParameters,
59-
HomeDepotParameters,
60-
HomeDepotProductParameters,
61-
LinkedinParameters,
62-
LinkedinProfileParameters,
63-
NaverParameters,
64-
WalmartParameters,
65-
WalmartProductParameters,
66-
WalmartProductReviewsParameters,
67-
YahooImagesParameters,
68-
YahooParameters,
69-
YahooShoppingParameters,
70-
YahooVideosParameters,
71-
YandexImagesParameters,
72-
YandexParameters,
73-
YandexVideosParameters,
74-
YelpParameters,
75-
YelpReviewsParameters,
76-
YoutubeParameters,
77-
} from "./src/engines/index.d.ts";
23+
export type { GoogleParameters } from "./src/engines/google.d.ts";
24+
export type { GoogleJobsParameters } from "./src/engines/google_jobs.d.ts";
25+
export type { GoogleJobsListingParameters } from "./src/engines/google_jobs_listing.d.ts";
26+
export type { GoogleReverseImageParameters } from "./src/engines/google_reverse_image.d.ts";
27+
export type { GoogleScholarProfilesParameters } from "./src/engines/google_scholar_profiles.d.ts";
28+
export type { GoogleScholarParameters } from "./src/engines/google_scholar.d.ts";
29+
export type { GoogleScholarCiteParameters } from "./src/engines/google_scholar_cite.d.ts";
30+
export type { GoogleScholarAuthorParameters } from "./src/engines/google_scholar_author.d.ts";
31+
export type { GoogleProductParameters } from "./src/engines/google_product.d.ts";
32+
export type { GoogleMapsParameters } from "./src/engines/google_maps.d.ts";
33+
export type { GoogleMapsPhotosParameters } from "./src/engines/google_maps_photos.d.ts";
34+
export type { GoogleMapsReviewsParameters } from "./src/engines/google_maps_reviews.d.ts";
35+
export type { GoogleEventsParameters } from "./src/engines/google_events.d.ts";
36+
export type { GoogleAutocompleteParameters } from "./src/engines/google_autocomplete.d.ts";
37+
export type { GoogleRelatedQuestionsParameters } from "./src/engines/google_related_questions.d.ts";
38+
export type { GoogleTrendsParameters } from "./src/engines/google_trends.d.ts";
39+
export type { GoogleTrendsAutocompleteParameters } from "./src/engines/google_trends_autocomplete.d.ts";
40+
export type { GoogleFinanceMarketsParameters } from "./src/engines/google_finance_markets.d.ts";
41+
export type { GoogleImmersiveProductParameters } from "./src/engines/google_immersive_product.d.ts";
42+
export type { BingParameters } from "./src/engines/bing.d.ts";
43+
export type { BingNewsParameters } from "./src/engines/bing_news.d.ts";
44+
export type { BingImagesParameters } from "./src/engines/bing_images.d.ts";
45+
export type { BaiduParameters } from "./src/engines/baidu.d.ts";
46+
export type { BaiduNewsParameters } from "./src/engines/baidu_news.d.ts";
47+
export type { YahooParameters } from "./src/engines/yahoo.d.ts";
48+
export type { YahooImagesParameters } from "./src/engines/yahoo_images.d.ts";
49+
export type { YahooVideosParameters } from "./src/engines/yahoo_videos.d.ts";
50+
export type { YahooShoppingParameters } from "./src/engines/yahoo_shopping.d.ts";
51+
export type { EbayParameters } from "./src/engines/ebay.d.ts";
52+
export type { YandexParameters } from "./src/engines/yandex.d.ts";
53+
export type { YandexImagesParameters } from "./src/engines/yandex_images.d.ts";
54+
export type { YandexVideosParameters } from "./src/engines/yandex_videos.d.ts";
55+
export type { YoutubeParameters } from "./src/engines/youtube.d.ts";
56+
export type { WalmartParameters } from "./src/engines/walmart.d.ts";
57+
export type { WalmartProductParameters } from "./src/engines/walmart_product.d.ts";
58+
export type { WalmartProductReviewsParameters } from "./src/engines/walmart_product_reviews.d.ts";
59+
export type { HomeDepotParameters } from "./src/engines/home_depot.d.ts";
60+
export type { HomeDepotProductParameters } from "./src/engines/home_depot_product.d.ts";
61+
export type { LinkedinParameters } from "./src/engines/linkedin.d.ts";
62+
export type { LinkedinProfileParameters } from "./src/engines/linkedin_profile.d.ts";
63+
export type { DuckduckgoParameters } from "./src/engines/duckduckgo.d.ts";
64+
export type { GooglePlayProductParameters } from "./src/engines/google_play_product.d.ts";
65+
export type { GooglePlayParameters } from "./src/engines/google_play.d.ts";
66+
export type { AppleAppStoreParameters } from "./src/engines/apple_app_store.d.ts";
67+
export type { AppleReviewsParameters } from "./src/engines/apple_reviews.d.ts";
68+
export type { AppleProductParameters } from "./src/engines/apple_product.d.ts";
69+
export type { NaverParameters } from "./src/engines/naver.d.ts";
70+
export type { GoogleLensParameters } from "./src/engines/google_lens.d.ts";
71+
export type { GoogleLocalServicesParameters } from "./src/engines/google_local_services.d.ts";
72+
export type { GoogleAboutThisResultParameters } from "./src/engines/google_about_this_result.d.ts";
73+
export type { YelpParameters } from "./src/engines/yelp.d.ts";
74+
export type { YelpReviewsParameters } from "./src/engines/yelp_reviews.d.ts";

src/engines/index.d.ts renamed to src/engines/engine_map.d.ts

Lines changed: 0 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -51,59 +51,6 @@ import type { GoogleAboutThisResultParameters } from "./google_about_this_result
5151
import type { YelpParameters } from "./yelp.d.ts";
5252
import type { YelpReviewsParameters } from "./yelp_reviews.d.ts";
5353

54-
export type { GoogleParameters } from "./google.d.ts";
55-
export type { GoogleJobsParameters } from "./google_jobs.d.ts";
56-
export type { GoogleJobsListingParameters } from "./google_jobs_listing.d.ts";
57-
export type { GoogleReverseImageParameters } from "./google_reverse_image.d.ts";
58-
export type { GoogleScholarProfilesParameters } from "./google_scholar_profiles.d.ts";
59-
export type { GoogleScholarParameters } from "./google_scholar.d.ts";
60-
export type { GoogleScholarCiteParameters } from "./google_scholar_cite.d.ts";
61-
export type { GoogleScholarAuthorParameters } from "./google_scholar_author.d.ts";
62-
export type { GoogleProductParameters } from "./google_product.d.ts";
63-
export type { GoogleMapsParameters } from "./google_maps.d.ts";
64-
export type { GoogleMapsPhotosParameters } from "./google_maps_photos.d.ts";
65-
export type { GoogleMapsReviewsParameters } from "./google_maps_reviews.d.ts";
66-
export type { GoogleEventsParameters } from "./google_events.d.ts";
67-
export type { GoogleAutocompleteParameters } from "./google_autocomplete.d.ts";
68-
export type { GoogleRelatedQuestionsParameters } from "./google_related_questions.d.ts";
69-
export type { GoogleTrendsParameters } from "./google_trends.d.ts";
70-
export type { GoogleTrendsAutocompleteParameters } from "./google_trends_autocomplete.d.ts";
71-
export type { GoogleFinanceMarketsParameters } from "./google_finance_markets.d.ts";
72-
export type { GoogleImmersiveProductParameters } from "./google_immersive_product.d.ts";
73-
export type { BingParameters } from "./bing.d.ts";
74-
export type { BingNewsParameters } from "./bing_news.d.ts";
75-
export type { BingImagesParameters } from "./bing_images.d.ts";
76-
export type { BaiduParameters } from "./baidu.d.ts";
77-
export type { BaiduNewsParameters } from "./baidu_news.d.ts";
78-
export type { YahooParameters } from "./yahoo.d.ts";
79-
export type { YahooImagesParameters } from "./yahoo_images.d.ts";
80-
export type { YahooVideosParameters } from "./yahoo_videos.d.ts";
81-
export type { YahooShoppingParameters } from "./yahoo_shopping.d.ts";
82-
export type { EbayParameters } from "./ebay.d.ts";
83-
export type { YandexParameters } from "./yandex.d.ts";
84-
export type { YandexImagesParameters } from "./yandex_images.d.ts";
85-
export type { YandexVideosParameters } from "./yandex_videos.d.ts";
86-
export type { YoutubeParameters } from "./youtube.d.ts";
87-
export type { WalmartParameters } from "./walmart.d.ts";
88-
export type { WalmartProductParameters } from "./walmart_product.d.ts";
89-
export type { WalmartProductReviewsParameters } from "./walmart_product_reviews.d.ts";
90-
export type { HomeDepotParameters } from "./home_depot.d.ts";
91-
export type { HomeDepotProductParameters } from "./home_depot_product.d.ts";
92-
export type { LinkedinParameters } from "./linkedin.d.ts";
93-
export type { LinkedinProfileParameters } from "./linkedin_profile.d.ts";
94-
export type { DuckduckgoParameters } from "./duckduckgo.d.ts";
95-
export type { GooglePlayProductParameters } from "./google_play_product.d.ts";
96-
export type { GooglePlayParameters } from "./google_play.d.ts";
97-
export type { AppleAppStoreParameters } from "./apple_app_store.d.ts";
98-
export type { AppleReviewsParameters } from "./apple_reviews.d.ts";
99-
export type { AppleProductParameters } from "./apple_product.d.ts";
100-
export type { NaverParameters } from "./naver.d.ts";
101-
export type { GoogleLensParameters } from "./google_lens.d.ts";
102-
export type { GoogleLocalServicesParameters } from "./google_local_services.d.ts";
103-
export type { GoogleAboutThisResultParameters } from "./google_about_this_result.d.ts";
104-
export type { YelpParameters } from "./yelp.d.ts";
105-
export type { YelpReviewsParameters } from "./yelp_reviews.d.ts";
106-
10754
export type EngineMap = {
10855
google: { parameters: GoogleParameters };
10956
google_jobs: { parameters: GoogleJobsParameters };

‎src/serpapi.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import {
66
Locations,
77
LocationsApiParameters,
88
} from "./types.d.ts";
9-
import { EngineMap } from "./engines/index.d.ts";
9+
import { EngineMap } from "./engines/engine_map.d.ts";
1010
import { _internals, execute } from "./utils.ts";
1111
import { validateApiKey, validateTimeout } from "./validators.ts";
1212

0 commit comments

Comments
 (0)