@corsair-dev/litescrape 0.1.0 → 0.1.1

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 (45) hide show
  1. package/README.md +214 -26
  2. package/dist/client.d.ts +5 -1
  3. package/dist/client.d.ts.map +1 -1
  4. package/dist/docs-examples.test.d.ts +2 -0
  5. package/dist/docs-examples.test.d.ts.map +1 -0
  6. package/dist/endpoints/catalog.d.ts +2083 -0
  7. package/dist/endpoints/catalog.d.ts.map +1 -0
  8. package/dist/endpoints/index.d.ts +5 -1683
  9. package/dist/endpoints/index.d.ts.map +1 -1
  10. package/dist/endpoints/keys.d.ts +69 -2
  11. package/dist/endpoints/keys.d.ts.map +1 -1
  12. package/dist/endpoints/manifest.d.ts +51 -0
  13. package/dist/endpoints/manifest.d.ts.map +1 -0
  14. package/dist/endpoints/openapi-schema.d.ts +17 -0
  15. package/dist/endpoints/openapi-schema.d.ts.map +1 -0
  16. package/dist/endpoints/operation-types.d.ts +12023 -0
  17. package/dist/endpoints/operation-types.d.ts.map +1 -0
  18. package/dist/endpoints/operations.d.ts +12 -0
  19. package/dist/endpoints/operations.d.ts.map +1 -0
  20. package/dist/endpoints/types.d.ts +18 -3358
  21. package/dist/endpoints/types.d.ts.map +1 -1
  22. package/dist/index.d.ts +8 -1727
  23. package/dist/index.d.ts.map +1 -1
  24. package/dist/index.js +1 -1
  25. package/package.json +2 -2
  26. package/dist/endpoints/apple-app-store.d.ts +0 -5
  27. package/dist/endpoints/apple-app-store.d.ts.map +0 -1
  28. package/dist/endpoints/apple-maps.d.ts +0 -4
  29. package/dist/endpoints/apple-maps.d.ts.map +0 -1
  30. package/dist/endpoints/bing.d.ts +0 -4
  31. package/dist/endpoints/bing.d.ts.map +0 -1
  32. package/dist/endpoints/duckduckgo.d.ts +0 -4
  33. package/dist/endpoints/duckduckgo.d.ts.map +0 -1
  34. package/dist/endpoints/google-maps.d.ts +0 -8
  35. package/dist/endpoints/google-maps.d.ts.map +0 -1
  36. package/dist/endpoints/google-play.d.ts +0 -8
  37. package/dist/endpoints/google-play.d.ts.map +0 -1
  38. package/dist/endpoints/google.d.ts +0 -9
  39. package/dist/endpoints/google.d.ts.map +0 -1
  40. package/dist/endpoints/tripadvisor.d.ts +0 -5
  41. package/dist/endpoints/tripadvisor.d.ts.map +0 -1
  42. package/dist/endpoints/web.d.ts +0 -4
  43. package/dist/endpoints/web.d.ts.map +0 -1
  44. package/dist/endpoints/yelp.d.ts +0 -4
  45. package/dist/endpoints/yelp.d.ts.map +0 -1
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../endpoints/index.ts"],"names":[],"mappings":"AAgDA,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAQlB,CAAC;AAEF,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOtB,CAAC;AAEF,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAGhB,CAAC;AAEF,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAGtB,CAAC;AAEF,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAGhB,CAAC;AAEF,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAIvB,CAAC;AAEF,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAGrB,CAAC;AAEF,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOtB,CAAC;AAEF,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAIzB,CAAC;AAEF,eAAO,MAAM,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAGf,CAAC;AAEF,eAAO,MAAM,IAAI;;;;;;;;;;;CAEhB,CAAC;AAEF,cAAc,SAAS,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../endpoints/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,sBAAsB,EACtB,yBAAyB,EACzB,yBAAyB,GACzB,MAAM,WAAW,CAAC;AACnB,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,EACN,wBAAwB,EACxB,yBAAyB,GACzB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AAC7D,OAAO,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC"}
@@ -1,3 +1,70 @@
1
- import type { LitescrapeEndpoints } from '..';
2
- export declare const status: LitescrapeEndpoints['keysStatus'];
1
+ import type { CorsairEndpoint } from 'corsair/core';
2
+ import { z } from 'zod';
3
+ import type { LitescrapeContext } from '../index';
4
+ export declare const KeysStatusInputSchema: z.ZodObject<{}, z.core.$strict>;
5
+ export declare const KeysStatusResponseSchema: z.ZodObject<{
6
+ remaining_calls: z.ZodNumber;
7
+ concurrency_limit: z.ZodNumber;
8
+ status: z.ZodString;
9
+ zdr_enabled: z.ZodOptional<z.ZodBoolean>;
10
+ zdr_available: z.ZodOptional<z.ZodBoolean>;
11
+ credit_expiry_months: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
12
+ credits_expire_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
13
+ expiring_calls: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
14
+ cents_per_1000_calls: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
15
+ }, z.core.$loose>;
16
+ export declare const KeysUsageInputSchema: z.ZodObject<{
17
+ range: z.ZodOptional<z.ZodEnum<{
18
+ "24h": "24h";
19
+ "7d": "7d";
20
+ "30d": "30d";
21
+ "90d": "90d";
22
+ }>>;
23
+ tz: z.ZodOptional<z.ZodString>;
24
+ }, z.core.$strict>;
25
+ export declare const KeysUsageResponseSchema: z.ZodObject<{
26
+ range: z.ZodOptional<z.ZodNullable<z.ZodString>>;
27
+ bucket: z.ZodOptional<z.ZodNullable<z.ZodString>>;
28
+ timezone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
29
+ since: z.ZodOptional<z.ZodNullable<z.ZodString>>;
30
+ until: z.ZodOptional<z.ZodNullable<z.ZodString>>;
31
+ totals: z.ZodOptional<z.ZodNullable<z.ZodObject<{
32
+ requests: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
33
+ succeeded: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
34
+ failed: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
35
+ pending: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
36
+ success_rate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
37
+ p50_ms: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
38
+ p95_ms: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
39
+ }, z.core.$loose>>>;
40
+ previous: z.ZodOptional<z.ZodNullable<z.ZodObject<{
41
+ requests: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
42
+ succeeded: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
43
+ failed: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
44
+ pending: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
45
+ success_rate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
46
+ p50_ms: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
47
+ p95_ms: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
48
+ }, z.core.$loose>>>;
49
+ series: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
50
+ requests: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
51
+ succeeded: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
52
+ failed: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
53
+ pending: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
54
+ success_rate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
55
+ p50_ms: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
56
+ p95_ms: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
57
+ bucket: z.ZodOptional<z.ZodNullable<z.ZodString>>;
58
+ }, z.core.$loose>>>>;
59
+ apis: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnknown>>>;
60
+ providers: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnknown>>>;
61
+ channels: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnknown>>>;
62
+ errors: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnknown>>>;
63
+ }, z.core.$loose>;
64
+ export type KeysStatusInput = z.infer<typeof KeysStatusInputSchema>;
65
+ export type KeysStatusResponse = z.infer<typeof KeysStatusResponseSchema>;
66
+ export type KeysUsageInput = z.infer<typeof KeysUsageInputSchema>;
67
+ export type KeysUsageResponse = z.infer<typeof KeysUsageResponseSchema>;
68
+ export declare const status: CorsairEndpoint<LitescrapeContext, KeysStatusInput, KeysStatusResponse>;
69
+ export declare const usage: CorsairEndpoint<LitescrapeContext, KeysUsageInput, KeysUsageResponse>;
3
70
  //# sourceMappingURL=keys.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"keys.d.ts","sourceRoot":"","sources":["../../endpoints/keys.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,IAAI,CAAC;AAU9C,eAAO,MAAM,MAAM,EAAE,mBAAmB,CAAC,YAAY,CAgBpD,CAAC"}
1
+ {"version":3,"file":"keys.d.ts","sourceRoot":"","sources":["../../endpoints/keys.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAEpD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAMlD,eAAO,MAAM,qBAAqB,iCAAwB,CAAC;AAE3D,eAAO,MAAM,wBAAwB;;;;;;;;;;iBAYtB,CAAC;AAEhB,eAAO,MAAM,oBAAoB;;;;;;;;kBAevB,CAAC;AAcX,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAmBrB,CAAC;AAEhB,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AACpE,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAClE,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE,eAAO,MAAM,MAAM,EAAE,eAAe,CACnC,iBAAiB,EACjB,eAAe,EACf,kBAAkB,CAalB,CAAC;AAEF,eAAO,MAAM,KAAK,EAAE,eAAe,CAClC,iBAAiB,EACjB,cAAc,EACd,iBAAiB,CAWjB,CAAC"}
@@ -0,0 +1,51 @@
1
+ import { z } from 'zod';
2
+ /**
3
+ * litescrape-manifest.json is Litescrape's published OpenAPI spec
4
+ * (https://api.litescrape.com/api/openapi.json) cut down to what this plugin
5
+ * uses: one entry per data operation with its request body schema inlined and
6
+ * its response pointing into `definitions` (identical response models merged).
7
+ * Each operation's `id` is its Corsair name (`amazon.search`).
8
+ *
9
+ * The manifest is not run through zod at import: that would copy ~1.3 MB of
10
+ * JSON into a second object graph on every load. `LitescrapeManifestSchema`
11
+ * checks the file in schema.test.ts instead.
12
+ */
13
+ declare const OpenApiSchemaDocument: z.ZodRecord<z.ZodString, z.ZodUnknown>;
14
+ declare const OperationSchema: z.ZodObject<{
15
+ id: z.ZodString;
16
+ method: z.ZodLiteral<"POST">;
17
+ path: z.ZodString;
18
+ tag: z.ZodString;
19
+ summary: z.ZodString;
20
+ description: z.ZodString;
21
+ alpha: z.ZodBoolean;
22
+ input: z.ZodRecord<z.ZodString, z.ZodUnknown>;
23
+ output: z.ZodObject<{
24
+ $ref: z.ZodString;
25
+ }, z.core.$strict>;
26
+ }, z.core.$strict>;
27
+ export declare const LitescrapeManifestSchema: z.ZodObject<{
28
+ source: z.ZodString;
29
+ operations: z.ZodArray<z.ZodObject<{
30
+ id: z.ZodString;
31
+ method: z.ZodLiteral<"POST">;
32
+ path: z.ZodString;
33
+ tag: z.ZodString;
34
+ summary: z.ZodString;
35
+ description: z.ZodString;
36
+ alpha: z.ZodBoolean;
37
+ input: z.ZodRecord<z.ZodString, z.ZodUnknown>;
38
+ output: z.ZodObject<{
39
+ $ref: z.ZodString;
40
+ }, z.core.$strict>;
41
+ }, z.core.$strict>>;
42
+ definitions: z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>>;
43
+ }, z.core.$strict>;
44
+ export type LitescrapeOperationDefinition = z.infer<typeof OperationSchema>;
45
+ export type LitescrapeOpenApiSchema = z.infer<typeof OpenApiSchemaDocument>;
46
+ type LitescrapeManifest = z.infer<typeof LitescrapeManifestSchema>;
47
+ export declare const litescrapeManifest: LitescrapeManifest;
48
+ export declare const litescrapeOperations: readonly LitescrapeOperationDefinition[];
49
+ export declare const litescrapeDefinitions: Record<string, LitescrapeOpenApiSchema>;
50
+ export {};
51
+ //# sourceMappingURL=manifest.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"manifest.d.ts","sourceRoot":"","sources":["../../endpoints/manifest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;;;;;;;;GAUG;AAGH,QAAA,MAAM,qBAAqB,wCAAoC,CAAC;AAEhE,QAAA,MAAM,eAAe;;;;;;;;;;;;kBAYX,CAAC;AAEX,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;kBAM3B,CAAC;AAEX,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAC5E,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAC5E,KAAK,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAGnE,eAAO,MAAM,kBAAkB,EAEO,kBAAkB,CAAC;AAEzD,eAAO,MAAM,oBAAoB,EAAE,SAAS,6BAA6B,EAC3C,CAAC;AAE/B,eAAO,MAAM,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAC3C,CAAC"}
@@ -0,0 +1,17 @@
1
+ import { z } from 'zod';
2
+ import type { LitescrapeOpenApiSchema, LitescrapeOperationDefinition } from './manifest';
3
+ export declare function litescrapeOperationFor(id: string): LitescrapeOperationDefinition;
4
+ export declare function getLitescrapeInputSchema(id: string): z.ZodType<Record<string, unknown>>;
5
+ export declare function getLitescrapeOutputSchema(id: string): z.ZodType;
6
+ /** `input` and `output` are getters, so a schema is built only when something reads it. */
7
+ export declare function litescrapeSchemaEntry(id: string): {
8
+ readonly input: z.ZodType;
9
+ readonly output: z.ZodType;
10
+ };
11
+ /** Every manifest operation's schemas by id. Reading a key builds that schema (then cached). */
12
+ export declare const litescrapeInputSchemas: Readonly<Record<string, z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
13
+ export declare const litescrapeOutputSchemas: Readonly<Record<string, z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
14
+ /** Names of input fields the API reads from the query string (`timeout`). */
15
+ export declare function litescrapeQueryFields(id: string): string[];
16
+ export type { LitescrapeOpenApiSchema, LitescrapeOperationDefinition };
17
+ //# sourceMappingURL=openapi-schema.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"openapi-schema.d.ts","sourceRoot":"","sources":["../../endpoints/openapi-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,KAAK,EACX,uBAAuB,EACvB,6BAA6B,EAC7B,MAAM,YAAY,CAAC;AA4NpB,wBAAgB,sBAAsB,CACrC,EAAE,EAAE,MAAM,GACR,6BAA6B,CAI/B;AAGD,wBAAgB,wBAAwB,CACvC,EAAE,EAAE,MAAM,GACR,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAWpC;AAED,wBAAgB,yBAAyB,CAAC,EAAE,EAAE,MAAM,GAAG,CAAC,CAAC,OAAO,CAa/D;AAED,2FAA2F;AAC3F,wBAAgB,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG;IAClD,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC;CAC3B,CASA;AAeD,gGAAgG;AAChG,eAAO,MAAM,sBAAsB,mGAAuC,CAAC;AAC3E,eAAO,MAAM,uBAAuB,mGAAwC,CAAC;AAE7E,6EAA6E;AAC7E,wBAAgB,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAS1D;AAED,YAAY,EAAE,uBAAuB,EAAE,6BAA6B,EAAE,CAAC"}