@factpulse/sdk 2.0.12 → 3.0.1

package/dist/src/helpers/exceptions.d.ts

@@ -0,0 +1,23 @@
+export declare class FactPulseError extends Error {
+    constructor(message: string);
+}
+export declare class FactPulseAuthError extends FactPulseError {
+    constructor(message?: string);
+}
+export declare class FactPulsePollingTimeout extends FactPulseError {
+    readonly taskId: string;
+    readonly timeout: number;
+    constructor(taskId: string, timeout: number);
+}
+export interface ValidationErrorDetail {
+    level?: string;
+    item?: string;
+    reason?: string;
+    source?: string;
+    code?: string;
+}
+export declare function formatValidationError(e: ValidationErrorDetail): string;
+export declare class FactPulseValidationError extends FactPulseError {
+    readonly errors: ValidationErrorDetail[];
+    constructor(message: string, errors?: ValidationErrorDetail[]);
+}

package/dist/src/helpers/exceptions.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FactPulseValidationError = exports.FactPulsePollingTimeout = exports.FactPulseAuthError = exports.FactPulseError = void 0;
+exports.formatValidationError = formatValidationError;
+class FactPulseError extends Error {
+    constructor(message) { super(message); this.name = 'FactPulseError'; Object.setPrototypeOf(this, FactPulseError.prototype); }
+}
+exports.FactPulseError = FactPulseError;
+class FactPulseAuthError extends FactPulseError {
+    constructor(message = "Erreur d'authentification") { super(message); this.name = 'FactPulseAuthError'; Object.setPrototypeOf(this, FactPulseAuthError.prototype); }
+}
+exports.FactPulseAuthError = FactPulseAuthError;
+class FactPulsePollingTimeout extends FactPulseError {
+    constructor(taskId, timeout) {
+        super(`Timeout (${timeout}ms) atteint pour la tâche ${taskId}`);
+        this.name = 'FactPulsePollingTimeout';
+        this.taskId = taskId;
+        this.timeout = timeout;
+        Object.setPrototypeOf(this, FactPulsePollingTimeout.prototype);
+    }
+}
+exports.FactPulsePollingTimeout = FactPulsePollingTimeout;
+function formatValidationError(e) {
+    return `[${e.item || 'unknown'}] ${e.reason || 'Unknown error'}`;
+}
+class FactPulseValidationError extends FactPulseError {
+    constructor(message, errors = []) {
+        const fullMessage = errors.length > 0 ? `${message}\n\nDétails:\n${errors.map(e => `  - ${formatValidationError(e)}`).join('\n')}` : message;
+        super(fullMessage);
+        this.name = 'FactPulseValidationError';
+        this.errors = errors;
+        Object.setPrototypeOf(this, FactPulseValidationError.prototype);
+    }
+}
+exports.FactPulseValidationError = FactPulseValidationError;

package/dist/src/helpers/index.d.ts

@@ -0,0 +1,3 @@
+export { FactPulseError, FactPulseAuthError, FactPulsePollingTimeout, FactPulseValidationError, ValidationErrorDetail, formatValidationError } from './exceptions';
+export { FactPulseClient, FactPulseClientConfig, ChorusProCredentials, AFNORCredentials } from './client';
+export { amount, invoiceTotals, invoiceLine, vatLine, postalAddress, electronicAddress, supplier, recipient, beneficiary } from './client';

package/dist/src/helpers/index.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.beneficiary = exports.recipient = exports.supplier = exports.electronicAddress = exports.postalAddress = exports.vatLine = exports.invoiceLine = exports.invoiceTotals = exports.amount = exports.FactPulseClient = exports.formatValidationError = exports.FactPulseValidationError = exports.FactPulsePollingTimeout = exports.FactPulseAuthError = exports.FactPulseError = void 0;
+// Exceptions
+var exceptions_1 = require("./exceptions");
+Object.defineProperty(exports, "FactPulseError", { enumerable: true, get: function () { return exceptions_1.FactPulseError; } });
+Object.defineProperty(exports, "FactPulseAuthError", { enumerable: true, get: function () { return exceptions_1.FactPulseAuthError; } });
+Object.defineProperty(exports, "FactPulsePollingTimeout", { enumerable: true, get: function () { return exceptions_1.FactPulsePollingTimeout; } });
+Object.defineProperty(exports, "FactPulseValidationError", { enumerable: true, get: function () { return exceptions_1.FactPulseValidationError; } });
+Object.defineProperty(exports, "formatValidationError", { enumerable: true, get: function () { return exceptions_1.formatValidationError; } });
+// Client and configuration
+var client_1 = require("./client");
+Object.defineProperty(exports, "FactPulseClient", { enumerable: true, get: function () { return client_1.FactPulseClient; } });
+// Helpers for amounts
+var client_2 = require("./client");
+Object.defineProperty(exports, "amount", { enumerable: true, get: function () { return client_2.amount; } });
+Object.defineProperty(exports, "invoiceTotals", { enumerable: true, get: function () { return client_2.invoiceTotals; } });
+Object.defineProperty(exports, "invoiceLine", { enumerable: true, get: function () { return client_2.invoiceLine; } });
+Object.defineProperty(exports, "vatLine", { enumerable: true, get: function () { return client_2.vatLine; } });
+Object.defineProperty(exports, "postalAddress", { enumerable: true, get: function () { return client_2.postalAddress; } });
+Object.defineProperty(exports, "electronicAddress", { enumerable: true, get: function () { return client_2.electronicAddress; } });
+Object.defineProperty(exports, "supplier", { enumerable: true, get: function () { return client_2.supplier; } });
+Object.defineProperty(exports, "recipient", { enumerable: true, get: function () { return client_2.recipient; } });
+Object.defineProperty(exports, "beneficiary", { enumerable: true, get: function () { return client_2.beneficiary; } });

package/docs/AFNORCredentials.md

@@ -0,0 +1,25 @@
+# AFNORCredentials
+
+Optional AFNOR PDP credentials.  **MODE 1 - JWT retrieval (recommended):** Do not provide this `credentials` field in the payload. PDP credentials will be automatically retrieved via client_uid from JWT (0-trust).  **MODE 2 - Credentials in payload (zero-storage):** Provide all required fields below. Useful for tests or third-party integrations.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clientId** | **string** |  | [optional] [default to undefined]
+**clientSecret** | **string** |  | [optional] [default to undefined]
+**flowServiceUrl** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AFNORCredentials } from '@factpulse/sdk';
+
+const instance: AFNORCredentials = {
+    clientId,
+    clientSecret,
+    flowServiceUrl,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AFNORDestination.md

@@ -0,0 +1,27 @@
+# AFNORDestination
+
+Specific configuration for AFNOR PDP destination.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** |  | [optional] [default to TypeEnum_Afnor]
+**credentials** | [**AFNORCredentials**](AFNORCredentials.md) |  | [optional] [default to undefined]
+**flowSyntax** | **string** | Flow syntax to send | [optional] [default to FlowSyntaxEnum_FacturX]
+**trackingId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AFNORDestination } from '@factpulse/sdk';
+
+const instance: AFNORDestination = {
+    type,
+    credentials,
+    flowSyntax,
+    trackingId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AFNORHealthCheckResponse.md

@@ -0,0 +1,25 @@
+# AFNORHealthCheckResponse
+
+Response from AFNOR services healthcheck.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**flow_service_ok** | **boolean** | Flow Service API status | [default to undefined]
+**directory_service_ok** | **boolean** | Directory Service API status | [default to undefined]
+**message** | **string** | Descriptive status message | [default to undefined]
+
+## Example
+
+```typescript
+import { AFNORHealthCheckResponse } from '@factpulse/sdk';
+
+const instance: AFNORHealthCheckResponse = {
+    flow_service_ok,
+    directory_service_ok,
+    message,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AFNORPDPPAApi.md

@@ -4,12 +4,120 @@ All URIs are relative to *http://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**oauthTokenProxyApiV1AfnorOauthTokenPost**](#oauthtokenproxyapiv1afnoroauthtokenpost) | **POST** /api/v1/afnor/oauth/token | Endpoint OAuth2 pour authentification AFNOR|
+|[**getAfnorCredentialsApiV1AfnorCredentialsGet**](#getafnorcredentialsapiv1afnorcredentialsget) | **GET** /api/v1/afnor/credentials | Retrieve stored AFNOR credentials|
+|[**getFluxEntrantApiV1AfnorIncomingFlowsFlowIdGet**](#getfluxentrantapiv1afnorincomingflowsflowidget) | **GET** /api/v1/afnor/incoming-flows/{flow_id} | Retrieve and extract an incoming invoice|
+|[**oauthTokenProxyApiV1AfnorOauthTokenPost**](#oauthtokenproxyapiv1afnoroauthtokenpost) | **POST** /api/v1/afnor/oauth/token | OAuth2 endpoint for AFNOR authentication|
+
+# **getAfnorCredentialsApiV1AfnorCredentialsGet**
+> any getAfnorCredentialsApiV1AfnorCredentialsGet()
+
+Retrieves stored AFNOR/PDP credentials for the JWT\'s client_uid. This endpoint is used by the SDK in \'stored\' mode to retrieve credentials before performing AFNOR OAuth itself.
+
+### Example
+
+```typescript
+import {
+    AFNORPDPPAApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AFNORPDPPAApi(configuration);
+
+const { status, data } = await apiInstance.getAfnorCredentialsApiV1AfnorCredentialsGet();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**any**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | AFNOR credentials retrieved successfully |  -  |
+|**400** | No client_uid in JWT |  -  |
+|**401** | Not authenticated - Missing or invalid JWT token |  -  |
+|**404** | Client not found or no AFNOR credentials configured |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getFluxEntrantApiV1AfnorIncomingFlowsFlowIdGet**
+> IncomingInvoice getFluxEntrantApiV1AfnorIncomingFlowsFlowIdGet()
+
+Downloads an incoming flow from the AFNOR PDP and extracts invoice metadata into a unified JSON format. Supports Factur-X, CII, and UBL formats.
+
+### Example
+
+```typescript
+import {
+    AFNORPDPPAApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AFNORPDPPAApi(configuration);
+
+let flowId: string; // (default to undefined)
+let includeDocument: boolean; // (optional) (default to false)
+
+const { status, data } = await apiInstance.getFluxEntrantApiV1AfnorIncomingFlowsFlowIdGet(
+    flowId,
+    includeDocument
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **flowId** | [**string**] |  | defaults to undefined|
+| **includeDocument** | [**boolean**] |  | (optional) defaults to false|
+
+
+### Return type
+
+**IncomingInvoice**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Invoice extracted successfully |  -  |
+|**400** | Unsupported or invalid invoice format |  -  |
+|**401** | Not authenticated |  -  |
+|**404** | Flow not found |  -  |
+|**503** | PDP service unavailable |  -  |
+|**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **oauthTokenProxyApiV1AfnorOauthTokenPost**
 > any oauthTokenProxyApiV1AfnorOauthTokenPost()
 
-Endpoint proxy OAuth2 pour obtenir un token d\'accès AFNOR. Fait proxy vers le mock AFNOR (sandbox) ou la vraie PDP selon MOCK_AFNOR_BASE_URL. Cet endpoint est public (pas d\'auth Django requise) car il est appelé par le SDK AFNOR.
+OAuth2 proxy endpoint to obtain an AFNOR access token. Proxies to AFNOR mock (sandbox) or real PDP depending on MOCK_AFNOR_BASE_URL. This endpoint is public (no Django auth required) as it is called by the AFNOR SDK.
 
 ### Example
 
@@ -46,8 +154,8 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Token OAuth2 acquis avec succès |  -  |
-|**401** | Credentials invalides |  -  |
+|**200** | OAuth2 token acquired successfully |  -  |
+|**401** | Invalid credentials |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)