@experteam-mx/ngx-services 20.8.6-dev3.0 → 20.9.0

package/README.md

@@ -22,8 +22,12 @@ import { routes } from './app.routes'
 
 const envs = {
 	...environment,
-	authCookie: 'token',
-	cacheTtl: 3000
+	authCookie: 'token'
+	// cacheRoutes is opt-in; omit or leave empty until routes are registered:
+	// cacheRoutes: [
+	//   { pattern: '/api/catalogs', ttl: 60_000 },
+	//   { pattern: '/api/companies/.+/branches', ttl: 30_000 }
+	// ]
 } as Environment
 
 export const appConfig: ApplicationConfig = {
@@ -41,6 +45,8 @@ export const appConfig: ApplicationConfig = {
 
 `provideNgxServices` registers `ENVIRONMENT_TOKEN`, which is required by the API services and some interceptors in this package.
 
+`httpCachingInterceptor` caches only GET requests whose URL matches an entry in `cacheRoutes` (first matching RegExp pattern wins). With no routes configured, nothing is cached.
+
 ## NgModule compatibility
 
 `NgxServicesModule.forRoot(environment)` is still available for compatibility, but it is deprecated for new standalone applications and will be removed in `20.2.0`.

package/fesm2022/experteam-mx-ngx-services.mjs

@@ -2561,16 +2561,6 @@ class ApiCompositionService {
         return this.http.get(`${this.url}/shipments/${id}`)
             .pipe(map(({ data }) => data));
     }
-    /**
-     * Retrieves shipments based on the provided query parameters.
-     *
-     * @param {QueryParams} params - The query parameters for the API request.
-     * @returns {Observable<ShipmentsOut>} An observable that emits the shipments data.
-     */
-    getShipments(params) {
-        return this.http.get(`${this.url}/shipments`, { params })
-            .pipe(map(({ data }) => data));
-    }
     /**
      * Fetches the country references data based on the provided query parameters.
      *
@@ -3159,7 +3149,7 @@ class ApiExternalOperationsService {
      * Retrieves delivery confirmation details based on the provided OTP code.
      *
      * @param {string} otpCode - The OTP code used to search for delivery confirmation.
-     * @return {Observable<DeliveryConfirmationData>} An observable containing the delivery confirmation data.
+     * @return {Observable<DeliveryConfirmationSearchOut>} An observable containing the delivery confirmation data.
      */
     getDeliveryConfirmation(otpCode) {
         return this.http.get(`${this.url}/delivery-confirmation/search/${otpCode}`)
@@ -3200,6 +3190,38 @@ class ApiExternalOperationsService {
         return this.http.put(`${this.url}/delivery-confirmation/confirmation/${otp}`, body)
             .pipe(map$1(({ data }) => data));
     }
+    /**
+     * Retrieves signature page confirmation information associated with an OTP code.
+     *
+     * @param {string} otpCode - OTP code used to search for the signature page confirmation.
+     * @returns {Observable<SignaturePageConfirmationOut>} An observable containing the signature page confirmation details.
+     */
+    getSignaturePageConfirmationSearch(otpCode) {
+        return this.http.get(`${this.url}/signature-page-confirmation/search/${otpCode}`)
+            .pipe(map$1(({ data }) => data));
+    }
+    /**
+     * Generates a signature page confirmation request for a shipment.
+     *
+     * @param {ShipmentSignaturePageIn} payload - Shipment data required to generate the signature page confirmation.
+     * @returns {Observable<SignaturePageConfirmationGenerateOut>} An observable containing the generated confirmation information.
+     */
+    postSignaturePageConfirmationGenerate(payload) {
+        return this.http.post(`${this.url}/signature-page-confirmation/generate`, payload)
+            .pipe(map$1(({ data }) => data));
+    }
+    /**
+     * Confirms a shipment signature page using an OTP code.
+     *
+     * @param {ShipmentSignaturePageConfirmationIn} input - Signature page confirmation data.
+     * @param {string} input.otp - OTP code used to validate the confirmation.
+     * @param {...Object} input.body - Additional confirmation information sent in the request body.
+     * @returns {Observable<{}>} An observable that emits the API response data.
+     */
+    putSignaturePageConfirmation({ otp, ...body }) {
+        return this.http.put(`${this.url}/signature-page-confirmation/${otp}`, body)
+            .pipe(map$1(({ data }) => data));
+    }
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.3.25", ngImport: i0, type: ApiExternalOperationsService, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
     static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "20.3.25", ngImport: i0, type: ApiExternalOperationsService, providedIn: 'root' });
 }
@@ -5560,14 +5582,6 @@ var DocumentStatusCode;
     DocumentStatusCode[DocumentStatusCode["WITH_ERRORS"] = 3] = "WITH_ERRORS";
 })(DocumentStatusCode || (DocumentStatusCode = {}));
 
-var CustomerRoleType;
-(function (CustomerRoleType) {
-    CustomerRoleType["SHIPPER"] = "SP";
-    CustomerRoleType["CONSIGNEE"] = "RV";
-    CustomerRoleType["IMPORTER"] = "IP";
-    CustomerRoleType["EXPORTER"] = "EP";
-})(CustomerRoleType || (CustomerRoleType = {}));
-
 class WebSocketsService {
     pusher;
     environments = inject(ENVIRONMENT_TOKEN);
@@ -5819,23 +5833,40 @@ function apiTokenInterceptor(req, next) {
     return next(req);
 }
 
-const DEFAULT_TTL = 10000; // ttl in ms
 const cache = new Map();
 const inFlightRequests = new Map();
 /**
- * Interceptor function to handle HTTP caching for GET requests. It retrieves cached responses
- * if available and valid; otherwise, it processes the request and caches the response for future use.
+ * Resolves the TTL for a URL from the first matching `cacheRoutes` entry.
+ * Returns `null` when there is no match or no routes configured.
+ */
+function resolveCacheTtl(url, cacheRoutes) {
+    if (!cacheRoutes?.length)
+        return null;
+    for (const route of cacheRoutes) {
+        if (new RegExp(route.pattern).test(url)) {
+            return route.ttl;
+        }
+    }
+    return null;
+}
+/**
+ * Interceptor function to handle opt-in HTTP caching for GET requests that match
+ * a configured `cacheRoutes` pattern. Non-matching GETs pass through uncached.
+ * Concurrent in-flight requests for the same key are deduplicated via `shareReplay`.
  *
- * @param {HttpRequest<any>} req - The HTTP request object being intercepted.
+ * @param {HttpRequest<unknown>} req - The HTTP request object being intercepted.
  * @param {HttpHandlerFn} next - The next HTTP handler function in the chain to process the request.
- * @return {Observable<HttpEvent<any>>} An observable that emits the HTTP event, either from cache
+ * @return {Observable<HttpEvent<unknown>>} An observable that emits the HTTP event, either from cache
  * or by invoking the next handler.
  */
 function httpCachingInterceptor(req, next) {
-    const { cacheTtl } = inject(ENVIRONMENT_TOKEN);
+    const { cacheRoutes } = inject(ENVIRONMENT_TOKEN);
     if (req.method !== 'GET')
         return next(req);
     const key = req.urlWithParams;
+    const routeTtl = resolveCacheTtl(key, cacheRoutes);
+    if (routeTtl === null)
+        return next(req);
     const cached = cache.get(key);
     if (cached) {
         const isExpired = Date.now() > cached.ttl;
@@ -5852,7 +5883,7 @@ function httpCachingInterceptor(req, next) {
         if (!(res instanceof HttpResponse)) {
             return;
         }
-        const ttl = Date.now() + (cacheTtl ?? DEFAULT_TTL);
+        const ttl = Date.now() + routeTtl;
         cache.set(key, { res, ttl });
     }), finalize(() => {
         inFlightRequests.delete(key);
@@ -5934,5 +5965,5 @@ const xmlHeaders = (format = 'object') => {
  * Generated bundle index. Do not edit.
  */
 
-export { AccountTypeId, AccountTypeName, AlphaNumeric, ApiBillingCOService, ApiBillingDOService, ApiBillingGtService, ApiBillingMxService, ApiBillingPaService, ApiBillingSvService, ApiCashOperationsService, ApiCatalogsService, ApiCheckpointsService, ApiCompaniesService, ApiCompositionService, ApiCustomsService, ApiDiscountsService, ApiDropoffsService, ApiEToolsAutoBillingService, ApiEventsService, ApiExternalOperationsService, ApiInventoriesService, ApiInvoicesService, ApiNotificationsService, ApiOpenItemsService, ApiQuoteService, ApiReportsService, ApiSecurityService, ApiServicesService, ApiShipmentsService, ApiSuppliesService, ApiSurveysService, CryptoService, CustomerRoleType, DefaultValueType, DepositTypeCode, DocumentStatusCode, ENVIRONMENT_TOKEN, Event, Group, InventoryActions, InventoryErrorCodes, NgxServicesModule, OpeningStatusCode, OperationModuleStatus, PaymentTypeCode, PrintMode, PrintableFormat, PrintersService, PrintersType, RouteModelType, ShipmentIncomeTypeCode, TransferenceTypeCode, ViewSectionOption, WebSocketsService, apiHeadersInterceptor, apiTokenInterceptor, base64PdfToUrl, downloadBase64Pdf, httpCachingInterceptor, httpParams, pdfHeaders, provideNgxServices, queryString, xmlHeaders };
+export { AccountTypeId, AccountTypeName, AlphaNumeric, ApiBillingCOService, ApiBillingDOService, ApiBillingGtService, ApiBillingMxService, ApiBillingPaService, ApiBillingSvService, ApiCashOperationsService, ApiCatalogsService, ApiCheckpointsService, ApiCompaniesService, ApiCompositionService, ApiCustomsService, ApiDiscountsService, ApiDropoffsService, ApiEToolsAutoBillingService, ApiEventsService, ApiExternalOperationsService, ApiInventoriesService, ApiInvoicesService, ApiNotificationsService, ApiOpenItemsService, ApiQuoteService, ApiReportsService, ApiSecurityService, ApiServicesService, ApiShipmentsService, ApiSuppliesService, ApiSurveysService, CryptoService, DefaultValueType, DepositTypeCode, DocumentStatusCode, ENVIRONMENT_TOKEN, Event, Group, InventoryActions, InventoryErrorCodes, NgxServicesModule, OpeningStatusCode, OperationModuleStatus, PaymentTypeCode, PrintMode, PrintableFormat, PrintersService, PrintersType, RouteModelType, ShipmentIncomeTypeCode, TransferenceTypeCode, ViewSectionOption, WebSocketsService, apiHeadersInterceptor, apiTokenInterceptor, base64PdfToUrl, downloadBase64Pdf, httpCachingInterceptor, httpParams, pdfHeaders, provideNgxServices, queryString, xmlHeaders };
 //# sourceMappingURL=experteam-mx-ngx-services.mjs.map