@sneekin/sdk 0.3.2 → 1.0.0

package/dist/core/index.d.ts

@@ -0,0 +1,2 @@
+export * from './client.js';
+export * from './derive-keys.js';

package/dist/index.cjs

@@ -0,0 +1,223 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  OrdersClient: () => OrdersClient,
+  SneekApiError: () => SneekApiError,
+  SneekClient: () => SneekClient,
+  SneekPayClient: () => SneekPayClient,
+  deriveKeys: () => deriveKeys
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/core/client.ts
+var SneekApiError = class extends Error {
+  constructor(status, type, title, detail) {
+    super(`${title}${detail ? `: ${detail}` : ""} [${status}]`);
+    this.status = status;
+    this.type = type;
+    this.title = title;
+    this.detail = detail;
+    this.name = "SneekApiError";
+  }
+  status;
+  type;
+  title;
+  detail;
+};
+var SneekClient = class {
+  apiUrl;
+  apiKey;
+  fetchImpl;
+  maxRetries;
+  retryBaseMs;
+  constructor(options) {
+    if (!options.apiUrl) throw new Error("apiUrl is required");
+    if (!options.apiKey) throw new Error("apiKey is required");
+    this.apiUrl = options.apiUrl.replace(/\/+$/, "");
+    this.apiKey = options.apiKey;
+    this.fetchImpl = options.fetch ?? fetch;
+    this.maxRetries = options.maxRetries ?? 2;
+    this.retryBaseMs = options.retryBaseMs ?? 200;
+  }
+  async request(method, path, body, extraHeaders) {
+    const raw = body === void 0 ? void 0 : JSON.stringify(body);
+    let attempt = 0;
+    let lastError;
+    for (; ; ) {
+      try {
+        const response = await this.fetchImpl(`${this.apiUrl}${path}`, {
+          method,
+          headers: {
+            "content-type": "application/json",
+            authorization: `Bearer ${this.apiKey}`,
+            ...extraHeaders ?? {}
+          },
+          body: raw
+        });
+        const text = await response.text();
+        const parsed = text ? parseJson(text) : void 0;
+        if (!response.ok) {
+          const problem = asProblem(parsed);
+          const error = new SneekApiError(
+            response.status,
+            problem.type ?? "about:blank",
+            problem.title ?? response.statusText,
+            problem.detail
+          );
+          if (response.status >= 500 && attempt < this.maxRetries) {
+            lastError = error;
+            await this.backoff(attempt++);
+            continue;
+          }
+          throw error;
+        }
+        return parsed;
+      } catch (error) {
+        if (error instanceof SneekApiError) throw error;
+        if (attempt < this.maxRetries) {
+          lastError = error;
+          await this.backoff(attempt++);
+          continue;
+        }
+        throw lastError ?? error;
+      }
+    }
+  }
+  backoff(attempt) {
+    return new Promise((resolve) => setTimeout(resolve, this.retryBaseMs * 2 ** attempt));
+  }
+};
+function parseJson(text) {
+  try {
+    return JSON.parse(text);
+  } catch {
+    return void 0;
+  }
+}
+function asProblem(value) {
+  if (typeof value !== "object" || value === null) return {};
+  const problem = value;
+  return {
+    type: typeof problem.type === "string" ? problem.type : void 0,
+    title: typeof problem.title === "string" ? problem.title : void 0,
+    detail: typeof problem.detail === "string" ? problem.detail : void 0
+  };
+}
+
+// src/core/derive-keys.ts
+var import_node_crypto = require("crypto");
+var KEY_LABELS = {
+  qrSigningKey: "sneek-qr-v1",
+  webhookSigningKey: "sneek-webhook-v1",
+  proofKey: "sneek-proof-v1"
+};
+function deriveKeys(apiKey) {
+  if (typeof apiKey !== "string" || apiKey.length === 0) {
+    throw new TypeError("apiKey must be a nonempty string");
+  }
+  const inputKeyMaterial = Buffer.from(apiKey, "utf8");
+  const derive = (label) => Buffer.from(
+    (0, import_node_crypto.hkdfSync)("sha256", inputKeyMaterial, Buffer.alloc(0), label, 32)
+  );
+  return {
+    qrSigningKey: derive(KEY_LABELS.qrSigningKey),
+    webhookSigningKey: derive(KEY_LABELS.webhookSigningKey),
+    proofKey: derive(KEY_LABELS.proofKey)
+  };
+}
+
+// src/pay/payments.ts
+var SneekPayClient = class {
+  client;
+  orders;
+  constructor(options) {
+    this.client = new SneekClient(options);
+    this.orders = new OrdersClient(this);
+  }
+  /** @internal */
+  async request(method, path, body, extraHeaders) {
+    return this.client.request(method, path, body, extraHeaders);
+  }
+  /**
+   * Verify the checkout handler payload and settle the order. Idempotent:
+   * calling it twice with the same pair returns the same result.
+   */
+  verify(input) {
+    return this.request("POST", "/api/payments/verify", {
+      order_id: input.orderId,
+      payment_id: input.paymentId,
+      signature: input.signature
+    });
+  }
+};
+var OrdersClient = class {
+  constructor(pay) {
+    this.pay = pay;
+  }
+  pay;
+  create(input) {
+    const payload = {
+      amount: String(input.amount),
+      currency: input.currency ?? "INR"
+    };
+    if (input.receipt !== void 0) payload.receipt = input.receipt;
+    if (input.clientRef !== void 0) payload.client_ref = input.clientRef;
+    if (input.notes !== void 0) payload.notes = input.notes;
+    if (input.settleAfter !== void 0) {
+      payload.settle_after = input.settleAfter instanceof Date ? input.settleAfter.toISOString() : input.settleAfter;
+    }
+    const headers = input.idempotencyKey ? { "idempotency-key": input.idempotencyKey } : void 0;
+    return this.pay.request(
+      "POST",
+      "/api/payments/orders",
+      payload,
+      headers
+    );
+  }
+  get(id) {
+    return this.pay.request(
+      "GET",
+      `/api/payments/orders/${encodeURIComponent(id)}`
+    );
+  }
+  /**
+   * The event moved: hold the organizer share until the new end plus the
+   * platform refund window. Only works while the payout is still on hold;
+   * a released payout answers 409.
+   */
+  reschedule(id, input) {
+    const settleAfter = input.settleAfter instanceof Date ? input.settleAfter.toISOString() : input.settleAfter;
+    return this.pay.request(
+      "PATCH",
+      `/api/payments/orders/${encodeURIComponent(id)}/settlement`,
+      { settle_after: settleAfter }
+    );
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  OrdersClient,
+  SneekApiError,
+  SneekClient,
+  SneekPayClient,
+  deriveKeys
+});

package/dist/index.d.ts

@@ -1,118 +1,2 @@
-/**
- * @sneekin/sdk — Node.js SDK for the Sneek Send API.
- *
- *   const sneek = new Sneek({
- *       apiUrl: 'https://api.sneek.in',
- *       apiKey: process.env.SNEEK_API_KEY!, // snk_live_… / snk_test_…
- *   });
- *
- *   await sneek.messages.send({ to: '+91…', body: 'Your OTP is 123456' });
- *   await sneek.sendSMS('+91…', 'Your OTP is 123456');
- *   await sneek.sendOTP({ to: '+91…', code: '123456', appName: 'ConfHub' });
- *
- * Authenticates with `Authorization: Bearer snk_…` against the server's
- * `BearerApiKeyGuard`. No request signing — the bearer key is the credential.
- */
-interface SneekOptions {
-    /** Base URL of the Sneek API, e.g. https://api.sneek.in */
-    apiUrl: string;
-    /** Bearer API key: `snk_live_…` or `snk_test_…`. */
-    apiKey: string;
-    /** Override the global fetch (for tests / non-Node runtimes). */
-    fetch?: typeof fetch;
-    /** Max retry attempts for transient failures (5xx / network). Default 2. */
-    maxRetries?: number;
-    /** Base backoff in ms between retries (exponential). Default 200. */
-    retryBaseMs?: number;
-}
-type MessageChannel = 'sms' | 'whatsapp' | 'email';
-interface SendMessageInput {
-    to: string;
-    /** Free-form message body. Required unless `template` is given. */
-    body?: string;
-    channel?: 'auto' | MessageChannel;
-    clientRef?: string;
-    /**
-     * Declares intent so the right approved provider template is used:
-     * `otp` → auth/OTP template, `transactional` → utility/communication.
-     * When omitted, Sneek infers it from the body text.
-     */
-    type?: 'otp' | 'transactional';
-    /** Named/DLT provider template key (server-rendered). */
-    template?: string;
-    /** Variables substituted into `template`. */
-    variables?: Record<string, string | number>;
-    /**
-     * Replay-protection key. Two sends with the same key (per application)
-     * deliver only once — the first result is returned for every retry. Pair
-     * with the SDK's automatic 5xx retries to make sends safely repeatable.
-     */
-    idempotencyKey?: string;
-}
-interface SendMessageResult {
-    id: string;
-    status: 'accepted';
-    channel: MessageChannel;
-    provider: string;
-    accepted_at: string;
-    client_ref?: string;
-}
-interface SendOtpInput {
-    to: string;
-    code: string;
-    /** App/brand name shown inside the message. */
-    appName?: string;
-    channel?: 'auto' | MessageChannel;
-    clientRef?: string;
-    /**
-     * Override the default body. Receives `{appName, otp}`. When omitted a
-     * sensible default is used. Ignored if `template` is provided.
-     */
-    body?: (vars: {
-        appName: string;
-        otp: string;
-    }) => string;
-    /** DLT/provider template key, when the partner uses server-side rendering. */
-    template?: string;
-    /** Extra template variables (merged with `{appName, otp}`). */
-    variables?: Record<string, string | number>;
-}
-declare class SneekApiError extends Error {
-    status: number;
-    type: string;
-    title: string;
-    detail?: string | undefined;
-    constructor(status: number, type: string, title: string, detail?: string | undefined);
-}
-declare class Sneek {
-    private readonly apiUrl;
-    private readonly apiKey;
-    private readonly fetchImpl;
-    private readonly maxRetries;
-    private readonly retryBaseMs;
-    readonly messages: MessagesClient;
-    constructor(opts: SneekOptions);
-    /** @internal — dispatches a bearer-authenticated request with retries. */
-    request<T>(method: string, path: string, body?: unknown, extraHeaders?: Record<string, string>): Promise<T>;
-    private backoff;
-    /** Convenience: send an SMS. */
-    sendSMS(to: string, body: string, clientRef?: string): Promise<SendMessageResult>;
-    /** Convenience: send a WhatsApp message. */
-    sendWhatsApp(to: string, body: string, clientRef?: string): Promise<SendMessageResult>;
-    /** Convenience: send an email. */
-    sendEmail(to: string, body: string, clientRef?: string): Promise<SendMessageResult>;
-    /**
-     * OTP body-formatting helper. Sneek only *delivers*; the partner generates
-     * and verifies the code. This formats `{appName, otp}` into a body (or
-     * forwards a template) and sends it.
-     */
-    sendOTP(input: SendOtpInput): Promise<SendMessageResult>;
-}
-declare class MessagesClient {
-    private readonly sneek;
-    constructor(sneek: Sneek);
-    send(input: SendMessageInput): Promise<SendMessageResult>;
-    get(id: string): Promise<SendMessageResult>;
-}
-
-export { type MessageChannel, type SendMessageInput, type SendMessageResult, type SendOtpInput, Sneek, SneekApiError, type SneekOptions, Sneek as default };
+export * from './core/index.js';
+export * from './pay/index.js';

package/dist/index.js

@@ -1,30 +1,4 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var index_exports = {};
-__export(index_exports, {
-  Sneek: () => Sneek,
-  SneekApiError: () => SneekApiError,
-  default: () => index_default
-});
-module.exports = __toCommonJS(index_exports);
+// src/core/client.ts
 var SneekApiError = class extends Error {
   constructor(status, type, title, detail) {
     super(`${title}${detail ? `: ${detail}` : ""} [${status}]`);
@@ -34,34 +8,33 @@ var SneekApiError = class extends Error {
     this.detail = detail;
     this.name = "SneekApiError";
   }
+  status;
+  type;
+  title;
+  detail;
 };
-var DEFAULT_MAX_RETRIES = 2;
-var DEFAULT_RETRY_BASE_MS = 200;
-var Sneek = class {
+var SneekClient = class {
   apiUrl;
   apiKey;
   fetchImpl;
   maxRetries;
   retryBaseMs;
-  messages;
-  constructor(opts) {
-    if (!opts.apiUrl) throw new Error("apiUrl is required");
-    if (!opts.apiKey) throw new Error("apiKey is required");
-    this.apiUrl = opts.apiUrl.replace(/\/+$/, "");
-    this.apiKey = opts.apiKey;
-    this.fetchImpl = opts.fetch ?? fetch;
-    this.maxRetries = opts.maxRetries ?? DEFAULT_MAX_RETRIES;
-    this.retryBaseMs = opts.retryBaseMs ?? DEFAULT_RETRY_BASE_MS;
-    this.messages = new MessagesClient(this);
+  constructor(options) {
+    if (!options.apiUrl) throw new Error("apiUrl is required");
+    if (!options.apiKey) throw new Error("apiKey is required");
+    this.apiUrl = options.apiUrl.replace(/\/+$/, "");
+    this.apiKey = options.apiKey;
+    this.fetchImpl = options.fetch ?? fetch;
+    this.maxRetries = options.maxRetries ?? 2;
+    this.retryBaseMs = options.retryBaseMs ?? 200;
   }
-  /** @internal — dispatches a bearer-authenticated request with retries. */
   async request(method, path, body, extraHeaders) {
     const raw = body === void 0 ? void 0 : JSON.stringify(body);
     let attempt = 0;
-    let lastErr;
+    let lastError;
     for (; ; ) {
       try {
-        const res = await this.fetchImpl(`${this.apiUrl}${path}`, {
+        const response = await this.fetchImpl(`${this.apiUrl}${path}`, {
           method,
           headers: {
             "content-type": "application/json",
@@ -70,125 +43,150 @@ var Sneek = class {
           },
           body: raw
         });
-        const text = await res.text();
-        const parsed = text ? safeJson(text) : void 0;
-        if (!res.ok) {
-          const p = parsed ?? {};
-          const err = new SneekApiError(
-            res.status,
-            p.type ?? "about:blank",
-            p.title ?? res.statusText,
-            p.detail
+        const text = await response.text();
+        const parsed = text ? parseJson(text) : void 0;
+        if (!response.ok) {
+          const problem = asProblem(parsed);
+          const error = new SneekApiError(
+            response.status,
+            problem.type ?? "about:blank",
+            problem.title ?? response.statusText,
+            problem.detail
           );
-          if (res.status >= 500 && attempt < this.maxRetries) {
-            lastErr = err;
+          if (response.status >= 500 && attempt < this.maxRetries) {
+            lastError = error;
             await this.backoff(attempt++);
             continue;
           }
-          throw err;
+          throw error;
         }
         return parsed;
-      } catch (err) {
-        if (err instanceof SneekApiError) throw err;
+      } catch (error) {
+        if (error instanceof SneekApiError) throw error;
         if (attempt < this.maxRetries) {
-          lastErr = err;
+          lastError = error;
           await this.backoff(attempt++);
           continue;
         }
-        throw lastErr ?? err;
+        throw lastError ?? error;
       }
     }
   }
   backoff(attempt) {
-    const ms = this.retryBaseMs * Math.pow(2, attempt);
-    return new Promise((resolve) => setTimeout(resolve, ms));
+    return new Promise((resolve) => setTimeout(resolve, this.retryBaseMs * 2 ** attempt));
   }
-  /** Convenience: send an SMS. */
-  sendSMS(to, body, clientRef) {
-    return this.messages.send({ to, body, channel: "sms", clientRef });
+};
+function parseJson(text) {
+  try {
+    return JSON.parse(text);
+  } catch {
+    return void 0;
   }
-  /** Convenience: send a WhatsApp message. */
-  sendWhatsApp(to, body, clientRef) {
-    return this.messages.send({ to, body, channel: "whatsapp", clientRef });
+}
+function asProblem(value) {
+  if (typeof value !== "object" || value === null) return {};
+  const problem = value;
+  return {
+    type: typeof problem.type === "string" ? problem.type : void 0,
+    title: typeof problem.title === "string" ? problem.title : void 0,
+    detail: typeof problem.detail === "string" ? problem.detail : void 0
+  };
+}
+
+// src/core/derive-keys.ts
+import { hkdfSync } from "crypto";
+var KEY_LABELS = {
+  qrSigningKey: "sneek-qr-v1",
+  webhookSigningKey: "sneek-webhook-v1",
+  proofKey: "sneek-proof-v1"
+};
+function deriveKeys(apiKey) {
+  if (typeof apiKey !== "string" || apiKey.length === 0) {
+    throw new TypeError("apiKey must be a nonempty string");
+  }
+  const inputKeyMaterial = Buffer.from(apiKey, "utf8");
+  const derive = (label) => Buffer.from(
+    hkdfSync("sha256", inputKeyMaterial, Buffer.alloc(0), label, 32)
+  );
+  return {
+    qrSigningKey: derive(KEY_LABELS.qrSigningKey),
+    webhookSigningKey: derive(KEY_LABELS.webhookSigningKey),
+    proofKey: derive(KEY_LABELS.proofKey)
+  };
+}
+
+// src/pay/payments.ts
+var SneekPayClient = class {
+  client;
+  orders;
+  constructor(options) {
+    this.client = new SneekClient(options);
+    this.orders = new OrdersClient(this);
   }
-  /** Convenience: send an email. */
-  sendEmail(to, body, clientRef) {
-    return this.messages.send({ to, body, channel: "email", clientRef });
+  /** @internal */
+  async request(method, path, body, extraHeaders) {
+    return this.client.request(method, path, body, extraHeaders);
   }
   /**
-   * OTP body-formatting helper. Sneek only *delivers*; the partner generates
-   * and verifies the code. This formats `{appName, otp}` into a body (or
-   * forwards a template) and sends it.
+   * Verify the checkout handler payload and settle the order. Idempotent:
+   * calling it twice with the same pair returns the same result.
    */
-  sendOTP(input) {
-    const appName = input.appName ?? "your account";
-    if (input.template) {
-      return this.messages.send({
-        to: input.to,
-        channel: input.channel ?? "auto",
-        clientRef: input.clientRef,
-        type: "otp",
-        template: input.template,
-        variables: {
-          appName,
-          otp: input.code,
-          ...input.variables ?? {}
-        }
-      });
-    }
-    const body = input.body ? input.body({ appName, otp: input.code }) : `Your OTP to login to ${appName} is ${input.code}. Do not share it with anyone.`;
-    return this.messages.send({
-      to: input.to,
-      body,
-      channel: input.channel ?? "auto",
-      clientRef: input.clientRef,
-      type: "otp"
+  verify(input) {
+    return this.request("POST", "/api/payments/verify", {
+      order_id: input.orderId,
+      payment_id: input.paymentId,
+      signature: input.signature
     });
   }
 };
-var MessagesClient = class {
-  constructor(sneek) {
-    this.sneek = sneek;
+var OrdersClient = class {
+  constructor(pay) {
+    this.pay = pay;
   }
-  async send(input) {
-    if (!input.body && !input.template) {
-      throw new Error("send() requires either `body` or `template`");
-    }
+  pay;
+  create(input) {
     const payload = {
-      to: input.to,
-      channel: input.channel ?? "auto"
+      amount: String(input.amount),
+      currency: input.currency ?? "INR"
     };
-    if (input.body !== void 0) payload.body = input.body;
-    if (input.type !== void 0) payload.type = input.type;
-    if (input.template !== void 0) payload.template = input.template;
-    if (input.variables !== void 0) payload.variables = input.variables;
-    if (input.clientRef) payload.client_ref = input.clientRef;
+    if (input.receipt !== void 0) payload.receipt = input.receipt;
+    if (input.clientRef !== void 0) payload.client_ref = input.clientRef;
+    if (input.notes !== void 0) payload.notes = input.notes;
+    if (input.settleAfter !== void 0) {
+      payload.settle_after = input.settleAfter instanceof Date ? input.settleAfter.toISOString() : input.settleAfter;
+    }
     const headers = input.idempotencyKey ? { "idempotency-key": input.idempotencyKey } : void 0;
-    return this.sneek.request(
+    return this.pay.request(
       "POST",
-      "/api/messages/send",
+      "/api/payments/orders",
       payload,
       headers
     );
   }
-  async get(id) {
-    return this.sneek.request(
+  get(id) {
+    return this.pay.request(
       "GET",
-      `/api/messages/${encodeURIComponent(id)}`
+      `/api/payments/orders/${encodeURIComponent(id)}`
     );
   }
-};
-function safeJson(s) {
-  try {
-    return JSON.parse(s);
-  } catch {
-    return void 0;
+  /**
+   * The event moved: hold the organizer share until the new end plus the
+   * platform refund window. Only works while the payout is still on hold;
+   * a released payout answers 409.
+   */
+  reschedule(id, input) {
+    const settleAfter = input.settleAfter instanceof Date ? input.settleAfter.toISOString() : input.settleAfter;
+    return this.pay.request(
+      "PATCH",
+      `/api/payments/orders/${encodeURIComponent(id)}/settlement`,
+      { settle_after: settleAfter }
+    );
   }
-}
-var index_default = Sneek;
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  Sneek,
-  SneekApiError
-});
-//# sourceMappingURL=index.js.map
+};
+export {
+  OrdersClient,
+  SneekApiError,
+  SneekClient,
+  SneekPayClient,
+  deriveKeys
+};