Added: createCollection docs and index.ts tweaks

Author: GPortas

docs/useCases.md

@@ -100,6 +100,39 @@ The `collectionIdOrAlias` is a generic collection identifier, which can be eithe
 
 If no collection identifier is specified, the default collection identifier; `root` will be used. If you want to search for a different collection, you must add the collection identifier as a parameter in the use case call.
 
+### Collections Write Use Cases
+
+#### Create a Collection
+
+Creates a new Collection, given a [CollectionDTO](../src/collections/domain/dtos/CollectionDTO.ts) object and an optional parent collection identifier, which defaults to `root`.
+
+##### Example call:
+
+```typescript
+import { createCollection } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+const collectionDTO: CollectionDTO = {
+  alias: alias,
+  name: 'Test Collection',
+  contacts: ['[email protected]'],
+  type: CollectionType.DEPARTMENT
+}
+
+createCollection.execute(collectionDTO).then((createdCollectionId: number) => {
+  /* ... */
+})
+
+/* ... */
+```
+
+_See [use case](../src/collections/domain/useCases/CreateCollection.ts) implementation_.
+
+The above example creates the new collection in the `root` collection since no collection identifier is specified. If you want to create the collection in a different collection, you must add the collection identifier as a second parameter in the use case call.
+
+The use case returns a number, which is the identifier of the created collection.
+
 ## Datasets
 
 ### Datasets Read Use Cases

src/collections/domain/useCases/CreateCollection.ts

@@ -11,7 +11,12 @@ export class CreateCollection implements UseCase<number> {
   }
 
   /**
-   * TODO
+   * Creates a new collection, given a CollectionDTO object and an optional collection identifier, which defaults to root.
+   *
+   * @param {CollectionDTO} [newCollection] - CollectionDTO object including the new collection data.
+   * @param {string} [parentCollectionId] - Specifies the parent collection identifier (optional, defaults to root).
+   * @returns {Promise<number>} - The created collection identifier.
+   * @throws {WriteError} - If there are errors while writing data.
    */
   async execute(
     newCollection: CollectionDTO,

src/collections/index.ts

@@ -10,3 +10,4 @@ const createCollection = new CreateCollection(collectionsRepository)
 
 export { getCollection, createCollection }
 export { Collection } from './domain/models/Collection'
+export { CollectionDTO } from './domain/dtos/CollectionDTO'