@po-ui/ng-templates 19.27.0 → 20.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (137) hide show
  1. package/fesm2022/po-ui-ng-templates.mjs +174 -174
  2. package/index.d.ts +6547 -3
  3. package/package.json +13 -13
  4. package/po-ui-ng-templates-20.1.0.tgz +0 -0
  5. package/schematics/ng-add/index.js +1 -1
  6. package/lib/components/components.module.d.ts +0 -16
  7. package/lib/components/enums/po-page-components-size.enum.d.ts +0 -12
  8. package/lib/components/index.d.ts +0 -11
  9. package/lib/components/po-modal-password-recovery/enums/po-modal-password-recovery-modal-content.enum.d.ts +0 -15
  10. package/lib/components/po-modal-password-recovery/enums/po-modal-password-recovery-type.enum.d.ts +0 -15
  11. package/lib/components/po-modal-password-recovery/index.d.ts +0 -7
  12. package/lib/components/po-modal-password-recovery/interfaces/po-modal-password-recovery.interface.d.ts +0 -25
  13. package/lib/components/po-modal-password-recovery/literals/i18n/po-modal-password-recovery-literals.d.ts +0 -6
  14. package/lib/components/po-modal-password-recovery/po-modal-password-recovery-base.component.d.ts +0 -300
  15. package/lib/components/po-modal-password-recovery/po-modal-password-recovery-error-message/po-modal-password-recovery-error-message.component.d.ts +0 -14
  16. package/lib/components/po-modal-password-recovery/po-modal-password-recovery.component.d.ts +0 -88
  17. package/lib/components/po-modal-password-recovery/po-modal-password-recovery.module.d.ts +0 -16
  18. package/lib/components/po-modal-password-recovery/po-modal-password-recovery.service.d.ts +0 -12
  19. package/lib/components/po-page-background/index.d.ts +0 -2
  20. package/lib/components/po-page-background/po-page-background.component.d.ts +0 -68
  21. package/lib/components/po-page-background/po-page-background.module.d.ts +0 -16
  22. package/lib/components/po-page-blocked-user/enums/po-page-blocked-user-reason.enum.d.ts +0 -15
  23. package/lib/components/po-page-blocked-user/index.d.ts +0 -7
  24. package/lib/components/po-page-blocked-user/interfaces/po-page-blocked-user-reason-params.interface.d.ts +0 -15
  25. package/lib/components/po-page-blocked-user/literals/i18n/po-page-blocked-user-literals.d.ts +0 -72
  26. package/lib/components/po-page-blocked-user/po-page-blocked-user-base.component.d.ts +0 -163
  27. package/lib/components/po-page-blocked-user/po-page-blocked-user-contacts/po-page-blocked-user-contacts.component.d.ts +0 -18
  28. package/lib/components/po-page-blocked-user/po-page-blocked-user-reason/po-page-blocked-user-reason.component.d.ts +0 -25
  29. package/lib/components/po-page-blocked-user/po-page-blocked-user.component.d.ts +0 -41
  30. package/lib/components/po-page-blocked-user/po-page-blocked-user.module.d.ts +0 -18
  31. package/lib/components/po-page-change-password/index.d.ts +0 -6
  32. package/lib/components/po-page-change-password/interfaces/po-page-change-password-recovery.interface.d.ts +0 -30
  33. package/lib/components/po-page-change-password/interfaces/po-page-change-password-requirement.interface.d.ts +0 -17
  34. package/lib/components/po-page-change-password/interfaces/po-page-change-password.interface.d.ts +0 -13
  35. package/lib/components/po-page-change-password/literals/i18n/po-page-change-password-literals.d.ts +0 -6
  36. package/lib/components/po-page-change-password/po-page-change-password-base.component.d.ts +0 -262
  37. package/lib/components/po-page-change-password/po-page-change-password.component.d.ts +0 -91
  38. package/lib/components/po-page-change-password/po-page-change-password.module.d.ts +0 -17
  39. package/lib/components/po-page-change-password/po-page-change-password.service.d.ts +0 -9
  40. package/lib/components/po-page-dynamic-detail/index.d.ts +0 -9
  41. package/lib/components/po-page-dynamic-detail/interfaces/po-page-dynamic-detail-actions.interface.d.ts +0 -95
  42. package/lib/components/po-page-dynamic-detail/interfaces/po-page-dynamic-detail-before-back.interface.d.ts +0 -18
  43. package/lib/components/po-page-dynamic-detail/interfaces/po-page-dynamic-detail-before-edit.interface.d.ts +0 -18
  44. package/lib/components/po-page-dynamic-detail/interfaces/po-page-dynamic-detail-before-remove.interface.d.ts +0 -18
  45. package/lib/components/po-page-dynamic-detail/interfaces/po-page-dynamic-detail-field.interface.d.ts +0 -16
  46. package/lib/components/po-page-dynamic-detail/interfaces/po-page-dynamic-detail-metadata.interface.d.ts +0 -31
  47. package/lib/components/po-page-dynamic-detail/interfaces/po-page-dynamic-detail-options.interface.d.ts +0 -36
  48. package/lib/components/po-page-dynamic-detail/po-page-dynamic-detail-actions.service.d.ts +0 -17
  49. package/lib/components/po-page-dynamic-detail/po-page-dynamic-detail.component.d.ts +0 -279
  50. package/lib/components/po-page-dynamic-detail/po-page-dynamic-detail.module.d.ts +0 -17
  51. package/lib/components/po-page-dynamic-edit/index.d.ts +0 -10
  52. package/lib/components/po-page-dynamic-edit/interfaces/po-page-dynamic-edit-actions.interface.d.ts +0 -123
  53. package/lib/components/po-page-dynamic-edit/interfaces/po-page-dynamic-edit-before-cancel.interface.d.ts +0 -18
  54. package/lib/components/po-page-dynamic-edit/interfaces/po-page-dynamic-edit-before-save-new.interface.d.ts +0 -44
  55. package/lib/components/po-page-dynamic-edit/interfaces/po-page-dynamic-edit-before-save.interface.d.ts +0 -43
  56. package/lib/components/po-page-dynamic-edit/interfaces/po-page-dynamic-edit-field.interface.d.ts +0 -14
  57. package/lib/components/po-page-dynamic-edit/interfaces/po-page-dynamic-edit-literals.interface.d.ts +0 -69
  58. package/lib/components/po-page-dynamic-edit/interfaces/po-page-dynamic-edit-metadata.interface.d.ts +0 -25
  59. package/lib/components/po-page-dynamic-edit/interfaces/po-page-dynamic-edit-options.interface.d.ts +0 -28
  60. package/lib/components/po-page-dynamic-edit/po-page-dynamic-edit-actions.service.d.ts +0 -17
  61. package/lib/components/po-page-dynamic-edit/po-page-dynamic-edit.component.d.ts +0 -438
  62. package/lib/components/po-page-dynamic-edit/po-page-dynamic-edit.module.d.ts +0 -17
  63. package/lib/components/po-page-dynamic-search/index.d.ts +0 -6
  64. package/lib/components/po-page-dynamic-search/interfaces/po-page-dynamic-search-filters.interface.d.ts +0 -18
  65. package/lib/components/po-page-dynamic-search/interfaces/po-page-dynamic-search-literals.interface.d.ts +0 -21
  66. package/lib/components/po-page-dynamic-search/interfaces/po-page-dynamic-search-options.interface.d.ts +0 -73
  67. package/lib/components/po-page-dynamic-search/interfaces/po-page-dynamic-search.interface.d.ts +0 -29
  68. package/lib/components/po-page-dynamic-search/po-advanced-filter/po-advanced-filter-base.component.d.ts +0 -66
  69. package/lib/components/po-page-dynamic-search/po-advanced-filter/po-advanced-filter-literals.interface.d.ts +0 -15
  70. package/lib/components/po-page-dynamic-search/po-advanced-filter/po-advanced-filter.component.d.ts +0 -29
  71. package/lib/components/po-page-dynamic-search/po-page-dynamic-search-base.component.d.ts +0 -262
  72. package/lib/components/po-page-dynamic-search/po-page-dynamic-search.component.d.ts +0 -68
  73. package/lib/components/po-page-dynamic-search/po-page-dynamic-search.module.d.ts +0 -18
  74. package/lib/components/po-page-dynamic-table/index.d.ts +0 -15
  75. package/lib/components/po-page-dynamic-table/interfaces/po-page-dynamic-table-actions.interface.d.ts +0 -196
  76. package/lib/components/po-page-dynamic-table/interfaces/po-page-dynamic-table-before-detail.interface.d.ts +0 -21
  77. package/lib/components/po-page-dynamic-table/interfaces/po-page-dynamic-table-before-duplicate.interface.d.ts +0 -29
  78. package/lib/components/po-page-dynamic-table/interfaces/po-page-dynamic-table-before-edit.interface.d.ts +0 -22
  79. package/lib/components/po-page-dynamic-table/interfaces/po-page-dynamic-table-before-new.interface.d.ts +0 -18
  80. package/lib/components/po-page-dynamic-table/interfaces/po-page-dynamic-table-before-remove-all.interface.d.ts +0 -39
  81. package/lib/components/po-page-dynamic-table/interfaces/po-page-dynamic-table-before-remove.interface.d.ts +0 -18
  82. package/lib/components/po-page-dynamic-table/interfaces/po-page-dynamic-table-custom-action.interface.d.ts +0 -97
  83. package/lib/components/po-page-dynamic-table/interfaces/po-page-dynamic-table-custom-table-action.interface.d.ts +0 -106
  84. package/lib/components/po-page-dynamic-table/interfaces/po-page-dynamic-table-field.interface.d.ts +0 -49
  85. package/lib/components/po-page-dynamic-table/interfaces/po-page-dynamic-table-filters.interface.d.ts +0 -30
  86. package/lib/components/po-page-dynamic-table/interfaces/po-page-dynamic-table-metadata.interface.d.ts +0 -31
  87. package/lib/components/po-page-dynamic-table/interfaces/po-page-dynamic-table-options.interface.d.ts +0 -105
  88. package/lib/components/po-page-dynamic-table/po-page-dynamic-list-base.component.d.ts +0 -188
  89. package/lib/components/po-page-dynamic-table/po-page-dynamic-table-actions.service.d.ts +0 -25
  90. package/lib/components/po-page-dynamic-table/po-page-dynamic-table-literals.d.ts +0 -62
  91. package/lib/components/po-page-dynamic-table/po-page-dynamic-table.component.d.ts +0 -602
  92. package/lib/components/po-page-dynamic-table/po-page-dynamic-table.module.d.ts +0 -19
  93. package/lib/components/po-page-job-scheduler/index.d.ts +0 -5
  94. package/lib/components/po-page-job-scheduler/interfaces/po-job-scheduler-internal.interface.d.ts +0 -15
  95. package/lib/components/po-page-job-scheduler/interfaces/po-job-scheduler.interface.d.ts +0 -48
  96. package/lib/components/po-page-job-scheduler/po-page-job-scheduler-base.component.d.ts +0 -258
  97. package/lib/components/po-page-job-scheduler/po-page-job-scheduler-execution/po-page-job-scheduler-execution.component.d.ts +0 -52
  98. package/lib/components/po-page-job-scheduler/po-page-job-scheduler-internal.d.ts +0 -9
  99. package/lib/components/po-page-job-scheduler/po-page-job-scheduler-literals.d.ts +0 -194
  100. package/lib/components/po-page-job-scheduler/po-page-job-scheduler-lookup.service.d.ts +0 -14
  101. package/lib/components/po-page-job-scheduler/po-page-job-scheduler-parameters/index.d.ts +0 -1
  102. package/lib/components/po-page-job-scheduler/po-page-job-scheduler-parameters/po-job-scheduler-parameters-template/index.d.ts +0 -1
  103. package/lib/components/po-page-job-scheduler/po-page-job-scheduler-parameters/po-job-scheduler-parameters-template/po-job-scheduler-parameters-template.directive.d.ts +0 -73
  104. package/lib/components/po-page-job-scheduler/po-page-job-scheduler-parameters/po-page-job-scheduler-parameters.component.d.ts +0 -15
  105. package/lib/components/po-page-job-scheduler/po-page-job-scheduler-summary/index.d.ts +0 -1
  106. package/lib/components/po-page-job-scheduler/po-page-job-scheduler-summary/po-job-scheduler-summary-template/index.d.ts +0 -1
  107. package/lib/components/po-page-job-scheduler/po-page-job-scheduler-summary/po-job-scheduler-summary-template/po-job-scheduler-summary-template.directive.d.ts +0 -34
  108. package/lib/components/po-page-job-scheduler/po-page-job-scheduler-summary/po-page-job-scheduler-summary.component.d.ts +0 -36
  109. package/lib/components/po-page-job-scheduler/po-page-job-scheduler.component.d.ts +0 -136
  110. package/lib/components/po-page-job-scheduler/po-page-job-scheduler.module.d.ts +0 -15
  111. package/lib/components/po-page-job-scheduler/po-page-job-scheduler.service.d.ts +0 -31
  112. package/lib/components/po-page-login/enums/po-page-login-authentication-type.enum.d.ts +0 -13
  113. package/lib/components/po-page-login/index.d.ts +0 -7
  114. package/lib/components/po-page-login/interfaces/po-page-login-custom-field.interface.d.ts +0 -72
  115. package/lib/components/po-page-login/interfaces/po-page-login-literals.interface.d.ts +0 -59
  116. package/lib/components/po-page-login/interfaces/po-page-login-recovery.interface.d.ts +0 -30
  117. package/lib/components/po-page-login/interfaces/po-page-login.interface.d.ts +0 -15
  118. package/lib/components/po-page-login/po-page-login-base.component.d.ts +0 -724
  119. package/lib/components/po-page-login/po-page-login-popover/po-page-login-popover.component.d.ts +0 -19
  120. package/lib/components/po-page-login/po-page-login.component.d.ts +0 -68
  121. package/lib/components/po-page-login/po-page-login.module.d.ts +0 -18
  122. package/lib/components/po-page-login/po-page-login.service.d.ts +0 -12
  123. package/lib/index.d.ts +0 -3
  124. package/lib/po-templates.module.d.ts +0 -8
  125. package/lib/services/index.d.ts +0 -3
  126. package/lib/services/po-page-customization/index.d.ts +0 -3
  127. package/lib/services/po-page-customization/po-page-customization.module.d.ts +0 -12
  128. package/lib/services/po-page-customization/po-page-customization.service.d.ts +0 -17
  129. package/lib/services/po-page-customization/po-page-dynamic-options.interface.d.ts +0 -8
  130. package/lib/services/po-page-dynamic/index.d.ts +0 -2
  131. package/lib/services/po-page-dynamic/po-page-dynamic-literals.interface.d.ts +0 -4
  132. package/lib/services/po-page-dynamic/po-page-dynamic.module.d.ts +0 -12
  133. package/lib/services/po-page-dynamic/po-page-dynamic.service.d.ts +0 -30
  134. package/lib/services/services.module.d.ts +0 -8
  135. package/lib/utils/util.d.ts +0 -242
  136. package/po-ui-ng-templates-19.27.0.tgz +0 -0
  137. package/public-api.d.ts +0 -1
@@ -1,724 +0,0 @@
1
- import { EventEmitter, OnDestroy } from '@angular/core';
2
- import { Router } from '@angular/router';
3
- import { Subscription } from 'rxjs';
4
- import { PoLanguage, PoLanguageService } from '@po-ui/ng-components';
5
- import { PoPageLoginAuthenticationType } from './enums/po-page-login-authentication-type.enum';
6
- import { PoPageLoginCustomField } from './interfaces/po-page-login-custom-field.interface';
7
- import { PoPageLoginLiterals } from './interfaces/po-page-login-literals.interface';
8
- import { PoPageLoginRecovery } from './interfaces/po-page-login-recovery.interface';
9
- import { PoPageLogin } from './interfaces/po-page-login.interface';
10
- import { PoPageLoginService } from './po-page-login.service';
11
- import * as i0 from "@angular/core";
12
- export declare const poPageLoginLiteralsDefault: {
13
- en: PoPageLoginLiterals;
14
- es: PoPageLoginLiterals;
15
- pt: PoPageLoginLiterals;
16
- ru: PoPageLoginLiterals;
17
- };
18
- export declare const poPageLoginLiteralIn: {
19
- en: string;
20
- es: string;
21
- pt: string;
22
- ru: string;
23
- };
24
- /**
25
- * @description
26
- *
27
- * O componente `po-page-login` é utilizado como template para tela de login.
28
- * Com ele é possível definirmos valores para usuário, senha e definir ações para recuperação de senha e gravação de dados do usuário.
29
- * Também é possível inserir uma imagem em conjunto com um texto de destaque.
30
- *
31
- *
32
- * A propriedade `p-authentication-url` automatiza a rotina do componente e simplifica o processo para autenticação do usuário, bastando
33
- * definir uma url para requisição da autenticação. A flexibilidade e praticidade podem chegar a um nível em que o desenvolvimento
34
- * da aplicação no *client side* é desprovida de qualquer código-fonte relacionado à rotina de login de usuário.
35
- * Seu detalhamento para uso pode ser visto logo abaixo em *propriedades*.
36
- * Caso julgue necessário, pode-se também definir manualmente a rotina do componente.
37
- *
38
- *
39
- * Para que as imagens sejam exibidas corretamente, é necessário incluir o caminho delas ao projeto. Para isso, edite
40
- * o *assets* no arquivo **angular.json** da aplicação na seguinte ordem:
41
- * ```
42
- * "assets": [
43
- * "src/assets",
44
- * "src/favicon.ico",
45
- * {
46
- * "glob": "**\/*",
47
- * "input": "node_modules/@po-ui/style/images",
48
- * "output": "assets/images"
49
- * }
50
- * ]
51
- * ```
52
- */
53
- export declare abstract class PoPageLoginBaseComponent implements OnDestroy {
54
- private loginService;
55
- router: Router;
56
- poLanguageService: PoLanguageService;
57
- /**
58
- * O `p-background` permite inserir uma imagem de destaque ao lado direito do formulário de login, caso a propriedade
59
- * não seja preenchida o formulário será centralizado no espaço disponível.
60
- *
61
- * A fonte da imagem pode ser de um caminho local ou uma url de um servidor externo.
62
- *
63
- * Além da imagem, é possível adicionar um texto informativo por cima da imagem da imagem de destaque, para isso informe
64
- * um valor para a literal `highlightInfo`.
65
- *
66
- * > Veja mais sobre as literais na propriedade `p-literals`.
67
- *
68
- * Exemplos de valores válidos:
69
- * - **local**: `./assets/images/login-background.png`
70
- * - **url externa**: `https://po-ui.io/assets/images/login-background.png`
71
- *
72
- * > Essa propriedade é ignorada para aplicações mobile.
73
- */
74
- background?: string;
75
- /**
76
- * @optional
77
- *
78
- * @description
79
- *
80
- * Caminho para a logomarca localizada na parte superior.
81
- *
82
- * > Caso seja indefinida o espaço se mantém preservado porém vazio.
83
- */
84
- logo?: string;
85
- /**
86
- * @optional
87
- *
88
- * @description
89
- *
90
- * Expressão regular para validar o campo de login, caso a expressão não seja atentida, a literal `loginErrorPattern`
91
- * será exibida.
92
- *
93
- * Exemplos de valores válidos:
94
- * - email: `[expressao-regular-email]`
95
- * - cpf: `[expressao-regular-cpf]`
96
- *
97
- * > Veja a propriedade `p-literals` para customizar a literal `loginErrorPattern`.
98
- */
99
- loginPattern?: string;
100
- /**
101
- * @optional
102
- *
103
- * @description
104
- *
105
- * Expressão regular para validar o campo de password, caso a expressão não seja atentida, a literal `passwordErrorPattern`
106
- * será exibida.
107
- *
108
- * Exemplos de valores válidos:
109
- * - Apenas números: `\d?`
110
- * - Letras mínusculas: `\z?`
111
- *
112
- * > Veja a propriedade `p-literals` para customizar a literal `passwordErrorPattern`.
113
- */
114
- passwordPattern?: string;
115
- /**
116
- * @optional
117
- *
118
- * @description
119
- *
120
- * Caminho para a logomarca localizada no rodapé.
121
- */
122
- secondaryLogo?: string;
123
- /**
124
- * @optional
125
- *
126
- * @description
127
- *
128
- * Evento disparado quando o usuário alterar o input do campo login.
129
- *
130
- * Esse evento receberá como parâmetro uma variável do tipo `string` com o texto informado no campo.
131
- *
132
- * > Esta propriedade será ignorada se for definido valor para a propriedade `p-authentication-url`.
133
- */
134
- loginChange: EventEmitter<string>;
135
- /**
136
- * Evento disparado ao submeter o formulário de login (apertando `Enter` dentro dos campos ou pressionando o botão de confirmação).
137
- *
138
- * Esse evento receberá como parâmetro um objeto do tipo `PoPageLogin` com os dados informados no formulário.
139
- *
140
- * > Esta propriedade será ignorada se for definido valor para a propriedade `p-url-recovery`.
141
- *
142
- * > Para mais detalhes consulte a documentação sobre a interface `PoPageLogin` mais abaixo.
143
- */
144
- loginSubmit: EventEmitter<PoPageLogin>;
145
- /**
146
- * @optional
147
- *
148
- * @description
149
- *
150
- * Evento disparado quando o usuário alterar o input do campo password.
151
- *
152
- * Esse evento receberá como parâmetro uma variável do tipo `string` com o texto informado no campo.
153
- *
154
- * > Esta propriedade será ignorada se for definido valor para a propriedade `p-authentication-url`.
155
- */
156
- passwordChange: EventEmitter<string>;
157
- /**
158
- * @optional
159
- *
160
- * @description
161
- *
162
- * Evento disparado quando o usuário alterar o idioma da página.
163
- *
164
- * Esse evento receberá como parâmetro um objeto do tipo `PoLanguage` com a linguagem selecionada.
165
- *
166
- */
167
- languageChange: EventEmitter<PoLanguage>;
168
- /**
169
- * @optional
170
- *
171
- * @description
172
- *
173
- * Define a propriedade nativa `autocomplete` do campo como `off`.
174
- *
175
- * @default `true`
176
- */
177
- noAutocompleteLogin: boolean;
178
- /**
179
- * @optional
180
- *
181
- * @description
182
- *
183
- * Define a propriedade nativa `autocomplete` do campo como `off`.
184
- *
185
- * > No componente `po-password` será definido como `new-password`.
186
- *
187
- * @default `true`
188
- */
189
- noAutocompletePassword: boolean;
190
- /**
191
- * @optional
192
- *
193
- * @description
194
- *
195
- * Indica se o status do `model` do switch de lembrar o usuário será escondido visualmente.
196
- *
197
- * > Por padrão será atribuído `false`.
198
- * @default `false`
199
- */
200
- hideLabelStatus: boolean;
201
- /**
202
- * @optional
203
- *
204
- * @description
205
- *
206
- * Permite esconder a função de espiar a senha digitada.
207
- *
208
- * @default `false`
209
- */
210
- hidePasswordPeek: boolean;
211
- allLoginErrors: Array<string>;
212
- allPasswordErrors: Array<string>;
213
- customFieldObject: PoPageLoginCustomField;
214
- customFieldType: string;
215
- loginSubscription: Subscription;
216
- password: string;
217
- rememberUser: boolean;
218
- selectedLanguage: string;
219
- showExceededAttemptsWarning: boolean;
220
- private _authenticationType;
221
- private _authenticationUrl;
222
- private _blockedUrl;
223
- private _componentsSize?;
224
- private _contactEmail;
225
- private _customField;
226
- private _environment?;
227
- private _exceededAttemptsWarning?;
228
- private _hideRememberUser;
229
- private _literals;
230
- private _loading?;
231
- private _login;
232
- private _loginErrors;
233
- private _passwordErrors;
234
- private _productName;
235
- private _recovery;
236
- private _registerUrl;
237
- private _support;
238
- private _languagesList;
239
- /**
240
- * @optional
241
- *
242
- * @description
243
- *
244
- * Define o tamanho dos componentes de formulário no template:
245
- * - `small`: aplica a medida small de cada componente (disponível apenas para acessibilidade AA).
246
- * - `medium`: aplica a medida medium de cada componente.
247
- *
248
- * > Caso a acessibilidade AA não esteja configurada, o tamanho `medium` será mantido.
249
- * Para mais detalhes, consulte a documentação do [po-theme](https://po-ui.io/documentation/po-theme).
250
- *
251
- * @default `medium`
252
- */
253
- set componentsSize(value: string);
254
- get componentsSize(): string;
255
- /**
256
- * @optional
257
- *
258
- * @description
259
- *
260
- * Ao informar um valor do tipo `string`, o mesmo será aplicado como a chave do campo customizado e utilizará
261
- * os valores padrões contidos na propriedade `literals` como `customFieldErrorPattern` e `customFieldPlaceholder`.
262
- *
263
- * Existe a possibilidade de informar um objeto que segue a definição da interface `PoPageLoginCustomField`, onde
264
- * através dos parâmetros enviados pode gerar um `po-input`, `po-combo` especificamente para serviços
265
- * ou `po-select` para valores fixos.
266
- *
267
- * Abaixo seguem os exemplos de cada tipo de campo.
268
- *
269
- * `po-input`:
270
- *
271
- * ```
272
- * {
273
- * property: 'domain',
274
- * value: 'jv01',
275
- * placeholder: 'Enter your domain',
276
- * pattern: '[a-z]',
277
- * errorPattern: 'Invalid value'
278
- * }
279
- * ```
280
- *
281
- * `po-combo`:
282
- *
283
- * ```
284
- * {
285
- * property: 'domain',
286
- * value: 'jv01',
287
- * placeholder: 'Enter your domain',
288
- * url: 'https://po-ui.io/sample/api/comboOption/domains',
289
- * fieldValue: 'nickname'
290
- * }
291
- * ```
292
- *
293
- * `po-select`:
294
- *
295
- * ```
296
- * {
297
- * property: 'domain',
298
- * value: 'jv01',
299
- * placeholder: 'Enter your domain',
300
- * options: [{label: 'Domain 1', value: '1'}, {label: 'Domain 2', value: '2'}]
301
- * }
302
- * ```
303
- *
304
- * Caso o customField possua options, url e fieldValue preenchidos, será priorizado o po-select
305
- * utilizando o options.
306
- *
307
- */
308
- set customField(value: string | PoPageLoginCustomField);
309
- get customField(): string | PoPageLoginCustomField;
310
- /**
311
- * @optional
312
- *
313
- * @description
314
- *
315
- * Personaliza o e-mail que é exibido na mensagem de dica de login padrão para contato de suporte.
316
- */
317
- set contactEmail(value: string);
318
- get contactEmail(): string;
319
- /**
320
- * @optional
321
- *
322
- * @description
323
- *
324
- * Texto customizado que fica entre a logo e a mensagem de boas-vindas.
325
- */
326
- set productName(value: string);
327
- get productName(): string;
328
- /**
329
- * @optional
330
- *
331
- * @description
332
- * Adiciona uma `tag` abaixo do título que especifica o ambiente que o usuário está fazendo o login.
333
- *
334
- * > Essa propriedade limita o texto em 40 caracteres.
335
- */
336
- set environment(environment: string);
337
- get environment(): string;
338
- /**
339
- * @optional
340
- *
341
- * @description
342
- * Exibe um aviso de bloqueio de acordo com a quantidade restante de tentativas.
343
- * O aviso será exibido somente se a quantidade for maior que zero.
344
- *
345
- * > Caso tenha algum valor atribuído para o atributo `p-authentication-url` e o retorno da requisição estiver atribuindo valor
346
- * para o `p-exceeded-attempts-warning`, o valor considerado será o do retorno da requisição.
347
- *
348
- * @default `0`
349
- */
350
- set exceededAttemptsWarning(value: number);
351
- get exceededAttemptsWarning(): number;
352
- /**
353
- * @optional
354
- *
355
- * @description
356
- *
357
- * Esconde a função "Lembrar usuário" do formulário de login.
358
- *
359
- * Quando essa propriedade é setada com `true` a propriedade `rememberUser` enviada no evento `p-login-submit` será sempre
360
- * `false`.
361
- *
362
- * > Veja a propriedade `p-literals` para customizar a literal `rememberUser`.
363
- *
364
- * @default `false`
365
- */
366
- set hideRememberUser(value: boolean);
367
- get hideRememberUser(): boolean;
368
- /**
369
- * @optional
370
- *
371
- * @description
372
- *
373
- * Objeto com as literais usadas no `po-page-login`.
374
- *
375
- * Existem duas maneiras de customizar o componente, passando um objeto com todas as literais disponíveis:
376
- *
377
- * ```
378
- * const customLiterals: PoPageLoginLiterals = {
379
- * attempts: '{0} vez(es) ',
380
- * createANewPasswordNow: 'Melhor criar uma senha nova agora! Você vai poder entrar no sistema logo em seguida.',
381
- * forgotPassword: 'Esqueceu sua senha?',
382
- * forgotYourPassword: 'Esqueceu sua senha?',
383
- * highlightInfo: '',
384
- * iForgotMyPassword: 'Esqueci minha senha',
385
- * ifYouTryHarder: 'Se tentar mais ',
386
- * welcome: 'Boas-vindas',
387
- * loginErrorPattern: 'Login obrigatório',
388
- * loginHint: 'Caso não possua usuário entre em contato com o suporte',
389
- * loginLabel: 'Insira seu usuário',
390
- * loginPlaceholder: 'Insira seu usuário de acesso',
391
- * passwordErrorPattern: 'Senha obrigatória',
392
- * passwordLabel: 'Insira sua senha',
393
- * passwordPlaceholder: 'Insira sua senha de acesso',
394
- * customFieldErrorPattern: 'Campo customizado inválido',
395
- * customFieldPlaceholder: 'Por favor insira um valor',
396
- * registerUrl: 'Novo registro',
397
- * rememberUser: 'Lembrar usuário',
398
- * rememberUserHint: 'Esta opção pode ser desabilitada nas configurações do sistema',
399
- * submitLabel: 'Acessar sistema',
400
- * submittedLabel: 'Carregando...',
401
- * titlePopover: 'Opa!',
402
- * yourUserWillBeBlocked: 'sem sucesso seu usuário será bloqueado e você fica 24 horas sem poder acessar :('
403
- * };
404
- * ```
405
- *
406
- * Ou passando apenas as literais que deseja customizar:
407
- *
408
- * ```
409
- * const customLiterals: PoPageLoginLiterals = {
410
- * loginPlaceholder: 'Insira seu usuário de acesso',
411
- * passwordPlaceholder: 'Insira sua senha de acesso',
412
- * submitLabel: 'Acessar sistema'
413
- * };
414
- * ```
415
- *
416
- * E para carregar as literais customizadas, basta apenas passar o objeto para o componente.
417
- *
418
- * ```
419
- * <po-page-login
420
- * [p-literals]="customLiterals">
421
- * </po-page-login>
422
- * ```
423
- *
424
- * > O objeto padrão de literais será traduzido de acordo com o idioma do browser (pt, en, es).
425
- * > É também possível alternar o objeto padrão de literais através do seletor de idiomas localizado na parte inferior do template,
426
- * nesse caso, há também a opção do idioma russo.
427
- */
428
- set literals(value: PoPageLoginLiterals);
429
- get literals(): PoPageLoginLiterals;
430
- /**
431
- * @optional
432
- *
433
- * @description
434
- *
435
- * Habilita um estado de carregamento ao botão de *login*.
436
- *
437
- * > É necessário atribuir `true` à esta propriedade na função definida em `p-login-submit`.
438
- *
439
- * @default `false`
440
- */
441
- set loading(value: boolean);
442
- get loading(): boolean;
443
- /**
444
- * @optional
445
- *
446
- * @description
447
- *
448
- * Valor do modelo do campo de login.
449
- */
450
- set login(value: string);
451
- get login(): string;
452
- /**
453
- * @optional
454
- *
455
- * @description
456
- *
457
- * Atributo que recebe uma lista de erros e exibe abaixo do campo de login.
458
- */
459
- set loginErrors(value: Array<string>);
460
- get loginErrors(): Array<string>;
461
- /**
462
- * @optional
463
- *
464
- * @description
465
- *
466
- * Atributo que recebe uma lista de erros e exibe abaixo do campo de password.
467
- */
468
- set passwordErrors(value: Array<string>);
469
- get passwordErrors(): Array<string>;
470
- /**
471
- * @optional
472
- *
473
- * @description
474
- *
475
- * Exibe um link abaixo do formulário de login para que os usuários da aplicação façam a recuperação dos dados de autenticação.
476
- *
477
- * A propriedade aceita os seguintes tipos:
478
- *
479
- * - **String**: informe uma url externa ou uma rota válida;
480
- * - **Function**: pode-se customizar a ação. Para esta possilidade basta atribuir:
481
- * ```
482
- * <po-page-login>
483
- * [recovery]="this.myRecovery.bind(this)">
484
- * </po-page-login>
485
- * ```
486
- *
487
- * - **PoPageLoginRecovery**: cria-se vínculo automático com o template **po-modal-password-recovery**.
488
- * O objeto deve conter a **url** para requisição dos recursos e pode-se definir o **tipo** de modal para recuperação de senha,
489
- * **email** para contato e **máscara** do campo de telefone.
490
- */
491
- set recovery(value: string | Function | PoPageLoginRecovery);
492
- get recovery(): string | Function | PoPageLoginRecovery;
493
- /**
494
- * @optional
495
- *
496
- * @description
497
- *
498
- * Caso a aplicação tenha um link para novos cadastros, informe uma url externa ou uma rota válida, dessa
499
- * forma será exibido um link abaixo do formulário de login para os usuários da aplicação.
500
- *
501
- * Exemplos de valores válidos:
502
- * - **local**: `/home`
503
- * - **url externa**: `https://po-ui.io`
504
- *
505
- * > Veja a propriedade `p-literals` para customizar a literal `registerUrl`.
506
- */
507
- set registerUrl(value: string);
508
- get registerUrl(): string;
509
- /**
510
- * @optional
511
- *
512
- * @description
513
- *
514
- * Atributo que recebe o tipo de esquema da autenticação, sendo suportados apenas os valores `Basic` e `Bearer`.
515
- *
516
- * > Caso o tipo definido seja `Basic`, o componente fará uma requisição `POST` contendo:
517
- *
518
- * ```
519
- * headers {
520
- * Authorization: Basic base64(login:password)
521
- * }
522
- *
523
- * body {
524
- * rememberUser: rememberUser
525
- * }
526
- * ```
527
- *
528
- * > Caso o tipo definido seja `Bearer`, o componente fará uma requisição `POST` contendo:
529
- *
530
- * ```
531
- * body {
532
- * login: login,
533
- * password: base64(password),
534
- * rememberUser: rememberUser
535
- * }
536
- * ```
537
- *
538
- * @default `PoPageLoginAuthenticationType.Basic`
539
- */
540
- set authenticationType(value: PoPageLoginAuthenticationType);
541
- get authenticationType(): PoPageLoginAuthenticationType;
542
- /**
543
- * @optional
544
- *
545
- * @description
546
- *
547
- * Endpoint usado pelo template para requisição do recurso. Quando preenchido, o método `p-login-submit` será ignorado e o
548
- * componente adquirirá automatização para o processo de autenticação.
549
- *
550
- * ### Processos
551
- * Ao digitar um valor válido no campo de login/password e pressionar **Enter**, o componente fará uma requisição `POST`
552
- * na url especificada nesta propriedade passando o objeto contendo o valor definido pelo usuário:
553
- *
554
- * ```
555
- * headers {
556
- * Authorization: Basic base64(login:password)
557
- * }
558
- *
559
- * body {
560
- * rememberUser: rememberUser
561
- * }
562
- * ```
563
- *
564
- * Em caso de **sucesso**, o objeto de retorno é armazenado no `sessionStorage` e o usuário é redirecionado para a página inicial da
565
- * aplicação `/`.
566
- *
567
- * ```
568
- * 200:
569
- * {
570
- * user: user
571
- * }
572
- * ```
573
- *
574
- * Em caso de **erro** na autenticação, espera-se o seguinte retorno:
575
- *
576
- * ```
577
- * 400/401
578
- * {
579
- * code: 400/401,
580
- * message: message,
581
- * detailedMessage: detailedMessage,
582
- * helpUrl?: helpUrl
583
- * }
584
- * ```
585
- *
586
- * > Pode-se atribuir uma quantidade máxima de tentativas restantes (maxAttemptsRemaining) para o atributo `p-exceeded-attempts-warning`,
587
- * assim como os avisos relacionados aos campos login e password (loginWarnings, passwordWarnings) para os atributos `p-login-errors` e
588
- * `p-password-errors` conforme retorno abaixo:
589
- *
590
- * ```
591
- * 400
592
- * {
593
- * code: 400/401,
594
- * message: message,
595
- * detailedMessage: detailedMessage,
596
- * helpUrl?: helpUrl,
597
- * maxAttemptsRemaining?: maxAttemptsRemaining,
598
- * loginWarnings?: [loginWarnings],
599
- * passwordWarnings?: [passwordWarnings]
600
- * }
601
- * ```
602
- *
603
- * > Caso o valor atribuído para `p-exceeded-attempts-warning` seja igual a 0(zero), poderá ser passado um valor para o
604
- * atributo `p-blocked-url` e o usuário será redirecionado para uma tela de bloqueio.
605
- *
606
- * *Processo finalizado.*
607
- *
608
- * _______________
609
- *
610
- * #### Praticidade
611
- * As informações do serviço de autenticação também podem ser transmitidas diretamente pelas configuraçãos de rota e, desta maneira,
612
- * dispensa-se qualquer menção e/ou importação do componente `po-page-login` no restante da aplicação. O exemplo abaixo exemplifica
613
- * a forma dinâmica com a qual o template de tela de login pode ser gerado ao navegar para rota `/login`, e também como ele se comunica
614
- * com o serviço para efetuação do processo de autenticação do usuário e solicitação de nova senha.
615
- * Basta definir nas configurações de rota:
616
- *
617
- *
618
- * ```
619
- * import { PoPageLoginComponent, PoPageLoginAthenticationType } from '@po-ui/ng-templates';
620
- *
621
- * ...
622
- * const routes: Routes = [
623
- * {
624
- * path: 'login', component: PoPageLoginComponent, data: {
625
- * serviceApi: 'https://po-ui.io/sample/api/users/authentication',
626
- * environment: 'development',
627
- * recovery: {
628
- * url: 'https://po-ui.io/sample/api/users',
629
- * type: PoModalPasswordRecoveryType.All,
630
- * contactMail: 'dev.po@po-ui.com',
631
- * phoneMask: '9-999-999-9999'
632
- * },
633
- * registerUrl: '/new-password',
634
- * authenticationType: PoPageLoginAthenticationType.Basic
635
- * }
636
- * }
637
- * ...
638
- * ];
639
- *
640
- * @NgModule({
641
- * imports: [RouterModule.forRoot(routes)],
642
- * exports: [RouterModule]
643
- * })
644
- * export class AppRoutingModule { }
645
- * ```
646
- *
647
- *
648
- * O metadado `serviceApi` deve ser a **url** para requisição dos recursos de autenticação, o `environment` alimenta a propriedade
649
- * `p-environment`, `recovery` é a interface `PoPageLoginRecovery` responsável pelas especificações contidas na modal de recuperação de
650
- * senha, `registerUrl` alimenta a propriedade `p-register-url` e `authenticationType` que define a propriedade `p-authentication-type`.
651
- *
652
- * > É essencial que siga a nomenclatura dos atributos exemplificados acima para sua efetiva funcionalidade.
653
- *
654
- */
655
- set authenticationUrl(value: string);
656
- get authenticationUrl(): string;
657
- /**
658
- * @optional
659
- *
660
- * @description
661
- *
662
- * Caso o valor atribuído para `p-exceeded-attempts-warning` seja igual a 0(zero) e a aplicação tenha um link de bloqueio de usuário,
663
- * informe uma url externa ou uma rota válida, dessa forma em caso de bloqueio o usuário será redirecionado.
664
- */
665
- set blockedUrl(value: string);
666
- get blockedUrl(): string;
667
- /**
668
- * @optional
669
- *
670
- * @description
671
- *
672
- * Exibe um botão para suporte.
673
- *
674
- * A propriedade aceita os seguintes tipos:
675
- *
676
- * - **String**: URL externa ou uma rota válida;
677
- * - **Function**: Função a ser disparada ao clicar no botão de suporte;
678
- * ```
679
- * <po-page-login>
680
- * [p-support]="this.mySupport.bind(this)">
681
- * </po-page-login>
682
- * ```
683
- *
684
- */
685
- set support(value: string | Function);
686
- get support(): string | Function;
687
- /**
688
- * @optional
689
- *
690
- * @description
691
- *
692
- * Coleção de idiomas que o componente irá tratar e disponibilizará para o usuário escolher.
693
- *
694
- * Caso essa propriedade não seja utilizada o componente mostrará no combo os idiomas que ele suporta por padrão.
695
- *
696
- * Caso a coleção tenha um idioma, a página estará nesse idioma e não mostrará o combo.
697
- *
698
- * Caso seja passado um array vazio, a página terá o idioma configurado no `i18n` e não mostrará o combo de seleção.
699
- *
700
- * > Se for passado um idioma não suportado, será preciso passar as literais pela propriedade `p-literals`.
701
- *
702
- *
703
- */
704
- set languagesList(languagesList: Array<PoLanguage>);
705
- get languagesList(): Array<PoLanguage>;
706
- get showLanguage(): boolean;
707
- get language(): string;
708
- get pageLoginLiterals(): PoPageLoginLiterals;
709
- constructor(loginService: PoPageLoginService, router: Router, poLanguageService: PoLanguageService);
710
- ngOnDestroy(): void;
711
- closePopover(): void;
712
- onLoginSubmit(): void;
713
- private getDefaultCustomFieldObject;
714
- private openExternalLink;
715
- private openInternalLink;
716
- private redirectBlockedUrl;
717
- private setValuesToProperties;
718
- protected abstract concatenateLoginHintWithContactEmail(contactEmail: string): any;
719
- protected abstract setLoginErrors(value: Array<string>): void;
720
- protected abstract setPasswordErrors(value: Array<string>): void;
721
- static ɵfac: i0.ɵɵFactoryDeclaration<PoPageLoginBaseComponent, never>;
722
- static ɵdir: i0.ɵɵDirectiveDeclaration<PoPageLoginBaseComponent, never, never, { "background": { "alias": "p-background"; "required": false; }; "logo": { "alias": "p-logo"; "required": false; }; "loginPattern": { "alias": "p-login-pattern"; "required": false; }; "passwordPattern": { "alias": "p-password-pattern"; "required": false; }; "secondaryLogo": { "alias": "p-secondary-logo"; "required": false; }; "noAutocompleteLogin": { "alias": "p-no-autocomplete-login"; "required": false; }; "noAutocompletePassword": { "alias": "p-no-autocomplete-password"; "required": false; }; "hideLabelStatus": { "alias": "p-hide-label-status"; "required": false; }; "hidePasswordPeek": { "alias": "p-hide-password-peek"; "required": false; }; "componentsSize": { "alias": "p-components-size"; "required": false; }; "customField": { "alias": "p-custom-field"; "required": false; }; "contactEmail": { "alias": "p-contact-email"; "required": false; }; "productName": { "alias": "p-product-name"; "required": false; }; "environment": { "alias": "p-environment"; "required": false; }; "exceededAttemptsWarning": { "alias": "p-exceeded-attempts-warning"; "required": false; }; "hideRememberUser": { "alias": "p-hide-remember-user"; "required": false; }; "literals": { "alias": "p-literals"; "required": false; }; "loading": { "alias": "p-loading"; "required": false; }; "login": { "alias": "p-login"; "required": false; }; "loginErrors": { "alias": "p-login-errors"; "required": false; }; "passwordErrors": { "alias": "p-password-errors"; "required": false; }; "recovery": { "alias": "p-recovery"; "required": false; }; "registerUrl": { "alias": "p-register-url"; "required": false; }; "authenticationType": { "alias": "p-authentication-type"; "required": false; }; "authenticationUrl": { "alias": "p-authentication-url"; "required": false; }; "blockedUrl": { "alias": "p-blocked-url"; "required": false; }; "support": { "alias": "p-support"; "required": false; }; "languagesList": { "alias": "p-languages"; "required": false; }; }, { "loginChange": "p-login-change"; "loginSubmit": "p-login-submit"; "passwordChange": "p-password-change"; "languageChange": "p-language-change"; }, never, never, true, never>;
723
- static ngAcceptInputType_hideLabelStatus: any;
724
- }