---
title: Document
slug: oip-next/P-j0-api
icon: {"lucideIcon":"📘"}
createdAt: 2026-03-19T09:39:46.000Z
---

Permet de stocker/supprimer des documents via le service **fasst\_file\_storage&#x20;**&#x65;t de mettre à jour l'entité projet (création/suppression d'entités Document).

## uploadDocument

```javascript
import { DocumentFeature } from '@fasstech/oip-features-document';
import { documentTypeEnum } from '@fasstech/oip-core/entities';

const document = {
  fileName: 'test.pdf',          // obligatoire
  mimeType: 'application/pdf',
  path: 'test/test.pdf',         // obligatoire
  type: documentTypeEnum.IDCARD
};

const { uploadDocument } = DocumentFeature({
  service: {
    url: process.env.SERVICE_FILESTORAGE_URL
  }
});

const { projectEntity: updatedProjectEntity, metadata } = await uploadDocument({
  projectEntity,
  args: { document }
});
```

### Options

| Propriété   | Type   | Description                                     | Obligatoire |
| ----------- | ------ | ----------------------------------------------- | ----------- |
| service     | object | Objet de configuration du service file\_storage | x           |
| service.url | string | URL du service file\_storage                    | x           |

### Paramètres

| Propriété | Type   | Obligatoire | Description           |
| --------- | ------ | ----------- | --------------------- |
| fileName  | string | x           | Nom du fichier        |
| mimeType  | string |             | Type MIME             |
| path      | string | x           | Chemin du fichier     |
| type      | string |             | Type (oip) du fichier |

**Retour**

- `projectEntity` : l'entité projet mise à jour
- `metadata.documentEntity` : entité Document créée

## deleteDocument

```javascript
import { DocumentFeature } from '@fasstech/oip-features-document';

const { deleteDocument } = DocumentFeature({
  service: {
    url: process.env.SERVICE_FILESTORAGE_URL
  }
});

const { projectEntity: updatedProjectEntity } = await deleteDocument({
  projectEntity,
  args: { documentId: 'xxx' }
});
```

### Options

| **Propriété** | **Type** | **Description**                                 | **Obligatoire** |
| ------------- | -------- | ----------------------------------------------- | --------------- |
| service       | object   | Objet de configuration du service file\_storage | x               |
| service.url   | string   | URL du service file\_storage                    | x               |

### Paramètres

| **Propriété** | **Type** | **Obligatoire** | **Description**                     |
| ------------- | -------- | --------------- | ----------------------------------- |
| documentId    | string   | x               | id de l'entité Document à supprimer |

**Retour**

- `projectEntity` : l'entité projet mise à jour

## downloadDocument

```javascript
import { DocumentFeature } from '@fasstech/oip-features-document';

const { downloadDocument } = DocumentFeature({
  service: {
    url: process.env.SERVICE_FILESTORAGE_URL
  }
});

try {
  // retrieve an image file
  const { file } = await downloadDocument({
    projectEntity,
    args: { documentId } // Document entity id
  });

  // downloadDocument will throw an error if http status is not 200
  const fileArrayBuffer = await file.arrayBuffer();
  const fileImageBuffer = Buffer.from(fileArrayBuffer);
  const fileImageBase64 = fileImageBuffer.toString('base64');
} catch (error) {
  console.error('Erreur lors du téléchargement du document :', error);
  throw error;
}
```

### Options

| **Propriété** | **Type** | **Description**                                 | **Obligatoire** |
| ------------- | -------- | ----------------------------------------------- | --------------- |
| service       | object   | Objet de configuration du service file\_storage | x               |
| service.url   | string   | URL du service file\_storage                    | x               |

### Paramètres

| **Propriété** | **Type** | **Obligatoire** | **Description**                       |
| ------------- | -------- | --------------- | ------------------------------------- |
| documentId    | string   | x               | id de l'entité Document à télécharger |

### Retour

- `projectEntity` : l'entité projet (unchanged)
- `file` : la réponse du fetch au service file\_storage
