@experteam-mx/ngx-services/lib/ngx-services.models.d.ts

Angular common services for Experteam apps

import { InjectionToken } from '@angular/core';
/**
 * Represents the configuration settings for the application's environment.
 * This type includes various API endpoint URLs, authentication details, caching options, and other relevant settings.
 *
 * Properties:
 * - apiCompaniesUrl: The URL for the companies API endpoint.
 * - apiInvoicesUrl: The URL for the invoices API endpoint.
 * - apiReportsUrl: The URL for the reports API endpoint.
 * - apiSecurityUrl: The URL for the security-related API endpoint.
 * - apiShipmentUrl: The URL for the shipment API endpoint.
 * - authCookie: The name of the authentication cookie used for user sessions.
 * - cacheTtl: Optional. Specifies the time-to-live (TTL) for cached items.
 * - printUrl: Optional. The URL used for generating or downloading printable documents.
 * - secretKey: A secret key used for authentication or other secure operations.
 */
export type Environment = {
    apiBillingDO?: string;
    apiBillingMX?: string;
    apiCashOperationsUrl?: string;
    apiCatalogsUrl?: string;
    apiCompaniesUrl?: string;
    apiEToolsAutoBilling?: string;
    apiExternalOperationsKey?: string;
    apiExternalOperationsUrl?: string;
    apiInvoicesUrl?: string;
    apiOpenItemsUrl?: string;
    apiReportsUrl?: string;
    apiSecurityUrl?: string;
    apiShipmentUrl?: string;
    authCookie: string;
    cacheTtl?: number;
    printUrl?: string;
    secretKey: string;
    sockets?: {
        app_key: string;
        debug?: boolean;
        port: number;
        url: string;
    };
};
/**
 * Injection token used to inject environment configurations.
 *
 * `ENVIRONMENT_TOKEN` is a dependency injection token that allows
 * for the provision and retrieval of environment-specific configurations
 * within the application. This token is typically associated with an
 * `Environment` type that defines the structure of the configuration.
 */
export declare const ENVIRONMENT_TOKEN: InjectionToken<Environment>;