@pipe0/ops 0.0.5 → 0.0.6

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 (49) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/README.md +47 -34
  3. package/dist/fields/field-catalog.d.ts +15 -0
  4. package/dist/fields/json-meta/fields/person-reverse-match.d.ts +1 -0
  5. package/dist/fields/types.d.ts +1 -0
  6. package/dist/index.d.ts +2 -0
  7. package/dist/index.js +3333 -2858
  8. package/dist/pipes/catalog/entries/company-identity-2.d.ts +4 -4
  9. package/dist/pipes/catalog/entries/company-lookalikes-companyenrich-1.d.ts +4 -4
  10. package/dist/pipes/catalog/entries/company-match-logodev-1.d.ts +4 -4
  11. package/dist/pipes/catalog/entries/company-newssummary-website-1.d.ts +4 -4
  12. package/dist/pipes/catalog/entries/company-overview-2.d.ts +8 -8
  13. package/dist/pipes/catalog/entries/company-techstack-builtwith-1.d.ts +8 -8
  14. package/dist/pipes/catalog/entries/company-websiteurl-email-1.d.ts +4 -4
  15. package/dist/pipes/catalog/entries/deprecated/company-identity-1.d.ts +4 -4
  16. package/dist/pipes/catalog/entries/deprecated/company-overview-1.d.ts +8 -8
  17. package/dist/pipes/catalog/entries/deprecated/people-mobile-number-professional-profile-waterfall-1.d.ts +8 -8
  18. package/dist/pipes/catalog/entries/deprecated/people-mobile-number-work-email-waterfall-1.d.ts +9 -9
  19. package/dist/pipes/catalog/entries/deprecated/people-professionalprofile-waterfall-1.d.ts +5 -5
  20. package/dist/pipes/catalog/entries/deprecated/people-professionalprofileurl-email-waterfall-1.d.ts +8 -8
  21. package/dist/pipes/catalog/entries/people-email-iswork-1.d.ts +4 -4
  22. package/dist/pipes/catalog/entries/people-identity-email-waterfall-1.d.ts +305 -0
  23. package/dist/pipes/catalog/entries/people-match-role-waterfall-1.d.ts +4 -4
  24. package/dist/pipes/catalog/entries/people-name-join-1.d.ts +8 -8
  25. package/dist/pipes/catalog/entries/people-name-split-1.d.ts +4 -4
  26. package/dist/pipes/catalog/entries/people-personalemail-profile-waterfall-1.d.ts +8 -8
  27. package/dist/pipes/catalog/entries/people-phone-profile-waterfall-1.d.ts +27 -11
  28. package/dist/pipes/catalog/entries/people-phone-workemail-waterfall-1.d.ts +9 -9
  29. package/dist/pipes/catalog/entries/people-posts-crustdata-1.d.ts +4 -4
  30. package/dist/pipes/catalog/entries/people-profile-waterfall-1.d.ts +5 -5
  31. package/dist/pipes/catalog/entries/people-profile-workemail-curstdata-1.d.ts +220 -0
  32. package/dist/pipes/catalog/entries/people-profileurl-email-waterfall-1.d.ts +8 -8
  33. package/dist/pipes/catalog/entries/people-workemail-profileurl-waterfall-1.d.ts +295 -0
  34. package/dist/pipes/catalog/entries/people-workemail-waterfall-1.d.ts +41 -7
  35. package/dist/pipes/catalog/pipe.d.ts +4 -4
  36. package/dist/pipes/catalog/pipes-catalog.d.ts +1640 -302
  37. package/dist/pipes/catalog/utils/get-pipe-instances.d.ts +2 -2
  38. package/dist/pipes/catalog/utils/index.d.ts +34 -34
  39. package/dist/pipes/providers/provider-catalog.d.ts +12 -0
  40. package/dist/pipes/providers/provider-utils.d.ts +34 -22
  41. package/dist/pipes/utils/pipes-utils.d.ts +30 -30
  42. package/dist/pipes/utils/schemas-primitives.d.ts +55 -1
  43. package/dist/pipes/utils/sheet-schemas-primitives.d.ts +751 -13
  44. package/dist/searches/catalog/entries/people-profiles-clado-2.d.ts +1 -1
  45. package/dist/searches/catalog/searches-catalog.d.ts +20 -2
  46. package/dist/utils/connection-id.d.ts +1 -1
  47. package/dist/utils/get-domain.d.ts +1 -0
  48. package/dist/utils/schemas.d.ts +4 -2
  49. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # @pipe0/ops
2
2
 
3
+ ## 0.0.6
4
+
5
+ ### Patch Changes
6
+
7
+ - 106b4b1: Add new waterfall pipes
8
+ - Updated dependencies [106b4b1]
9
+ - @pipe0/client@0.0.9
10
+
3
11
  ## 0.0.5
4
12
 
5
13
  ### Patch Changes
package/README.md CHANGED
@@ -15,51 +15,64 @@ Here are some things pipe0 does for you:
15
15
  - 💨 Analyze enrichment pipelines and parallelize execution (we're fast!)
16
16
  - 💰 Run enrichment, scraping and AI infrastructure at low cost (we take 0% margin on external providers)
17
17
 
18
- ## Browser SDK
18
+ ## Client Library
19
19
 
20
- This package contains the browser SDK for [pipe0](https://pipe0.com). It is written in TypeScript and contains
21
- many useful types and utilities for building [UI-based apps](https://pipe0.com/resources/documentation/ui-apps)
22
- based on pipe0.
20
+ This package contains a strongly typed client for [pipe0](https://pipe0.com).
23
21
 
24
- ## Quckstart
22
+ ## Pipes (Enrichment)
25
23
 
26
- The main way to interact with the SDK is the `Pipe0` class. Use it like this.
24
+ Perform enrichments and actions. See [pipes catalog](https://www.pipe0.com/resources/pipe-catalog) to find all available pipes.
27
25
 
28
26
  ```typescript
29
- export const pipe0 = new Pipe0({ url: YOUR_SERVER_URL });
30
-
31
- const req = pipe0.request
32
- .create({
33
- pipes: initialPipeList,
34
- input: initialInput,
35
- fieldAnnotations,
36
- })
37
- .validate()
38
- .getResponse();
39
-
40
- const res = await req.send();
27
+ import { Pipe0 } from "@pipe0/client";
28
+
29
+ const client = new Pipe0({ apiKey: API_KEY });
30
+
31
+ const data = await client.pipes.pipe({
32
+ config: {
33
+ environment: "sandbox",
34
+ },
35
+ pipes: [
36
+ {
37
+ pipe_id: "people:name:split@1",
38
+ },
39
+ ],
40
+ input: [
41
+ {
42
+ id: "1",
43
+ name: "John Doe",
44
+ },
45
+ ],
46
+ });
41
47
  ```
42
48
 
43
- ## What makes a framework?
49
+ ## Search
44
50
 
45
- The term `framework` may surprise you because pipe0 is an API, dashboard, and SDK.
51
+ Find companies and people. See [search catalog](https://www.pipe0.com/resources/search-catalog) to find all available searches.
46
52
 
47
- While you can perform powerful enrichments in just 10 lines of code, you can choose to express logic and direction of data flow
48
- with it, too.
49
-
50
- The following is an example of an enrichment flow that requires logic.
51
-
52
- ```text filename="Flow that needs logic"
53
- FIND phone number of person
54
- IF found
55
- FIND website of current employer
56
- IF NOT found
57
- FIND work email address
53
+ ```typescript
54
+ import { Pipe0 } from "@pipe0/client";
55
+
56
+ const piper = new Pipe0({ apiKey: API_KEY });
57
+
58
+ const data = await piper.searches.search({
59
+ config: {
60
+ environment: "sandbox",
61
+ },
62
+ searches: [
63
+ {
64
+ search_id: "people:profiles:exa@1",
65
+ config: {
66
+ limit: 1,
67
+ filters: {
68
+ query: "Find all employees of pipe0",
69
+ },
70
+ },
71
+ },
72
+ ],
73
+ });
58
74
  ```
59
75
 
60
- Your first instinct might be to implement this with code. However, pipe0 offers a much simpler way to express this
61
- and removes brittle spaghetti code once and for all.
62
-
63
76
  ## Useful links
64
77
 
65
78
  - [Documentation](https://pipe0.com/resources/documentation)
@@ -2581,6 +2581,13 @@ export declare const fieldCatalog: {
2581
2581
  };
2582
2582
  };
2583
2583
  };
2584
+ readonly crustdata_profile_match_score: {
2585
+ readonly label: "Match score";
2586
+ readonly type: "number";
2587
+ readonly format: "decimal";
2588
+ readonly description: "A number between 1 and 0 indicating the confidence that the profile belongs to the input email address.";
2589
+ readonly jsonMeta: null;
2590
+ };
2584
2591
  readonly crustdata_company_match: {
2585
2592
  readonly label: "Company match";
2586
2593
  readonly type: "json";
@@ -3334,6 +3341,7 @@ export declare const fieldBehaviorCatalog: {
3334
3341
  } | undefined;
3335
3342
  };
3336
3343
  };
3344
+ crustdata_profile_match_score: {};
3337
3345
  is_email_valid: {};
3338
3346
  profile_url: {
3339
3347
  getStaticWidgets(v: string | number | boolean | Record<string, unknown> | unknown[] | null): {
@@ -6095,6 +6103,13 @@ export declare function getField<T extends FieldName>(fieldName: T): {
6095
6103
  };
6096
6104
  };
6097
6105
  };
6106
+ readonly crustdata_profile_match_score: {
6107
+ readonly label: "Match score";
6108
+ readonly type: "number";
6109
+ readonly format: "decimal";
6110
+ readonly description: "A number between 1 and 0 indicating the confidence that the profile belongs to the input email address.";
6111
+ readonly jsonMeta: null;
6112
+ };
6098
6113
  readonly crustdata_company_match: {
6099
6114
  readonly label: "Company match";
6100
6115
  readonly type: "json";
@@ -0,0 +1 @@
1
+ export type EmailValidationStatus = "catch_all" | "invalid" | "valid" | "unkown";
package/dist/index.d.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  export * from "./fields/field-catalog.js";
2
+ export * from "./fields/types.js";
2
3
  export * from "./fields/utils/field-utils.js";
3
4
  export * from "./form-generation/fields.js";
4
5
  export * from "./form-generation/get-pipes-form-config.js";
@@ -37,6 +38,7 @@ export type { SearchCategory } from "./searches/catalog/types.js";
37
38
  export * from "./utils/catalog-utils.js";
38
39
  export { cleanObject } from "./utils/clean-object.js";
39
40
  export { cleanUrl, cleanWebsiteUrl } from "./utils/clean-url.js";
41
+ export { getDomain } from "./utils/get-domain.js";
40
42
  export { joinConnectionString, splitConnectionString, } from "./utils/connection-id.js";
41
43
  export { type IconKey } from "./utils/icons.js";
42
44
  export { isEmptyValue } from "./utils/index.js";