@ikonintegration/module-config-api 2.0.19 → 2.0.21

package/dist/CacheTypes.d.ts

@@ -19,7 +19,7 @@ export interface CacheConfig {
     version?: number;
 }
 /**
- * Cache key prefixes and TTL constants (matching the legacy client).
+ * Cache key prefixes and TTL constants (matching the persistent cache).
  */
 export declare const CacheConstants: {
     readonly CustomerPrefix: "CO::";
@@ -29,3 +29,299 @@ export declare const CacheConstants: {
     readonly AllTenantsTTL: number;
     readonly TenantTTL: 60;
 };
+/**
+ * Course provider object as stored in the expanded customer cache.
+ */
+export interface CachedCourseProvider {
+    id: string;
+    type?: string;
+    onlineTemplateIDs?: string[];
+    provider?: any;
+    createdBy?: string;
+    createdOn?: number;
+    updatedBy?: string;
+    updatedOn?: number;
+}
+/**
+ * Tile permissions as injected into the cached customer.
+ */
+export interface CachedTilePermissions {
+    customerID?: string;
+    tilePermissions?: Record<string, any>;
+    [key: string]: any;
+}
+/**
+ * The expanded customer object stored in the persistent cache.
+ * Differs from CustomerResponse:
+ * - `allowedOnlineCourseProviders` contains full CourseProvider objects (not just IDs)
+ * - `tilePermissions` is injected from the PortalTilePermissions table
+ */
+export interface CachedCustomer {
+    id: string;
+    createdBy?: string;
+    createdOn?: number;
+    updatedBy?: string;
+    updatedOn?: number;
+    timezoneCode?: string;
+    adminRole?: string;
+    userRole?: string;
+    instructorRole?: string;
+    idmKey?: string;
+    idmToken?: string;
+    idmAPIUser?: string;
+    idmAPIPassword?: string;
+    mailerSender?: string;
+    preventUserFromUpdatingNames?: boolean;
+    orgModEndpoint?: string;
+    orgAdminRole?: string;
+    orgSubAdminRole?: string;
+    orgUserRole?: string;
+    orgModNamespace?: string;
+    /** Expanded: full CourseProvider objects (not just IDs) */
+    allowedOnlineCourseProviders?: CachedCourseProvider[];
+    allowedForeignReqs?: string[];
+    displayName?: string;
+    sharedModuleLicenseAPIKey?: string;
+    sharedModuleConfigAPIKey?: string;
+    sharedModuleAuditingAPIKey?: string;
+    sharedModuleAgreementAPIKey?: string;
+    sharedModuleOrganizationAPIKey?: string;
+    sharedModuleClassroomAPIKey?: string;
+    sharedModuleMailerAPIKey?: string;
+    authConfig?: Record<string, any>;
+    portalConfig?: {
+        theme?: string;
+        domain?: string;
+        cookiesHubDomain?: string;
+        acceptConnectionsFrom?: string;
+    };
+    theme?: Record<string, any>;
+    domain?: string;
+    cookiesHubDomain?: string;
+    acceptConnectionsFrom?: string[];
+    worksafeTerm?: string;
+    cancelationPolicies?: Array<{
+        id?: string;
+        description?: string;
+        cancelPolicy?: {
+            isBusinessDays?: boolean;
+            canBeCanceled?: boolean;
+            canBeRescheduled?: boolean;
+            rules?: Array<{
+                untilDaysBefore?: number;
+                percentageRefunded?: number;
+                amountCharged?: number;
+                deductEnrolmentPayment?: boolean;
+            }>;
+        };
+    }>;
+    salesTaxLabel?: string;
+    ignoreCustomAttributesForSignUp?: boolean;
+    timezone?: string;
+    /** Injected from PortalTilePermissions table */
+    tilePermissions?: CachedTilePermissions | null;
+    cooldownPolicies?: Array<{
+        id?: string;
+        description?: string;
+        cooldownPolicy?: {
+            rules?: Array<{
+                untilFailedAttempts?: number;
+                cooldownPeriod?: number;
+                invalidateCourseRequirements?: boolean;
+                lockApplication?: boolean;
+                blockCourse?: boolean;
+                autoUnlockInDays?: number;
+            }>;
+        };
+    }>;
+    ui?: {
+        banner?: {
+            type?: string;
+            content?: string;
+        };
+    };
+    featureFlags?: Array<{
+        name: string;
+        enabled: boolean;
+        metadata?: string;
+    }>;
+    [key: string]: any;
+}
+/**
+ * Course object as stored inside cached certification requirements.
+ */
+export interface CachedCourse {
+    id: string;
+    certificationID: string;
+    tenantID?: string;
+    customerID?: string;
+    productID?: string;
+    waivePayments?: boolean;
+    coolDownPeriod?: number | number[] | null;
+    coolDownPolicy?: any;
+    enableRequestToEnrol?: boolean;
+    materialsProductID?: string;
+    maxRetry?: number;
+    requirementsIDs?: string[];
+    requiredOnRenew?: boolean;
+    validityPeriod?: number;
+    validityPeriodInMonths?: number;
+    validityPeriodInYears?: number;
+    webhooks?: string[];
+    isRetakeAllowed?: boolean;
+    allowStudentUploads?: boolean;
+    allowIfAnyRequirementMet?: boolean;
+    allowOnlyIfCertificationIsValid?: boolean;
+    gracePeriodAfterCertCompletion?: number;
+    courseFailWebhooks?: string[];
+    cooldownStartWebhooks?: string[];
+    cooldownEndWebhooks?: string[];
+    lockAfterFailure?: boolean;
+    agreementID?: string;
+    isMandatory?: boolean;
+    points?: number;
+    courseBooks?: Array<{
+        fileID: string;
+        fileName: string;
+        attachToEmail?: boolean;
+    }>;
+    courseCertificateType?: string;
+    courseCertificateTemplate?: string;
+    courseCertNumberMaskFormat?: string;
+    courseCertNumberMode?: string;
+    courseCertNumberInitialNumber?: string;
+    externalRequirementWebhook?: string;
+    reuseCertNumber?: boolean;
+    warningDuePaymentRemainingDays?: number;
+    warningRemainingDays?: Array<{
+        template: string;
+        period: number;
+    }>;
+    onlineWarningRemainingDays?: Array<{
+        template: string;
+        period: number;
+    }>;
+    emailComplement?: string;
+    emailTemplates?: {
+        coursePassed?: string | null;
+        courseFailed?: string | null;
+    };
+    emailEventOverrides?: Array<{
+        eventID: string;
+        templateID: string;
+    }>;
+    displayName?: string;
+    cardDescription?: string;
+    description?: string;
+    uiTerm?: string;
+    uiLogo?: string;
+    calendarColor?: string;
+    showCollapsed?: boolean;
+    passUiTerm?: string;
+    failUiTerm?: string;
+    courseType?: string;
+    preventLaunchIfCompleted?: boolean;
+    requirementUserAttribIDs?: Array<{
+        partition: string;
+        attributeName: string;
+        description: string;
+    }>;
+    createdBy?: string;
+    createdOn?: number;
+    updatedBy?: string;
+    updatedOn?: number;
+    [key: string]: any;
+}
+/**
+ * Training provider object as stored inside cached certifications.
+ */
+export interface CachedTrainingProvider {
+    id: string;
+    customerID: string;
+    name?: string;
+    url?: string;
+    isDisabled?: boolean;
+    createdBy?: string;
+    createdOn?: number;
+    updatedBy?: string;
+    updatedOn?: number;
+}
+/**
+ * Application section within a cached certification.
+ */
+export interface CachedApplicationSection {
+    applicationEnabled?: boolean;
+    equivalenciesSection?: {
+        sectionEnabled?: boolean;
+        /** Expanded equivalence objects with isDisabled flag */
+        options?: Array<{
+            id: string;
+            isDisabled?: boolean;
+            [key: string]: any;
+        }>;
+    };
+    requirementsSection?: {
+        sectionEnabled?: boolean;
+        /** Expanded requirement objects with isDisabled flag */
+        requirements?: Array<{
+            id: string;
+            isDisabled?: boolean;
+            [key: string]: any;
+        }>;
+    };
+    electiveRequirementsSection?: {
+        sectionEnabled?: boolean;
+        requirements?: Array<{
+            id: string;
+            isDisabled?: boolean;
+            [key: string]: any;
+        }>;
+    };
+    customRequirementsSections?: Array<{
+        sectionEnabled?: boolean;
+        requirements?: Array<{
+            id: string;
+            isDisabled?: boolean;
+            [key: string]: any;
+        }>;
+        [key: string]: any;
+    }>;
+    [key: string]: any;
+}
+/**
+ * Certification object as stored inside the cached tenant.
+ * Contains expanded requirements (full course objects) and application sections.
+ */
+export interface CachedCertification {
+    id: string;
+    customerID: string;
+    tenantID: string;
+    /** Expanded course requirements — can be CachedCourse or CachedCourse[] (grouped alternatives) */
+    requirements?: (CachedCourse | CachedCourse[])[];
+    application?: CachedApplicationSection;
+    renewal?: {
+        application?: CachedApplicationSection;
+        [key: string]: any;
+    };
+    /** Training providers relevant to this certification */
+    trainingProviders?: CachedTrainingProvider[];
+    [key: string]: any;
+}
+/**
+ * The expanded tenant object stored in the persistent cache.
+ * Differs from TenantResponse:
+ * - `certifications` array is injected with fully expanded certification objects
+ *   (including courses, applications with equivalencies/requirements, training providers)
+ */
+export interface CachedTenant {
+    id: string;
+    customerID: string;
+    createdBy?: string;
+    createdOn?: number;
+    updatedBy?: string;
+    updatedOn?: number;
+    name?: string;
+    /** Expanded certifications with full course/application/training provider data */
+    certifications?: CachedCertification[];
+    [key: string]: any;
+}

package/dist/CacheTypes.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CacheConstants = void 0;
 /**
- * Cache key prefixes and TTL constants (matching the legacy client).
+ * Cache key prefixes and TTL constants (matching the persistent cache).
  */
 exports.CacheConstants = {
     // Customer

package/dist/index.d.ts

@@ -6,4 +6,4 @@ export * from './Api.js';
 export { CacheClient } from './CacheClient.js';
 export { MemoryCache } from './MemoryCache.js';
 export { CacheConstants } from './CacheTypes.js';
-export type { RedisLike, CacheConfig } from './CacheTypes.js';
+export type { RedisLike, CacheConfig, CachedCustomer, CachedTenant, CachedCertification, CachedCourse, CachedCourseProvider, CachedTrainingProvider, CachedApplicationSection, CachedTilePermissions, } from './CacheTypes.js';

package/index.ts

@@ -11,4 +11,15 @@ export * from './Api.js'
 export { CacheClient } from './CacheClient.js'
 export { MemoryCache } from './MemoryCache.js'
 export { CacheConstants } from './CacheTypes.js'
-export type { RedisLike, CacheConfig } from './CacheTypes.js'
+export type {
+  RedisLike,
+  CacheConfig,
+  CachedCustomer,
+  CachedTenant,
+  CachedCertification,
+  CachedCourse,
+  CachedCourseProvider,
+  CachedTrainingProvider,
+  CachedApplicationSection,
+  CachedTilePermissions,
+} from './CacheTypes.js'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ikonintegration/module-config-api",
-  "version": "2.0.19",
+  "version": "2.0.21",
   "description": "",
   "main": "dist/index.js",
   "scripts": {