refactor: rename external tool URL methods and interfaces for clarity

Author: g-saracca

docs/useCases.md

@@ -96,8 +96,8 @@ The different use cases currently available in the package are classified below,
 - [External Tools](#external-tools)
   - [External Tools read use cases](#external-tools-read-use-cases)
     - [Get External Tools](#get-external-tools)
-    - [Get Dataset External Tool Url](#get-dataset-external-tool-url)
-    - [Get File External Tool Url](#get-file-external-tool-url)
+    - [Get Dataset External Tool Resolved](#get-dataset-external-tool-resolved)
+    - [Get File External Tool Resolved](#get-file-external-tool-resolved)
 
 ## Collections
 
@@ -2172,14 +2172,14 @@ getExternalTools.execute().then((externalTools: ExternalTool[]) => {
 
 _See [use case](../src/externalTools/domain/useCases/GetExternalTools.ts) implementation_.
 
-#### Get Dataset External Tool Url
+#### Get Dataset External Tool Resolved
 
-Returns an instance of [DatasetExternalToolUrl](../src/externalTools/domain/models/ExternalTool.ts), which contains the resolved URL for accessing an external tool that operates at the dataset level.
+Returns an instance of [DatasetExternalToolResolved](../src/externalTools/domain/models/ExternalTool.ts), which contains the resolved URL for accessing an external tool that operates at the dataset level.
 
 ##### Example call:
 
 ```typescript
-import { getDatasetExternalToolUrl } from '@iqss/dataverse-client-javascript'
+import { getDatasetExternalToolResolved } from '@iqss/dataverse-client-javascript'
 
 /* ... */
 const toolId = 1
@@ -2189,24 +2189,24 @@ const getExternalToolDTO: GetExternalToolDTO = {
   locale: 'en'
 }
 
-getDatasetExternalToolUrl
+getDatasetExternalToolResolved
   .execute(toolId, datasetId, getExternalToolDTO)
-  .then((datasetExternalToolUrl: DatasetExternalToolUrl) => {
+  .then((datasetExternalToolResolved: DatasetExternalToolResolved) => {
     /* ... */
   })
 /* ... */
 ```
 
-_See [use case](../src/externalTools/domain/useCases/GetDatasetExternalToolUrl.ts) implementation_.
+_See [use case](../src/externalTools/domain/useCases/GetDatasetExternalToolResolved.ts) implementation_.
 
-#### Get File External Tool Url
+#### Get File External Tool Resolved
 
-Returns an instance of [FileExternalToolUrl](../src/externalTools/domain/models/ExternalTool.ts), which contains the resolved URL for accessing an external tool that operates at the file level.
+Returns an instance of [FileExternalToolResolved](../src/externalTools/domain/models/ExternalTool.ts), which contains the resolved URL for accessing an external tool that operates at the file level.
 
 ##### Example call:
 
 ```typescript
-import { getFileExternalToolUrl } from '@iqss/dataverse-client-javascript'
+import { getFileExternalToolResolved } from '@iqss/dataverse-client-javascript'
 
 /* ... */
 const toolId = 1
@@ -2216,12 +2216,12 @@ const getExternalToolDTO: GetExternalToolDTO = {
   locale: 'en'
 }
 
-getFileExternalToolUrl
+getFileExternalToolResolved
   .execute(toolId, fileId, getExternalToolDTO)
-  .then((fileExternalToolUrl: FileExternalToolUrl) => {
+  .then((fileExternalToolResolved: FileExternalToolResolved) => {
     /* ... */
   })
 /* ... */
 ```
 
-_See [use case](../src/externalTools/domain/useCases/GetfileExternalToolUrl.ts) implementation_.
+_See [use case](../src/externalTools/domain/useCases/GetfileExternalToolResolved.ts) implementation_.

src/externalTools/domain/models/ExternalTool.ts

@@ -18,14 +18,14 @@ export enum ToolScope {
   File = 'file'
 }
 
-export interface DatasetExternalToolUrl {
+export interface DatasetExternalToolResolved {
   toolUrlResolved: string
   displayName: string
   datasetId: number
   preview: boolean
 }
 
-export interface FileExternalToolUrl {
+export interface FileExternalToolResolved {
   toolUrlResolved: string
   displayName: string
   fileId: number

src/externalTools/domain/repositories/IExternalToolsRepository.ts

@@ -1,16 +1,20 @@
 import { GetExternalToolDTO } from '../dtos/GetExternalToolDTO'
-import { DatasetExternalToolUrl, ExternalTool, FileExternalToolUrl } from '../models/ExternalTool'
+import {
+  DatasetExternalToolResolved,
+  ExternalTool,
+  FileExternalToolResolved
+} from '../models/ExternalTool'
 
 export interface IExternalToolsRepository {
   getExternalTools(): Promise<ExternalTool[]>
-  getDatasetExternalToolUrl(
+  getDatasetExternalToolResolved(
     datasetId: number | string,
     toolId: number,
     getExternalToolDTO: GetExternalToolDTO
-  ): Promise<DatasetExternalToolUrl>
-  getFileExternalToolUrl(
+  ): Promise<DatasetExternalToolResolved>
+  getFileExternalToolResolved(
     fileId: number | string,
     toolId: number,
     getExternalToolDTO: GetExternalToolDTO
-  ): Promise<FileExternalToolUrl>
+  ): Promise<FileExternalToolResolved>
 }

…in/useCases/GetDatasetExternalToolUrl.ts …eCases/GetDatasetExternalToolResolved.tssrc/externalTools/domain/useCases/GetDatasetExternalToolUrl.ts renamed to src/externalTools/domain/useCases/GetDatasetExternalToolResolved.ts src/externalTools/domain/useCases/GetDatasetExternalToolUrl.ts renamed to src/externalTools/domain/useCases/GetDatasetExternalToolResolved.ts

@@ -1,31 +1,31 @@
 import { UseCase } from '../../../core/domain/useCases/UseCase'
 import { GetExternalToolDTO } from '../dtos/GetExternalToolDTO'
-import { DatasetExternalToolUrl } from '../models/ExternalTool'
+import { DatasetExternalToolResolved } from '../models/ExternalTool'
 import { IExternalToolsRepository } from '../repositories/IExternalToolsRepository'
 
-export class GetDatasetExternalToolUrl implements UseCase<DatasetExternalToolUrl> {
+export class GetDatasetExternalToolResolved implements UseCase<DatasetExternalToolResolved> {
   private externalToolsRepository: IExternalToolsRepository
 
   constructor(externalToolsRepository: IExternalToolsRepository) {
     this.externalToolsRepository = externalToolsRepository
   }
 
   /**
-   * Returns a DatasetExternalToolUrl object containing the resolved URL for accessing an external tool that operates at the dataset level.
+   * Returns a DatasetExternalToolResolved object containing the resolved URL for accessing an external tool that operates at the dataset level.
    * The URL includes necessary authentication tokens and parameters based on the user's permissions and the tool's configuration.
    * Authentication is required for draft or deaccessioned datasets and the user must have ViewUnpublishedDataset permission.
    *
    * @param {number | string} [datasetId] - The dataset identifier, which can be a string (for persistent identifiers), or a number (for numeric identifiers).
    * @param {number} toolId - The identifier of the external tool.
    * @param {GetExternalToolDTO} getExternalToolDTO - The GetExternalToolDTO object containing additional parameters for the request.
-   * @returns {Promise<DatasetExternalToolUrl>}
+   * @returns {Promise<DatasetExternalToolResolved>}
    */
   async execute(
     datasetId: number | string,
     toolId: number,
     getExternalToolDTO: GetExternalToolDTO
-  ): Promise<DatasetExternalToolUrl> {
-    return await this.externalToolsRepository.getDatasetExternalToolUrl(
+  ): Promise<DatasetExternalToolResolved> {
+    return await this.externalToolsRepository.getDatasetExternalToolResolved(
       datasetId,
       toolId,
       getExternalToolDTO

…omain/useCases/GetFileExternalToolUrl.ts …/useCases/GetFileExternalToolResolved.tssrc/externalTools/domain/useCases/GetFileExternalToolUrl.ts renamed to src/externalTools/domain/useCases/GetFileExternalToolResolved.ts src/externalTools/domain/useCases/GetFileExternalToolUrl.ts renamed to src/externalTools/domain/useCases/GetFileExternalToolResolved.ts

@@ -1,31 +1,31 @@
 import { UseCase } from '../../../core/domain/useCases/UseCase'
 import { GetExternalToolDTO } from '../dtos/GetExternalToolDTO'
-import { FileExternalToolUrl } from '../models/ExternalTool'
+import { FileExternalToolResolved } from '../models/ExternalTool'
 import { IExternalToolsRepository } from '../repositories/IExternalToolsRepository'
 
-export class GetFileExternalToolUrl implements UseCase<FileExternalToolUrl> {
+export class GetFileExternalToolResolved implements UseCase<FileExternalToolResolved> {
   private externalToolsRepository: IExternalToolsRepository
 
   constructor(externalToolsRepository: IExternalToolsRepository) {
     this.externalToolsRepository = externalToolsRepository
   }
 
   /**
-   * Returns a FileExternalToolUrl object containing the resolved URL for accessing an external tool that operates at the file level.
+   * Returns a FileExternalToolResolved object containing the resolved URL for accessing an external tool that operates at the file level.
    * The URL includes necessary authentication tokens and parameters based on the user's permissions and the tool's configuration.
    * Authentication is required for draft, restricted, embargoed, or expired (retention period) files, the user must have appropriate permissions.
    *
    * @param {number | string} [fileId] - The File identifier, which can be a string (for persistent identifiers), or a number (for numeric identifiers).
    * @param {number} toolId - The identifier of the external tool.
    * @param {GetExternalToolDTO} getExternalToolDTO - The GetExternalToolDTO object containing additional parameters for the request.
-   * @returns {Promise<FileExternalToolUrl>}
+   * @returns {Promise<FileExternalToolResolved>}
    */
   async execute(
     fileId: number | string,
     toolId: number,
     getExternalToolDTO: GetExternalToolDTO
-  ): Promise<FileExternalToolUrl> {
-    return await this.externalToolsRepository.getFileExternalToolUrl(
+  ): Promise<FileExternalToolResolved> {
+    return await this.externalToolsRepository.getFileExternalToolResolved(
       fileId,
       toolId,
       getExternalToolDTO

src/externalTools/index.ts

@@ -1,25 +1,25 @@
-import { GetDatasetExternalToolUrl } from './domain/useCases/GetDatasetExternalToolUrl'
+import { GetDatasetExternalToolResolved } from './domain/useCases/GetDatasetExternalToolResolved'
 import { GetExternalTools } from './domain/useCases/GetExternalTools'
-import { GetFileExternalToolUrl } from './domain/useCases/GetFileExternalToolUrl'
+import { GetFileExternalToolResolved } from './domain/useCases/GetFileExternalToolResolved'
 import { ExternalToolsRepository } from './infra/ExternalToolsRepository'
 
 const externalToolsRepository = new ExternalToolsRepository()
 
 const getExternalTools = new GetExternalTools(externalToolsRepository)
-const getDatasetExternalToolUrl = new GetDatasetExternalToolUrl(externalToolsRepository)
-const getFileExternalToolUrl = new GetFileExternalToolUrl(externalToolsRepository)
+const getDatasetExternalToolResolved = new GetDatasetExternalToolResolved(externalToolsRepository)
+const getFileExternalToolResolved = new GetFileExternalToolResolved(externalToolsRepository)
 
 export {
   getExternalTools,
-  getDatasetExternalToolUrl,
-  getFileExternalToolUrl,
+  getDatasetExternalToolResolved,
+  getFileExternalToolResolved,
   externalToolsRepository
 }
 
 export {
   ExternalTool,
   ToolScope,
   ToolType,
-  DatasetExternalToolUrl,
-  FileExternalToolUrl
+  DatasetExternalToolResolved,
+  FileExternalToolResolved
 } from './domain/models/ExternalTool'

src/externalTools/infra/ExternalToolsRepository.ts

@@ -1,9 +1,9 @@
 import { IExternalToolsRepository } from '../domain/repositories/IExternalToolsRepository'
 import { ApiRepository } from '../../core/infra/repositories/ApiRepository'
 import {
-  DatasetExternalToolUrl,
+  DatasetExternalToolResolved,
   ExternalTool,
-  FileExternalToolUrl
+  FileExternalToolResolved
 } from '../domain/models/ExternalTool'
 import { GetExternalToolDTO } from '../domain/dtos/GetExternalToolDTO'
 import { datasetExternalToolTransformer } from './transformers/datasetExternalToolTransformer'
@@ -21,11 +21,11 @@ export class ExternalToolsRepository extends ApiRepository implements IExternalT
       })
   }
 
-  public async getDatasetExternalToolUrl(
+  public async getDatasetExternalToolResolved(
     datasetId: number | string,
     toolId: number,
     getExternalToolDTO: GetExternalToolDTO
-  ): Promise<DatasetExternalToolUrl> {
+  ): Promise<DatasetExternalToolResolved> {
     return this.doPost(
       this.buildApiEndpoint('datasets', `externalTool/${toolId}/toolUrl`, datasetId),
       getExternalToolDTO
@@ -36,11 +36,11 @@ export class ExternalToolsRepository extends ApiRepository implements IExternalT
       })
   }
 
-  public async getFileExternalToolUrl(
+  public async getFileExternalToolResolved(
     fileId: number | string,
     toolId: number,
     getExternalToolDTO: GetExternalToolDTO
-  ): Promise<FileExternalToolUrl> {
+  ): Promise<FileExternalToolResolved> {
     return this.doPost(
       this.buildApiEndpoint('files', `externalTool/${toolId}/toolUrl`, fileId),
       getExternalToolDTO

src/externalTools/infra/transformers/datasetExternalToolTransformer.ts

@@ -1,11 +1,11 @@
 import { AxiosResponse } from 'axios'
-import { DatasetExternalToolUrl } from '../../domain/models/ExternalTool'
+import { DatasetExternalToolResolved } from '../../domain/models/ExternalTool'
 
 export const datasetExternalToolTransformer = (
   response: AxiosResponse<{
     data: { toolUrl: string; displayName: string; datasetId: number; preview: boolean }
   }>
-): DatasetExternalToolUrl => {
+): DatasetExternalToolResolved => {
   const datasetExtTool = response.data.data
 
   return {

src/externalTools/infra/transformers/fileExternalToolTransformer.ts

@@ -1,11 +1,11 @@
 import { AxiosResponse } from 'axios'
-import { FileExternalToolUrl } from '../../domain/models/ExternalTool'
+import { FileExternalToolResolved } from '../../domain/models/ExternalTool'
 
 export const fileExternalToolTransformer = (
   response: AxiosResponse<{
     data: { toolUrl: string; displayName: string; fileId: number; preview: boolean }
   }>
-): FileExternalToolUrl => {
+): FileExternalToolResolved => {
   const fileExtTool = response.data.data
 
   return {