cas-parser-node 1.8.0 → 1.10.0

package/src/client.ts

@@ -11,6 +11,7 @@ import type { APIResponseProps } from './internal/parse';
 import { getPlatformHeaders } from './internal/detect-platform';
 import * as Shims from './internal/shims';
 import * as Opts from './internal/request-options';
+import { stringifyQuery } from './internal/utils/query';
 import { VERSION } from './version';
 import * as Errors from './core/error';
 import * as Uploads from './core/uploads';
@@ -71,13 +72,6 @@ import {
 } from './internal/utils/log';
 import { isEmptyObj } from './internal/utils/values';
 
-const environments = {
-  production: 'https://portfolio-parser.api.casparser.in',
-  environment_1: 'https://client-apis.casparser.in',
-  environment_2: 'http://localhost:5000',
-};
-type Environment = keyof typeof environments;
-
 export interface ClientOptions {
   /**
    * Your API key for authentication.
@@ -86,16 +80,6 @@ export interface ClientOptions {
    */
   apiKey?: string | undefined;
 
-  /**
-   * Specifies the environment to use for the API.
-   *
-   * Each environment maps to a different base URL:
-   * - `production` corresponds to `https://portfolio-parser.api.casparser.in`
-   * - `environment_1` corresponds to `https://client-apis.casparser.in`
-   * - `environment_2` corresponds to `http://localhost:5000`
-   */
-  environment?: Environment | undefined;
-
   /**
    * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
    *
@@ -187,8 +171,7 @@ export class CasParser {
    * API Client for interfacing with the Cas Parser API.
    *
    * @param {string | undefined} [opts.apiKey=process.env['CAS_PARSER_API_KEY'] ?? undefined]
-   * @param {Environment} [opts.environment=production] - Specifies the environment URL to use for the API.
-   * @param {string} [opts.baseURL=process.env['CAS_PARSER_BASE_URL'] ?? https://portfolio-parser.api.casparser.in] - Override the default base URL for the API.
+   * @param {string} [opts.baseURL=process.env['CAS_PARSER_BASE_URL'] ?? https://api.casparser.in] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
    * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
@@ -210,17 +193,10 @@ export class CasParser {
     const options: ClientOptions = {
       apiKey,
       ...opts,
-      baseURL,
-      environment: opts.environment ?? 'production',
+      baseURL: baseURL || `https://api.casparser.in`,
     };
 
-    if (baseURL && opts.environment) {
-      throw new Errors.CasParserError(
-        'Ambiguous URL; The `baseURL` option (or CAS_PARSER_BASE_URL env var) and the `environment` option are given. If you want to use the environment you must pass baseURL: null',
-      );
-    }
-
-    this.baseURL = options.baseURL || environments[options.environment || 'production'];
+    this.baseURL = options.baseURL!;
     this.timeout = options.timeout ?? CasParser.DEFAULT_TIMEOUT /* 1 minute */;
     this.logger = options.logger ?? console;
     const defaultLogLevel = 'warn';
@@ -246,8 +222,7 @@ export class CasParser {
   withOptions(options: Partial<ClientOptions>): this {
     const client = new (this.constructor as any as new (props: ClientOptions) => typeof this)({
       ...this._options,
-      environment: options.environment ? options.environment : undefined,
-      baseURL: options.environment ? undefined : this.baseURL,
+      baseURL: this.baseURL,
       maxRetries: this.maxRetries,
       timeout: this.timeout,
       logger: this.logger,
@@ -264,7 +239,7 @@ export class CasParser {
    * Check whether the base URL is set to its default.
    */
   #baseURLOverridden(): boolean {
-    return this.baseURL !== environments[this._options.environment || 'production'];
+    return this.baseURL !== 'https://api.casparser.in';
   }
 
   protected defaultQuery(): Record<string, string | undefined> | undefined {
@@ -282,21 +257,8 @@ export class CasParser {
   /**
    * Basic re-implementation of `qs.stringify` for primitive types.
    */
-  protected stringifyQuery(query: Record<string, unknown>): string {
-    return Object.entries(query)
-      .filter(([_, value]) => typeof value !== 'undefined')
-      .map(([key, value]) => {
-        if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
-          return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
-        }
-        if (value === null) {
-          return `${encodeURIComponent(key)}=`;
-        }
-        throw new Errors.CasParserError(
-          `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
-        );
-      })
-      .join('&');
+  protected stringifyQuery(query: object | Record<string, unknown>): string {
+    return stringifyQuery(query);
   }
 
   private getUserAgent(): string {
@@ -333,7 +295,7 @@ export class CasParser {
     }
 
     if (typeof query === 'object' && query && !Array.isArray(query)) {
-      url.search = this.stringifyQuery(query as Record<string, unknown>);
+      url.search = this.stringifyQuery(query);
     }
 
     return url.toString();
@@ -772,7 +734,7 @@ export class CasParser {
     ) {
       return {
         bodyHeaders: { 'content-type': 'application/x-www-form-urlencoded' },
-        body: this.stringifyQuery(body as Record<string, unknown>),
+        body: this.stringifyQuery(body),
       };
     } else {
       return this.#encoder({ body, headers });
@@ -798,17 +760,98 @@ export class CasParser {
 
   static toFile = Uploads.toFile;
 
+  /**
+   * Endpoints for checking API quota and credits usage.
+   * These endpoints help you monitor your API usage and remaining quota.
+   *
+   */
   credits: API.Credits = new API.Credits(this);
+  /**
+   * Endpoints for checking API quota and credits usage.
+   * These endpoints help you monitor your API usage and remaining quota.
+   *
+   */
   logs: API.Logs = new API.Logs(this);
+  /**
+   * Endpoints for managing access tokens for the Portfolio Connect SDK.
+   * Use these to generate short-lived `at_` prefixed tokens that can be safely passed to frontend applications.
+   * Access tokens can be used in place of API keys on all v4 endpoints.
+   *
+   */
   accessToken: API.AccessToken = new API.AccessToken(this);
+  /**
+   * Endpoints for managing access tokens for the Portfolio Connect SDK.
+   * Use these to generate short-lived `at_` prefixed tokens that can be safely passed to frontend applications.
+   * Access tokens can be used in place of API keys on all v4 endpoints.
+   *
+   */
   verifyToken: API.VerifyToken = new API.VerifyToken(this);
+  /**
+   * Endpoints for parsing CAS PDF files from different sources.
+   */
   camsKfintech: API.CamsKfintech = new API.CamsKfintech(this);
+  /**
+   * Endpoints for parsing CAS PDF files from different sources.
+   */
   cdsl: API.Cdsl = new API.Cdsl(this);
+  /**
+   * Endpoints for parsing Contract Note PDF files from various SEBI brokers like Zerodha, Groww, Upstox, ICICI etc.
+   */
   contractNote: API.ContractNote = new API.ContractNote(this);
+  /**
+   * Endpoints for importing CAS files directly from user email inboxes.
+   *
+   * **Supported Providers:** Gmail (more coming soon)
+   *
+   * **How it works:**
+   * 1. Call `POST /v4/inbox/connect` to get an OAuth URL
+   * 2. Redirect user to the OAuth URL for consent
+   * 3. User is redirected back to your `redirect_uri` with an encrypted `inbox_token`
+   * 4. Use the token to list/fetch CAS files from their inbox (`/v4/inbox/cas`)
+   * 5. Files are uploaded to temporary cloud storage (URLs expire in 24 hours)
+   *
+   * **Security:**
+   * - Read-only access (we cannot send emails)
+   * - Tokens are encrypted with server-side secret
+   * - User can revoke access anytime via `/v4/inbox/disconnect`
+   *
+   */
   inbox: API.Inbox = new API.Inbox(this);
+  /**
+   * Endpoints for generating new CAS documents via email mailback (KFintech).
+   */
   kfintech: API.Kfintech = new API.Kfintech(this);
+  /**
+   * Endpoints for parsing CAS PDF files from different sources.
+   */
   nsdl: API.Nsdl = new API.Nsdl(this);
+  /**
+   * Endpoints for parsing CAS PDF files from different sources.
+   */
   smart: API.Smart = new API.Smart(this);
+  /**
+   * Create dedicated inbound email addresses for investors to forward their CAS statements.
+   *
+   * **Use Case:** Your app wants to collect CAS statements from users without requiring OAuth or file upload.
+   *
+   * **How it works:**
+   * 1. Call `POST /v4/inbound-email` to create a unique inbound email address
+   * 2. Display this email to your user: "Forward your CAS statement to ie_xxx@import.casparser.in"
+   * 3. When user forwards a CAS email, we verify sender authenticity (SPF/DKIM) and call your webhook
+   * 4. Your webhook receives email metadata + attachment download URLs
+   *
+   * **Sender Validation:**
+   * - Only emails from verified CAS authorities are processed:
+   *   - CDSL: `eCAS@cdslstatement.com`
+   *   - NSDL: `NSDL-CAS@nsdl.co.in`
+   *   - CAMS: `donotreply@camsonline.com`
+   *   - KFintech: `samfS@kfintech.com`
+   * - Emails failing SPF/DKIM/DMARC are rejected
+   * - Forwarded emails must contain the original sender in headers
+   *
+   * **Billing:** 0.2 credits per successfully processed valid email
+   *
+   */
   inboundEmail: API.InboundEmail = new API.InboundEmail(this);
 }
 

package/src/internal/utils/query.ts

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { CasParserError } from '../../core/error';
+
+/**
+ * Basic re-implementation of `qs.stringify` for primitive types.
+ */
+export function stringifyQuery(query: object | Record<string, unknown>) {
+  return Object.entries(query)
+    .filter(([_, value]) => typeof value !== 'undefined')
+    .map(([key, value]) => {
+      if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
+        return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
+      }
+      if (value === null) {
+        return `${encodeURIComponent(key)}=`;
+      }
+      throw new CasParserError(
+        `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
+      );
+    })
+    .join('&');
+}

package/src/internal/utils.ts

@@ -6,3 +6,4 @@ export * from './utils/env';
 export * from './utils/log';
 export * from './utils/uuid';
 export * from './utils/sleep';
+export * from './utils/query';

package/src/resources/access-token.ts

@@ -4,6 +4,11 @@ import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Endpoints for managing access tokens for the Portfolio Connect SDK.
+ * Use these to generate short-lived `at_` prefixed tokens that can be safely passed to frontend applications.
+ * Access tokens can be used in place of API keys on all v4 endpoints.
+ */
 export class AccessToken extends APIResource {
   /**
    * Generate a short-lived access token from your API key.

package/src/resources/cams-kfintech.ts

@@ -6,6 +6,9 @@ import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { maybeMultipartFormRequestOptions } from '../internal/uploads';
 
+/**
+ * Endpoints for parsing CAS PDF files from different sources.
+ */
 export class CamsKfintech extends APIResource {
   /**
    * This endpoint specifically parses CAMS/KFintech CAS (Consolidated Account

package/src/resources/cdsl/cdsl.ts

@@ -14,6 +14,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { maybeMultipartFormRequestOptions } from '../../internal/uploads';
 
+/**
+ * Endpoints for parsing CAS PDF files from different sources.
+ */
 export class Cdsl extends APIResource {
   fetch: FetchAPI.Fetch = new FetchAPI.Fetch(this._client);
 

package/src/resources/cdsl/fetch.ts

@@ -5,6 +5,10 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Endpoints for fetching CAS documents with instant download.
+ * Currently supports CDSL via OTP authentication.
+ */
 export class Fetch extends APIResource {
   /**
    * **Step 1 of 2**: Request OTP for CDSL CAS fetch.

package/src/resources/contract-note.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { maybeMultipartFormRequestOptions } from '../internal/uploads';
 
+/**
+ * Endpoints for parsing Contract Note PDF files from various SEBI brokers like Zerodha, Groww, Upstox, ICICI etc.
+ */
 export class ContractNote extends APIResource {
   /**
    * This endpoint parses Contract Note PDF files from various brokers including

package/src/resources/credits.ts

@@ -4,6 +4,10 @@ import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Endpoints for checking API quota and credits usage.
+ * These endpoints help you monitor your API usage and remaining quota.
+ */
 export class Credits extends APIResource {
   /**
    * Check your remaining API credits and usage for the current billing period.

package/src/resources/inbound-email.ts

@@ -5,6 +5,28 @@ import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Create dedicated inbound email addresses for investors to forward their CAS statements.
+ *
+ * **Use Case:** Your app wants to collect CAS statements from users without requiring OAuth or file upload.
+ *
+ * **How it works:**
+ * 1. Call `POST /v4/inbound-email` to create a unique inbound email address
+ * 2. Display this email to your user: "Forward your CAS statement to ie_xxx@import.casparser.in"
+ * 3. When user forwards a CAS email, we verify sender authenticity (SPF/DKIM) and call your webhook
+ * 4. Your webhook receives email metadata + attachment download URLs
+ *
+ * **Sender Validation:**
+ * - Only emails from verified CAS authorities are processed:
+ *   - CDSL: `eCAS@cdslstatement.com`
+ *   - NSDL: `NSDL-CAS@nsdl.co.in`
+ *   - CAMS: `donotreply@camsonline.com`
+ *   - KFintech: `samfS@kfintech.com`
+ * - Emails failing SPF/DKIM/DMARC are rejected
+ * - Forwarded emails must contain the original sender in headers
+ *
+ * **Billing:** 0.2 credits per successfully processed valid email
+ */
 export class InboundEmail extends APIResource {
   /**
    * Create a dedicated inbound email address for collecting CAS statements via email

package/src/resources/inbox.ts

@@ -5,6 +5,23 @@ import { APIPromise } from '../core/api-promise';
 import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Endpoints for importing CAS files directly from user email inboxes.
+ *
+ * **Supported Providers:** Gmail (more coming soon)
+ *
+ * **How it works:**
+ * 1. Call `POST /v4/inbox/connect` to get an OAuth URL
+ * 2. Redirect user to the OAuth URL for consent
+ * 3. User is redirected back to your `redirect_uri` with an encrypted `inbox_token`
+ * 4. Use the token to list/fetch CAS files from their inbox (`/v4/inbox/cas`)
+ * 5. Files are uploaded to temporary cloud storage (URLs expire in 24 hours)
+ *
+ * **Security:**
+ * - Read-only access (we cannot send emails)
+ * - Tokens are encrypted with server-side secret
+ * - User can revoke access anytime via `/v4/inbox/disconnect`
+ */
 export class Inbox extends APIResource {
   /**
    * Verify if an `inbox_token` is still valid and check connection status.

package/src/resources/kfintech.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Endpoints for generating new CAS documents via email mailback (KFintech).
+ */
 export class Kfintech extends APIResource {
   /**
    * Generate CAS via KFintech mailback. The CAS PDF will be sent to the investor's

package/src/resources/logs.ts

@@ -4,6 +4,10 @@ import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Endpoints for checking API quota and credits usage.
+ * These endpoints help you monitor your API usage and remaining quota.
+ */
 export class Logs extends APIResource {
   /**
    * Retrieve detailed API usage logs for your account.

package/src/resources/nsdl.ts

@@ -6,6 +6,9 @@ import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { maybeMultipartFormRequestOptions } from '../internal/uploads';
 
+/**
+ * Endpoints for parsing CAS PDF files from different sources.
+ */
 export class Nsdl extends APIResource {
   /**
    * This endpoint specifically parses NSDL CAS (Consolidated Account Statement) PDF

package/src/resources/smart.ts

@@ -6,6 +6,9 @@ import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { maybeMultipartFormRequestOptions } from '../internal/uploads';
 
+/**
+ * Endpoints for parsing CAS PDF files from different sources.
+ */
 export class Smart extends APIResource {
   /**
    * This endpoint parses CAS (Consolidated Account Statement) PDF files from NSDL,

package/src/resources/verify-token.ts

@@ -4,6 +4,11 @@ import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Endpoints for managing access tokens for the Portfolio Connect SDK.
+ * Use these to generate short-lived `at_` prefixed tokens that can be safely passed to frontend applications.
+ * Access tokens can be used in place of API keys on all v4 endpoints.
+ */
 export class VerifyToken extends APIResource {
   /**
    * Verify an access token and check if it's still valid. Useful for debugging token

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.8.0'; // x-release-please-version
+export const VERSION = '1.10.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.8.0";
+export declare const VERSION = "1.10.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.8.0";
+export declare const VERSION = "1.10.0";
 //# sourceMappingURL=version.d.ts.map

package/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '1.8.0'; // x-release-please-version
+exports.VERSION = '1.10.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '1.8.0'; // x-release-please-version
+export const VERSION = '1.10.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map

package/version.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}