@corsair-dev/dropcontact 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,191 @@
+  Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work 
+      (which shall not include Communications that are clearly marked or
+      otherwise designated in writing by the copyright owner as "Not a Work").
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution".
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright (c) 2026 Corsair
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,36 @@
-# Temporary Holding Version
+# @corsair-dev/dropcontact
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Dropcontact plugin for Corsair.
+
+## Install
+
+```bash
+pnpm add @corsair-dev/dropcontact
+```
+
+## Endpoints
+
+| Operation | Operation ID | Risk | Description |
+|-----------|--------------|------|-------------|
+| `account.credits` | `dropcontact.api.account.credits` | `read` | Read the enrichment credits left on the account; costs no credits |
+| `enrichment.enrich` | `dropcontact.api.enrichment.enrich` | `write` | Submit up to 250 contacts for email finding, verification and company enrichment; spends one credit per contact and returns a request_id, not the results |
+| `enrichment.results` | `dropcontact.api.enrichment.results` | `read` | Read the enriched contacts for a request_id: qualified emails, LinkedIn, phone and company data; reports success false with a reason while the batch is still processing |
+| `webhook.get` | `dropcontact.api.webhook.get` | `read` | Read the default webhook callback URL used by enrichment requests that carry no custom callback of their own |
+| `webhook.remove` | `dropcontact.api.webhook.remove` | `destructive` | Delete the account default webhook callback URL; afterwards only requests carrying their own custom_callback_url notify anything |
+| `webhook.set` | `dropcontact.api.webhook.set` | `write` | Set the account default webhook callback URL, replacing any previous one; enrichment requests without their own callback POST their results there |
+
+## Auth
+
+Auth: API key. Corsair prompts your tenant for credentials on first use.
+
+## Webhooks
+
+No webhooks.
+
+## Reference
+
+Full docs, types, and examples: https://docs.corsair.dev/plugins/dropcontact
+
+## License
+
+Apache-2.0

package/dist/api.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=api.test.d.ts.map

package/dist/api.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.test.d.ts","sourceRoot":"","sources":["../api.test.ts"],"names":[],"mappings":""}

package/dist/client.d.ts

@@ -0,0 +1,53 @@
+export declare const DROPCONTACT_API_BASE = "https://api.dropcontact.com";
+/** `error_code` as a number, whichever type the route used. */
+export declare function readReason(body: unknown): string | undefined;
+/** True when the body says the call failed, whatever the HTTP status was. */
+export declare function isFailedBody(body: unknown): boolean;
+/**
+ * Dropcontact answers with its own envelope on most routes,
+ * `{ error, success, reason }`, and a FastAPI shape on others,
+ * `{ detail }` or `{ detail: [{ loc, msg, type }] }`. Both are read here.
+ *
+ * A 200 can still be a failure: fetching results before the batch is ready
+ * answers `success: false` with a `reason`, which is a normal state rather than
+ * an error, so the caller decides with `isFailedBody` instead of the client
+ * throwing.
+ */
+export declare class DropcontactAPIError extends Error {
+    readonly status?: number;
+    /** The provider's own `reason` or `detail`, when it sent one. */
+    readonly reason?: string;
+    /** The credit balance Dropcontact reported, when it sent one. */
+    readonly creditsLeft?: number;
+    /** Milliseconds from a Retry-After header, when Dropcontact sent one. */
+    readonly retryAfter?: number;
+    /** The HTTP method of the failed request. */
+    readonly method?: string;
+    readonly body?: unknown;
+    constructor(message: string, options?: {
+        cause?: Error;
+        status?: number;
+        body?: unknown;
+        retryAfter?: number;
+        method?: string;
+    });
+}
+export declare function describeDropcontactError(status: number | undefined, body: unknown, // unknown: the untyped error body, read field by field.
+fallback: string): string;
+/**
+ * A status-only description, safe to pass as the fallback above.
+ *
+ * The shared client's own message must never be that fallback: for a status
+ * outside its fixed map (504, for one) `ApiError.message` embeds the whole
+ * response body, and a failed enrich response can echo the submitted contacts.
+ */
+export declare function statusOnlyDescription(status: number | undefined, statusText: string | undefined): string;
+export type DropcontactQuery = Record<string, string | number | boolean | undefined>;
+export type DropcontactRequest = {
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    path: string;
+    query?: DropcontactQuery;
+    body?: unknown;
+};
+export declare function makeDropcontactRequest(apiKey: string, { method, path, query, body }: DropcontactRequest): Promise<unknown>;
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../client.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,oBAAoB,gCAAgC,CAAC;AAMlE,+DAA+D;AAE/D,wBAAgB,UAAU,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAqB5D;AAED,6EAA6E;AAE7E,wBAAgB,YAAY,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAMnD;AAaD;;;;;;;;;GASG;AACH,qBAAa,mBAAoB,SAAQ,KAAK;IAC7C,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,iEAAiE;IACjE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,iEAAiE;IACjE,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,yEAAyE;IACzE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,6CAA6C;IAC7C,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAGzB,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;gBAGvB,OAAO,EAAE,MAAM,EACf,OAAO,GAAE;QACR,KAAK,CAAC,EAAE,KAAK,CAAC;QACd,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,MAAM,CAAC,EAAE,MAAM,CAAC;KACX;CAmBP;AAGD,wBAAgB,wBAAwB,CACvC,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,IAAI,EAAE,OAAO,EAAE,wDAAwD;AACvE,QAAQ,EAAE,MAAM,GACd,MAAM,CAGR;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CACpC,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,UAAU,EAAE,MAAM,GAAG,SAAS,GAC5B,MAAM,CAGR;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,CACpC,MAAM,EACN,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CACrC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAChC,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,gBAAgB,CAAC;IAEzB,IAAI,CAAC,EAAE,OAAO,CAAC;CACf,CAAC;AAGF,wBAAsB,sBAAsB,CAC3C,MAAM,EAAE,MAAM,EACd,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,kBAAkB,GAC/C,OAAO,CAAC,OAAO,CAAC,CAuDlB"}

package/dist/client.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=client.test.d.ts.map

package/dist/client.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.test.d.ts","sourceRoot":"","sources":["../client.test.ts"],"names":[],"mappings":""}

package/dist/endpoints/call.d.ts

@@ -0,0 +1,33 @@
+import type { z } from 'zod';
+import type { DropcontactContext } from '..';
+import type { DropcontactRequest } from '../client';
+type LogFields = Record<string, string | number | boolean | undefined>;
+/**
+ * Validates the input, sends the request, shapes and validates the response,
+ * then logs the event.
+ *
+ * Dropcontact names its fields in snake_case and repeats `request_id`,
+ * `credits_left` and `hashedInputs` across routes, so each operation's `shape`
+ * renames them once, here, rather than leaving callers to remember which route
+ * used which spelling. Renaming happens before `parse`, never in a
+ * `.transform()`, because the docs generator reads a transform's input side.
+ */
+export declare function call<Input extends z.ZodType, Output extends z.ZodType>(ctx: DropcontactContext, operation: {
+    event: string;
+    input: Input;
+    output: Output;
+}, rawInput: unknown, toRequest: (parsed: z.output<Input>) => DropcontactRequest, options: {
+    shape: (raw: unknown, parsed: z.output<Input>) => unknown;
+    log?: (parsed: z.output<Input>, result: z.output<Output>) => LogFields;
+}): Promise<z.output<Output>>;
+/**
+ * A 200 that still reports a failure, for the routes where that can only mean
+ * a real problem.
+ *
+ * `enrichment.results` is deliberately excluded: a batch that is still
+ * processing answers `success: false` with a reason, which is a normal state
+ * for a polled job, so that operation returns it and lets the caller re-poll.
+ */
+export declare function throwIfFailed(body: unknown, status?: number): void;
+export {};
+//# sourceMappingURL=call.d.ts.map

package/dist/endpoints/call.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"call.d.ts","sourceRoot":"","sources":["../../endpoints/call.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAC7B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,IAAI,CAAC;AAC7C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAQpD,KAAK,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC,CAAC;AAmBvE;;;;;;;;;GASG;AACH,wBAAsB,IAAI,CAAC,KAAK,SAAS,CAAC,CAAC,OAAO,EAAE,MAAM,SAAS,CAAC,CAAC,OAAO,EAC3E,GAAG,EAAE,kBAAkB,EACvB,SAAS,EAAE;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAE1D,QAAQ,EAAE,OAAO,EACjB,SAAS,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,kBAAkB,EAC1D,OAAO,EAAE;IAGR,KAAK,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,OAAO,CAAC;IAC1D,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,SAAS,CAAC;CACvE,GACC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAwB3B;AAED;;;;;;;GAOG;AAEH,wBAAgB,aAAa,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,SAAM,GAAG,IAAI,CAO/D"}

package/dist/endpoints/enrichment.d.ts

@@ -0,0 +1,8 @@
+import type { DropcontactEndpoints } from '..';
+export declare const enrich: DropcontactEndpoints['enrichmentEnrich'];
+export declare const results: DropcontactEndpoints['enrichmentResults'];
+export declare const credits: DropcontactEndpoints['accountCredits'];
+export declare const getWebhook: DropcontactEndpoints['webhookGet'];
+export declare const setWebhook: DropcontactEndpoints['webhookSet'];
+export declare const removeWebhook: DropcontactEndpoints['webhookRemove'];
+//# sourceMappingURL=enrichment.d.ts.map

package/dist/endpoints/enrichment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enrichment.d.ts","sourceRoot":"","sources":["../../endpoints/enrichment.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,IAAI,CAAC;AAuB/C,eAAO,MAAM,MAAM,EAAE,oBAAoB,CAAC,kBAAkB,CAwC1D,CAAC;AAEH,eAAO,MAAM,OAAO,EAAE,oBAAoB,CAAC,mBAAmB,CAoE5D,CAAC;AAEH,eAAO,MAAM,OAAO,EAAE,oBAAoB,CAAC,gBAAgB,CAiBzD,CAAC;AAEH,eAAO,MAAM,UAAU,EAAE,oBAAoB,CAAC,YAAY,CAyBxD,CAAC;AAEH,eAAO,MAAM,UAAU,EAAE,oBAAoB,CAAC,YAAY,CAwBxD,CAAC;AAEH,eAAO,MAAM,aAAa,EAAE,oBAAoB,CAAC,eAAe,CAkB9D,CAAC"}

package/dist/endpoints/index.d.ts

@@ -0,0 +1,3 @@
+export { call, throwIfFailed } from './call';
+export { credits, enrich, getWebhook, removeWebhook, results, setWebhook, } from './enrichment';
+//# sourceMappingURL=index.d.ts.map

package/dist/endpoints/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../endpoints/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AAC7C,OAAO,EACN,OAAO,EACP,MAAM,EACN,UAAU,EACV,aAAa,EACb,OAAO,EACP,UAAU,GACV,MAAM,cAAc,CAAC"}