@reforgium/internal

Shared infrastructure package for Reforgium Angular libraries.

Install

npm i @reforgium/internal

Public API

@reforgium/internal exports:

• models
• tokens
• utils

Models

Main model groups:

• api.ts: RestMethods, SortToken, PageableRequest, PageableResponse<T>, ErrorResponse, QueryParams, Query
• components.ts: Appearance, SelectOption, SelectIconOption
• elements.ts: Direction, ElementRect, ElementSize, ElementPosition, ElementEdges
• util.ts: AnyType, AnyDict, LiteralOf, ValueOf, Nullable, Nullish, NullableProps, OptionalExcept, RequiredExcept, Mutable, JSON helper types

Tokens

Language tokens:

• SELECTED_LANG: InjectionToken<Signal<Langs>>
• CHANGE_LANG: InjectionToken<(lang: Langs) => void>
• TRANSLATION
• REGISTER_LANG (multi-token)
• BUILTIN_LANGS
• provideLangs(...langs: string[])
• Langs = BuiltInLangs | (string & {})

Theme/device/validation tokens:

• SELECTED_THEME, CHANGE_THEME, Themes
• CURRENT_DEVICE, Devices
• VALIDATION_MESSAGES, ValidationMessages, ValidationErrorData

Example:

import { provideLangs } from '@reforgium/internal';

export const appConfig = {
  providers: [provideLangs('de', 'fr')],
};

Utilities

Exported utilities:

• web.utils.ts: downloadByBlob, downloadByUrl, copyText, base64ToBlob
• timers.utils.ts: throttleSignal, debounceSignal
• date.utils.ts: toDate, formatDate, formatToLocaledDate, parseToDate, parseToDatePeriod, isDatePeriod, reformatDateToISO
• types.utils.ts: isNumber, isNullable, isObject, parseQueryArray, concatArray
• format.utils.ts: formatToSpacedNumber, truncate
• positions.utils.ts: getCorrectedPosition
• available-height.utils.ts: getAvailableHeight
• get-chained-value.utils.ts: getChainedValue
• urls.utils.ts: normalizeUrl, fillUrlWithParams, appendQueryParams, parseQueryParams
• routes.utils.ts: materializeRoutePath, compareRoutes, makeQuery
• deep-equal.utils.ts: deepEqual
• generate.utils.ts: generateId

makeQuery(..., 'multi') behavior:

import { makeQuery } from '@reforgium/internal';

makeQuery({ ids: [1, 2, 3], q: 'ok' }, 'multi');
// ids=1&ids=2&ids=3&q=ok

License

MIT