@ikonintegration/module-config-api 2.0.20 → 2.0.22

package/Api.ts

@@ -2934,7 +2934,7 @@ export interface FaqResponse {
   answer?: string
 }
 
-export interface InputL7Xnhpovxz {
+export interface Input83M8Qu78L7J {
   /**
    * Tenant ID this FAQ belongs to
    * @example "tenant456"
@@ -2957,7 +2957,7 @@ export interface InputL7Xnhpovxz {
   answer?: string
 }
 
-export interface InputMr9V08Vrqrh {
+export interface Input8Ywv6L6Asf {
   /**
    * Tenant ID this FAQ belongs to
    * @example "tenant456"
@@ -3136,10 +3136,15 @@ export interface CertificationResponse {
      */
     eventID: string
     /**
-     * Email template identifier override for the event
+     * Optional email template identifier override for the event
      * @example "template001"
      */
-    templateID: string
+    templateID?: string
+    /**
+     * Optional array of email addresses that will be receive a cc for this event
+     * @example "["mail1@email.com","mail2@email.com"]"
+     */
+    cc: string[]
   }[]
   /** Warning threshold for incomplete certification */
   warningIncompleteCertificationDays?: {
@@ -3201,6 +3206,11 @@ export interface CertificationResponse {
    * @example false
    */
   overrideCompletionRequirementOnRenewal?: boolean
+  /**
+   * supercedes overrideCompletionRequirementOnRenewal when used, calculates the cert expiration date in a renewal using the certification renewal completion date
+   * @example false
+   */
+  calculateExpirationUsingRenewalCompletionDate?: boolean
   /** Application configuration */
   application?: any
   /** Renewal configuration */
@@ -3349,10 +3359,15 @@ export interface CertificationRequestBody {
      */
     eventID: string
     /**
-     * Email template identifier override for the event
+     * Optional email template identifier override for the event
      * @example "template001"
      */
-    templateID: string
+    templateID?: string
+    /**
+     * Optional array of email addresses that will be receive a cc for this event
+     * @example "["mail1@email.com","mail2@email.com"]"
+     */
+    cc: string[]
   }[]
   /** Warning threshold for incomplete certification */
   warningIncompleteCertificationDays?: {
@@ -3414,6 +3429,11 @@ export interface CertificationRequestBody {
    * @example false
    */
   overrideCompletionRequirementOnRenewal?: boolean
+  /**
+   * supercedes overrideCompletionRequirementOnRenewal when used, calculates the cert expiration date in a renewal using the certification renewal completion date
+   * @example false
+   */
+  calculateExpirationUsingRenewalCompletionDate?: boolean
   /** Application configuration */
   application?: any
   /** Renewal configuration */
@@ -3583,10 +3603,15 @@ export interface CertificationListResponse {
        */
       eventID: string
       /**
-       * Email template identifier override for the event
+       * Optional email template identifier override for the event
        * @example "template001"
        */
-      templateID: string
+      templateID?: string
+      /**
+       * Optional array of email addresses that will be receive a cc for this event
+       * @example "["mail1@email.com","mail2@email.com"]"
+       */
+      cc: string[]
     }[]
     /** Warning threshold for incomplete certification */
     warningIncompleteCertificationDays?: {
@@ -3648,6 +3673,11 @@ export interface CertificationListResponse {
      * @example false
      */
     overrideCompletionRequirementOnRenewal?: boolean
+    /**
+     * supercedes overrideCompletionRequirementOnRenewal when used, calculates the cert expiration date in a renewal using the certification renewal completion date
+     * @example false
+     */
+    calculateExpirationUsingRenewalCompletionDate?: boolean
     /** Application configuration */
     application?: any
     /** Renewal configuration */
@@ -3969,10 +3999,15 @@ export interface CourseResponse {
      */
     eventID: string
     /**
-     * Email template identifier override for the event
+     * Optional email template identifier override for the event
      * @example "template001"
      */
-    templateID: string
+    templateID?: string
+    /**
+     * Optional array of email addresses that will be receive a cc for this event
+     * @example "["mail1@email.com","mail2@email.com"]"
+     */
+    cc: string[]
   }[]
   /**
    * Display name
@@ -4286,10 +4321,15 @@ export interface CourseRequestBody {
      */
     eventID: string
     /**
-     * Email template identifier override for the event
+     * Optional email template identifier override for the event
      * @example "template001"
      */
-    templateID: string
+    templateID?: string
+    /**
+     * Optional array of email addresses that will be receive a cc for this event
+     * @example "["mail1@email.com","mail2@email.com"]"
+     */
+    cc: string[]
   }[]
   /**
    * Display name
@@ -4665,10 +4705,15 @@ export interface CourseListResponse {
        */
       eventID: string
       /**
-       * Email template identifier override for the event
+       * Optional email template identifier override for the event
        * @example "template001"
        */
-      templateID: string
+      templateID?: string
+      /**
+       * Optional array of email addresses that will be receive a cc for this event
+       * @example "["mail1@email.com","mail2@email.com"]"
+       */
+      cc: string[]
     }[]
     /**
      * Display name
@@ -5432,7 +5477,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title No title
- * @version 2.0.20
+ * @version 2.0.22
  * @baseUrl http://localhost:8080
  * @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
  */
@@ -6097,7 +6142,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request POST:/tenant/{tenantID}/faq/{faqID}
      * @secure
      */
-    createFaq: (tenantId: string, faqId: string, data: InputL7Xnhpovxz, params: RequestParams = {}) =>
+    createFaq: (tenantId: string, faqId: string, data: Input83M8Qu78L7J, params: RequestParams = {}) =>
       this.request<CreateFaqData, CreateFaqError>({
         path: `/tenant/${tenantId}/faq/${faqId}`,
         method: 'POST',
@@ -6116,7 +6161,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request PUT:/tenant/{tenantID}/faq/{faqID}
      * @secure
      */
-    updateFaq: (tenantId: string, faqId: string, data: InputMr9V08Vrqrh, params: RequestParams = {}) =>
+    updateFaq: (tenantId: string, faqId: string, data: Input8Ywv6L6Asf, params: RequestParams = {}) =>
       this.request<UpdateFaqData, UpdateFaqError>({
         path: `/tenant/${tenantId}/faq/${faqId}`,
         method: 'PUT',

package/CacheClient.ts

@@ -1,21 +1,26 @@
 // @ts-nocheck — This file is compiled in CI alongside generated sources (Api.js)
-import { Api } from './Api.js'
-import type { CustomerResponse, TenantResponse } from './Api.js'
 import { MemoryCache } from './MemoryCache.js'
-import { RedisLike, CacheConfig, CacheConstants } from './CacheTypes.js'
+import {
+  RedisLike,
+  CacheConfig,
+  CacheConstants,
+  CachedCustomer,
+  CachedTenant,
+  CachedCertification,
+  CachedCourse,
+} from './CacheTypes.js'
 
 /**
  * Extended client that wraps the auto-generated Api with Redis cache support.
- * Provides direct Redis-backed lookups for customers, tenants, certifications, and courses.
+ * Provides direct Redis-backed lookups for expanded customers, tenants, certifications, and courses
+ * as they are stored in the persistent cache (not the raw API responses).
  *
  * Usage:
  * ```ts
- * import { CacheClient } from "@ikonintegration/module-config-api/cache";
+ * import { CacheClient } from "@ikonintegration/module-config-api";
  *
  * const client = new CacheClient({
- *   // API layer (passed to the generated Api client)
  *   baseUrl: "https://api.example.com",
- *   // Cache layer (optional — enables Redis-backed lookups)
  *   cache: {
  *     endpoint: "redis.example.com",
  *     username: "default",
@@ -27,28 +32,21 @@ import { RedisLike, CacheConfig, CacheConstants } from './CacheTypes.js'
  * ```
  */
 export class CacheClient {
-  public api: Api<unknown>
   private _localCache: MemoryCache
+
   private _remoteCache: RedisLike | null = null
+
   private _cacheConfig: CacheConfig | null
 
-  constructor(options: {
-    baseUrl?: string
-    baseApiParams?: ConstructorParameters<typeof Api>[0]
-    cache?: CacheConfig
-  }) {
-    this.api = new Api({
-      baseURL: options.baseUrl,
-      ...options.baseApiParams,
-    })
+  constructor(options: { cache?: CacheConfig }) {
     this._localCache = new MemoryCache()
     this._cacheConfig = options.cache || null
   }
 
   /********* CACHE LAYER — Customers *********/
 
-  async getAllCustomers(): Promise<CustomerResponse[] | null> {
-    let allCustomers = this._localCache.getValue<CustomerResponse[]>(CacheConstants.CustomerPrefix)
+  async getAllCustomers(): Promise<CachedCustomer[] | null> {
+    let allCustomers = this._localCache.getValue<CachedCustomer[]>(CacheConstants.CustomerPrefix)
     if (!allCustomers) {
       console.debug('ConfigClient - Customers Fetch All')
       allCustomers = await this._getAllRemoteCustomers()
@@ -58,12 +56,12 @@ export class CacheClient {
     return allCustomers
   }
 
-  async getCustomerByID(customerID: string): Promise<CustomerResponse | null> {
+  async getCustomerByID(customerID: string): Promise<CachedCustomer | null> {
     // Attempt local cache
-    let customer = this._localCache.getValue<CustomerResponse>(`${CacheConstants.CustomerPrefix}${customerID}`)
+    let customer = this._localCache.getValue<CachedCustomer>(`${CacheConstants.CustomerPrefix}${customerID}`)
     // Attempt from allCustomers local cache
     if (!customer) {
-      const allCustomers = this._localCache.getValue<CustomerResponse[]>(CacheConstants.CustomerPrefix)
+      const allCustomers = this._localCache.getValue<CachedCustomer[]>(CacheConstants.CustomerPrefix)
       customer = allCustomers?.find(c => c.id === customerID) || null
     }
     // Attempt remote cache
@@ -80,8 +78,8 @@ export class CacheClient {
 
   /********* CACHE LAYER — Tenants *********/
 
-  async getAllTenants(): Promise<TenantResponse[] | null> {
-    let allTenants = this._localCache.getValue<TenantResponse[]>(CacheConstants.TenantPrefix)
+  async getAllTenants(): Promise<CachedTenant[] | null> {
+    let allTenants = this._localCache.getValue<CachedTenant[]>(CacheConstants.TenantPrefix)
     if (!allTenants) {
       console.debug('ConfigClient - Tenants Fetch All')
       allTenants = await this._getAllRemoteTenants()
@@ -91,8 +89,8 @@ export class CacheClient {
     return allTenants
   }
 
-  async getTenantByID(tenantID: string): Promise<TenantResponse | null> {
-    let tenant = this._localCache.getValue<TenantResponse>(`${CacheConstants.TenantPrefix}${tenantID}`)
+  async getTenantByID(tenantID: string): Promise<CachedTenant | null> {
+    let tenant = this._localCache.getValue<CachedTenant>(`${CacheConstants.TenantPrefix}${tenantID}`)
     if (!tenant) {
       console.debug('ConfigClient - Tenant Fetch:', tenantID)
       await this._initCacheClient()
@@ -106,19 +104,19 @@ export class CacheClient {
 
   /********* CACHE LAYER — Certifications & Courses *********/
 
-  async getCertificationByID(certID: string, tenantID: string) {
+  async getCertificationByID(certID: string, tenantID: string): Promise<CachedCertification | null> {
     const tenant = await this.getTenantByID(tenantID)
-    if (!tenant || !Array.isArray((tenant as any).certifications)) return null
-    return (tenant as any).certifications.find((c: any) => c.id === certID) || null
+    if (!tenant?.certifications) return null
+    return tenant.certifications.find(c => c.id === certID) || null
   }
 
-  async getCourseByID(courseID: string, tenantID: string) {
+  async getCourseByID(courseID: string, tenantID: string): Promise<CachedCourse | null> {
     const tenant = await this.getTenantByID(tenantID)
-    if (!tenant || !Array.isArray((tenant as any).certifications)) return null
-    for (const cert of (tenant as any).certifications) {
+    if (!tenant?.certifications) return null
+    for (const cert of tenant.certifications) {
       for (const req of cert.requirements || []) {
         if (Array.isArray(req)) {
-          const found = req.find((r: any) => r.id === courseID)
+          const found = req.find(r => r.id === courseID)
           if (found) return found
         } else if (req.id === courseID) return req
       }
@@ -126,25 +124,29 @@ export class CacheClient {
     return null
   }
 
-  async getCourseInCertificationByID(certificationID: string, courseID: string, tenantID: string) {
+  async getCourseInCertificationByID(
+    certificationID: string,
+    courseID: string,
+    tenantID: string
+  ): Promise<CachedCourse | null> {
     const tenant = await this.getTenantByID(tenantID)
-    if (!tenant || !Array.isArray((tenant as any).certifications)) return null
-    const cert = (tenant as any).certifications.find((c: any) => c.id === certificationID)
+    if (!tenant?.certifications) return null
+    const cert = tenant.certifications.find(c => c.id === certificationID)
     if (!cert) return null
     for (const req of cert.requirements || []) {
       if (Array.isArray(req)) {
-        const found = req.find((r: any) => r.id === courseID)
+        const found = req.find(r => r.id === courseID)
         if (found) return found
       } else if (req.id === courseID) return req
     }
     return null
   }
 
-  async getAllCoursesByTenantID(tenantID: string) {
+  async getAllCoursesByTenantID(tenantID: string): Promise<CachedCourse[] | null> {
     const tenant = await this.getTenantByID(tenantID)
-    if (!tenant || !Array.isArray((tenant as any).certifications)) return null
-    const courses: any[] = []
-    for (const cert of (tenant as any).certifications) {
+    if (!tenant?.certifications) return null
+    const courses: CachedCourse[] = []
+    for (const cert of tenant.certifications) {
       for (const req of cert.requirements || []) {
         if (Array.isArray(req)) {
           for (const sub of req) courses.push(sub)
@@ -154,11 +156,11 @@ export class CacheClient {
     return courses
   }
 
-  async getAllCoursesByCertificationID(certID: string, tenantID: string) {
+  async getAllCoursesByCertificationID(certID: string, tenantID: string): Promise<CachedCourse[] | null> {
     const tenant = await this.getTenantByID(tenantID)
-    if (!tenant || !Array.isArray((tenant as any).certifications)) return null
-    const courses: any[] = []
-    for (const cert of (tenant as any).certifications) {
+    if (!tenant?.certifications) return null
+    const courses: CachedCourse[] = []
+    for (const cert of tenant.certifications) {
       if (cert.id !== certID) continue
       for (const req of cert.requirements || []) {
         if (Array.isArray(req)) {
@@ -169,18 +171,18 @@ export class CacheClient {
     return courses
   }
 
-  async getAllCourses() {
+  async getAllCourses(): Promise<CachedCourse[]> {
     return this.getAllCoursesByCustomerID(null)
   }
 
-  async getAllCoursesByCustomerID(customerID: string | null) {
+  async getAllCoursesByCustomerID(customerID: string | null): Promise<CachedCourse[]> {
     const allTenants = await this.getAllTenants()
     if (!allTenants) return []
-    const filtered = allTenants.filter(t => !customerID || (t as any).customerID === customerID)
-    const courses: any[] = []
+    const filtered = allTenants.filter(t => !customerID || t.customerID === customerID)
+    const courses: CachedCourse[] = []
     for (const tenant of filtered) {
-      if (!Array.isArray((tenant as any).certifications)) continue
-      for (const cert of (tenant as any).certifications) {
+      if (!tenant.certifications) continue
+      for (const cert of tenant.certifications) {
         for (const req of cert.requirements || []) {
           if (Array.isArray(req)) {
             for (const sub of req) {
@@ -199,13 +201,13 @@ export class CacheClient {
 
   async getCourseProviderByIDs(courseProviderID: string, customerID: string) {
     const customer = await this.getCustomerByID(customerID)
-    if (!customer || !Array.isArray((customer as any).courseProviders)) return null
-    return (customer as any).courseProviders.find((p: any) => p === courseProviderID) || null
+    if (!customer?.allowedOnlineCourseProviders) return null
+    return customer.allowedOnlineCourseProviders.find(p => p.id === courseProviderID) || null
   }
 
   /********* Private *********/
 
-  private async _getAllRemoteCustomers(): Promise<CustomerResponse[] | null> {
+  private async _getAllRemoteCustomers(): Promise<CachedCustomer[] | null> {
     await this._initCacheClient()
     if (!this._remoteCache) return null
     const allKeys = await this._remoteCache.keys(`${CacheConstants.CustomerPrefix}*`)
@@ -214,7 +216,7 @@ export class CacheClient {
     return Array.isArray(raw) ? raw.map(r => JSON.parse(r)) : null
   }
 
-  private async _getAllRemoteTenants(): Promise<TenantResponse[] | null> {
+  private async _getAllRemoteTenants(): Promise<CachedTenant[] | null> {
     await this._initCacheClient()
     if (!this._remoteCache) return null
     const allKeys = await this._remoteCache.keys(`${CacheConstants.TenantPrefix}*`)