persian-bank-react 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,87 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { HTMLAttributes } from 'react';
+
+/**
+ * Identifiers for supported Iranian banks and financial institutions.
+ *
+ * The values are intentionally kept as stable, lowercase identifiers
+ * so they can safely be used as component props, lookup keys, and
+ * serialized values.
+ */
+type BankNameType$1 = "ayandeh" | "markazi" | "blue" | "caspian" | "dey" | "eghtesaade-novin" | "future" | "gardeshgari" | "iran-europe" | "iran-venezuela" | "iran-zamin" | "karafarin" | "keshavarzi" | "khavar-mianeh" | "maskan" | "mehr-iran" | "melall" | "mellat" | "melli" | "noor" | "parsian" | "pasargad" | "post" | "refah" | "resalat" | "saderat" | "saman" | "sanat-madan" | "sarmayeh" | "sepah" | "shahr" | "sina" | "standard-chartered" | "taavon-eslami" | "tejarat" | "tosee" | "tosee-sedarat" | "tossee-taavon" | "kosar" | "mehr-eghtesaad" | "ghavamin" | "hekmat" | "ansar" | "unknown";
+/**
+ * Props shared by the BankIcon component.
+ *
+ * Extending SVG HTML attributes allows consumers to use standard
+ * SVG properties such as className, aria-label, width, height,
+ * and other native React SVG attributes.
+ */
+interface BankIconPropsType extends HTMLAttributes<SVGElement> {
+    /** Identifier of the bank whose icon should be rendered. */
+    name: BankNameType$1;
+}
+/**
+ * Metadata associated with a bank.
+ *
+ * `type` is the stable identifier used internally by the icon system,
+ * while `name` represents the human-readable bank name.
+ */
+interface BankInfo$1 {
+    type: BankNameType$1;
+    name: string;
+}
+
+type bankType_BankIconPropsType = BankIconPropsType;
+declare namespace bankType {
+  export type { bankType_BankIconPropsType as BankIconPropsType, BankInfo$1 as BankInfo, BankNameType$1 as BankNameType };
+}
+
+/**
+ * Renders the icon for a supported Iranian bank.
+ *
+ * Each bank icon is kept as an inline SVG so it:
+ * - Scales cleanly at any size.
+ * - Inherits standard SVG/React props from the caller.
+ * - Doesn't require an additional image request.
+ */
+declare function BankIcon({ name, ...props }: BankIconPropsType): false | react_jsx_runtime.JSX.Element;
+
+type BankNameType = "ayandeh" | "markazi" | "blue" | "caspian" | "dey" | "eghtesaade-novin" | "future" | "gardeshgari" | "iran-europe" | "iran-venezuela" | "iran-zamin" | "karafarin" | "keshavarzi" | "khavar-mianeh" | "maskan" | "mehr-iran" | "melall" | "mellat" | "melli" | "noor" | "parsian" | "pasargad" | "post" | "refah" | "resalat" | "saderat" | "saman" | "sanat-madan" | "sarmayeh" | "sepah" | "shahr" | "sina" | "standard-chartered" | "taavon-eslami" | "tejarat" | "tosee" | "tosee-sedarat" | "tossee-taavon" | "kosar" | "mehr-eghtesaad" | "ghavamin" | "hekmat" | "ansar" | "unknown";
+interface BankInfo {
+    type: BankNameType;
+    name: string;
+}
+
+/**
+ * Resolves the issuing bank from an Iranian card number.
+ *
+ * The function accepts both string and numeric input and normalizes
+ * formatting characters such as spaces or hyphens before performing
+ * the BIN lookup.
+ *
+ * @returns Bank metadata when the BIN is recognized; otherwise `null`.
+ */
+declare function getBankFromCard(cardNumber: string | number): BankInfo | null;
+/**
+ * Resolves the issuing bank from an Iranian SHEBA/IBAN number.
+ *
+ * Both formats are supported:
+ * - `IR` prefixed: `IRxxxxxxxxxxxxxxxxxxxxxxxx`
+ * - 24-digit numeric value when `useIR` is enabled
+ *
+ * Whitespace is ignored, making formatted SHEBA values safe to pass
+ * directly to the function.
+ *
+ * @param sheba - Iranian SHEBA/IBAN value.
+ * @param useIR - Whether the supplied value omits the `IR` prefix.
+ * @returns Bank metadata when the bank code is recognized; otherwise `null`.
+ */
+declare function getBankFromSheba(sheba: string, useIR?: boolean): BankInfo | null;
+
+declare const bankUtil_getBankFromCard: typeof getBankFromCard;
+declare const bankUtil_getBankFromSheba: typeof getBankFromSheba;
+declare namespace bankUtil {
+  export { bankUtil_getBankFromCard as getBankFromCard, bankUtil_getBankFromSheba as getBankFromSheba };
+}
+
+export { BankIcon, bankType as Types, bankUtil as Utils };