@deployed.md/dpd-implementation-partner-sdk 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Deployed Core
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,121 @@
-# Temporary Holding Version
+# @deployed.md/dpd-implementation-partner-sdk
+
+Report user sign-ups from your app to **Deployed**. Every email is captured; enterprise emails (not Gmail, Outlook, …) receive a one-time introduction from Deployed, as an official implementation partner of your company.
+
+```
+Your user signs up ──► your server ──(DeployedImplementationSDK + API key/secret)──► Deployed
+```
+
+> **Never ship your API secret to a browser.** The SDK refuses to run in one. Call it from your backend after your own sign-up succeeds.
+
+## Install
+
+```bash
+npm install @deployed.md/dpd-implementation-partner-sdk
+```
+
+Requires Node.js 18+.
+
+## Configure
+
+Get an API key and secret from the Deployed Implementation SDK admin dashboard (**API Keys → Generate key**).
+
+```bash
+# .env (server)
+DEPLOYED_API_URL=https://api.deployed.md
+DEPLOYED_API_KEY=ak_live_...
+DEPLOYED_API_SECRET=sk_live_...
+```
+
+```ts
+import { DeployedImplementationSDK } from "@deployed.md/dpd-implementation-partner-sdk";
+
+export const deployed = new DeployedImplementationSDK({
+  apiKey: process.env.DEPLOYED_API_KEY!,
+  apiSecret: process.env.DEPLOYED_API_SECRET!,
+  baseUrl: process.env.DEPLOYED_API_URL, // default http://localhost:4000
+  timeoutMs: 10_000, // optional
+});
+```
+
+## Report a sign-up
+
+```ts
+import { getRequestContext } from "@deployed.md/dpd-implementation-partner-sdk";
+
+const result = await deployed.signUp(
+  {
+    email: "nirav@deployed.md", // required
+    name: "Nirav Boghra", // optional
+    metadata: { company: "Deployed", role: "Developer", plan: "pro" }, // optional, any JSON (max 16 KB)
+  },
+  getRequestContext(req), // optional: the user's IP and user agent
+);
+```
+
+`signUp` resolves to:
+
+```ts
+{
+  signup: {
+    id: string;
+    email: string;
+    name: string | null;
+    emailType: "ENTERPRISE" | "PERSONAL";
+    submissions: number; // how many times this email signed up through your key
+    firstSeenAt: string;
+    lastSeenAt: string;
+  }
+  isNew: boolean; // first time this email signed up through your key
+  outreach: "queued" | "already_sent" | "not_applicable" | "disabled";
+}
+```
+
+| `outreach`       | Meaning                                                                              |
+| ---------------- | ------------------------------------------------------------------------------------ |
+| `queued`         | Enterprise email seen for the first time; Deployed is sending its introduction email |
+| `already_sent`   | Enterprise email that Deployed already contacted (once per address)                  |
+| `not_applicable` | Personal email; stored, no outreach                                                  |
+| `disabled`       | Enterprise email, but outreach is turned off on the Deployed server                  |
+
+Calling `signUp` again for the same email updates the stored record (latest name and metadata, repeat count) and never sends a second email.
+
+`getRequestContext(req)` works with Node/Express requests and Fetch API `Request` objects (Next.js route handlers, etc.).
+
+### Example: Express
+
+```ts
+app.post("/signup", async (req, res, next) => {
+  try {
+    const user = await createUserInYourDatabase(req.body); // your own sign-up
+    await deployed.signUp(
+      { email: user.email, name: user.name, metadata: { plan: user.plan } },
+      getRequestContext(req),
+    );
+    res.status(201).json(user);
+  } catch (err) {
+    next(err);
+  }
+});
+```
+
+Reporting to Deployed shouldn't block your sign-up: if you prefer, call `signUp` without `await` and log failures with `.catch(...)`.
+
+## Errors
+
+Every failed call rejects with a `DeployedImplementationSDKError`:
+
+```ts
+import { isDeployedImplementationSDKError } from "@deployed.md/dpd-implementation-partner-sdk";
+
+try {
+  await deployed.signUp({ email });
+} catch (err) {
+  if (isDeployedImplementationSDKError(err)) {
+    err.code; // 'VALIDATION_ERROR' | 'INVALID_API_CREDENTIALS' | 'API_KEY_REVOKED' | 'RATE_LIMITED' | 'NETWORK_ERROR' | 'TIMEOUT' | ...
+    err.status; // HTTP status (0 for NETWORK_ERROR / TIMEOUT)
+    err.details; // field errors for VALIDATION_ERROR
+  }
+}
+```
 
-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.

package/dist/client.d.ts

@@ -0,0 +1,40 @@
+import type { DeployedImplementationSDKOptions, RequestContext, SignUpInput, SignUpResult } from './types';
+/**
+ * Server-side client for the Deployed Implementation SDK.
+ *
+ * ```ts
+ * const deployed = new DeployedImplementationSDK({ apiKey: process.env.DEPLOYED_API_KEY!, apiSecret: process.env.DEPLOYED_API_SECRET! });
+ * await deployed.signUp({ email, name, metadata: { company, role } });
+ * ```
+ */
+export declare class DeployedImplementationSDK {
+    private readonly apiKey;
+    private readonly apiSecret;
+    private readonly baseUrl;
+    private readonly timeoutMs;
+    private readonly fetchImpl;
+    constructor(options: DeployedImplementationSDKOptions);
+    /**
+     * Records a user sign-up from your app. Call it after your own sign-up succeeds.
+     * Every email is stored; enterprise emails (not Gmail, Outlook, ...) receive the Deployed
+     * outreach email once. Calling it again for the same email updates the record.
+     */
+    signUp(input: SignUpInput, context?: RequestContext): Promise<SignUpResult>;
+    private request;
+}
+type HeaderBag = Record<string, string | string[] | undefined> | {
+    get(name: string): string | null;
+};
+/**
+ * Builds a RequestContext from an incoming request (Node/Express `req` or a Fetch API `Request`),
+ * so the sign-up records the end user's IP and user agent.
+ */
+export declare const getRequestContext: (req: {
+    headers: HeaderBag;
+    ip?: string;
+    socket?: {
+        remoteAddress?: string;
+    };
+}) => RequestContext;
+export {};
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gCAAgC,EAAE,cAAc,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAK3G;;;;;;;GAOG;AACH,qBAAa,yBAAyB;IACpC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;gBAE7B,OAAO,EAAE,gCAAgC;IAoBrD;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;YAI7D,OAAO;CAkDtB;AAED,KAAK,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,GAAG;IAAE,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;CAAE,CAAC;AAEtG;;;GAGG;AACH,eAAO,MAAM,iBAAiB,GAAI,KAAK;IAAE,OAAO,EAAE,SAAS,CAAC;IAAC,EAAE,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE;QAAE,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,KAAG,cAcjH,CAAC"}

package/dist/client.js

@@ -0,0 +1,114 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRequestContext = exports.DeployedImplementationSDK = void 0;
+const errors_1 = require("./errors");
+const DEFAULT_BASE_URL = 'http://localhost:4000';
+const VERSION = '0.3.0';
+/**
+ * Server-side client for the Deployed Implementation SDK.
+ *
+ * ```ts
+ * const deployed = new DeployedImplementationSDK({ apiKey: process.env.DEPLOYED_API_KEY!, apiSecret: process.env.DEPLOYED_API_SECRET! });
+ * await deployed.signUp({ email, name, metadata: { company, role } });
+ * ```
+ */
+class DeployedImplementationSDK {
+    apiKey;
+    apiSecret;
+    baseUrl;
+    timeoutMs;
+    fetchImpl;
+    constructor(options) {
+        if (!options?.apiKey || !options?.apiSecret) {
+            throw new Error('DeployedImplementationSDK: `apiKey` and `apiSecret` are required');
+        }
+        if (typeof window !== 'undefined' && typeof document !== 'undefined' && !options.dangerouslyAllowBrowser) {
+            throw new Error('DeployedImplementationSDK must not run in a browser because it would expose your API secret. ' +
+                'Call it from your backend when a user signs up.');
+        }
+        const fetchImpl = options.fetch ?? globalThis.fetch;
+        if (!fetchImpl)
+            throw new Error('DeployedImplementationSDK: global fetch is not available. Use Node 18+ or pass `fetch`.');
+        this.apiKey = options.apiKey;
+        this.apiSecret = options.apiSecret;
+        this.baseUrl = (options.baseUrl ?? DEFAULT_BASE_URL).replace(/\/+$/, '');
+        this.timeoutMs = options.timeoutMs ?? 10_000;
+        this.fetchImpl = fetchImpl.bind(globalThis);
+    }
+    /**
+     * Records a user sign-up from your app. Call it after your own sign-up succeeds.
+     * Every email is stored; enterprise emails (not Gmail, Outlook, ...) receive the Deployed
+     * outreach email once. Calling it again for the same email updates the record.
+     */
+    signUp(input, context) {
+        return this.request('POST', '/v1/signups', { body: input, context });
+    }
+    async request(method, path, opts = {}) {
+        const headers = {
+            accept: 'application/json',
+            'x-api-key': this.apiKey,
+            'x-api-secret': this.apiSecret,
+            'x-dpd-sdk': `node/${VERSION}`,
+        };
+        if (opts.body !== undefined)
+            headers['content-type'] = 'application/json';
+        if (opts.context?.ip)
+            headers['x-dpd-client-ip'] = opts.context.ip;
+        if (opts.context?.userAgent)
+            headers['x-dpd-client-ua'] = opts.context.userAgent;
+        const controller = new AbortController();
+        const timer = setTimeout(() => controller.abort(), this.timeoutMs);
+        let res;
+        try {
+            res = await this.fetchImpl(this.baseUrl + path, {
+                method,
+                headers,
+                body: opts.body === undefined ? undefined : JSON.stringify(opts.body),
+                signal: controller.signal,
+            });
+        }
+        catch (err) {
+            if (controller.signal.aborted) {
+                throw new errors_1.DeployedImplementationSDKError('TIMEOUT', `Request timed out after ${this.timeoutMs}ms`, 0);
+            }
+            throw new errors_1.DeployedImplementationSDKError('NETWORK_ERROR', `Could not reach ${this.baseUrl}: ${err.message}`, 0);
+        }
+        finally {
+            clearTimeout(timer);
+        }
+        const text = await res.text();
+        let data;
+        try {
+            data = text ? JSON.parse(text) : undefined;
+        }
+        catch {
+            data = undefined;
+        }
+        if (!res.ok) {
+            const error = data?.error;
+            throw new errors_1.DeployedImplementationSDKError(error?.code ?? 'INTERNAL_ERROR', error?.message ?? `Request failed (${res.status})`, res.status, error?.details);
+        }
+        return data;
+    }
+}
+exports.DeployedImplementationSDK = DeployedImplementationSDK;
+/**
+ * Builds a RequestContext from an incoming request (Node/Express `req` or a Fetch API `Request`),
+ * so the sign-up records the end user's IP and user agent.
+ */
+const getRequestContext = (req) => {
+    const header = (name) => {
+        const h = req.headers;
+        const value = typeof h.get === 'function'
+            ? h.get(name)
+            : h[name];
+        return (Array.isArray(value) ? value[0] : value) ?? undefined;
+    };
+    const forwarded = header('x-forwarded-for')?.split(',')[0]?.trim();
+    return {
+        ip: forwarded || header('x-real-ip') || req.ip || req.socket?.remoteAddress,
+        userAgent: header('user-agent'),
+    };
+};
+exports.getRequestContext = getRequestContext;
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;AAAA,qCAA0D;AAG1D,MAAM,gBAAgB,GAAG,uBAAuB,CAAC;AACjD,MAAM,OAAO,GAAG,OAAO,CAAC;AAExB;;;;;;;GAOG;AACH,MAAa,yBAAyB;IACnB,MAAM,CAAS;IACf,SAAS,CAAS;IAClB,OAAO,CAAS;IAChB,SAAS,CAAS;IAClB,SAAS,CAAe;IAEzC,YAAY,OAAyC;QACnD,IAAI,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAC;QACtF,CAAC;QACD,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,OAAO,QAAQ,KAAK,WAAW,IAAI,CAAC,OAAO,CAAC,uBAAuB,EAAE,CAAC;YACzG,MAAM,IAAI,KAAK,CACb,+FAA+F;gBAC7F,iDAAiD,CACpD,CAAC;QACJ,CAAC;QACD,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC;QACpD,IAAI,CAAC,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,yFAAyF,CAAC,CAAC;QAE3H,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,gBAAgB,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACzE,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,MAAM,CAAC;QAC7C,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAkB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,aAAa,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAEO,KAAK,CAAC,OAAO,CAAI,MAAsB,EAAE,IAAY,EAAE,OAAqD,EAAE;QACpH,MAAM,OAAO,GAA2B;YACtC,MAAM,EAAE,kBAAkB;YAC1B,WAAW,EAAE,IAAI,CAAC,MAAM;YACxB,cAAc,EAAE,IAAI,CAAC,SAAS;YAC9B,WAAW,EAAE,QAAQ,OAAO,EAAE;SAC/B,CAAC;QACF,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS;YAAE,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAC1E,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE;YAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QACnE,IAAI,IAAI,CAAC,OAAO,EAAE,SAAS;YAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;QAEjF,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACzC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAEnE,IAAI,GAAa,CAAC;QAClB,IAAI,CAAC;YACH,GAAG,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE;gBAC9C,MAAM;gBACN,OAAO;gBACP,IAAI,EAAE,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC;gBACrE,MAAM,EAAE,UAAU,CAAC,MAAM;aAC1B,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,UAAU,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBAC9B,MAAM,IAAI,uCAA8B,CAAC,SAAS,EAAE,2BAA2B,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,CAAC;YACxG,CAAC;YACD,MAAM,IAAI,uCAA8B,CAAC,eAAe,EAAE,mBAAmB,IAAI,CAAC,OAAO,KAAM,GAAa,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;QAC7H,CAAC;gBAAS,CAAC;YACT,YAAY,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QAC9B,IAAI,IAAa,CAAC;QAClB,IAAI,CAAC;YACH,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC7C,CAAC;QAAC,MAAM,CAAC;YACP,IAAI,GAAG,SAAS,CAAC;QACnB,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;YACZ,MAAM,KAAK,GAAI,IAA6G,EAAE,KAAK,CAAC;YACpI,MAAM,IAAI,uCAA8B,CACtC,KAAK,EAAE,IAAI,IAAI,gBAAgB,EAC/B,KAAK,EAAE,OAAO,IAAI,mBAAmB,GAAG,CAAC,MAAM,GAAG,EAClD,GAAG,CAAC,MAAM,EACV,KAAK,EAAE,OAAO,CACf,CAAC;QACJ,CAAC;QACD,OAAO,IAAS,CAAC;IACnB,CAAC;CACF;AAtFD,8DAsFC;AAID;;;GAGG;AACI,MAAM,iBAAiB,GAAG,CAAC,GAA6E,EAAkB,EAAE;IACjI,MAAM,MAAM,GAAG,CAAC,IAAY,EAAE,EAAE;QAC9B,MAAM,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC;QACtB,MAAM,KAAK,GACT,OAAQ,CAAuB,CAAC,GAAG,KAAK,UAAU;YAChD,CAAC,CAAE,CAAuC,CAAC,GAAG,CAAC,IAAI,CAAC;YACpD,CAAC,CAAE,CAAmD,CAAC,IAAI,CAAC,CAAC;QACjE,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,SAAS,CAAC;IAChE,CAAC,CAAC;IACF,MAAM,SAAS,GAAG,MAAM,CAAC,iBAAiB,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC;IACnE,OAAO;QACL,EAAE,EAAE,SAAS,IAAI,MAAM,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,CAAC,MAAM,EAAE,aAAa;QAC3E,SAAS,EAAE,MAAM,CAAC,YAAY,CAAC;KAChC,CAAC;AACJ,CAAC,CAAC;AAdW,QAAA,iBAAiB,qBAc5B"}

package/dist/errors.d.ts

@@ -0,0 +1,31 @@
+export type DeployedImplementationSDKErrorCode = 'VALIDATION_ERROR' | 'INVALID_API_CREDENTIALS' | 'API_KEY_REVOKED' | 'NOT_FOUND' | 'RATE_LIMITED' | 'INTERNAL_ERROR' | 'NETWORK_ERROR' | 'TIMEOUT';
+export interface DeployedImplementationSDKErrorDetail {
+    path: string;
+    message: string;
+}
+/** Every failed SDK call rejects with a DeployedImplementationSDKError. */
+export declare class DeployedImplementationSDKError extends Error {
+    /** Machine-readable code, stable across versions. */
+    readonly code: DeployedImplementationSDKErrorCode | (string & {});
+    /** HTTP status from the API (0 for network errors and timeouts). */
+    readonly status: number;
+    /** Field-level validation errors, when `code` is VALIDATION_ERROR. */
+    readonly details?: DeployedImplementationSDKErrorDetail[] | undefined;
+    readonly name = "DeployedImplementationSDKError";
+    constructor(
+    /** Machine-readable code, stable across versions. */
+    code: DeployedImplementationSDKErrorCode | (string & {}), message: string, 
+    /** HTTP status from the API (0 for network errors and timeouts). */
+    status: number, 
+    /** Field-level validation errors, when `code` is VALIDATION_ERROR. */
+    details?: DeployedImplementationSDKErrorDetail[] | undefined);
+    toJSON(): {
+        name: string;
+        code: DeployedImplementationSDKErrorCode | (string & {});
+        message: string;
+        status: number;
+        details: DeployedImplementationSDKErrorDetail[] | undefined;
+    };
+}
+export declare const isDeployedImplementationSDKError: (err: unknown) => err is DeployedImplementationSDKError;
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,kCAAkC,GAC1C,kBAAkB,GAClB,yBAAyB,GACzB,iBAAiB,GACjB,WAAW,GACX,cAAc,GACd,gBAAgB,GAChB,eAAe,GACf,SAAS,CAAC;AAEd,MAAM,WAAW,oCAAoC;IACnD,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,2EAA2E;AAC3E,qBAAa,8BAA+B,SAAQ,KAAK;IAIrD,qDAAqD;IACrD,QAAQ,CAAC,IAAI,EAAE,kCAAkC,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC;IAEjE,oEAAoE;IACpE,QAAQ,CAAC,MAAM,EAAE,MAAM;IACvB,sEAAsE;IACtE,QAAQ,CAAC,OAAO,CAAC,EAAE,oCAAoC,EAAE;IAT3D,QAAQ,CAAC,IAAI,oCAAoC;;IAG/C,qDAAqD;IAC5C,IAAI,EAAE,kCAAkC,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,EACjE,OAAO,EAAE,MAAM;IACf,oEAAoE;IAC3D,MAAM,EAAE,MAAM;IACvB,sEAAsE;IAC7D,OAAO,CAAC,EAAE,oCAAoC,EAAE,YAAA;IAK3D,MAAM;;;;;;;CAGP;AAED,eAAO,MAAM,gCAAgC,GAAI,KAAK,OAAO,KAAG,GAAG,IAAI,8BAE4C,CAAC"}

package/dist/errors.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isDeployedImplementationSDKError = exports.DeployedImplementationSDKError = void 0;
+/** Every failed SDK call rejects with a DeployedImplementationSDKError. */
+class DeployedImplementationSDKError extends Error {
+    code;
+    status;
+    details;
+    name = 'DeployedImplementationSDKError';
+    constructor(
+    /** Machine-readable code, stable across versions. */
+    code, message, 
+    /** HTTP status from the API (0 for network errors and timeouts). */
+    status, 
+    /** Field-level validation errors, when `code` is VALIDATION_ERROR. */
+    details) {
+        super(message);
+        this.code = code;
+        this.status = status;
+        this.details = details;
+    }
+    toJSON() {
+        return { name: this.name, code: this.code, message: this.message, status: this.status, details: this.details };
+    }
+}
+exports.DeployedImplementationSDKError = DeployedImplementationSDKError;
+const isDeployedImplementationSDKError = (err) => err instanceof DeployedImplementationSDKError ||
+    (typeof err === 'object' && err !== null && err.name === 'DeployedImplementationSDKError');
+exports.isDeployedImplementationSDKError = isDeployedImplementationSDKError;
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;AAeA,2EAA2E;AAC3E,MAAa,8BAA+B,SAAQ,KAAK;IAK5C;IAGA;IAEA;IATF,IAAI,GAAG,gCAAgC,CAAC;IAEjD;IACE,qDAAqD;IAC5C,IAAwD,EACjE,OAAe;IACf,oEAAoE;IAC3D,MAAc;IACvB,sEAAsE;IAC7D,OAAgD;QAEzD,KAAK,CAAC,OAAO,CAAC,CAAC;QAPN,SAAI,GAAJ,IAAI,CAAoD;QAGxD,WAAM,GAAN,MAAM,CAAQ;QAEd,YAAO,GAAP,OAAO,CAAyC;IAG3D,CAAC;IAED,MAAM;QACJ,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;IACjH,CAAC;CACF;AAlBD,wEAkBC;AAEM,MAAM,gCAAgC,GAAG,CAAC,GAAY,EAAyC,EAAE,CACtG,GAAG,YAAY,8BAA8B;IAC7C,CAAC,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAK,GAAyB,CAAC,IAAI,KAAK,gCAAgC,CAAC,CAAC;AAFvG,QAAA,gCAAgC,oCAEuE"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { DeployedImplementationSDK, getRequestContext } from './client';
+export { DeployedImplementationSDKError, isDeployedImplementationSDKError } from './errors';
+export type { DeployedImplementationSDKErrorCode, DeployedImplementationSDKErrorDetail } from './errors';
+export type * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AACxE,OAAO,EAAE,8BAA8B,EAAE,gCAAgC,EAAE,MAAM,UAAU,CAAC;AAC5F,YAAY,EAAE,kCAAkC,EAAE,oCAAoC,EAAE,MAAM,UAAU,CAAC;AACzG,mBAAmB,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isDeployedImplementationSDKError = exports.DeployedImplementationSDKError = exports.getRequestContext = exports.DeployedImplementationSDK = void 0;
+var client_1 = require("./client");
+Object.defineProperty(exports, "DeployedImplementationSDK", { enumerable: true, get: function () { return client_1.DeployedImplementationSDK; } });
+Object.defineProperty(exports, "getRequestContext", { enumerable: true, get: function () { return client_1.getRequestContext; } });
+var errors_1 = require("./errors");
+Object.defineProperty(exports, "DeployedImplementationSDKError", { enumerable: true, get: function () { return errors_1.DeployedImplementationSDKError; } });
+Object.defineProperty(exports, "isDeployedImplementationSDKError", { enumerable: true, get: function () { return errors_1.isDeployedImplementationSDKError; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,mCAAwE;AAA/D,mHAAA,yBAAyB,OAAA;AAAE,2GAAA,iBAAiB,OAAA;AACrD,mCAA4F;AAAnF,wHAAA,8BAA8B,OAAA;AAAE,0HAAA,gCAAgC,OAAA"}

package/dist/types.d.ts

@@ -0,0 +1,60 @@
+export interface DeployedImplementationSDKOptions {
+    /** Public API key (`ak_live_...`) from the Deployed Implementation SDK admin dashboard. */
+    apiKey: string;
+    /** API secret (`sk_live_...`). Server-side only - never ship it to a browser. */
+    apiSecret: string;
+    /** API base URL, e.g. `https://api.deployed.md`. Defaults to `http://localhost:4000`. */
+    baseUrl?: string;
+    /** Request timeout in milliseconds. Default 10 000. */
+    timeoutMs?: number;
+    /** Custom fetch implementation (defaults to the global `fetch`, Node 18+). */
+    fetch?: typeof fetch;
+    /**
+     * The SDK refuses to run in a browser because the API secret would be exposed.
+     * Only set this for local experiments.
+     */
+    dangerouslyAllowBrowser?: boolean;
+}
+/** Information about the end user's request, recorded with the sign-up. */
+export interface RequestContext {
+    ip?: string;
+    userAgent?: string;
+}
+/** Any JSON-serialisable value. */
+export type JsonValue = string | number | boolean | null | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+export interface SignUpInput {
+    /** The user's email address (required). */
+    email: string;
+    /** The user's name (optional). The first word is used to greet them in the outreach email. */
+    name?: string;
+    /** Any extra information about the user, e.g. `{ company, role, plan, signupMethod }`. Max 16 KB. */
+    metadata?: {
+        [key: string]: JsonValue;
+    };
+}
+export type EmailType = 'PERSONAL' | 'ENTERPRISE';
+/**
+ * - `queued`: enterprise email seen for the first time; the outreach email is being sent.
+ * - `already_sent`: enterprise email that already received outreach (sent once per address).
+ * - `not_applicable`: personal email (Gmail, Outlook, ...); no outreach.
+ * - `disabled`: outreach is turned off on the server.
+ */
+export type OutreachStatus = 'queued' | 'already_sent' | 'not_applicable' | 'disabled';
+export interface SignUpResult {
+    signup: {
+        id: string;
+        email: string;
+        name: string | null;
+        emailType: EmailType;
+        /** How many times this email has signed up through your integration. */
+        submissions: number;
+        firstSeenAt: string;
+        lastSeenAt: string;
+    };
+    /** True the first time this email signs up through your integration. */
+    isNew: boolean;
+    outreach: OutreachStatus;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,gCAAgC;IAC/C,2FAA2F;IAC3F,MAAM,EAAE,MAAM,CAAC;IACf,iFAAiF;IACjF,SAAS,EAAE,MAAM,CAAC;IAClB,yFAAyF;IACzF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,uDAAuD;IACvD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,8EAA8E;IAC9E,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACnC;AAED,2EAA2E;AAC3E,MAAM,WAAW,cAAc;IAC7B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,mCAAmC;AACnC,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,EAAE,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC;AAEtG,MAAM,WAAW,WAAW;IAC1B,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;IACd,8FAA8F;IAC9F,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qGAAqG;IACrG,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,CAAC;CACzC;AAED,MAAM,MAAM,SAAS,GAAG,UAAU,GAAG,YAAY,CAAC;AAElD;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,cAAc,GAAG,gBAAgB,GAAG,UAAU,CAAC;AAEvF,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE;QACN,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QACpB,SAAS,EAAE,SAAS,CAAC;QACrB,wEAAwE;QACxE,WAAW,EAAE,MAAM,CAAC;QACpB,WAAW,EAAE,MAAM,CAAC;QACpB,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,wEAAwE;IACxE,KAAK,EAAE,OAAO,CAAC;IACf,QAAQ,EAAE,cAAc,CAAC;CAC1B"}

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,53 @@
 {
   "name": "@deployed.md/dpd-implementation-partner-sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Record user sign-ups from your app with Deployed: every email is captured and enterprise emails get a Deployed introduction.",
+  "keywords": [
+    "deployed",
+    "signup",
+    "leads",
+    "enterprise",
+    "outreach",
+    "sdk"
+  ],
+  "author": "Deployed (https://deployed.md)",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/Deployed-Core/dpd-implementation-partner-sdk.git"
+  },
+  "homepage": "https://github.com/Deployed-Core/dpd-implementation-partner-sdk#readme",
+  "bugs": "https://github.com/Deployed-Core/dpd-implementation-partner-sdk/issues",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "dev": "tsc -p tsconfig.json --watch --preserveWatchOutput",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "clean": "node -e \"require('fs').rmSync('dist',{recursive:true,force:true})\"",
+    "prepack": "npm run clean && npm run build",
+    "prepare": "npm run build",
+    "prepublishOnly": "npm run typecheck"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "typescript": "^5.6.3"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}