@vigneshreddy/cms-sdk 1.0.7 → 1.0.8

package/README.md

@@ -1,11 +1,10 @@
-# CMS TypeScript SDK (cms)
+# @vigneshreddy/cms-sdk
 
-TypeScript/JavaScript SDK for the CutMeShort CMS API.
+Official TypeScript/JavaScript SDK for the CutMeShort CMS API.
 
-This SDK is:
-- Fetch-based (uses native `fetch`).
-- Typed (TypeScript types for requests/responses).
-- Resilient (built-in retries for transient errors).
+Use this package to send:
+- lead tracking events (`trackLead`)
+- sale tracking events (`trackSale`)
 
 ## Install
 
@@ -13,104 +12,117 @@ This SDK is:
 npm install @vigneshreddy/cms-sdk
 ```
 
-## Runtime requirements
+## Requirements
 
-- Browser: any modern browser with `fetch`.
-- Node.js: Node 18+ recommended (built-in `fetch`).
-- Node < 18: add a fetch polyfill and set it globally before using the SDK.
+- Node.js 18+ (recommended) or any runtime with global `fetch`
+- TypeScript 5+ (optional, for type safety)
+
+If your runtime does not provide `fetch`, add a polyfill before creating the client.
 
 ```ts
 import fetch, { Headers, Request, Response } from "cross-fetch";
 
-// @ts-ignore
-global.fetch = fetch as any;
-// @ts-ignore
-global.Headers = Headers as any;
-// @ts-ignore
-global.Request = Request as any;
-// @ts-ignore
-global.Response = Response as any;
+(globalThis as any).fetch = fetch;
+(globalThis as any).Headers = Headers;
+(globalThis as any).Request = Request;
+(globalThis as any).Response = Response;
 ```
 
-## Quick start
-
-Create the client once and reuse it across calls.
+## Quick Start
 
 ```ts
 import { CMS } from "@vigneshreddy/cms-sdk";
 
-const sdk = new CMS({
+const cms = new CMS({
   apiKey: process.env.CMS_API_KEY!,
   timeout: 10_000,
 });
-```
-
-## Track a lead
-
-### Class-based usage (throws on error)
 
-```ts
-import { CMS } from "@vigneshreddy/cms-sdk";
-
-const sdk = new CMS({ apiKey: "sk_live_123" });
-
-const leadResponse = await sdk.trackLead({
+const response = await cms.trackLead({
   clickId: "id_123",
   eventName: "signup_started",
   customerId: "user_42",
 });
 
-console.log("Lead response:", leadResponse);
+console.log(response);
 ```
 
-### Functional helper (Result pattern)
+## API Methods
+
+### `trackLead(leadData, options?)`
 
 ```ts
-import { CMS, trackLead } from "@vigneshreddy/cms-sdk";
+import { CMS } from "@vigneshreddy/cms-sdk";
 
-const sdk = new CMS({ apiKey: "sk_live_123" });
+const cms = new CMS({ apiKey: "sk_live_xxx" });
 
-const res = await trackLead(sdk, {
+await cms.trackLead({
   clickId: "id_123",
   eventName: "signup_started",
   customerId: "user_42",
 });
-
-if (res.ok) {
-  console.log("Lead response:", res.value);
-} else {
-  console.error("Lead error:", res.error);
-}
 ```
 
-## Track a sale
+Lead payload fields:
+- `clickId: string`
+- `eventName: string`
+- `customerId: string`
 
-### Class-based usage (throws on error)
+### `trackSale(saleData, options?)`
 
 ```ts
 import { CMS } from "@vigneshreddy/cms-sdk";
 
-const sdk = new CMS({ apiKey: "sk_live_123" });
+const cms = new CMS({ apiKey: "sk_live_xxx" });
 
-const saleResponse = await sdk.trackSale({
+await cms.trackSale({
   clickId: "id_123",
   eventName: "purchase_completed",
   invoiceId: "inv_987",
   amount: 4999,
   currency: "USD",
 });
+```
+
+Sale payload fields:
+- `clickId: string`
+- `eventName: string`
+- `invoiceId: string`
+- `amount: number` (in cents)
+- `currency: string` (3-letter code, e.g. `USD`)
+
+## Functional Style (Result Pattern)
+
+If you prefer not to use `try/catch`, use helper functions that return `Result`.
+
+### Lead Example
+
+```ts
+import { CMS, trackLead } from "@vigneshreddy/cms-sdk";
+
+const cms = new CMS({ apiKey: "sk_live_xxx" });
+
+const result = await trackLead(cms, {
+  clickId: "id_123",
+  eventName: "signup_started",
+  customerId: "user_42",
+});
 
-console.log("Sale response:", saleResponse);
+if (result.ok) {
+  console.log("Tracked lead:", result.value);
+} else {
+  console.error("Lead error:", result.error);
+}
 ```
 
-### Functional helper (Result pattern)
+### Sale Example
 
 ```ts
-import { CMS, trackSale } from "cms";
+import { CMS, trackSale } from "@vigneshreddy/cms-sdk";
 
-const sdk = new CMS({ apiKey: "sk_live_123" });
+const cms = new CMS({ apiKey: "sk_live_xxx" });
 
-const res = await trackSale(sdk, {
+const result = await trackSale(cms, {
   clickId: "id_123",
   eventName: "purchase_completed",
   invoiceId: "inv_987",
@@ -118,43 +130,45 @@ const res = await trackSale(sdk, {
   currency: "USD",
 });
 
-if (res.ok) {
-  console.log("Sale response:", res.value);
+if (result.ok) {
+  console.log("Tracked sale:", result.value);
 } else {
-  console.error("Sale error:", res.error);
+  console.error("Sale error:", result.error);
 }
 ```
 
 ## Configuration
 
+`new CMS(config)` accepts:
+
 ```ts
-export interface CMSConfig {
+type CMSConfig = {
   apiKey: string;
   timeout?: number;
   maxRetries?: number;
   retryDelayMs?: number;
   retryOnStatuses?: number[];
   retryOnNetworkError?: boolean;
-}
+};
 ```
 
-- `apiKey` (required): CMS secret API key.
-- `timeout`: request timeout in ms (default: 10000).
-- `maxRetries`: retry attempts for transient failures (default: 2).
-- `retryDelayMs`: base delay for linear backoff (default: 500).
-- `retryOnStatuses`: HTTP codes that are retryable (default: 429, 500, 502, 503, 504).
-- `retryOnNetworkError`: retry on network/timeout errors (default: true).
+Defaults:
+- `timeout`: `10000`
+- `maxRetries`: `2`
+- `retryDelayMs`: `500`
+- `retryOnStatuses`: `[429, 500, 502, 503, 504]`
+- `retryOnNetworkError`: `true`
 
-## Per-request overrides
+## Per-request Overrides
 
-You can override retries and timeout on a single request.
+You can override retry/timeout settings for a specific call:
 
 ```ts
 import { CMS } from "@vigneshreddy/cms-sdk";
 
-const sdk = new CMS({ apiKey: "sk_live_123" });
+const cms = new CMS({ apiKey: "sk_live_xxx" });
 
-await sdk.trackLead(
+await cms.trackLead(
   {
     clickId: "id_123",
     eventName: "signup_started",
@@ -163,47 +177,62 @@ await sdk.trackLead(
   {
     timeout: 5000,
     maxRetries: 1,
+    retryDelayMs: 300,
   }
 );
 ```
 
-## Error handling
+## Error Handling
 
-All thrown errors from class-based methods are normalized as `CMSAPIError` or its specific subclasses.
+Class-based methods (`cms.trackLead`, `cms.trackSale`) throw `CMSAPIError` on failure.
 
 ```ts
 import { CMS, CMSAPIError } from "@vigneshreddy/cms-sdk";
 
-const sdk = new CMS({ apiKey: "sk_live_123" });
+const cms = new CMS({ apiKey: "sk_live_xxx" });
 
 try {
-  await sdk.trackLead({
+  await cms.trackSale({
     clickId: "id_123",
-    eventName: "signup_started",
-    customerId: "user_42",
+    eventName: "purchase_completed",
+    invoiceId: "inv_987",
+    amount: 4999,
+    currency: "USD",
   });
-} catch (err) {
-  if (err instanceof CMSAPIError) {
-    console.error("CMS API Error:", {
-      statusCode: err.statusCode,
-      type: err.type,
-      message: err.message,
+} catch (error) {
+  if (error instanceof CMSAPIError) {
+    console.error("CMS API error", {
+      statusCode: error.statusCode,
+      type: error.type,
+      message: error.message,
     });
   } else {
-    console.error("Unexpected error:", err);
+    console.error("Unexpected error", error);
   }
 }
 ```
 
-## Exports
+## TypeScript Types
 
 ```ts
-import { CMS } from "@vigneshreddy/cms-sdk";
-import { trackLead, trackSale } from "@vigneshreddy/cms-sdk";
-import { CMSAPIError } from "@vigneshreddy/cms-sdk";
-import type { TrackLeadRequest, TrackSaleRequest, TrackResponse } from "@vigneshreddy/cms-sdk";
+import type {
+  TrackLeadRequest,
+  TrackSaleRequest,
+  TrackResponse,
+  RequestOptions,
+  CMSConfig,
+} from "@vigneshreddy/cms-sdk";
 ```
 
-## Security
+## Exports
+
+Main package exports:
+- `CMS`
+- `trackLead`, `trackSale`
+- `CMSAPIError` and specific error classes
+- `ok`, `err`, `Result`
+- generated request/response types
+
+## Security Best Practice
 
-Do not expose secret API keys in frontend code. Use a backend or secure proxy if the key is private.
+Do not expose private API keys in public frontend code. Use this SDK from a trusted backend/server environment when using secret keys.

package/dist/src/generated/base.d.ts

@@ -1,14 +1,3 @@
-/**
- * CMS API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 1.0.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
 import type { Configuration } from './configuration';
 export type RequestOptions = RequestInit & {
     /**

package/dist/src/generated/base.js

@@ -1,20 +1,7 @@
 "use strict";
-/* tslint:disable */
-/* eslint-disable */
-/**
- * CMS API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 1.0.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
-exports.BASE_PATH = "https://www.cutmeshort.com/api".replace(/\/+$/, "");
+exports.BASE_PATH = "https://www.cutmeshort.com/sdk".replace(/\/+$/, "");
 exports.COLLECTION_FORMATS = {
     csv: ",",
     ssv: " ",

package/dist/src/generated/common.d.ts

@@ -1,14 +1,3 @@
-/**
- * CMS API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 1.0.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
 import type { Configuration } from "./configuration";
 export declare const DUMMY_BASE_URL = "https://example.com";
 /**

package/dist/src/generated/common.js

@@ -1,17 +1,4 @@
 "use strict";
-/* tslint:disable */
-/* eslint-disable */
-/**
- * CMS API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 1.0.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toPathString = exports.serializeDataIfNeeded = exports.replaceWithSerializableTypeIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
 const base_1 = require("./base");

package/dist/src/generated/configuration.d.ts

@@ -1,14 +1,3 @@
-/**
- * CMS API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 1.0.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
 interface AWSv4Configuration {
     options?: {
         region?: string;

package/dist/src/generated/configuration.js

@@ -1,16 +1,4 @@
 "use strict";
-/* tslint:disable */
-/**
- * CMS API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 1.0.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Configuration = void 0;
 class Configuration {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vigneshreddy/cms-sdk",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "description": "Official TypeScript SDK for CutMeShort CMS API",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",