itlab-internal-services 2.16.8 → 2.16.9

package/dist/modules/services/providers/pass/pass.service.js

@@ -33,7 +33,7 @@ let PassService = class PassService extends base_http_service_1.BaseHttpService
      * @param configService NestJS configuration service for environment resolution.
      */
     constructor(authenticationOptions, configService) {
-        super('Pass', base_urls_1.BaseUrls.PassService, authenticationOptions, configService);
+        super('Pass', base_urls_1.BaseUrls.passService, authenticationOptions, configService);
     }
     // ─────────────────────────────────────────────
     // Serial Number-Based Operations
@@ -44,9 +44,9 @@ let PassService = class PassService extends base_http_service_1.BaseHttpService
      * @param {string} serialNumber - Unique serial number of the pass.
      * @returns {Promise<string>} - Returns the SAS URL of the pass.
      */
-    async getPassBySerial(serialNumber) {
+    async getPassBySerialV1(serialNumber) {
         try {
-            const { data } = await this.client.get(`internal/${serialNumber}`);
+            const { data } = await this.httpClient.get(`v1/internal/pass/${serialNumber}`);
             this.logger.log(`Pass retrieved using serial: ${serialNumber}`);
             return data;
         }
@@ -61,9 +61,9 @@ let PassService = class PassService extends base_http_service_1.BaseHttpService
      *
      * @param {string} serialNumber - Unique serial number of the pass.
      */
-    deletePassBySerial(serialNumber) {
-        this.client
-            .delete(`internal/${serialNumber}`)
+    deletePassBySerialV1(serialNumber) {
+        this.httpClient
+            .delete(`v1/internal/pass/${serialNumber}`)
             .then(() => {
             this.logger.log(`Pass deleted for serial: ${serialNumber}`);
         })
@@ -82,10 +82,10 @@ let PassService = class PassService extends base_http_service_1.BaseHttpService
      * @param {string} memberId - Identifier of the associated member.
      * @returns {Promise<string>} - Returns the SAS URL of the pass.
      */
-    async getPassByType(type, memberId) {
-        const endpoint = `internal/${type}/${memberId}`;
+    async getPassByTypeV1(type, memberId) {
+        const endpoint = `v1/internal/${type}/${memberId}`;
         try {
-            const { data } = await this.client.get(endpoint);
+            const { data } = await this.httpClient.get(endpoint);
             this.logger.log(`Pass retrieved for ${type} member ID: ${memberId}`);
             return data;
         }
@@ -101,9 +101,9 @@ let PassService = class PassService extends base_http_service_1.BaseHttpService
      * @param {PassType} type - Type of the pass.
      * @param {string} memberId - Identifier of the associated member.
      */
-    deletePassByType(type, memberId) {
-        const endpoint = `internal/${type}/${memberId}`;
-        this.client
+    deletePassByTypeV1(type, memberId) {
+        const endpoint = `v1/internal/${type}/${memberId}`;
+        this.httpClient
             .delete(endpoint)
             .then(() => {
             this.logger.log(`Pass deleted for ${type} member ID: ${memberId}`);
@@ -121,9 +121,9 @@ let PassService = class PassService extends base_http_service_1.BaseHttpService
      * @param {PassTypeDtoMap[Type]} payload - DTO matching the type of pass.
      * @returns {Promise<string>} - The resulting pass URL or identifier.
      */
-    async createPass(type, payload) {
+    async createPassV1(type, payload) {
         try {
-            const { data } = await this.client.post('internal/type', payload);
+            const { data } = await this.httpClient.post(`v1/internal/${type}`, payload);
             this.logger.log(`Pass successfully created for ${type}`);
             return data;
         }
@@ -142,25 +142,25 @@ let PassService = class PassService extends base_http_service_1.BaseHttpService
      * @param {string} memberId - Identifier of the team member.
      * @returns {Promise<string>} - SAS URL of the team member's pass.
      */
-    async getTeamMemberPass(memberId) {
-        return this.getPassByType('team-member', memberId);
+    async getTeamMemberPassV1(memberId) {
+        return this.getPassByTypeV1('team-member', memberId);
     }
     /**
      * Creates a pass for a team member.
      *
-     * @param {CreateTeamMemberPassDto} data - Required details to generate the team member pass.
+     * @param {CreateTeamMemberPassDtoV1} data - Required details to generate the team member pass.
      * @returns {Promise<string>} - URL or ID of the created pass.
      */
-    async createTeamMemberPass(data) {
-        return this.createPass('team-member', data);
+    async createTeamMemberPassV1(data) {
+        return this.createPassV1('team-member', data);
     }
     /**
      * Deletes a team member’s pass.
      *
      * @param {string} memberId - Identifier of the team member.
      */
-    deleteTeamMemberPass(memberId) {
-        this.deletePassByType('team-member', memberId);
+    deleteTeamMemberPassV1(memberId) {
+        this.deletePassByTypeV1('team-member', memberId);
     }
     // ─────────────────────────────────────────────
     // Guild Member Pass Helpers
@@ -171,25 +171,25 @@ let PassService = class PassService extends base_http_service_1.BaseHttpService
      * @param {string} memberId - Identifier of the guild member.
      * @returns {Promise<string>} - SAS URL of the guild member's pass.
      */
-    async getGuildMemberPass(memberId) {
-        return this.getPassByType('guild-member', memberId);
+    async getGuildMemberPassV1(memberId) {
+        return this.getPassByTypeV1('guild-member', memberId);
     }
     /**
      * Creates a pass for a guild member.
      *
-     * @param {CreateGuildMemberPassDto} data - Required details to generate the guild member pass.
+     * @param {CreateGuildMemberPassDtoV1} data - Required details to generate the guild member pass.
      * @returns {Promise<string>} - URL or ID of the created pass.
      */
-    async createGuildMemberPass(data) {
-        return this.createPass('guild-member', data);
+    async createGuildMemberPassV1(data) {
+        return this.createPassV1('guild-member', data);
     }
     /**
      * Deletes a guild member’s pass.
      *
      * @param {string} memberId - Identifier of the guild member.
      */
-    deleteGuildMemberPass(memberId) {
-        this.deletePassByType('guild-member', memberId);
+    deleteGuildMemberPassV1(memberId) {
+        this.deletePassByTypeV1('guild-member', memberId);
     }
 };
 exports.PassService = PassService;

package/dist/modules/services/providers/podcasts/fetch-episode-options.dto.v1.type.d.ts

@@ -0,0 +1,19 @@
+import { BaseFetchOptions, CommentsFetchOptions, DraftedFetchOptions, LikedByFetchOptions, TimestampsFetchOptions, ViewedByFetchOptions } from '../../../../classes';
+/**
+ * FetchEpisodeOptionsDtoV1
+ *
+ * Data Transfer Object for querying episode collections.
+ * Inherits timestamp filtering fields and extends them with
+ * episode-specific query parameters.
+ */
+export type FetchEpisodeOptionsDtoV1 = BaseFetchOptions & TimestampsFetchOptions & DraftedFetchOptions & ViewedByFetchOptions & LikedByFetchOptions & CommentsFetchOptions & {
+    includePodcasters?: boolean;
+    includePlayedBy?: boolean;
+    includePlayedByIds?: boolean;
+    topic?: string;
+    topics?: string[];
+    podcasterId?: string;
+    podcasterIds?: string[];
+    timestampMin?: number;
+    timestampMax?: number;
+};

package/dist/modules/services/providers/podcasts/fetch-episode-options.dto.v1.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/modules/services/providers/podcasts/index.d.ts

@@ -0,0 +1,2 @@
+export * from './fetch-episode-options.dto.v1.type';
+export * from './podcasts.service';

package/dist/modules/services/providers/podcasts/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./fetch-episode-options.dto.v1.type"), exports);
+__exportStar(require("./podcasts.service"), exports);

package/dist/modules/services/providers/podcasts/podcasts.service.d.ts

@@ -0,0 +1,49 @@
+import { ConfigService } from '@nestjs/config';
+import { LabPodcast } from 'itlab-functions';
+import { AuthenticationModuleOptions } from '../../../authentication';
+import { BaseHttpService } from '../../base-http.service';
+import { FetchEpisodeOptionsDtoV1 } from './fetch-episode-options.dto.v1.type';
+/**
+ * PodcastsService
+ *
+ * Service client responsible for interacting with the Podcasts microservice.
+ * Extends `BaseHttpService` to inherit:
+ * - Environment-sensitive URL resolution (internal vs. external).
+ * - Secure inter-service authentication.
+ * - Structured logging for traceability of outbound requests.
+ *
+ * Why this pattern?
+ * - Ensures all outbound calls follow a unified configuration and logging structure.
+ * - Promotes strong typing and maintainable HTTP logic.
+ * - Makes service interactions predictable and debuggable across environments.
+ */
+export declare class PodcastsService extends BaseHttpService {
+    /**
+     * Constructs an Podcasts service client instance.
+     *
+     * @param {AuthenticationModuleOptions} authenticationOptions - Injected authentication configuration.
+     * @param {ConfigService} configService - NestJS ConfigService for environment detection.
+     */
+    constructor(authenticationOptions: AuthenticationModuleOptions, configService: ConfigService);
+    /**
+     * Retrieves a single episode entry by its MongoDB identifier.
+     *
+     * This method gracefully handles downstream failures by logging
+     * and returning `undefined` instead of throwing.
+     *
+     * @param {string} episodeId - Unique MongoDB identifier of the episode.
+     * @param {FetchEpisodeOptionsDtoV1} [options] - Optional query parameters for filtering or projection.
+     * @returns {Promise<LabPodcast | undefined>} Resolves to an Episode or `undefined` on failure.
+     */
+    fetchEpisodeV1(episodeId: string, options?: FetchEpisodeOptionsDtoV1): Promise<LabPodcast | undefined>;
+    /**
+     * Retrieves a collection of episode entries.
+     *
+     * Useful for batch lookups or paginated listings.
+     * Returns an empty array if the downstream service call fails.
+     *
+     * @param {FetchEpisodeOptionsDtoV1} [options] - Optional filter options for narrowing results.
+     * @returns {Promise<LabPodcast[]>} Resolves to a list of episodes, or an empty array if none found.
+     */
+    fetchEpisodeCollectionV1(options?: FetchEpisodeOptionsDtoV1): Promise<LabPodcast[]>;
+}

package/dist/modules/services/providers/podcasts/podcasts.service.js

@@ -0,0 +1,79 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PodcastsService = void 0;
+const common_1 = require("@nestjs/common");
+const config_1 = require("@nestjs/config");
+const authentication_1 = require("../../../authentication");
+const base_http_service_1 = require("../../base-http.service");
+const base_urls_1 = require("../../base-urls");
+/**
+ * PodcastsService
+ *
+ * Service client responsible for interacting with the Podcasts microservice.
+ * Extends `BaseHttpService` to inherit:
+ * - Environment-sensitive URL resolution (internal vs. external).
+ * - Secure inter-service authentication.
+ * - Structured logging for traceability of outbound requests.
+ *
+ * Why this pattern?
+ * - Ensures all outbound calls follow a unified configuration and logging structure.
+ * - Promotes strong typing and maintainable HTTP logic.
+ * - Makes service interactions predictable and debuggable across environments.
+ */
+let PodcastsService = class PodcastsService extends base_http_service_1.BaseHttpService {
+    /**
+     * Constructs an Podcasts service client instance.
+     *
+     * @param {AuthenticationModuleOptions} authenticationOptions - Injected authentication configuration.
+     * @param {ConfigService} configService - NestJS ConfigService for environment detection.
+     */
+    constructor(authenticationOptions, configService) {
+        super('Podcasts', base_urls_1.BaseUrls.podcastsService, authenticationOptions, configService);
+    }
+    // ─────────────────────────────────────────────────────────────
+    // Episode Resource Methods
+    // ─────────────────────────────────────────────────────────────
+    /**
+     * Retrieves a single episode entry by its MongoDB identifier.
+     *
+     * This method gracefully handles downstream failures by logging
+     * and returning `undefined` instead of throwing.
+     *
+     * @param {string} episodeId - Unique MongoDB identifier of the episode.
+     * @param {FetchEpisodeOptionsDtoV1} [options] - Optional query parameters for filtering or projection.
+     * @returns {Promise<LabPodcast | undefined>} Resolves to an Episode or `undefined` on failure.
+     */
+    async fetchEpisodeV1(episodeId, options) {
+        return this.fetchResource(`v1/internal/episode/${episodeId}`, { params: options });
+    }
+    /**
+     * Retrieves a collection of episode entries.
+     *
+     * Useful for batch lookups or paginated listings.
+     * Returns an empty array if the downstream service call fails.
+     *
+     * @param {FetchEpisodeOptionsDtoV1} [options] - Optional filter options for narrowing results.
+     * @returns {Promise<LabPodcast[]>} Resolves to a list of episodes, or an empty array if none found.
+     */
+    async fetchEpisodeCollectionV1(options) {
+        return this.fetchResourceCollection(`v1/internal/episodes`, { params: options });
+    }
+};
+exports.PodcastsService = PodcastsService;
+exports.PodcastsService = PodcastsService = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, authentication_1.InjectAuthenticationOptions)()),
+    __metadata("design:paramtypes", [Object, config_1.ConfigService])
+], PodcastsService);

package/dist/modules/services/providers/quick-links/fetch-link-options.dto.v1.type.d.ts

@@ -0,0 +1,14 @@
+import { BaseFetchOptions, TimestampsFetchOptions } from '../../../../classes';
+/**
+ * FetchLinkOptionsDtoV1
+ *
+ * Data Transfer Object for querying link collections.
+ * Inherits timestamp filtering fields and extends them with
+ * link-specific query parameters.
+ */
+export type FetchLinkOptionsDtoV1 = BaseFetchOptions & TimestampsFetchOptions & {
+    tag?: string;
+    tags?: string[];
+    short?: string;
+    shorts?: string[];
+};

package/dist/modules/services/providers/quick-links/fetch-link-options.dto.v1.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/modules/services/providers/quick-links/index.d.ts

@@ -0,0 +1,2 @@
+export * from './fetch-link-options.dto.v1.type';
+export * from './quick-links.service';

package/dist/modules/services/providers/quick-links/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./fetch-link-options.dto.v1.type"), exports);
+__exportStar(require("./quick-links.service"), exports);

package/dist/modules/services/providers/quick-links/quick-links.service.d.ts

@@ -0,0 +1,61 @@
+import { ConfigService } from '@nestjs/config';
+import { AuthenticationModuleOptions } from '../../../authentication';
+import { BaseHttpService } from '../../base-http.service';
+import { FetchLinkOptionsDtoV1 } from './fetch-link-options.dto.v1.type';
+type LabQuickLink = {
+    id: string;
+    _url: string;
+    _qrCodeUrl: string;
+    short: string;
+    href: string;
+    tags: string[];
+    engagements: number;
+    engagedAt?: Date;
+    scans: number;
+    scannedAt?: Date;
+};
+/**
+ * QuickLinksService
+ *
+ * Service client responsible for interacting with the Quick Links microservice.
+ * Extends `BaseHttpService` to inherit:
+ * - Environment-sensitive URL resolution (internal vs. external).
+ * - Secure inter-service authentication.
+ * - Structured logging for traceability of outbound requests.
+ *
+ * Why this pattern?
+ * - Ensures all outbound calls follow a unified configuration and logging structure.
+ * - Promotes strong typing and maintainable HTTP logic.
+ * - Makes service interactions predictable and debuggable across environments.
+ */
+export declare class QuickLinksService extends BaseHttpService {
+    /**
+     * Constructs an Quick Links service client instance.
+     *
+     * @param {AuthenticationModuleOptions} authenticationOptions - Injected authentication configuration.
+     * @param {ConfigService} configService - NestJS ConfigService for environment detection.
+     */
+    constructor(authenticationOptions: AuthenticationModuleOptions, configService: ConfigService);
+    /**
+     * Retrieves a single link entry by its MongoDB identifier.
+     *
+     * This method gracefully handles downstream failures by logging
+     * and returning `undefined` instead of throwing.
+     *
+     * @param {string} linkId - Unique MongoDB identifier of the link.
+     * @param {FetchLinkOptionsDtoV1} [options] - Optional query parameters for filtering or projection.
+     * @returns {Promise<LabQuickLink | undefined>} Resolves to an Link or `undefined` on failure.
+     */
+    fetchLinkV1(linkId: string, options?: FetchLinkOptionsDtoV1): Promise<LabQuickLink | undefined>;
+    /**
+     * Retrieves a collection of link entries.
+     *
+     * Useful for batch lookups or paginated listings.
+     * Returns an empty array if the downstream service call fails.
+     *
+     * @param {FetchLinkOptionsDtoV1} [options] - Optional filter options for narrowing results.
+     * @returns {Promise<LabQuickLink[]>} Resolves to a list of links, or an empty array if none found.
+     */
+    fetchLinkCollectionV1(options?: FetchLinkOptionsDtoV1): Promise<LabQuickLink[]>;
+}
+export {};

package/dist/modules/services/providers/quick-links/quick-links.service.js

@@ -0,0 +1,79 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QuickLinksService = void 0;
+const common_1 = require("@nestjs/common");
+const config_1 = require("@nestjs/config");
+const authentication_1 = require("../../../authentication");
+const base_http_service_1 = require("../../base-http.service");
+const base_urls_1 = require("../../base-urls");
+/**
+ * QuickLinksService
+ *
+ * Service client responsible for interacting with the Quick Links microservice.
+ * Extends `BaseHttpService` to inherit:
+ * - Environment-sensitive URL resolution (internal vs. external).
+ * - Secure inter-service authentication.
+ * - Structured logging for traceability of outbound requests.
+ *
+ * Why this pattern?
+ * - Ensures all outbound calls follow a unified configuration and logging structure.
+ * - Promotes strong typing and maintainable HTTP logic.
+ * - Makes service interactions predictable and debuggable across environments.
+ */
+let QuickLinksService = class QuickLinksService extends base_http_service_1.BaseHttpService {
+    /**
+     * Constructs an Quick Links service client instance.
+     *
+     * @param {AuthenticationModuleOptions} authenticationOptions - Injected authentication configuration.
+     * @param {ConfigService} configService - NestJS ConfigService for environment detection.
+     */
+    constructor(authenticationOptions, configService) {
+        super('QuickLinks', base_urls_1.BaseUrls.quickLinksService, authenticationOptions, configService);
+    }
+    // ─────────────────────────────────────────────────────────────
+    // Link Resource Methods
+    // ─────────────────────────────────────────────────────────────
+    /**
+     * Retrieves a single link entry by its MongoDB identifier.
+     *
+     * This method gracefully handles downstream failures by logging
+     * and returning `undefined` instead of throwing.
+     *
+     * @param {string} linkId - Unique MongoDB identifier of the link.
+     * @param {FetchLinkOptionsDtoV1} [options] - Optional query parameters for filtering or projection.
+     * @returns {Promise<LabQuickLink | undefined>} Resolves to an Link or `undefined` on failure.
+     */
+    async fetchLinkV1(linkId, options) {
+        return this.fetchResource(`v1/internal/link/${linkId}`, { params: options });
+    }
+    /**
+     * Retrieves a collection of link entries.
+     *
+     * Useful for batch lookups or paginated listings.
+     * Returns an empty array if the downstream service call fails.
+     *
+     * @param {FetchLinkOptionsDtoV1} [options] - Optional filter options for narrowing results.
+     * @returns {Promise<LabQuickLink[]>} Resolves to a list of links, or an empty array if none found.
+     */
+    async fetchLinkCollectionV1(options) {
+        return this.fetchResourceCollection(`v1/internal/links`, { params: options });
+    }
+};
+exports.QuickLinksService = QuickLinksService;
+exports.QuickLinksService = QuickLinksService = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, authentication_1.InjectAuthenticationOptions)()),
+    __metadata("design:paramtypes", [Object, config_1.ConfigService])
+], QuickLinksService);

package/dist/modules/services/providers/search/dtos/{index-search-document.dto.d.ts → index-document.dto.v1.d.ts}

@@ -1,10 +1,10 @@
 /**
- * IndexSearchDocumentDto
+ * IndexDocumentDtoV1
  *
  * Defines the structure of a document that can be indexed by the search engine.
  * Contains essential metadata used for querying, filtering, and result rendering.
  */
-export type IndexSearchDocumentDto = {
+export type IndexDocumentDtoV1 = {
     /**
      * Display label or title of the indexed resource.
      *

package/dist/modules/services/providers/search/dtos/index-document.dto.v1.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/modules/services/providers/search/dtos/index.d.ts

@@ -1 +1 @@
-export * from './index-search-document.dto';
+export * from './index-document.dto.v1';

package/dist/modules/services/providers/search/dtos/index.js

@@ -14,4 +14,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./index-search-document.dto"), exports);
+__exportStar(require("./index-document.dto.v1"), exports);

package/dist/modules/services/providers/search/search.service.d.ts

@@ -6,7 +6,7 @@ import { AuthenticationModuleOptions } from '../../../authentication';
 import { CacheService } from '../../../cache';
 import { BaseHttpService } from '../../base-http.service';
 import { ServicesModuleOptions } from '../../services-module-options.interface';
-import { IndexSearchDocumentDto } from './dtos';
+import { IndexDocumentDtoV1 } from './dtos';
 export declare function InjectFeatureSearchService(): ParameterDecorator;
 /**
  * SearchService
@@ -38,16 +38,16 @@ export declare class SearchService extends BaseHttpService {
      * Useful for ensuring resource changes are discoverable via search.
      *
      * @param {string} resourceId - Unique identifier of the resource.
-     * @param {IndexSearchDocumentDto} document - Document containing searchable content.
+     * @param {IndexDocumentDtoV1} document - Document containing searchable content.
      */
-    indexDocument(resourceId: string, document: IndexSearchDocumentDto): void;
+    indexDocumentV1(resourceId: string, document: IndexDocumentDtoV1): void;
     /**
      * Removes a resource from the search index.
      * Ideal when the resource is deleted or should no longer be discoverable.
      *
      * @param {string} resourceId - Identifier of the resource to be deindexed.
      */
-    deleteDocument(resourceId: string): void;
+    deleteDocumentV1(resourceId: string): void;
     /**
      * Retrieves documents similar to the provided resource from the search index.
      * Helps with content discovery and recommendations.
@@ -55,12 +55,12 @@ export declare class SearchService extends BaseHttpService {
      * @param {string} resourceId - Identifier of the base resource for similarity matching.
      * @returns {Promise<SearchDocument[]>} - Array of documents similar to the given resource.
      */
-    getSimilarDocuments(resourceId: string): Promise<SearchDocument[]>;
+    fetchSimilarDocumentsV1(resourceId: string): Promise<SearchDocument[]>;
     /**
      * Retrieves similar documents from the cache if available; otherwise fetches from the backend.
      *
      * @param resourceId Unique identifier of the resource.
      * @returns Cached or freshly retrieved similar documents.
      */
-    getCachedSimilarDocuments(resourceId: string): Promise<SearchDocument[]>;
+    fetchCachedSimilarDocumentsV1(resourceId: string): Promise<SearchDocument[]>;
 }