Procházet zdrojové kódy

add type annotations with jsdoc

Yuki Takei před 1 rokem
rodič
revize
a7aeed1aeb

+ 7 - 5
apps/app/src/server/routes/apiv3/import.js

@@ -56,6 +56,7 @@ const router = express.Router();
  * @param {string} collectionName
  * @param {string} collectionName
  * @param {string} operatorUserId Operator user id
  * @param {string} operatorUserId Operator user id
  * @param {GrowiArchiveImportOption} options GrowiArchiveImportOption instance
  * @param {GrowiArchiveImportOption} options GrowiArchiveImportOption instance
+ * @return {import('~/server/service/import').OverwriteParams}
  */
  */
 export const generateOverwriteParams = (collectionName, operatorUserId, options) => {
 export const generateOverwriteParams = (collectionName, operatorUserId, options) => {
   switch (collectionName) {
   switch (collectionName) {
@@ -281,11 +282,12 @@ export default function route(crowi) {
       const options = new GrowiArchiveImportOption(null, optionsMap[collectionName]);
       const options = new GrowiArchiveImportOption(null, optionsMap[collectionName]);
 
 
       // generate options
       // generate options
-      const importSettings = importService.generateImportSettings(options.mode);
-      importSettings.jsonFileName = fileName;
-
-      // generate overwrite params
-      importSettings.overwriteParams = generateOverwriteParams(collectionName, req.user._id, options);
+      /** @type {import('~/server/service/import').ImportSettings} */
+      const importSettings = {
+        mode: options.mode,
+        jsonFileName: fileName,
+        overwriteParams: generateOverwriteParams(collectionName, req.user._id, options),
+      };
 
 
       importSettingsMap[collectionName] = importSettings;
       importSettingsMap[collectionName] = importSettings;
     });
     });

+ 1 - 1
apps/app/src/server/routes/apiv3/overwrite-params/attachmentFiles.chunks.js

@@ -7,7 +7,7 @@ class AttachmentFilesChunksOverwriteParamsFactory {
    * generate overwrite params object
    * generate overwrite params object
    * @param {string} operatorUserId
    * @param {string} operatorUserId
    * @param {ImportOptionForPages} option
    * @param {ImportOptionForPages} option
-   * @return object
+   * @return {import('~/server/service/import').OverwriteParams}
    *  key: property name
    *  key: property name
    *  value: any value or a function `(value, { document, schema, propertyName }) => { return newValue }`
    *  value: any value or a function `(value, { document, schema, propertyName }) => { return newValue }`
    */
    */

+ 1 - 1
apps/app/src/server/routes/apiv3/overwrite-params/pages.js

@@ -13,7 +13,7 @@ class PageOverwriteParamsFactory {
    * generate overwrite params object
    * generate overwrite params object
    * @param {string} operatorUserId
    * @param {string} operatorUserId
    * @param {ImportOptionForPages} option
    * @param {ImportOptionForPages} option
-   * @return object
+   * @return {import('~/server/service/import').OverwriteParams}
    *  key: property name
    *  key: property name
    *  value: any value or a function `(value, { document, schema, propertyName }) => { return newValue }`
    *  value: any value or a function `(value, { document, schema, propertyName }) => { return newValue }`
    */
    */

+ 1 - 1
apps/app/src/server/routes/apiv3/overwrite-params/revisions.js

@@ -11,7 +11,7 @@ class RevisionOverwriteParamsFactory {
    * generate overwrite params object
    * generate overwrite params object
    * @param {string} operatorUserId
    * @param {string} operatorUserId
    * @param {ImportOptionForPages} option
    * @param {ImportOptionForPages} option
-   * @return object
+   * @return {import('~/server/service/import').OverwriteParams}
    *  key: property name
    *  key: property name
    *  value: any value or a function `(value, { document, schema, propertyName }) => { return newValue }`
    *  value: any value or a function `(value, { document, schema, propertyName }) => { return newValue }`
    */
    */

+ 5 - 3
apps/app/src/server/service/g2g-transfer.ts

@@ -622,9 +622,11 @@ export class G2GTransferReceiverService implements Receiver {
         throw new Error('`attachmentFiles.files` must not be transferred. Please omit it from request body `collections`.');
         throw new Error('`attachmentFiles.files` must not be transferred. Please omit it from request body `collections`.');
       }
       }
 
 
-      const importSettings = importService.generateImportSettings(options.mode);
-      importSettings.jsonFileName = fileName;
-      importSettings.overwriteParams = generateOverwriteParams(collectionName, operatorUserId, options);
+      const importSettings: ImportSettings = {
+        mode: options.mode,
+        jsonFileName: fileName,
+        overwriteParams: generateOverwriteParams(collectionName, operatorUserId, options),
+      };
       importSettingsMap[collectionName] = importSettings;
       importSettingsMap[collectionName] = importSettings;
     });
     });