@diia-inhouse/types 12.0.3 → 12.0.4

package/dist/types/index.d.ts

@@ -0,0 +1,20 @@
+export * from './address';
+export * from './documents';
+export * from './token';
+export * from './session';
+export * from './common';
+export * from './actions';
+export * from './interfaces';
+export * from './file';
+export * from './grpc';
+export * from './http';
+export * from './logger';
+export * from './durations';
+export * from './units';
+export * from './publicServices';
+export * from './versions';
+export * from './codeName';
+export * from './pdf';
+export * from './payment';
+export * from './generated';
+export * from './validators';

package/dist/types/interfaces/index.d.ts

@@ -0,0 +1,5 @@
+export * from './onInit';
+export * from './onHealthCheck';
+export * from './onDestroy';
+export * from './onRegistrationsFinished';
+export * from './notification';

package/dist/types/interfaces/notification.d.ts

@@ -0,0 +1,65 @@
+import { PlatformType } from '../generated/platformType';
+export declare enum TemplateStub {
+    ViolationDate = "VIOLATION_DATE",
+    AcquirerName = "ACQUIRER_NAME",
+    OpeningDate = "OPENING_DATE",
+    ApplicationId = "APPLICATION_ID",
+    ServiceCenterName = "SERVICE_CENTER_NAME",
+    Reason = "REASON",
+    Address = "ADDRESS",
+    PhoneNumber = "PHONE_NUMBER",
+    FullName = "FULL_NAME",
+    RecipientFullName = "RECIPIENT_FULL_NAME",
+    Owner = "OWNER",
+    OrderNum = "ORDER_NUM",
+    PollTitle = "POLL_TITLE",
+    DateFrom = "DATE_FROM",
+    DateUntil = "DATE_UNTIL",
+    Year = "YEAR",
+    Specializations = "SPECIALIZATIONS",
+    DocumentName = "DOCUMENT_NAME",
+    PartnerName = "PARTNER_NAME",
+    ChildName = "CHILD_NAME",
+    BondName = "BOND_NAME",
+    Quantity = "QUANTITY",
+    Amount = "AMOUNT",
+    Image = "IMAGE",
+    Link = "LINK",
+    BrandModel = "BRAND_MODEL",
+    LicensePlate = "LICENSE_PLATE",
+    Rate = "RATE",
+    MortgageMaxAmount = "MORTGAGE_MAX_AMOUNT",
+    MortgageTerm = "MORTGAGE_TERM",
+    MortgageAdvance = "MORTGAGE_ADVANCE",
+    MortgageRepayment = "MORTGAGE_REPAYMENT",
+    PenaltyDecision = "PENALTY_DECISION",
+    ShortText = "SHORT_TEXT",
+    CaseNumber = "CASE_NUMBER",
+    DecisionNumber = "DECISION_NUMBER",
+    DecisionDate = "DECISION_DATE",
+    DecisionName = "DECISION_NAME",
+    VehicleName = "VEHICLE_NAME"
+}
+export type TemplateParams = Partial<Record<TemplateStub, string>>;
+export declare enum MessageTemplateCode {
+}
+export interface NotificationAppVersions {
+    minVersion?: string;
+    maxVersion?: string;
+    versions?: string[];
+}
+export interface MessageAction {
+    type: string;
+    subtype?: string;
+    resourceId?: string;
+}
+export type NotificationAppVersionsByPlatformType = Partial<Record<PlatformType, NotificationAppVersions>>;
+export interface CreateNotificationWithPushesParams<T = MessageTemplateCode> {
+    templateCode: T;
+    userIdentifier: string;
+    templateParams?: TemplateParams;
+    resourceId?: string;
+    appVersions?: NotificationAppVersionsByPlatformType;
+    action?: MessageAction;
+}
+export type NotificationTemplateParams = Pick<CreateNotificationWithPushesParams, 'templateParams' | 'action' | 'appVersions'>;

package/dist/types/interfaces/onDestroy.d.ts

@@ -0,0 +1,6 @@
+export interface OnDestroy {
+    onDestroy(): Promise<void>;
+}
+export interface OnBeforeApplicationShutdown {
+    onBeforeApplicationShutdown(): Promise<void>;
+}

package/dist/types/interfaces/onHealthCheck.d.ts

@@ -0,0 +1,8 @@
+import { HttpStatusCode } from '../http';
+export type HealthCheckResult<T> = {
+    status: HttpStatusCode;
+    details: T;
+};
+export interface OnHealthCheck {
+    onHealthCheck(): Promise<HealthCheckResult<unknown>>;
+}

package/dist/types/interfaces/onInit.d.ts

@@ -0,0 +1,3 @@
+export interface OnInit {
+    onInit(): unknown;
+}

package/dist/types/interfaces/onRegistrationsFinished.d.ts

@@ -0,0 +1,3 @@
+export interface OnRegistrationsFinished {
+    onRegistrationsFinished(): unknown;
+}

package/dist/types/logger.d.ts

@@ -0,0 +1,41 @@
+import { AsyncLocalStorage } from 'node:async_hooks';
+import { AlsData, LogData } from './common';
+export declare enum LogLevel {
+    LOG = "log",
+    TRACE = "trace",
+    DEBUG = "debug",
+    INFO = "info",
+    WARN = "warn",
+    ERROR = "error",
+    FATAL = "fatal",
+    IO = "io"
+}
+export interface LoggerOptions {
+    logLevel?: LogLevel;
+    maxArrayLength?: number;
+    maxStringLength?: number;
+    endLengthToLog?: number;
+    maxObjectDepth?: number;
+    maxObjectBreadth?: number;
+    redact?: {
+        fields?: string[];
+        paths?: string[];
+        fieldsToRedactFullname?: string[];
+        fieldsToRedactItn?: string[];
+    };
+}
+export interface LoggerConstructor {
+    new (options?: LoggerOptions, asyncLocalStorage?: AsyncLocalStorage<AlsData>): Logger;
+}
+export interface Logger {
+    log(message: string, data?: unknown): void;
+    info(message: string, data?: unknown): void;
+    error(message: string, data?: unknown): void;
+    warn(message: string, data?: unknown): void;
+    fatal(message: string, data?: unknown): void;
+    trace(message: string, data?: unknown): void;
+    debug(message: string, data?: unknown): void;
+    io(message: string, data?: unknown): void;
+    child(bindings: Record<string, unknown>): Logger;
+    prepareContext(context: LogData): LogData;
+}

package/dist/types/payment.d.ts

@@ -0,0 +1,26 @@
+export declare enum PaymentTarget {
+    Debt = "debt",
+    Penalty = "penalty",
+    ReplacementDriverLicense = "replacement-driver-license",
+    SingleSocialContribution = "single-social-contribution",
+    SingleTax = "single-tax",
+    SingleTaxSpecial = "single-tax-special",
+    SingleSocialContributionPenalty = "single-social-contribution-penalty",
+    SingleTaxPenalty = "single-tax-penalty",
+    ResidenceRegistration = "residence-registration",
+    MilitaryDonation = "military-donation",
+    MilitaryBonds = "military-bonds",
+    CourtPenalties = "court-penalties",
+    VehicleReRegistration = "vehicle-re-registration",
+    Marriage = "marriage",
+    Divorce = "divorce",
+    MilitaryTax = "military-tax",
+    MilitaryTaxPenalty = "military-tax-penalty",
+    ReplacementVehicleLicense = "replacement-vehicle-license",
+    CriminalCert = "criminal-cert",
+    BusinessDiiaId = "business-diia-id",
+    /** deprecated */
+    Debts = "debts",
+    /** deprecated */
+    Penalties = "penalties"
+}

package/dist/types/pdf.d.ts

@@ -0,0 +1,66 @@
+export declare enum RowType {
+    OneColumn = "oneColumn",
+    OneColumnPrimaryOpacity = "oneColumnPrimaryOpacity",
+    TwoColumns = "twoColumns",
+    TwoColumnsPrimaryOpacity = "twoColumnsPrimaryOpacity",
+    TwoColumnsWithSign = "twoColumnsWithSign",
+    TwoColumnsSecondRightAlign = "twoColumnsSecondRightAlign",
+    ThreeColumns = "threeColumns"
+}
+export interface BlockStyle {
+    lineHeight?: string;
+    fontSize?: number;
+    marginBottom?: number;
+    fontWeight?: number;
+    opacity?: number;
+}
+export type TextItem = Content | CustomText;
+export type Content = string | string[];
+export interface CustomText extends BlockStyle {
+    content?: Content;
+}
+export interface LogoBlock {
+    logoHeader?: TextItem;
+    trident?: boolean;
+    header?: TextItem;
+    title?: TextItem;
+    subtitle?: TextItem;
+    tableBlock?: [RowType, TextBlock?, TextBlock?, TextBlock?][];
+    tableBlockStyle?: TableBlockStyle;
+}
+export interface IdentityBlock {
+    lastName?: TextItem;
+    firstName?: TextItem;
+    middleName?: TextItem;
+    fullName?: TextItem;
+    documentNumber?: TextItem;
+    documentDetail?: TextItem;
+    photo?: string;
+}
+export interface TextBlock {
+    primaryText?: TextItem;
+    secondaryText?: TextItem;
+    hasSeparator?: boolean;
+    footnote?: TextItem;
+}
+export interface TableBlockStyle {
+    gap?: string;
+    fontSize?: number;
+}
+export interface Block extends BlockStyle {
+    header?: TextItem;
+    title?: TextItem;
+    logoBlock?: LogoBlock;
+    textBlock?: TextItem;
+    identityBlock?: IdentityBlock;
+    tableBlock?: [RowType, TextBlock?, TextBlock?, TextBlock?][];
+    tableBlockStyle?: TableBlockStyle;
+    hasSeparator?: boolean;
+}
+export interface GenericData {
+    documentTitle?: string;
+    blocks?: Block[];
+}
+export interface GeneratedPdf {
+    file: string;
+}

package/dist/types/publicServices.d.ts

@@ -0,0 +1,5 @@
+export interface StatusHistoryItem<T> {
+    status: T;
+    date: Date;
+    traceId?: string;
+}

package/dist/types/session/index.d.ts

@@ -0,0 +1,2 @@
+export { SessionType, sessionTypeFromJSON, sessionTypeToJSON, sessionTypeToNumber } from '../generated/session/sessionType';
+export * from './session';

package/dist/types/session/session.d.ts

@@ -0,0 +1,52 @@
+import { SetRequired } from 'type-fest';
+import { ProfileFeature, UserFeatures } from '../generated/profileFeature';
+import { SessionType } from '../generated/session/sessionType';
+import { AcquirerTokenData, EResidentApplicantTokenData, EResidentTokenData, PartnerTokenData, PortalUserTokenData, ServiceEntranceTokenData, ServiceUserTokenData, TemporaryTokenData, UserTokenData } from '../token';
+export interface BaseSession {
+    sessionType: SessionType;
+}
+export interface NoneSession {
+    sessionType: SessionType.None;
+}
+export interface UserSession {
+    sessionType: SessionType.User;
+    user: UserTokenData;
+    features?: UserFeatures;
+}
+export interface DiiaOfficeUserSession extends UserSession {
+    features: SetRequired<UserFeatures, ProfileFeature.office>;
+}
+export interface EResidentSession {
+    sessionType: SessionType.EResident;
+    user: EResidentTokenData;
+    features?: UserFeatures;
+}
+export interface EResidentApplicantSession {
+    sessionType: SessionType.EResidentApplicant;
+    user: EResidentApplicantTokenData;
+}
+export interface AcquirerSession {
+    sessionType: SessionType.Acquirer;
+    acquirer: AcquirerTokenData;
+}
+export interface PartnerSession {
+    sessionType: SessionType.Partner;
+    partner: PartnerTokenData;
+}
+export interface TemporarySession {
+    sessionType: SessionType.Temporary;
+    temporary: TemporaryTokenData;
+}
+export interface ServiceEntranceSession {
+    sessionType: SessionType.ServiceEntrance;
+    entrance: ServiceEntranceTokenData;
+}
+export interface PortalUserSession {
+    sessionType: SessionType.PortalUser;
+    user: PortalUserTokenData;
+}
+export interface ServiceUserSession {
+    sessionType: SessionType.ServiceUser;
+    serviceUser: ServiceUserTokenData;
+}
+export type ActionSession = BaseSession | NoneSession | UserSession | EResidentSession | EResidentApplicantSession | AcquirerSession | PartnerSession | TemporarySession | ServiceEntranceSession | PortalUserSession | ServiceUserSession;

package/dist/types/token/index.d.ts

@@ -0,0 +1,5 @@
+export * from './tokenData';
+export { PortalUser } from '../generated/token/portalUser';
+export { User } from '../generated/token/user';
+export { Gender, genderFromJSON, genderToJSON, genderToNumber } from '../generated/token/gender';
+export { AuthEntryPoint, RefreshToken, UserTokenDataMsg, VerifiedBaseTokenDataMsg, EResidentTokenDataMsg, EResidentApplicantTokenDataMsg, AcquirerTokenDataMsg, PortalUserTokenDataMsg, PartnerTokenDataMsg, TemporaryTokenDataMsg, ServiceEntranceTokenDataMsg, ServiceUserTokenDataMsg, UserIdentificationData, } from '../generated/token/tokenData';

package/dist/types/token/tokenData.d.ts

@@ -0,0 +1,68 @@
+import { AuthDocument } from '../generated/documents/authDocument';
+import { PlatformType } from '../generated/platformType';
+import { PortalUserPermissions } from '../generated/portal/portalUserPermissions';
+import { SessionType } from '../generated/session/sessionType';
+import { PortalUser } from '../generated/token/portalUser';
+import { AuthEntryPoint, RefreshToken, UserIdentificationData } from '../generated/token/tokenData';
+import { User } from '../generated/token/user';
+interface BaseTokenData<T extends SessionType> {
+    refreshToken: RefreshToken | null;
+    sessionType: T;
+}
+export interface UserTokenData extends User, BaseTokenData<SessionType.User> {
+    mobileUid: string;
+    identifier: string;
+    authEntryPoint: AuthEntryPoint;
+}
+export interface EResidentApplicant {
+    email: string;
+    document?: AuthDocument;
+}
+export type VerifiedBaseTokenData<T extends UserTokenData | BaseTokenData<SessionType> = BaseTokenData<SessionType>> = T & {
+    exp?: number;
+    iat?: number;
+    refreshToken: RefreshToken;
+};
+export interface EResidentTokenData extends User, BaseTokenData<SessionType.EResident> {
+    mobileUid: string;
+    identifier: string;
+    authEntryPoint: AuthEntryPoint;
+}
+export interface EResidentApplicantTokenData extends EResidentApplicant, BaseTokenData<SessionType.EResidentApplicant> {
+    mobileUid: string;
+    identifier: string;
+    authEntryPoint: AuthEntryPoint;
+}
+export type AppUser = UserTokenData | EResidentTokenData;
+export type AppUserSessionType = SessionType.User | SessionType.EResident;
+export interface AcquirerTokenData extends BaseTokenData<SessionType.Acquirer> {
+    _id: string;
+    partnerId?: string;
+}
+export interface PortalUserTokenData extends PortalUser, BaseTokenData<SessionType.PortalUser> {
+    identifier: string;
+    permissions?: PortalUserPermissions;
+}
+export interface PartnerTokenData extends BaseTokenData<SessionType.Partner> {
+    _id: string;
+    scopes: Record<string, string[]>;
+}
+export interface TemporaryTokenData extends BaseTokenData<SessionType.Temporary> {
+    mobileUid: string;
+    platformType?: PlatformType;
+    jti: string;
+    scope: string[];
+    identificationData?: UserIdentificationData;
+}
+export interface ServiceEntranceTokenData extends BaseTokenData<SessionType.ServiceEntrance> {
+    acquirerId: string;
+    branchHashId: string;
+    offerHashId: string;
+    offerRequestHashId: string;
+    mobileUid: string;
+}
+export interface ServiceUserTokenData extends BaseTokenData<SessionType.ServiceUser> {
+    login: string;
+}
+export type TokenData = UserTokenData | AcquirerTokenData | EResidentTokenData | EResidentApplicantTokenData | PartnerTokenData | TemporaryTokenData | ServiceEntranceTokenData | PortalUserTokenData | ServiceUserTokenData;
+export {};

package/dist/types/units.d.ts

@@ -0,0 +1,3 @@
+export declare enum Units {
+    Hryvnia = "\u0433\u0440\u043D"
+}

package/dist/types/validators.d.ts

@@ -0,0 +1,7 @@
+/**
+ * If T has keys NOT in I, those keys are mapped to 'never'.
+ * This forces a compiler error if extra methods exist.
+ */
+export type StrictInterface<T, I> = {
+    [K in keyof T]: K extends keyof I ? T[K] : never;
+};

package/dist/types/versions.d.ts

@@ -0,0 +1,4 @@
+import { AppVersions } from './generated/version';
+export interface WithAppVersions {
+    appVersions?: AppVersions;
+}

package/dist/units.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Units = void 0;
+var Units;
+(function (Units) {
+    Units["Hryvnia"] = "\u0433\u0440\u043D";
+})(Units || (exports.Units = Units = {}));
+//# sourceMappingURL=units.js.map

package/dist/units.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"units.js","sourceRoot":"","sources":["../src/units.ts"],"names":[],"mappings":";;;AAAA,IAAY,KAEX;AAFD,WAAY,KAAK;IACb,uCAAe,CAAA;AACnB,CAAC,EAFW,KAAK,qBAAL,KAAK,QAEhB"}

package/dist/validators.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=validators.js.map

package/dist/validators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validators.js","sourceRoot":"","sources":["../src/validators.ts"],"names":[],"mappings":""}

package/dist/versions.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=versions.js.map

package/dist/versions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"versions.js","sourceRoot":"","sources":["../src/versions.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@diia-inhouse/types",
-    "version": "12.0.3",
+    "version": "12.0.4",
     "description": "Core types",
     "main": "dist/index.js",
     "types": "dist/types/index.d.ts",