fix: Types are now ok

cozy · Feb 14, 2024 · da7f975 · da7f975
1 parent 98ac997
commit da7f975
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 19 deletions.
diff --git a/docs/api/cozy-client/classes/models.document.Qualification.md b/docs/api/cozy-client/classes/models.document.Qualification.md
@@ -57,7 +57,7 @@ the checkValueAttributes method.
 
 *Defined in*
 
-[packages/cozy-client/src/models/document/qualification.js:46](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/document/qualification.js#L46)
+[packages/cozy-client/src/models/document/qualification.js:49](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/document/qualification.js#L49)
 
 ***
 
@@ -67,7 +67,7 @@ the checkValueAttributes method.
 
 *Defined in*
 
-[packages/cozy-client/src/models/document/qualification.js:51](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/document/qualification.js#L51)
+[packages/cozy-client/src/models/document/qualification.js:57](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/document/qualification.js#L57)
 
 ***
 
@@ -77,7 +77,7 @@ the checkValueAttributes method.
 
 *Defined in*
 
-[packages/cozy-client/src/models/document/qualification.js:55](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/document/qualification.js#L55)
+[packages/cozy-client/src/models/document/qualification.js:64](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/document/qualification.js#L64)
 
 ## Methods
 
@@ -108,7 +108,7 @@ Check the given qualification attributes respects the following rules:
 
 *Defined in*
 
-[packages/cozy-client/src/models/document/qualification.js:75](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/document/qualification.js#L75)
+[packages/cozy-client/src/models/document/qualification.js:84](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/document/qualification.js#L84)
 
 ***
 
@@ -132,7 +132,7 @@ The Qualification object.
 
 *Defined in*
 
-[packages/cozy-client/src/models/document/qualification.js:158](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/document/qualification.js#L158)
+[packages/cozy-client/src/models/document/qualification.js:167](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/document/qualification.js#L167)
 
 ***
 
@@ -156,7 +156,7 @@ The Qualification object.
 
 *Defined in*
 
-[packages/cozy-client/src/models/document/qualification.js:168](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/document/qualification.js#L168)
+[packages/cozy-client/src/models/document/qualification.js:177](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/document/qualification.js#L177)
 
 ***
 
@@ -180,7 +180,7 @@ The Qualification object.
 
 *Defined in*
 
-[packages/cozy-client/src/models/document/qualification.js:181](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/document/qualification.js#L181)
+[packages/cozy-client/src/models/document/qualification.js:190](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/document/qualification.js#L190)
 
 ***
 
@@ -204,7 +204,7 @@ The Qualification object.
 
 *Defined in*
 
-[packages/cozy-client/src/models/document/qualification.js:194](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/document/qualification.js#L194)
+[packages/cozy-client/src/models/document/qualification.js:203](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/document/qualification.js#L203)
 
 ***
 
@@ -222,7 +222,7 @@ The qualification attributes
 
 *Defined in*
 
-[packages/cozy-client/src/models/document/qualification.js:206](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/document/qualification.js#L206)
+[packages/cozy-client/src/models/document/qualification.js:215](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/document/qualification.js#L215)
 
 ***
 
@@ -246,4 +246,4 @@ Returns the qualification associated to a label.
 
 *Defined in*
 
-[packages/cozy-client/src/models/document/qualification.js:223](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/document/qualification.js#L223)
+[packages/cozy-client/src/models/document/qualification.js:232](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/document/qualification.js#L232)
diff --git a/docs/api/cozy-client/modules/models.document.md b/docs/api/cozy-client/modules/models.document.md
@@ -36,7 +36,7 @@ Helper to get the qualification from a document
 
 *Defined in*
 
-[packages/cozy-client/src/models/document/qualification.js:251](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/document/qualification.js#L251)
+[packages/cozy-client/src/models/document/qualification.js:260](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/document/qualification.js#L260)
 
 ***
 
@@ -61,4 +61,4 @@ Set the qualification to the document metadata
 
 *Defined in*
 
-[packages/cozy-client/src/models/document/qualification.js:234](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/document/qualification.js#L234)
+[packages/cozy-client/src/models/document/qualification.js:243](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/document/qualification.js#L243)
diff --git a/packages/cozy-client/src/models/document/qualification.js b/packages/cozy-client/src/models/document/qualification.js
@@ -33,25 +33,34 @@ export class Qualification {
        * @type {string?}
        */
       this.label = qualification.label
-      /**
-       * @type {string?}
-       */
       const purpose = attributes.purpose || qualification.purpose
       if (purpose) {
+        /**
+         * @type {string?}
+         */
         this.purpose = purpose
       }
       const sourceCategory =
         attributes.sourceCategory || qualification.sourceCategory
       if (sourceCategory) {
+        /**
+         * @type {string?}
+         */
         this.sourceCategory = sourceCategory
       }
       const sourceSubCategory =
         attributes.sourceSubCategory || qualification.sourceSubCategory
       if (sourceSubCategory) {
+        /**
+         * @type {string?}
+         */
         this.sourceSubCategory = sourceSubCategory
       }
       const subjects = attributes.subjects || qualification.subjects
       if (subjects) {
+        /**
+         * @type {Array<string>?}
+         */
         this.subjects = subjects
       }
     } else {

diff --git a/packages/cozy-client/types/models/document/qualification.d.ts b/packages/cozy-client/types/models/document/qualification.d.ts
@@ -25,10 +25,22 @@ export class Qualification {
      * @type {string?}
      */
     label: string | null;
-    purpose: string;
-    sourceCategory: string;
-    sourceSubCategory: string;
-    subjects: string[];
+    /**
+     * @type {string?}
+     */
+    purpose: string | null;
+    /**
+     * @type {string?}
+     */
+    sourceCategory: string | null;
+    /**
+     * @type {string?}
+     */
+    sourceSubCategory: string | null;
+    /**
+     * @type {Array<string>?}
+     */
+    subjects: Array<string> | null;
     /**
      * Check the given qualification attributes respects the following rules:
      *   - For the given label, if a purpose, sourceCategory or sourceSubCategory