rename interfaces

Author: leoraba

apps/server/src/controllers/indexerController.ts

@@ -1,5 +1,5 @@
 import { BadRequest } from '@overture-stack/maestro-common';
-import { MaestroProvider } from '@overture-stack/maestro-provider';
+import { initializeMaestroProvider } from '@overture-stack/maestro-provider';
 
 import { defaultAppConfig } from '../config/provider.js';
 import {
@@ -9,7 +9,7 @@ import {
 } from '../utils/requestSchemas.js';
 import { validateRequest } from '../utils/requestValidation.js';
 
-const maestroProvider = MaestroProvider(defaultAppConfig);
+const maestroProvider = initializeMaestroProvider(defaultAppConfig);
 
 const indexRepository = validateRequest(indexRepositoryRequestschema, async (req, res, next) => {
 	try {

packages/common/src/types/index.ts

@@ -8,5 +8,5 @@ export {
 } from './config.js';
 export { DataRecordValue, FailureData, IndexData, IndexResult } from './dataRecord.js';
 export { ConsoleLike, LoggerConfig } from './logger.js';
-export { IRepository, RepositoryIndexingOperations } from './repository.js';
-export { IElasticsearchService } from './service.js';
+export { Repository, RepositoryIndexingOperations } from './repository.js';
+export { ElasticsearchService } from './service.js';

packages/common/src/types/repository.ts

@@ -3,7 +3,7 @@ import type { DataRecordValue, IndexResult } from './dataRecord';
 /**
  * Interface for all types of repositories (i.e. song or lyric)
  */
-export interface IRepository {
+export interface Repository {
 	getRepositoryRecords(): AsyncGenerator<Record<string, DataRecordValue>[], void, unknown>;
 	getOrganizationRecords({
 		organization,

packages/common/src/types/service.ts

@@ -3,7 +3,7 @@ import type { DataRecordValue, IndexResult } from './dataRecord.js';
 /**
  * Interface defining the contract for Elasticsearch service operations.
  */
-export interface IElasticsearchService {
+export interface ElasticsearchService {
 	/**
 	 * Creates an index in Elasticsearch.
 	 *

packages/indexer-client/src/client/index.ts

@@ -1,19 +1,19 @@
-import { type DataRecordValue, ElasticSearchConfig, IElasticsearchService } from '@overture-stack/maestro-common';
+import { type DataRecordValue, ElasticSearchConfig, ElasticsearchService } from '@overture-stack/maestro-common';
 
 import { es7 } from './v7/client.js';
 import { es8 } from './v8/client.js';
 
 export type ESVersion = '7' | '8';
 
 /**
- * Provides an instance of `IElasticsearchService` based on the specified Elasticsearch version in the configuration
+ * Provides an instance of `ElasticsearchService` based on the specified Elasticsearch version in the configuration
  *
  * @param elasticSearchConfig The configuration object for Elasticsearch, including the version and custom settings
- * @returns An implementation of `IElasticsearchService` that matches the specified version
+ * @returns An implementation of `ElasticsearchService` that matches the specified version
  * @throws Will throw an error if the provided Elasticsearch version is not supported
  */
-export const clientProvider = (elasticSearchConfig: ElasticSearchConfig): IElasticsearchService => {
-	let service: IElasticsearchService;
+export const clientProvider = (elasticSearchConfig: ElasticSearchConfig): ElasticsearchService => {
+	let service: ElasticsearchService;
 
 	if (elasticSearchConfig.version === 7) {
 		service = es7(elasticSearchConfig);

packages/indexer-client/src/client/v7/client.ts

@@ -3,7 +3,7 @@ import { Client } from 'es7';
 import type {
 	DataRecordValue,
 	ElasticSearchConfig,
-	IElasticsearchService,
+	ElasticsearchService,
 	IndexResult,
 } from '@overture-stack/maestro-common';
 
@@ -14,14 +14,14 @@ import { bulkUpsert, createIndexIfNotExists, deleteData, indexData, ping, update
  *  Creates an instance of the Elasticsearch service for version 7.
  *
  * This function initializes an Elasticsearch client using the provided configuration
- * and returns an object that implements the `IElasticsearchService` interface.
+ * and returns an object that implements the `ElasticsearchService` interface.
  * The returned object includes methods for creating an index, indexing data,
  * checking the connection, updating data, and deleting data.
  *
  * @param {ElasticSearchConfig} config The configuration of the Elasticsearch to connect to
- * @returns {IElasticsearchService} An object implementing the `IElasticsearchService` interface, providing methods to interact with Elasticsearch
+ * @returns {ElasticsearchService} An object implementing the `ElasticsearchService` interface, providing methods to interact with Elasticsearch
  */
-export const es7 = (config: ElasticSearchConfig): IElasticsearchService => {
+export const es7 = (config: ElasticSearchConfig): ElasticsearchService => {
 	if (config.version !== 7) {
 		throw Error('Invalid Client Configuration');
 	}

packages/indexer-client/src/client/v8/client.ts

@@ -3,7 +3,7 @@ import { Client } from 'es8';
 import type {
 	DataRecordValue,
 	ElasticSearchConfig,
-	IElasticsearchService,
+	ElasticsearchService,
 	IndexResult,
 } from '@overture-stack/maestro-common';
 
@@ -14,14 +14,14 @@ import { bulkUpsert, createIndexIfNotExists, deleteData, indexData, ping, update
  *  Creates an instance of the Elasticsearch service for version 8.
  *
  * This function initializes an Elasticsearch client using the provided configuration
- * and returns an object that implements the `IElasticsearchService` interface.
+ * and returns an object that implements the `ElasticsearchService` interface.
  * The returned object includes methods for creating an index, indexing data,
  * checking the connection, updating data, and deleting data.
  *
  * @param {ElasticSearchConfig} config The configuration of the Elasticsearch to connect to
- * @returns {IElasticsearchService} An object implementing the `IElasticsearchService` interface, providing methods to interact with Elasticsearch
+ * @returns {ElasticsearchService} An object implementing the `ElasticsearchService` interface, providing methods to interact with Elasticsearch
  */
-export const es8 = (config: ElasticSearchConfig): IElasticsearchService => {
+export const es8 = (config: ElasticSearchConfig): ElasticsearchService => {
 	if (config.version !== 8) {
 		throw Error('Invalid Client Configuration');
 	}

packages/indexer-client/test/integration/bulkUpsertIndexedData.spec.ts

@@ -1,14 +1,14 @@
 import { ElasticsearchContainer, StartedElasticsearchContainer } from '@testcontainers/elasticsearch';
 import { expect } from 'chai';
 
-import type { DataRecordValue, IElasticsearchService } from '@overture-stack/maestro-common';
+import type { DataRecordValue, ElasticsearchService } from '@overture-stack/maestro-common';
 
 import { es7 } from '../../src/client/v7/client.js';
 import { es8 } from '../../src/client/v8/client.js';
 
 export default function suite() {
 	let container: StartedElasticsearchContainer;
-	let client: IElasticsearchService;
+	let client: ElasticsearchService;
 
 	before(async () => {
 		// Start an Elasticsearch container

packages/indexer-client/test/integration/createdIndex.spec.ts

@@ -1,14 +1,14 @@
 import { ElasticsearchContainer, StartedElasticsearchContainer } from '@testcontainers/elasticsearch';
 import { expect } from 'chai';
 
-import type { IElasticsearchService } from '@overture-stack/maestro-common';
+import type { ElasticsearchService } from '@overture-stack/maestro-common';
 
 import { es7 } from '../../src/client/v7/client.js';
 import { es8 } from '../../src/client/v8/client.js';
 
 export default function suite() {
 	let container: StartedElasticsearchContainer;
-	let client: IElasticsearchService;
+	let client: ElasticsearchService;
 
 	before(async () => {
 		// Start an Elasticsearch container

packages/indexer-client/test/integration/indexData.spec.ts

@@ -1,14 +1,14 @@
 import { ElasticsearchContainer, StartedElasticsearchContainer } from '@testcontainers/elasticsearch';
 import { expect } from 'chai';
 
-import { type DataRecordValue, IElasticsearchService } from '@overture-stack/maestro-common';
+import { type DataRecordValue, ElasticsearchService } from '@overture-stack/maestro-common';
 
 import { es7 } from '../../src/client/v7/client.js';
 import { es8 } from '../../src/client/v8/client.js';
 
 export default function suite() {
 	let container: StartedElasticsearchContainer;
-	let client: IElasticsearchService;
+	let client: ElasticsearchService;
 
 	before(async () => {
 		// Start an Elasticsearch container

packages/indexer-client/test/integration/ping.spec.ts

@@ -1,14 +1,14 @@
 import { ElasticsearchContainer, StartedElasticsearchContainer } from '@testcontainers/elasticsearch';
 import { expect } from 'chai';
 
-import type { IElasticsearchService } from '@overture-stack/maestro-common';
+import type { ElasticsearchService } from '@overture-stack/maestro-common';
 
 import { es7 } from '../../src/client/v7/client.js';
 import { es8 } from '../../src/client/v8/client.js';
 
 export default function suite() {
 	let container: StartedElasticsearchContainer;
-	let client: IElasticsearchService;
+	let client: ElasticsearchService;
 
 	before(async () => {
 		// Start an Elasticsearch container

packages/indexer-client/test/integration/updateIndexedData.spec.ts

@@ -1,14 +1,14 @@
 import { ElasticsearchContainer, StartedElasticsearchContainer } from '@testcontainers/elasticsearch';
 import { expect } from 'chai';
 
-import type { DataRecordValue, IElasticsearchService, IndexData } from '@overture-stack/maestro-common';
+import type { DataRecordValue, ElasticsearchService, IndexData } from '@overture-stack/maestro-common';
 
 import { es7 } from '../../src/client/v7/client.js';
 import { es8 } from '../../src/client/v8/client.js';
 
 export default function suite() {
 	let container: StartedElasticsearchContainer;
-	let client: IElasticsearchService;
+	let client: ElasticsearchService;
 
 	before(async () => {
 		// Start an Elasticsearch container

packages/maestro-provider/README.md

@@ -5,7 +5,7 @@
 
 This package provides indexing functionality for keeping data synchronized from data source repositories like Song and Lyric with search engines like ElasticSearch.
 
-The entry point to this functionality is through the `MaestroProvider`. The MaestroProvider acts as the main interface for configuring, managing, and executing tasks related to indexing data from repositories and payloads into a search engine like Elasticsearch. It simplifies the interaction with complex indexing workflows by providing a unified entry point to both automatic data synchronization and manual document indexing.
+The entry point to this functionality is through the `initializeMaestroProvider`. This function creates a provider that offers methods to configure, manage, and execute tasks related to indexing data from repositories and payloads into a search engine like Elasticsearch. It simplifies the interaction with complex indexing workflows by providing a unified entry point to both automatic data synchronization and manual document indexing.
 
 This package is designed to be imported as an npm dependency.
 
@@ -19,25 +19,25 @@ npm install @overture-provider/maestro-provider
 
 ## Configuration
 
-The **MaestroProvider** requires some initial configuration to work correctly. You can configure it by providing an object of type **MaestroProviderConfig**.
+To create a Maestro provider use the **initializeMaestroProvider** function. This can be done by providing an object of type **MaestroProviderConfig**.
 
 Here is an example of the configuration:
 
 ```bash
-import { MaestroProvider, MaestroProviderConfig } from '@overture-stack/maestro-provider';
+import { initializeMaestroProvider, MaestroProviderConfig } from '@overture-stack/maestro-provider';
 
 const config: MaestroProviderConfig = {
   // Configuration properties
 };
 
-const maestroProvider = MaestroProvider(config);
+const maestroProvider = initializeMaestroProvider(config);
 ```
 
 ## Features
 
 1. **Repository Indexing Operations**
 
-   The `MaestroProvider` provides a set of API functions designed to manage indexing operations for systems that work as data source repositories, such as _Song_ or _Lyric_. These repositories serve as data sources from which _Maestro_ fetches data when the operations are invoked. The `MaestroProvider` acts as the bridge to ensure that this data is correctly indexed into a search engine like Elasticsearch.
+   The `initializeMaestroProvider` function provides a set of API functions designed to manage indexing operations for systems that work as data source repositories, such as _Song_ or _Lyric_. These repositories serve as data sources from which _Maestro_ fetches data when the operations are invoked. The resulting provider acts as the bridge to ensure that this data is correctly indexed into a search engine like Elasticsearch.
 
    It provides bellow operations:
 
@@ -61,7 +61,7 @@ const maestroProvider = MaestroProvider(config);
 
 2. **Indexing Service Implementation for Payloads**
 
-   The `MaestroProvider` also offers a set of indexing operations that do not require fetching data from repositories. Instead, the data is provided directly in the payloads.
+   Maestro provider also offers a set of indexing operations that do not require fetching data from repositories. Instead, the data is provided directly in the payloads.
 
    It provides bellow operations:
 
@@ -94,16 +94,16 @@ const maestroProvider = MaestroProvider(config);
 
 ## Usage Example
 
-After installing and configuring the `MaestroProvider`, you can start using it to perform indexing operations.
+After installing and configuring the Maestro Provider, you can start using it to perform indexing operations.
 
 ```bash
-import { MaestroProvider, MaestroProviderConfig } from 'maestro-provider';
+import { initializeMaestroProvider, MaestroProviderConfig } from 'maestro-provider';
 
 const config: MaestroProviderConfig = {
 // Configure your provider
 };
 
-const maestroProvider = new MaestroProvider(config);
+const maestroProvider = initializeMaestroProvider(config);
 
 // Example API usage:
 maestroProvider.payload.createIndex(payload);

packages/maestro-provider/src/api/api.ts

@@ -1,6 +1,6 @@
 import {
 	BadRequest,
-	type IElasticsearchService,
+	type ElasticsearchService,
 	type IndexResult,
 	InternalServerError,
 	isEmpty,
@@ -27,10 +27,10 @@ const mergeResult = (accumulator: IndexResult, result: IndexResult): IndexResult
 /**
  * Creates an object containing indexing operations to be used in the API
  * @param config The configuration object for the `MaestroProvider`, which includes repository information
- * @param indexer An implementation of `IElasticsearchService` used for performing Elasticsearch operations
+ * @param indexer An implementation of `ElasticsearchService` used for performing Elasticsearch operations
  * @returns
  */
-export const api = (config: MaestroProviderConfig, indexer: IElasticsearchService): RepositoryIndexingOperations => {
+export const api = (config: MaestroProviderConfig, indexer: ElasticsearchService): RepositoryIndexingOperations => {
 	const repositories = config.repositories;
 	if (!repositories) {
 		return {

packages/maestro-provider/src/index.ts

@@ -1,2 +1,2 @@
-export { IMaestroProvider, MaestroProvider } from './provider/index.js';
+export { initializeMaestroProvider, MaestroProvider } from './provider/index.js';
 export type { ElasticSearchConfig, MaestroProviderConfig } from '@overture-stack/maestro-common';

packages/maestro-provider/src/provider/index.ts

@@ -1 +1 @@
-export { IMaestroProvider, MaestroProvider } from './provider.js';
+export { initializeMaestroProvider, MaestroProvider } from './provider.js';

packages/maestro-provider/src/provider/provider.ts

@@ -1,5 +1,5 @@
 import {
-	type IElasticsearchService,
+	type ElasticsearchService,
 	type RepositoryIndexingOperations,
 	setLoggerConfig,
 } from '@overture-stack/maestro-common';
@@ -11,23 +11,23 @@ import { api } from '../api/api.js';
 /**
  * Interface representing a provider for indexing operations
  */
-export interface IMaestroProvider {
+export interface MaestroProvider {
 	/**
 	 * The API for repository indexing operations.
 	 */
 	api: RepositoryIndexingOperations;
 	/**
 	 * The Elasticsearch service implementation payload.
 	 */
-	payload: IElasticsearchService;
+	payload: ElasticsearchService;
 }
 
 /**
  * Creates The Maestro Provider based on the provided configuration
  * @param config The configuration object for initializing the Maestro provider
  * @returns The Maestro Provider object containing API operations and an Elasticsearch service instance
  */
-export const MaestroProvider = (config: MaestroProviderConfig): IMaestroProvider => {
+export const initializeMaestroProvider = (config: MaestroProviderConfig): MaestroProvider => {
 	if (config.logger) {
 		setLoggerConfig(config.logger);
 	}

packages/repository/src/repositories/index.ts

@@ -1,14 +1,14 @@
 import {
-	type IRepository,
 	type LyricRepositoryConfig,
+	type Repository,
 	RepositoryType,
 	type SongRepositoryConfig,
 } from '@overture-stack/maestro-common';
 
 import { lyricRepository } from './lyric/repository';
 import { songRepository } from './song/repository';
 
-export const repository = (config: LyricRepositoryConfig | SongRepositoryConfig): IRepository => {
+export const repository = (config: LyricRepositoryConfig | SongRepositoryConfig): Repository => {
 	switch (config.type) {
 		case RepositoryType.LYRIC:
 			return lyricRepository(config);

packages/repository/src/repositories/lyric/repository.ts

@@ -2,9 +2,9 @@ import * as path from 'path';
 
 import {
 	type DataRecordValue,
-	type IRepository,
 	logger,
 	type LyricRepositoryConfig,
+	type Repository,
 } from '@overture-stack/maestro-common';
 
 import httpClient from '../../network/httpClient';
@@ -16,7 +16,7 @@ import { isArrayOfObjects } from '../../utils/utils';
  * @param config
  * @returns
  */
-export const lyricRepository = (config: LyricRepositoryConfig): IRepository => {
+export const lyricRepository = (config: LyricRepositoryConfig): Repository => {
 	const { baseUrl, categoryId, paginationSize } = config;
 	const getRepositoryRecords = async function* (): AsyncGenerator<Record<string, DataRecordValue>[], void, unknown> {
 		let page = 1;

packages/repository/src/repositories/song/repository.ts

@@ -1,6 +1,6 @@
 import * as path from 'path';
 
-import type { DataRecordValue, IRepository, SongRepositoryConfig } from '@overture-stack/maestro-common';
+import type { DataRecordValue, Repository, SongRepositoryConfig } from '@overture-stack/maestro-common';
 
 import httpClient from '../../network/httpClient';
 import { isArrayOfObjects } from '../../utils/utils';
@@ -10,7 +10,7 @@ import { isArrayOfObjects } from '../../utils/utils';
  * @param config
  * @returns
  */
-export const songRepository = (config: SongRepositoryConfig): IRepository => {
+export const songRepository = (config: SongRepositoryConfig): Repository => {
 	const { baseUrl, paginationSize } = config;
 
 	const getOrganizationRecords = async function* ({