@senior-gestao-pessoas/digital-hiring-components 1.0.0-d7806bb5-1da5-4230-8049-70ab0989c5cb

package/services/translation/translation-keys.service.d.ts

@@ -0,0 +1,134 @@
+/**
+ * Service for managing translation keys for enum values
+ * These keys map directly to the JSON locale files (pt-BR.json, en_US.json, etc.)
+ *
+ * Translation keys follow the pattern: hcm.onboarding.enum_{EnumName}_{VALUE}
+ *
+ * @example
+ * ```typescript
+ * constructor(private translationKeys: TranslationKeysService) {}
+ *
+ * // Get translation key for an enum value
+ * const key = this.translationKeys.getEnumTranslationKey('CategoryField', 'BASIC');
+ * // Returns: 'hcm.onboarding.enum_CategoryField_BASIC'
+ *
+ * // Use with your i18n service
+ * const translated = i18nService.translate(key);
+ * // Returns: 'Básicos' (pt-BR) or 'Basic' (en_US) or 'Básicos' (es-CO)
+ * ```
+ */
+export declare class TranslationKeysService {
+    /**
+     * Enum names for type safety and consistency
+     * Use these constants instead of string literals
+     */
+    readonly EnumNames: {
+        readonly CATEGORY_FIELD: "categoryField";
+        readonly E_SOCIAL_CATEGORY: "eSocialCategory";
+        readonly E_SOCIAL_STATUS: "eSocialStatus";
+        readonly EMPLOYEE_CONTRACT_TYPE: "employeeContractType";
+        readonly EMPLOYEE_TYPE: "employeeType";
+        readonly ACCOUNT_TYPE: "enumAccountType";
+        readonly ADDRESS_TYPE: "enumAddressType";
+        readonly ADDRESS_TYPE_COL: "enumAddressTypeCOL";
+        readonly AVERAGE_ADMISSIONS: "enumAverageAdmissions";
+        readonly BLOOD_FACTOR: "enumBloodFactor";
+        readonly BLOOD_TYPE: "enumBloodType";
+        readonly BUSINESS_SEGMENT: "enumBusinessSegment";
+        readonly CIVIL_CERTIFICATE: "enumCivilCertificate";
+        readonly CONDITION_VISA_TYPE: "enumConditionVisaType";
+        readonly DEGREE_OF_EDUCATION: "enumDegreeOfEducation";
+        readonly DEGREE_OF_KINSHIP: "enumDegreeOfKinship";
+        readonly DOCUMENT_REFERENCE: "enumDocumentReference";
+        readonly DOCUMENT_STATUS: "enumDocumentStatus";
+        readonly DRIVER_LICENSE_CATEGORY_COL: "enumDriverLicenseCategoryCOL";
+        readonly DRIVER_LICENCE_CATEGORY: "enumDriverLicenceCategory";
+        readonly EMAIL: "enumEmail";
+        readonly EMPLOYEE_QUANTITY: "enumEmployeeQuantity";
+        readonly EXTERNAL_MODULES: "enumExternalModules";
+        readonly GENDER: "enumGender";
+        readonly INVITATION_FIELDS_TYPE: "enumInvitationFieldsType";
+        readonly LOG_TYPE: "enumLogType";
+        readonly MARITAL_STATUS: "enumMaritalStatus";
+        readonly MILITARY_SERVICE_BOOK_CLASS_COL: "enumMilitaryServiceBookClassCOL";
+        readonly MOBILE_PHONE_OPTION: "enumMobilePhoneOption";
+        readonly NATIONALITY_TYPE: "enumNationalityType";
+        readonly ORIGIN_INTEGRATION: "enumOriginIntegration";
+        readonly PURCHASE_ACTIONS: "enumPurchaseActions";
+        readonly RACIAL_TYPE: "enumRacialType";
+        readonly RESIDENCE_TIME: "enumResidenceTime";
+        readonly SEND_TOKEN: "enumSendToken";
+        readonly SOCIAL_SECURITY_TYPE_COL: "enumSocialSecurityTypeCOL";
+        readonly TELEPHONE: "enumTelephone";
+        readonly YES_NO: "enumYesNo";
+        readonly INVITATION_STATUS: "invitationStatus";
+        readonly LIST_QUERY_TAB: "listQueryTab";
+        readonly MESSAGE_SENDER: "messageSender";
+        readonly SEARCH_TYPE: "searchType";
+        readonly SITUATION: "situation";
+        readonly DISABILITY_TYPE: "disabilityType";
+        readonly CONVERSION_STATUS: "conversionStatus";
+        readonly ELECTRONIC_SIGNATURE_SIGNER_TYPE: "electronicSignatureSignerType";
+        readonly ELECTRONIC_SIGNATURE_SIGNER_NOTIFICATION_METHOD: "electronicSignatureSignerNotificationMethod";
+        readonly WORKSHIFT_SHIFT: "workshiftShift";
+        readonly SALARY_TYPE: "salaryType";
+        readonly CONTRACT_MODEL_TYPE: "contractModelType";
+    };
+    constructor();
+    /**
+     * Get the translation key for an enum value
+     *
+     * @param enumName - The name of the enum (e.g., 'categoryField', 'eSocialCategory')
+     * @param value - The enum value (e.g., 'BASIC', 'CATEGORY_101')
+     * @returns The translation key in format: hcm.onboarding.enum_{EnumName}_{VALUE}
+     *
+     * @example
+     * ```typescript
+     * getEnumTranslationKey('categoryField', 'BASIC')
+     * // Returns: 'hcm.onboarding.enum_categoryField_BASIC'
+     *
+     * getEnumTranslationKey('eSocialCategory', 'CATEGORY_101')
+     * // Returns: 'hcm.onboarding.enum_eSocialCategory_CATEGORY_101'
+     * ```
+     */
+    getEnumTranslationKey(enumName: string, value: string): string;
+    /**
+     * Get translation keys for multiple enum values
+     *
+     * @param enumName - The name of the enum
+     * @param values - Array of enum values
+     * @returns Object mapping values to their translation keys
+     *
+     * @example
+     * ```typescript
+     * const keys = translationKeys.getEnumTranslationKeys('categoryField', ['BASIC', 'COMPLEMENTARY']);
+     * // Returns: {
+     * //   BASIC: 'hcm.onboarding.enum_categoryField_BASIC',
+     * //   COMPLEMENTARY: 'hcm.onboarding.enum_categoryField_COMPLEMENTARY'
+     * // }
+     * ```
+     */
+    getEnumTranslationKeys(enumName: string, values: string[]): Record<string, string>;
+    /**
+     * Get all translation keys for an enum object
+     *
+     * @param enumName - The name of the enum
+     * @param enumObj - The enum object
+     * @returns Object mapping enum keys to their translation keys
+     *
+     * @example
+     * ```typescript
+     * enum CategoryField {
+     *   BASIC = 'BASIC',
+     *   COMPLEMENTARY = 'COMPLEMENTARY'
+     * }
+     *
+     * const keys = translationKeys.getAllEnumTranslationKeys('categoryField', CategoryField);
+     * // Returns: {
+     * //   BASIC: 'hcm.onboarding.enum_categoryField_BASIC',
+     * //   COMPLEMENTARY: 'hcm.onboarding.enum_categoryField_COMPLEMENTARY'
+     * // }
+     * ```
+     */
+    getAllEnumTranslationKeys(enumName: string, enumObj: Record<string, unknown>): Record<string, string>;
+}