Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 | 12x 12x 12x 12x 12x 12x 12x 12x 2x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x | import {
DEFAULT_PATTERNS,
VALIDATION_PARENT_KEY,
ValidationKeys,
} from '@decaf-ts/decorator-validation';
import { I18nToken, ICrudFormOptions, IListEmptyOptions } from './interfaces';
import { ModalOptions } from '@ionic/angular/standalone';
import { OperationKeys } from '@decaf-ts/db-decorators';
import { InjectionToken } from '@angular/core';
import { DecafRepositoryAdapter } from './types';
export const DB_ADAPTER_FLAVOUR_TOKEN = 'DbAdapterFlavour';
/**
* Maps validation keys for password, email, and URL to their corresponding regex patterns.
* These patterns are used to validate field values against standard format requirements.
*/
/**
* Maps validation keys for password, email, and URL to their corresponding regex patterns.
* These patterns are used to validate field values against standard format requirements.
*/
export const patternValidators: Record<string, RegExp> = {
[ValidationKeys.PASSWORD]: DEFAULT_PATTERNS.PASSWORD.CHAR8_ONE_OF_EACH,
[ValidationKeys.EMAIL]: DEFAULT_PATTERNS.EMAIL,
[ValidationKeys.URL]: DEFAULT_PATTERNS.URL,
};
/**
* @description Injection token for registering the database adapter provider.
* @summary Used to inject the database adapter instance that implements DecafRepositoryAdapter.
* This token allows the framework to locate and use the application's specific database implementation.
* @const {InjectionToken<DecafRepositoryAdapter>}
* @memberOf module:lib/for-angular-common.module
*/
export const DB_ADAPTER_PROVIDER_TOKEN = new InjectionToken<DecafRepositoryAdapter>(
'DB_ADAPTER_PROVIDER_TOKEN',
);
/**
* @description Injection token for the root path of locale translation files.
* @summary Used to configure the base path where i18n translation files are located.
* This allows the translation loader to locate JSON files for different languages.
* @const {InjectionToken<string>}
* @memberOf module:lib/for-angular-common.module
* @example
* // Typical usage when providing the token
* { provide: LOCALE_ROOT_TOKEN, useValue: './assets/i18n/' }
*/
export const LOCALE_ROOT_TOKEN = new InjectionToken<string>('LOCALE_ROOT_TOKEN');
/* Generic token for injecting on class constructors */
/**
* @description Generic injection token for providing arbitrary values to constructors.
* @summary Used to inject classes, strings, or any other value into component or service constructors.
* This is a flexible token that can be used to provide any type of dependency when more specific
* tokens are not appropriate. The actual type and purpose of the injected value is determined by
* the provider configuration.
* @const {InjectionToken<unknown>}
* @memberOf module:lib/for-angular-common.module
* @example
* // Inject a string value
* { provide: CPTKN, useValue: 'some-config-value' }
*
* // Inject a class
* { provide: CPTKN, useClass: MyService }
*
* // Inject any arbitrary value
* { provide: CPTKN, useValue: { key: 'value', data: [1, 2, 3] } }
*/
export const CPTKN = new InjectionToken<unknown>('CPTKN', {
providedIn: 'root',
factory: () => '',
});
/**
* @description Injection token for i18n resource configuration.
* @summary Used to provide configuration for internationalization resources, including
* translation file locations and supported languages. This token configures how the
* application loads and manages translation resources.
* @const {InjectionToken<I18nToken>}
* @memberOf module:lib/for-angular-common.module
*/
export const I18N_CONFIG_TOKEN = new InjectionToken<I18nToken>('I18N_CONFIG_TOKEN');
/**
* @description Default options for empty list state display.
* @summary Provides default configuration for displaying empty state in list components
* when no data is available. Includes default text for title and subtitle, icon name,
* button text and visibility settings. These defaults can be overridden by individual
* list component implementations to customize the empty state presentation.
* @type {IListEmptyOptions}
* @property {string} title - Default translation key for empty list title
* @property {string} subtitle - Default translation key for empty list subtitle
* @property {boolean} showButton - Whether to show action button in empty state
* @property {string} icon - Default Ionic icon name for empty state
* @property {string} buttonText - Default translation key for button text
* @property {string} link - Default navigation link (empty string)
* @const DefaultListEmptyOptions
* @memberOf module:lib/engine/constants
*/
export const DefaultListEmptyOptions: IListEmptyOptions = {
title: 'empty.title',
subtitle: 'empty.subtitle',
showButton: true,
icon: 'folder-open-outline',
buttonText: 'create',
link: '',
} as const;
export const DefaultModalOptions = {
component: '',
showBackdrop: true,
backdropDismiss: false,
animated: true,
canDismiss: true,
showBackdropTapClose: true,
focusTrap: true,
} as ModalOptions;
export const ActionRoles = {
cancel: 'cancel',
confirm: 'confirm',
submit: 'submit',
clear: 'clear',
back: 'back',
[OperationKeys.CREATE]: OperationKeys.CREATE,
[OperationKeys.READ]: OperationKeys.READ,
[OperationKeys.UPDATE]: OperationKeys.UPDATE,
[OperationKeys.DELETE]: OperationKeys.DELETE,
} as const;
export const WindowColorSchemes = {
light: 'light',
dark: 'dark',
undefined: 'undefined',
} as const;
export const ListItemPositions = {
uid: 'uid',
title: 'title',
description: 'description',
info: 'info',
subinfo: 'subinfo',
} as const;
/**
* @description Angular engine key constants.
* @summary Contains key strings used by the Angular rendering engine for reflection,
* dynamic component creation, and other engine operations. These constants provide
* consistent naming for metadata keys, DOM attributes, and component identification
* throughout the rendering system.
* @typedef {Object} AngularEngineKeys
* @property {string} REFLECT - Prefix for reflection metadata keys
* @property {string} DYNAMIC - Key for dynamic component identification
* @property {string} ANNOTATIONS - Key for component annotations
* @property {string} ECMP - Key for embedded components
* @property {string} NG_REFLECT - Prefix for Angular reflection attributes
* @property {string} RENDERED - Prefix for rendered component markers
* @property {string} MAPPER - Key for property mappers
* @property {string} CHILDREN - Key for child components
* @property {string} LISTABLE - Key for listable components
* @property {string} RENDER - Key for renderable components
* @property {string} RENDERED_ID - Template for rendered component IDs
* @property {string} PARENT - Key for comparison decorators and validators
* @property {string} VALIDATION_PARENT_KEY - Key for validation parent reference
* @property {string} FLAVOUR - Identifier for the Angular engine flavor
* @const AngularEngineKeys
* @memberOf module:lib/engine/constants
*/
export const AngularEngineKeys = {
REFLECT: `angular`,
DYNAMIC: 'dynamic-component',
ANNOTATIONS: '__annotations__',
ECMP: 'ecmp',
NG_REFLECT: 'ng-reflect-',
RENDERED: 'rendered-as-',
MAPPER: 'mapper',
CHILDREN: 'children',
ERRORS: 'errors',
LISTABLE: 'listable',
RENDER: 'render',
RENDERED_ID: 'rendered-as-{0}',
PARENT: '_parent',
VALIDATION_PARENT_KEY: VALIDATION_PARENT_KEY,
FLAVOUR: 'angular',
LOADED: 'engineLoaded',
DARK_PALETTE_CLASS: 'dcf-palette-dark',
} as const;
/**
* @description Route direction constants.
* @summary Defines the possible navigation directions in the application.
* Used for controlling navigation flow and animation directions during route transitions.
* These constants help maintain consistent navigation behavior throughout the app.
* @enum {string}
* @readonly
* @property {string} BACK - Navigate back to the previous page
* @property {string} FORWARD - Navigate forward to the next page
* @property {string} ROOT - Navigate to the root/home page
* @memberOf module:lib/engine/constants
*/
export enum RouteDirections {
BACK = 'back',
FORWARD = 'forward',
ROOT = 'root',
}
/**
* @description Component tag name constants.
* @summary Defines the custom HTML tag names for specialized components used in the application.
* These tag names are registered with Angular and used for component rendering and identification.
* Each constant represents the selector for a specific custom component type.
* @enum {string}
* @readonly
* @property {string} LIST_ITEM - Tag name for list item component
* @property {string} LIST_INFINITE - Tag name for infinite scrolling list component
* @property {string} LIST_PAGINATED - Tag name for paginated list component
* @property {string} CRUD_FIELD - Tag name for CRUD form field component
* @property {string} LAYOUT_COMPONENT - Tag name for layout container component
* @memberOf module:lib/engine/constants
*/
export enum ComponentsTagNames {
LIST_ITEM = 'ngx-decaf-list-item',
LIST_INFINITE = 'ngx-decaf-list-infinite',
LIST_PAGINATED = 'ngx-decaf-list-paginated',
CRUD_FIELD = 'ngx-decaf-crud-field',
LAYOUT_COMPONENT = 'ngx-decaf-layout',
}
/**
* @description Base component property name constants.
* @summary Defines the standard property names used by base components throughout the application.
* These constants ensure consistent property naming across components and facilitate
* property access, validation, and data binding. Used primarily for component input
* properties and change detection.
* @enum {string}
* @readonly
* @property {string} MODEL - Property name for the component's data model
* @property {string} LOCALE - Property name for localization settings
* @property {string} LOCALE_ROOT - Property name for the locale root identifier
* @property {string} PK - Property name for primary key
* @property {string} ITEMS - Property name for collection items
* @property {string} ROUTE - Property name for routing information
* @property {string} OPERATIONS - Property name for available operations
* @property {string} UID - Property name for unique identifier
* @property {string} TRANSLATABLE - Property name for translation flag
* @property {string} MAPPER - Property name for property mapper
* @property {string} INITIALIZED - Property name for initialization state
* @property {string} COMPONENT_NAME - Property name for component identifier
* @property {string} PARENT_FORM - Property name for parent component reference
* @property {string} FORM_GROUP_COMPONENT_PROPS - Property name for form group component properties
* @memberOf module:lib/engine/constants
*/
export enum BaseComponentProps {
MODEL_ID = 'modelId',
MODEL = 'model',
HANDLERS = 'handlers',
LOCALE = 'locale',
LOCALE_ROOT = 'locale_root',
PK = 'pk',
ITEMS = 'items',
ROUTE = 'route',
OPERATION = 'operation',
OPERATIONS = 'operations',
UID = 'uid',
TRANSLATABLE = 'translatable',
MAPPER = 'mapper',
INITIALIZED = 'initialized',
COMPONENT_NAME = 'componentName',
PARENT_FORM = 'parentForm',
FORM_GROUP_COMPONENT_PROPS = 'componentProps',
}
/**
* @description List component type constants.
* @summary Defines the available types for list components, determining their
* pagination and scrolling behavior. Used to configure list rendering strategies.
* @enum {string}
* @readonly
* @property {string} INFINITE - Infinite scroll list type
* @property {string} PAGINATED - Paginated list type with page navigation
* @memberOf module:lib/engine/constants
*/
export enum ListComponentsTypes {
INFINITE = 'infinite',
PAGINATED = 'paginated',
}
/**
* @description CSS class name constants.
* @summary Contains predefined CSS class names used for consistent styling
* across components. These constants help maintain a unified visual language
* and make it easier to apply standard styles.
* @typedef {Object} CssClasses
* @property {string} BUTTONS_CONTAINER - CSS class for button container elements
* @const CssClasses
* @memberOf module:lib/engine/constants
*/
export const CssClasses = {
BUTTONS_CONTAINER: 'buttons-container',
};
/**
* @description Default options for reactive CRUD forms.
* @summary Provides default configuration for form buttons in CRUD operations.
* Includes default text labels for submit and clear buttons, which can be
* overridden by individual form implementations.
* @type {ICrudFormOptions}
* @property {Object} buttons - Configuration for form action buttons
* @property {Object} buttons.submit - Submit button configuration
* @property {string} buttons.submit.text - Default text for submit button
* @property {Object} buttons.clear - Clear button configuration
* @property {string} buttons.clear.text - Default text for clear button
* @const DefaultFormReactiveOptions
* @memberOf module:lib/engine/constants
*/
export const DefaultFormReactiveOptions: ICrudFormOptions = {
buttons: {
submit: {
text: 'Submit',
},
clear: {
text: 'Clear',
},
},
};
/**
* @description Mapping of select field interface types used in Ionic components.
* @summary Provides a set of supported select interface types for Ionic select fields,
* mapping human-readable keys to their corresponding `SelectInterface` string values.
* This allows for consistent usage and reference of select interface types throughout the application.
* @type {Record<string, SelectInterface>}
* @property {string} PopOver - Represents the 'popover' select interface.
* @property {string} Alert - Represents the 'alert' select interface.
* @property {string} ActionSheet - Represents the 'action-sheet' select interface.
* @property {string} modal - Represents the 'modal' select interface.
* @const SelectFieldInterfaces
* @memberOf module:lib/engine/constants
*/
export const SelectFieldInterfaces = {
POPOVER: 'popover',
ALERT: 'alert',
ACTION_SHEET: 'action-sheet',
MODAL: 'modal',
} as const;
|