@41devs/naya-id-js 0.1.0

package/dist/naya-id.d.cts

@@ -0,0 +1,252 @@
+/**
+ * Configuration du parcours de vérification Naya ID.
+ *
+ * Reprend, à l'identique, le modèle des SDK Flutter et Angular : tous les champs
+ * sont optionnels et le SDK fonctionne avec des valeurs par défaut raisonnables
+ * (tous pays, tous documents, français).
+ */
+/** Pays supportés par Naya ID (zone CEDEAO). Code = ISO 3166-1 alpha-2. */
+declare const NAYA_COUNTRIES: readonly [{
+    readonly code: "BJ";
+    readonly label: "Bénin";
+}, {
+    readonly code: "CI";
+    readonly label: "Côte d'Ivoire";
+}, {
+    readonly code: "SN";
+    readonly label: "Sénégal";
+}, {
+    readonly code: "ML";
+    readonly label: "Mali";
+}, {
+    readonly code: "BF";
+    readonly label: "Burkina Faso";
+}, {
+    readonly code: "TG";
+    readonly label: "Togo";
+}];
+type NayaCountryCode = (typeof NAYA_COUNTRIES)[number]['code'];
+/** Types de documents acceptés. La valeur est envoyée telle quelle à l'API. */
+type NayaDocumentType = 'cni' | 'passeport' | 'permis';
+declare const NAYA_DOCUMENT_TYPES: readonly NayaDocumentType[];
+/** Langues de l'interface du SDK. */
+type NayaLocale = 'fr' | 'en';
+/**
+ * Fournisseur d'authentification.
+ *
+ * Deux modes, un seul à renseigner :
+ *   • `apiKey`       — la clé d'application est transmise depuis le navigateur.
+ *                      Simple, mais la clé est lisible côté client : à réserver
+ *                      aux démos et aux intégrations où le front est maîtrisé.
+ *   • `sessionToken` — jeton éphémère obtenu par le backend du client, limité à
+ *                      une vérification. À privilégier en production.
+ */
+interface NayaAuth {
+    apiKey?: string;
+    sessionToken?: string;
+}
+/** Palette optionnelle : surcharge des couleurs de marque. */
+interface NayaThemeOverrides {
+    /** Couleur principale (défaut : navy Naya #1A3A5C). */
+    primaryColor?: string;
+    /** Couleur d'accent des CTA (défaut : ambre Naya #F5A623). */
+    accentColor?: string;
+}
+/**
+ * Emplacement des ressources de détection de vivacité (MediaPipe). Par défaut,
+ * elles sont chargées depuis un CDN public. Les applications à CSP stricte
+ * (qui bloquent les hôtes externes) doivent auto-héberger ces fichiers et
+ * renseigner ici leurs URL.
+ */
+interface NayaLivenessAssets {
+    /** URL du module ESM `@mediapipe/tasks-vision` (`vision_bundle.mjs`). */
+    esmUrl?: string;
+    /** Base des fichiers WASM `@mediapipe/tasks-vision`. */
+    wasmBaseUrl?: string;
+    /** URL du modèle `.task` de Face Landmarker. */
+    modelUrl?: string;
+}
+interface NayaConfig {
+    /** Pré-sélectionne le pays : l'utilisateur ne le choisit plus. */
+    country?: NayaCountryCode;
+    /**
+     * Types de documents proposés. S'il n'y en a qu'un et que `country` est
+     * défini, l'écran de sélection est sauté.
+     */
+    documentTypes?: readonly NayaDocumentType[];
+    /** Pays proposés quand `country` n'est pas défini. */
+    countries?: readonly NayaCountryCode[];
+    /** Langue de l'interface. */
+    locale?: NayaLocale;
+    /**
+     * URL (HTTPS) notifiée par le serveur Naya à chaque décision sur cette
+     * session — décision automatique puis, le cas échéant, revue manuelle.
+     */
+    callbackUrl?: string;
+    /** Nombre de parcours autorisés après un rejet (bouton « Réessayer »). */
+    maxAttempts?: number;
+    /** Surcharge des couleurs de marque. */
+    theme?: NayaThemeOverrides;
+    /** URL d'un logo client, affiché à côté de « Propulsé par Naya ID ». */
+    clientLogoUrl?: string;
+    /** Base URL de l'API — ne changer que pour un environnement de test. */
+    baseUrl?: string;
+    /** Auto-hébergement des ressources MediaPipe (CSP stricte). */
+    livenessAssets?: NayaLivenessAssets;
+}
+/** Configuration effective : `NayaConfig` avec tous les défauts appliqués. */
+interface ResolvedNayaConfig {
+    country?: NayaCountryCode;
+    documentTypes: readonly NayaDocumentType[];
+    countries: readonly NayaCountryCode[];
+    locale: NayaLocale;
+    callbackUrl?: string;
+    maxAttempts: number;
+    theme: Required<NayaThemeOverrides>;
+    clientLogoUrl?: string;
+    baseUrl: string;
+    livenessAssets: NayaLivenessAssets;
+}
+declare const NAYA_DEFAULT_PRIMARY = "#1A3A5C";
+declare const NAYA_DEFAULT_ACCENT = "#F5A623";
+declare const NAYA_DEFAULT_BASE_URL = "https://api.naya.41devs.com/v1";
+/** Applique les valeurs par défaut à une configuration partielle. */
+declare function resolveConfig(config?: NayaConfig): ResolvedNayaConfig;
+/** Libellé lisible d'un code pays. */
+declare function countryLabel(code: NayaCountryCode): string;
+/** La CNI CEDEAO porte sa MRZ au verso ; passeport et permis n'en ont pas besoin. */
+declare function documentNeedsVerso(doc: NayaDocumentType): boolean;
+
+/**
+ * Résultat du parcours, rendu à l'application cliente à la fermeture du SDK.
+ * Miroir fidèle des modèles Flutter et Angular.
+ */
+/** Issue du parcours de vérification. */
+type NayaStatus = 
+/** Identité vérifiée et approuvée automatiquement. */
+'approved'
+/** Dossier envoyé en revue manuelle — décision finale ultérieure. */
+ | 'review'
+/** Vérification rejetée (document expiré, visage non concordant…). */
+ | 'rejected'
+/** L'utilisateur a quitté le parcours avant la fin. */
+ | 'cancelled'
+/** Erreur technique (réseau, serveur…) ayant interrompu le parcours. */
+ | 'error';
+/**
+ * Données d'identité extraites du document par l'OCR Naya, éventuellement
+ * corrigées par l'utilisateur.
+ */
+interface NayaOcrData {
+    lastName?: string;
+    firstName?: string;
+    /** Format YYYY-MM-DD. */
+    dateOfBirth?: string;
+    placeOfBirth?: string;
+    nationality?: string;
+    /** Format YYYY-MM-DD. */
+    expirationDate?: string;
+    documentNumber?: string;
+    /** Numéro Personnel d'Identification (Bénin) — 10 chiffres. */
+    npi?: string;
+    issuingCountry?: string;
+    issuingAuthority?: string;
+    /** 'M' ou 'F'. */
+    gender?: string;
+}
+/** Lit un objet OCR brut de l'API en ne retenant que les champs connus. */
+declare function parseOcrData(raw: unknown): NayaOcrData | undefined;
+/** Réduit un objet OCR à ses seuls champs renseignés, en chaînes. */
+declare function ocrToDeclaredData(ocr: NayaOcrData): Record<string, string>;
+/** Résultat retourné à l'application cliente. */
+interface NayaResult {
+    status: NayaStatus;
+    /**
+     * Identifiant de la session Naya — à conserver côté client pour rapprocher
+     * les notifications `callbackUrl` et le dashboard.
+     */
+    verificationId?: string;
+    /** Score de risque agrégé 0-100 (plus haut = plus sûr). */
+    riskScore?: number;
+    /** Concordance faciale document ↔ selfie, 0-100. */
+    matchScore?: number;
+    /** Intégrité du document, 0-100. */
+    authenticityScore?: number;
+    /** Score de vivacité, 0-100. */
+    livenessScore?: number;
+    /** Confiance de l'extraction OCR, 0-100. */
+    ocrConfidence?: number;
+    /** Données d'identité finales (OCR fusionné avec les corrections). */
+    ocrData?: NayaOcrData;
+    /** Note d'analyse produite par le pipeline Naya. */
+    note?: string;
+    /** Détail de l'erreur quand `status` vaut `'error'`. */
+    errorMessage?: string;
+}
+declare function cancelledResult(verificationId?: string): NayaResult;
+declare function errorResult(errorMessage: string, verificationId?: string): NayaResult;
+
+/**
+ * Client HTTP du pipeline de vérification Naya.
+ *
+ * Bâti sur `fetch` natif, sans dépendance. Les délais sont dimensionnés pour les
+ * étapes longues (OCR et décision côté serveur).
+ *
+ * Authentification via `NayaAuth` : `apiKey` (en-tête `X-API-Key`) ou
+ * `sessionToken` (en-tête `Authorization: Bearer`). Le choix est transparent
+ * pour le reste du SDK.
+ */
+/** Erreur renvoyée par l'API Naya ou par le transport réseau. */
+declare class NayaApiError extends Error {
+    readonly statusCode?: number;
+    constructor(message: string, statusCode?: number);
+}
+
+/**
+ * SDK JavaScript officiel de Naya ID — vérification d'identité (eKYC) clé en
+ * main pour l'Afrique de l'Ouest (zone CEDEAO), chargeable en une balise
+ * `<script>`.
+ *
+ * Pendant web « sans framework » des SDK Flutter et Angular : même parcours,
+ * mêmes écrans, même contrat d'API.
+ *
+ * ```html
+ * <script src="https://cdn.jsdelivr.net/npm/@41devs/naya-id-js@0/dist/naya-id.min.js"></script>
+ * <script>
+ *   const result = await NayaId.startVerification({
+ *     apiKey: 'naya_live_xxx',
+ *     config: { country: 'BJ' },
+ *   });
+ *   // result.status → 'approved' | 'review' | 'rejected' | 'cancelled' | 'error'
+ * </script>
+ * ```
+ */
+
+interface StartVerificationParams {
+    /** Clé d'application `naya_live_…` / `naya_test_…` (lisible côté navigateur). */
+    apiKey?: string;
+    /** Jeton de session éphémère obtenu par votre backend (à privilégier). */
+    sessionToken?: string;
+    /** Alternative aux deux champs ci-dessus, forme objet. */
+    auth?: NayaAuth;
+    /** Configuration optionnelle (pays, documents, langue, callbackUrl, thème…). */
+    config?: NayaConfig;
+}
+/**
+ * Lance le parcours de vérification d'identité : l'interface Naya s'ouvre en
+ * plein écran au-dessus de la page, prend en charge la capture du document, la
+ * vivacité et la décision, puis résout un `NayaResult` et rend la main.
+ *
+ * **Ne rejette jamais** : une erreur réseau ou une annulation revient toujours
+ * sous forme de `NayaResult` (`status: 'error'` ou `'cancelled'`).
+ */
+declare function startVerification(params: StartVerificationParams): Promise<NayaResult>;
+/** Version du SDK. */
+declare const version = "0.1.0";
+
+declare const _default: {
+    startVerification: typeof startVerification;
+    version: string;
+};
+
+export { NAYA_COUNTRIES, NAYA_DEFAULT_ACCENT, NAYA_DEFAULT_BASE_URL, NAYA_DEFAULT_PRIMARY, NAYA_DOCUMENT_TYPES, NayaApiError, type NayaAuth, type NayaConfig, type NayaCountryCode, type NayaDocumentType, type NayaLivenessAssets, type NayaLocale, type NayaOcrData, type NayaResult, type NayaStatus, type NayaThemeOverrides, type ResolvedNayaConfig, type StartVerificationParams, cancelledResult, countryLabel, _default as default, documentNeedsVerso, errorResult, ocrToDeclaredData, parseOcrData, resolveConfig, startVerification, version };

package/dist/naya-id.d.ts

@@ -0,0 +1,252 @@
+/**
+ * Configuration du parcours de vérification Naya ID.
+ *
+ * Reprend, à l'identique, le modèle des SDK Flutter et Angular : tous les champs
+ * sont optionnels et le SDK fonctionne avec des valeurs par défaut raisonnables
+ * (tous pays, tous documents, français).
+ */
+/** Pays supportés par Naya ID (zone CEDEAO). Code = ISO 3166-1 alpha-2. */
+declare const NAYA_COUNTRIES: readonly [{
+    readonly code: "BJ";
+    readonly label: "Bénin";
+}, {
+    readonly code: "CI";
+    readonly label: "Côte d'Ivoire";
+}, {
+    readonly code: "SN";
+    readonly label: "Sénégal";
+}, {
+    readonly code: "ML";
+    readonly label: "Mali";
+}, {
+    readonly code: "BF";
+    readonly label: "Burkina Faso";
+}, {
+    readonly code: "TG";
+    readonly label: "Togo";
+}];
+type NayaCountryCode = (typeof NAYA_COUNTRIES)[number]['code'];
+/** Types de documents acceptés. La valeur est envoyée telle quelle à l'API. */
+type NayaDocumentType = 'cni' | 'passeport' | 'permis';
+declare const NAYA_DOCUMENT_TYPES: readonly NayaDocumentType[];
+/** Langues de l'interface du SDK. */
+type NayaLocale = 'fr' | 'en';
+/**
+ * Fournisseur d'authentification.
+ *
+ * Deux modes, un seul à renseigner :
+ *   • `apiKey`       — la clé d'application est transmise depuis le navigateur.
+ *                      Simple, mais la clé est lisible côté client : à réserver
+ *                      aux démos et aux intégrations où le front est maîtrisé.
+ *   • `sessionToken` — jeton éphémère obtenu par le backend du client, limité à
+ *                      une vérification. À privilégier en production.
+ */
+interface NayaAuth {
+    apiKey?: string;
+    sessionToken?: string;
+}
+/** Palette optionnelle : surcharge des couleurs de marque. */
+interface NayaThemeOverrides {
+    /** Couleur principale (défaut : navy Naya #1A3A5C). */
+    primaryColor?: string;
+    /** Couleur d'accent des CTA (défaut : ambre Naya #F5A623). */
+    accentColor?: string;
+}
+/**
+ * Emplacement des ressources de détection de vivacité (MediaPipe). Par défaut,
+ * elles sont chargées depuis un CDN public. Les applications à CSP stricte
+ * (qui bloquent les hôtes externes) doivent auto-héberger ces fichiers et
+ * renseigner ici leurs URL.
+ */
+interface NayaLivenessAssets {
+    /** URL du module ESM `@mediapipe/tasks-vision` (`vision_bundle.mjs`). */
+    esmUrl?: string;
+    /** Base des fichiers WASM `@mediapipe/tasks-vision`. */
+    wasmBaseUrl?: string;
+    /** URL du modèle `.task` de Face Landmarker. */
+    modelUrl?: string;
+}
+interface NayaConfig {
+    /** Pré-sélectionne le pays : l'utilisateur ne le choisit plus. */
+    country?: NayaCountryCode;
+    /**
+     * Types de documents proposés. S'il n'y en a qu'un et que `country` est
+     * défini, l'écran de sélection est sauté.
+     */
+    documentTypes?: readonly NayaDocumentType[];
+    /** Pays proposés quand `country` n'est pas défini. */
+    countries?: readonly NayaCountryCode[];
+    /** Langue de l'interface. */
+    locale?: NayaLocale;
+    /**
+     * URL (HTTPS) notifiée par le serveur Naya à chaque décision sur cette
+     * session — décision automatique puis, le cas échéant, revue manuelle.
+     */
+    callbackUrl?: string;
+    /** Nombre de parcours autorisés après un rejet (bouton « Réessayer »). */
+    maxAttempts?: number;
+    /** Surcharge des couleurs de marque. */
+    theme?: NayaThemeOverrides;
+    /** URL d'un logo client, affiché à côté de « Propulsé par Naya ID ». */
+    clientLogoUrl?: string;
+    /** Base URL de l'API — ne changer que pour un environnement de test. */
+    baseUrl?: string;
+    /** Auto-hébergement des ressources MediaPipe (CSP stricte). */
+    livenessAssets?: NayaLivenessAssets;
+}
+/** Configuration effective : `NayaConfig` avec tous les défauts appliqués. */
+interface ResolvedNayaConfig {
+    country?: NayaCountryCode;
+    documentTypes: readonly NayaDocumentType[];
+    countries: readonly NayaCountryCode[];
+    locale: NayaLocale;
+    callbackUrl?: string;
+    maxAttempts: number;
+    theme: Required<NayaThemeOverrides>;
+    clientLogoUrl?: string;
+    baseUrl: string;
+    livenessAssets: NayaLivenessAssets;
+}
+declare const NAYA_DEFAULT_PRIMARY = "#1A3A5C";
+declare const NAYA_DEFAULT_ACCENT = "#F5A623";
+declare const NAYA_DEFAULT_BASE_URL = "https://api.naya.41devs.com/v1";
+/** Applique les valeurs par défaut à une configuration partielle. */
+declare function resolveConfig(config?: NayaConfig): ResolvedNayaConfig;
+/** Libellé lisible d'un code pays. */
+declare function countryLabel(code: NayaCountryCode): string;
+/** La CNI CEDEAO porte sa MRZ au verso ; passeport et permis n'en ont pas besoin. */
+declare function documentNeedsVerso(doc: NayaDocumentType): boolean;
+
+/**
+ * Résultat du parcours, rendu à l'application cliente à la fermeture du SDK.
+ * Miroir fidèle des modèles Flutter et Angular.
+ */
+/** Issue du parcours de vérification. */
+type NayaStatus = 
+/** Identité vérifiée et approuvée automatiquement. */
+'approved'
+/** Dossier envoyé en revue manuelle — décision finale ultérieure. */
+ | 'review'
+/** Vérification rejetée (document expiré, visage non concordant…). */
+ | 'rejected'
+/** L'utilisateur a quitté le parcours avant la fin. */
+ | 'cancelled'
+/** Erreur technique (réseau, serveur…) ayant interrompu le parcours. */
+ | 'error';
+/**
+ * Données d'identité extraites du document par l'OCR Naya, éventuellement
+ * corrigées par l'utilisateur.
+ */
+interface NayaOcrData {
+    lastName?: string;
+    firstName?: string;
+    /** Format YYYY-MM-DD. */
+    dateOfBirth?: string;
+    placeOfBirth?: string;
+    nationality?: string;
+    /** Format YYYY-MM-DD. */
+    expirationDate?: string;
+    documentNumber?: string;
+    /** Numéro Personnel d'Identification (Bénin) — 10 chiffres. */
+    npi?: string;
+    issuingCountry?: string;
+    issuingAuthority?: string;
+    /** 'M' ou 'F'. */
+    gender?: string;
+}
+/** Lit un objet OCR brut de l'API en ne retenant que les champs connus. */
+declare function parseOcrData(raw: unknown): NayaOcrData | undefined;
+/** Réduit un objet OCR à ses seuls champs renseignés, en chaînes. */
+declare function ocrToDeclaredData(ocr: NayaOcrData): Record<string, string>;
+/** Résultat retourné à l'application cliente. */
+interface NayaResult {
+    status: NayaStatus;
+    /**
+     * Identifiant de la session Naya — à conserver côté client pour rapprocher
+     * les notifications `callbackUrl` et le dashboard.
+     */
+    verificationId?: string;
+    /** Score de risque agrégé 0-100 (plus haut = plus sûr). */
+    riskScore?: number;
+    /** Concordance faciale document ↔ selfie, 0-100. */
+    matchScore?: number;
+    /** Intégrité du document, 0-100. */
+    authenticityScore?: number;
+    /** Score de vivacité, 0-100. */
+    livenessScore?: number;
+    /** Confiance de l'extraction OCR, 0-100. */
+    ocrConfidence?: number;
+    /** Données d'identité finales (OCR fusionné avec les corrections). */
+    ocrData?: NayaOcrData;
+    /** Note d'analyse produite par le pipeline Naya. */
+    note?: string;
+    /** Détail de l'erreur quand `status` vaut `'error'`. */
+    errorMessage?: string;
+}
+declare function cancelledResult(verificationId?: string): NayaResult;
+declare function errorResult(errorMessage: string, verificationId?: string): NayaResult;
+
+/**
+ * Client HTTP du pipeline de vérification Naya.
+ *
+ * Bâti sur `fetch` natif, sans dépendance. Les délais sont dimensionnés pour les
+ * étapes longues (OCR et décision côté serveur).
+ *
+ * Authentification via `NayaAuth` : `apiKey` (en-tête `X-API-Key`) ou
+ * `sessionToken` (en-tête `Authorization: Bearer`). Le choix est transparent
+ * pour le reste du SDK.
+ */
+/** Erreur renvoyée par l'API Naya ou par le transport réseau. */
+declare class NayaApiError extends Error {
+    readonly statusCode?: number;
+    constructor(message: string, statusCode?: number);
+}
+
+/**
+ * SDK JavaScript officiel de Naya ID — vérification d'identité (eKYC) clé en
+ * main pour l'Afrique de l'Ouest (zone CEDEAO), chargeable en une balise
+ * `<script>`.
+ *
+ * Pendant web « sans framework » des SDK Flutter et Angular : même parcours,
+ * mêmes écrans, même contrat d'API.
+ *
+ * ```html
+ * <script src="https://cdn.jsdelivr.net/npm/@41devs/naya-id-js@0/dist/naya-id.min.js"></script>
+ * <script>
+ *   const result = await NayaId.startVerification({
+ *     apiKey: 'naya_live_xxx',
+ *     config: { country: 'BJ' },
+ *   });
+ *   // result.status → 'approved' | 'review' | 'rejected' | 'cancelled' | 'error'
+ * </script>
+ * ```
+ */
+
+interface StartVerificationParams {
+    /** Clé d'application `naya_live_…` / `naya_test_…` (lisible côté navigateur). */
+    apiKey?: string;
+    /** Jeton de session éphémère obtenu par votre backend (à privilégier). */
+    sessionToken?: string;
+    /** Alternative aux deux champs ci-dessus, forme objet. */
+    auth?: NayaAuth;
+    /** Configuration optionnelle (pays, documents, langue, callbackUrl, thème…). */
+    config?: NayaConfig;
+}
+/**
+ * Lance le parcours de vérification d'identité : l'interface Naya s'ouvre en
+ * plein écran au-dessus de la page, prend en charge la capture du document, la
+ * vivacité et la décision, puis résout un `NayaResult` et rend la main.
+ *
+ * **Ne rejette jamais** : une erreur réseau ou une annulation revient toujours
+ * sous forme de `NayaResult` (`status: 'error'` ou `'cancelled'`).
+ */
+declare function startVerification(params: StartVerificationParams): Promise<NayaResult>;
+/** Version du SDK. */
+declare const version = "0.1.0";
+
+declare const _default: {
+    startVerification: typeof startVerification;
+    version: string;
+};
+
+export { NAYA_COUNTRIES, NAYA_DEFAULT_ACCENT, NAYA_DEFAULT_BASE_URL, NAYA_DEFAULT_PRIMARY, NAYA_DOCUMENT_TYPES, NayaApiError, type NayaAuth, type NayaConfig, type NayaCountryCode, type NayaDocumentType, type NayaLivenessAssets, type NayaLocale, type NayaOcrData, type NayaResult, type NayaStatus, type NayaThemeOverrides, type ResolvedNayaConfig, type StartVerificationParams, cancelledResult, countryLabel, _default as default, documentNeedsVerso, errorResult, ocrToDeclaredData, parseOcrData, resolveConfig, startVerification, version };