@pipe0/client 0.0.5 → 0.0.7

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @pipe0/client
 
+## 0.0.7
+
+### Patch Changes
+
+- 6aaf957: Add new pipes and readme
+
+## 0.0.6
+
+### Patch Changes
+
+- 12c1b32: Change primitive names
+
 ## 0.0.5
 
 ### Patch Changes

package/README.md

@@ -15,51 +15,64 @@ Here are some things pipe0 does for you:
 - 💨 Analyze enrichment pipelines and parallelize execution (we're fast!)
 - 💰 Run enrichment, scraping and AI infrastructure at low cost (we take 0% margin on external providers)
 
-## Browser SDK
+## Client Library
 
-This package contains the browser SDK for [pipe0](https://pipe0.com). It is written in TypeScript and contains
-many useful types and utilities for building [UI-based apps](https://pipe0.com/resources/documentation/ui-apps)
-based on pipe0.
+This package contains a strongly typed client for [pipe0](https://pipe0.com).
 
-## Quckstart
+## Pipes (Enrichment)
 
-The main way to interact with the SDK is the `Pipe0` class. Use it like this.
+Perform enrichments and actions. See [pipes catalog](https://www.pipe0.com/resources/pipe-catalog) to find all available pipes.
 
 ```typescript
-export const pipe0 = new Pipe0({ url: YOUR_SERVER_URL });
-
-const req = pipe0.request
-  .create({
-    pipes: initialPipeList,
-    input: initialInput,
-    fieldAnnotations,
-  })
-  .validate()
-  .getResponse();
-
-const res = await req.send();
+import { Pipe0 } from "@pipe0/client";
+
+const piper = new Pipe0({ apiKey: API_KEY });
+
+const data = await piper.pipes.pipe({
+  config: {
+    environment: "sandbox",
+  },
+  pipes: [
+    {
+      pipe_id: "people:name:split@1",
+    },
+  ],
+  input: [
+    {
+      id: "1",
+      name: "John Doe",
+    },
+  ],
+});
 ```
 
-## What makes a framework?
+## Search
 
-The term `framework` may surprise you because pipe0 is an API, dashboard, and SDK.
+Find companies and people. See [search catalog](https://www.pipe0.com/resources/search-catalog) to find all available searches.
 
-While you can perform powerful enrichments in just 10 lines of code, you can choose to express logic and direction of data flow
-with it, too.
-
-The following is an example of an enrichment flow that requires logic.
-
-```text filename="Flow that needs logic"
-FIND phone number of person
-IF found
-    FIND website of current employer
-IF NOT found
-    FIND work email address
+```typescript
+import { Pipe0 } from "@pipe0/client";
+
+const piper = new Pipe0({ apiKey: API_KEY });
+
+const data = await piper.searches.search({
+  config: {
+    environment: "sandbox",
+  },
+  searches: [
+    {
+      search_id: "people:profiles:exa@1",
+      config: {
+        limit: 1,
+        filters: {
+          query: "Find all employees of pipe0",
+        },
+      },
+    },
+  ],
+});
 ```
 
-Your first instinct might be to implement this with code. However, pipe0 offers a much simpler way to express this
-and removes brittle spaghetti code once and for all.
-
 ## Useful links
 
 - [Documentation](https://pipe0.com/resources/documentation)

package/dist/generated/openapi.types.d.ts

@@ -7669,6 +7669,14 @@ export interface paths {
                                     type?: "string" | "number" | "boolean" | "json" | "unknown";
                                     /** @enum {string|null} */
                                     format?: "json_object" | "json_list" | "json_list_string" | "url" | "website_url" | "profile_url" | "email" | "datetime" | "currency" | "date" | "phone" | "markdown" | "text" | "int" | "decimal" | "address_line_1" | "zip_code" | "percent" | null;
+                                    resolved_by?: {
+                                        /** @enum {string|null} */
+                                        ref: "prompt:run@1" | "company:newssummary:website@1" | "company:techstack:builtwith@1" | "company:websiteurl:email@1" | "company:funding:leadmagic@1" | "people:workemail:waterfall@1" | "people:email:iswork@1" | "people:name:split@1" | "people:name:join@1" | "people:validate:email:zerobounce@1" | "people:email:validate:zerobounce@2" | "people:mobilenumber:workemail:waterfall@1" | "company:overview@1" | "company:overview@2" | "json:extract@1" | "email:write@1" | "message:write@1" | "email:send:resend@1" | "email:send:gmail@1" | "message:send:slack@1" | "template:fill@1" | "contact:create:resend@1" | "people:match:role:waterfall@1" | "company:identity@2" | "people:phone:profile:waterfall@1" | "people:personalemail:profile:waterfall@1" | "people:profile:waterfall@1" | "people:profileurl:email:waterfall@1" | "people:profileurl:name@1" | "people:email:validate:zerobounce@1" | "people:email:validate:millionverifier@1" | "people:phone:workemail:waterfall@1" | "fields:merge@1" | "website:scrape:firecrawl@1" | "website:scrapelist:firecrawl@1" | "website:extract:firecrawl@1" | "website:maplinks:firecrawl@1" | "sheet:append@1" | "sheet:expandappend@1" | "company:lookalikes:companyenrich@1" | "company:match:logodev@1" | "company:identity@1" | "people:professionalprofile:waterfall@1" | "people:professionalprofileurl:name@1" | "people:professionalprofileurl:email:waterfall@1" | "people:mobilenumber:professionalprofile:waterfall@1" | "input" | "system" | null;
+                                        /** @enum {string|null} */
+                                        environment: "production" | "sandbox" | null;
+                                        config_hash: string | null;
+                                        input_hash: string | null;
+                                    } | null;
                                     /** @description A map of widgets associated with this field for UI display, keyed by widget type. */
                                     widgets?: {
                                         display_value?: {
@@ -8600,6 +8608,14 @@ export interface paths {
                                     type?: "string" | "number" | "boolean" | "json" | "unknown";
                                     /** @enum {string|null} */
                                     format?: "json_object" | "json_list" | "json_list_string" | "url" | "website_url" | "profile_url" | "email" | "datetime" | "currency" | "date" | "phone" | "markdown" | "text" | "int" | "decimal" | "address_line_1" | "zip_code" | "percent" | null;
+                                    resolved_by?: {
+                                        /** @enum {string|null} */
+                                        ref: "prompt:run@1" | "company:newssummary:website@1" | "company:techstack:builtwith@1" | "company:websiteurl:email@1" | "company:funding:leadmagic@1" | "people:workemail:waterfall@1" | "people:email:iswork@1" | "people:name:split@1" | "people:name:join@1" | "people:validate:email:zerobounce@1" | "people:email:validate:zerobounce@2" | "people:mobilenumber:workemail:waterfall@1" | "company:overview@1" | "company:overview@2" | "json:extract@1" | "email:write@1" | "message:write@1" | "email:send:resend@1" | "email:send:gmail@1" | "message:send:slack@1" | "template:fill@1" | "contact:create:resend@1" | "people:match:role:waterfall@1" | "company:identity@2" | "people:phone:profile:waterfall@1" | "people:personalemail:profile:waterfall@1" | "people:profile:waterfall@1" | "people:profileurl:email:waterfall@1" | "people:profileurl:name@1" | "people:email:validate:zerobounce@1" | "people:email:validate:millionverifier@1" | "people:phone:workemail:waterfall@1" | "fields:merge@1" | "website:scrape:firecrawl@1" | "website:scrapelist:firecrawl@1" | "website:extract:firecrawl@1" | "website:maplinks:firecrawl@1" | "sheet:append@1" | "sheet:expandappend@1" | "company:lookalikes:companyenrich@1" | "company:match:logodev@1" | "company:identity@1" | "people:professionalprofile:waterfall@1" | "people:professionalprofileurl:name@1" | "people:professionalprofileurl:email:waterfall@1" | "people:mobilenumber:professionalprofile:waterfall@1" | "input" | "system" | null;
+                                        /** @enum {string|null} */
+                                        environment: "production" | "sandbox" | null;
+                                        config_hash: string | null;
+                                        input_hash: string | null;
+                                    } | null;
                                     /** @description A map of widgets associated with this field for UI display, keyed by widget type. */
                                     widgets?: {
                                         display_value?: {
@@ -9529,6 +9545,14 @@ export interface paths {
                                     type?: "string" | "number" | "boolean" | "json" | "unknown";
                                     /** @enum {string|null} */
                                     format?: "json_object" | "json_list" | "json_list_string" | "url" | "website_url" | "profile_url" | "email" | "datetime" | "currency" | "date" | "phone" | "markdown" | "text" | "int" | "decimal" | "address_line_1" | "zip_code" | "percent" | null;
+                                    resolved_by?: {
+                                        /** @enum {string|null} */
+                                        ref: "prompt:run@1" | "company:newssummary:website@1" | "company:techstack:builtwith@1" | "company:websiteurl:email@1" | "company:funding:leadmagic@1" | "people:workemail:waterfall@1" | "people:email:iswork@1" | "people:name:split@1" | "people:name:join@1" | "people:validate:email:zerobounce@1" | "people:email:validate:zerobounce@2" | "people:mobilenumber:workemail:waterfall@1" | "company:overview@1" | "company:overview@2" | "json:extract@1" | "email:write@1" | "message:write@1" | "email:send:resend@1" | "email:send:gmail@1" | "message:send:slack@1" | "template:fill@1" | "contact:create:resend@1" | "people:match:role:waterfall@1" | "company:identity@2" | "people:phone:profile:waterfall@1" | "people:personalemail:profile:waterfall@1" | "people:profile:waterfall@1" | "people:profileurl:email:waterfall@1" | "people:profileurl:name@1" | "people:email:validate:zerobounce@1" | "people:email:validate:millionverifier@1" | "people:phone:workemail:waterfall@1" | "fields:merge@1" | "website:scrape:firecrawl@1" | "website:scrapelist:firecrawl@1" | "website:extract:firecrawl@1" | "website:maplinks:firecrawl@1" | "sheet:append@1" | "sheet:expandappend@1" | "company:lookalikes:companyenrich@1" | "company:match:logodev@1" | "company:identity@1" | "people:professionalprofile:waterfall@1" | "people:professionalprofileurl:name@1" | "people:professionalprofileurl:email:waterfall@1" | "people:mobilenumber:professionalprofile:waterfall@1" | "input" | "system" | null;
+                                        /** @enum {string|null} */
+                                        environment: "production" | "sandbox" | null;
+                                        config_hash: string | null;
+                                        input_hash: string | null;
+                                    } | null;
                                     /** @description A map of widgets associated with this field for UI display, keyed by widget type. */
                                     widgets?: {
                                         display_value?: {

package/dist/index.d.ts

@@ -1 +1 @@
-export { Pipe0 } from "./pipe0.js";
+export * from "./pipe0.js";

package/dist/index.js

@@ -1 +1 @@
-export { Pipe0 } from "./pipe0.js";
+export * from "./pipe0.js";

package/dist/pipe0.d.ts

@@ -1,10 +1,10 @@
 import { type Client } from "openapi-fetch";
 import type { paths } from "./generated/openapi.types.js";
-export type PipesRequestPayload = paths["/v1/pipes/run"]["post"]["requestBody"]["content"]["application/json"];
+export type PipesRequest = paths["/v1/pipes/run"]["post"]["requestBody"]["content"]["application/json"];
 export type PipesResponse = paths["/v1/pipes/check/{run_id}"]["get"]["responses"]["200"]["content"]["application/json"];
-export type PiperSearchRequestPayload = paths["/v1/searches/run"]["post"]["requestBody"]["content"]["application/json"];
-export type PiperSearchResponse = paths["/v1/searches/check/{run_id}"]["get"]["responses"]["200"]["content"]["application/json"];
-export declare class PiperTimeoutError extends Error {
+export type SearchesRequest = paths["/v1/searches/run"]["post"]["requestBody"]["content"]["application/json"];
+export type SearchesResponse = paths["/v1/searches/check/{run_id}"]["get"]["responses"]["200"]["content"]["application/json"];
+export declare class Pipe0TimeoutError extends Error {
     readonly runId?: string | undefined;
     constructor(message: string, runId?: string | undefined);
 }
@@ -49,7 +49,7 @@ export interface BatchOptions {
      */
     signal?: AbortSignal;
 }
-export interface PiperOptions {
+export interface Pipe0Options {
     apiKey?: string;
     baseUrl?: string;
     /**
@@ -86,7 +86,7 @@ export declare class Pipe0 {
     private maxPollingIntervalMs;
     private defaultBatchSize;
     private maxConcurrentBatches;
-    constructor(options?: PiperOptions);
+    constructor(options?: Pipe0Options);
     /**
      * Centralized logic to poll until a task completes, fails, or times out.
      */
@@ -95,14 +95,14 @@ export declare class Pipe0 {
         /**
          * Create and immediately wait for completion (convenience method)
          */
-        pipe: (payload: PipesRequestPayload, options?: {
+        pipe: (payload: PipesRequest, options?: {
             onPoll?: (_response: PipesResponse) => unknown;
             signal?: AbortSignal;
         }) => Promise<PipesResponse>;
         /**
          * Create a pipes task but don't want for it. Use this method if you want to fire and forget.
          */
-        create: (payload: PipesRequestPayload) => Promise<string>;
+        create: (payload: PipesRequest) => Promise<string>;
         /**
          * Check the status of a pipes task manually.
          */
@@ -214,21 +214,21 @@ export declare class Pipe0 {
          * @param options - Batching options
          * @returns Array of completed batch responses
          */
-        pipeInBatches: (payload: PipesRequestPayload, { stopOnError, ...options }?: BatchOptions) => Promise<PipesResponse[]>;
+        pipeInBatches: (payload: PipesRequest, { stopOnError, ...options }?: BatchOptions) => Promise<PipesResponse[]>;
     };
     searches: {
         /**
          * Create and immediately wait for completion (convenience method)
          */
-        search: (payload: PiperSearchRequestPayload, options?: {
-            onPoll?: (_response: PiperSearchResponse) => unknown;
+        search: (payload: SearchesRequest, options?: {
+            onPoll?: (_response: SearchesResponse) => unknown;
             signal?: AbortSignal;
-        }) => Promise<PiperSearchResponse>;
+        }) => Promise<SearchesResponse>;
         /**
          * Create a searches task but don't wait for it.
          * Use this if you want fire and forget.
          */
-        create: (payload: PiperSearchRequestPayload) => Promise<string>;
+        create: (payload: SearchesRequest) => Promise<string>;
         /**
          * Check the status of a search task manually.
          */
@@ -243,6 +243,12 @@ export declare class Pipe0 {
                     status: "completed" | "failed" | "pending" | "queued" | "processing" | "no_result" | "skipped";
                     type?: "string" | "number" | "boolean" | "json" | "unknown";
                     format?: "json_object" | "json_list" | "json_list_string" | "url" | "website_url" | "profile_url" | "email" | "datetime" | "currency" | "date" | "phone" | "markdown" | "text" | "int" | "decimal" | "address_line_1" | "zip_code" | "percent" | null;
+                    resolved_by?: {
+                        ref: "prompt:run@1" | "company:newssummary:website@1" | "company:techstack:builtwith@1" | "company:websiteurl:email@1" | "company:funding:leadmagic@1" | "people:workemail:waterfall@1" | "people:email:iswork@1" | "people:name:split@1" | "people:name:join@1" | "people:validate:email:zerobounce@1" | "people:email:validate:zerobounce@2" | "people:mobilenumber:workemail:waterfall@1" | "company:overview@1" | "company:overview@2" | "json:extract@1" | "email:write@1" | "message:write@1" | "email:send:resend@1" | "email:send:gmail@1" | "message:send:slack@1" | "template:fill@1" | "contact:create:resend@1" | "people:match:role:waterfall@1" | "company:identity@2" | "people:phone:profile:waterfall@1" | "people:personalemail:profile:waterfall@1" | "people:profile:waterfall@1" | "people:profileurl:email:waterfall@1" | "people:profileurl:name@1" | "people:email:validate:zerobounce@1" | "people:email:validate:millionverifier@1" | "people:phone:workemail:waterfall@1" | "fields:merge@1" | "website:scrape:firecrawl@1" | "website:scrapelist:firecrawl@1" | "website:extract:firecrawl@1" | "website:maplinks:firecrawl@1" | "sheet:append@1" | "sheet:expandappend@1" | "company:lookalikes:companyenrich@1" | "company:match:logodev@1" | "company:identity@1" | "people:professionalprofile:waterfall@1" | "people:professionalprofileurl:name@1" | "people:professionalprofileurl:email:waterfall@1" | "people:mobilenumber:professionalprofile:waterfall@1" | "input" | "system" | null;
+                        environment: "production" | "sandbox" | null;
+                        config_hash: string | null;
+                        input_hash: string | null;
+                    } | null;
                     widgets?: {
                         display_value?: {
                             label?: string;
@@ -311,9 +317,9 @@ export declare class Pipe0 {
          * Poll until the search completes or fails.
          */
         waitUntilComplete: (runId: string | Promise<string>, options?: {
-            onPoll?: (_response: PiperSearchResponse) => unknown;
+            onPoll?: (_response: SearchesResponse) => unknown;
             signal?: AbortSignal;
-        }) => Promise<PiperSearchResponse>;
+        }) => Promise<SearchesResponse>;
     };
     private sleep;
 }

package/dist/pipe0.js

@@ -1,10 +1,10 @@
 import createFetchClient, {} from "openapi-fetch";
-export class PiperTimeoutError extends Error {
+export class Pipe0TimeoutError extends Error {
     runId;
     constructor(message, runId) {
         super(message);
         this.runId = runId;
-        this.name = "PiperTimeoutError";
+        this.name = "Pipe0TimeoutError";
         this.runId = runId;
     }
 }
@@ -13,7 +13,7 @@ export class Pipe0AbortError extends Error {
     constructor(message, runId) {
         super(message);
         this.runId = runId;
-        this.name = "PiperAbortError";
+        this.name = "Pipe0AbortError";
         this.runId = runId;
     }
 }
@@ -24,7 +24,7 @@ export class Pipe0BatchError extends Error {
         super(message);
         this.errors = errors;
         this.successfulBatches = successfulBatches;
-        this.name = "PiperBatchError";
+        this.name = "Pipe0BatchError";
         this.errors = errors;
         this.successfulBatches = successfulBatches;
     }
@@ -34,14 +34,14 @@ export class Pipe0TaskError extends Error {
     constructor(message, responseBody) {
         super(message);
         this.responseBody = responseBody;
-        this.name = "PiperTaskError";
+        this.name = "Pipe0TaskError";
         this.responseBody = responseBody;
     }
 }
 export class Pipe0ServerError extends Error {
     constructor(message) {
         super(message);
-        this.name = "PiperServerError";
+        this.name = "Pipe0ServerError";
     }
 }
 export class Pipe0 {
@@ -85,7 +85,7 @@ export class Pipe0 {
         let currentInterval = initialInterval;
         while (true) {
             if (Date.now() - startTime >= timeout) {
-                throw new PiperTimeoutError(`${taskType} polling timed out after ${timeout}ms`, resolvedRunId);
+                throw new Pipe0TimeoutError(`${taskType} polling timed out after ${timeout}ms`, resolvedRunId);
             }
             if (options.signal?.aborted) {
                 throw new Pipe0AbortError(`${taskType} polling was aborted`, resolvedRunId);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipe0/client",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "license": "MIT",
   "private": false,
   "type": "module",