[Word] Fix generatedocs error re ImportedStylesConflictBehavior (#2150)

OfficeDev · Dec 5, 2024 · 2f61cf2 · 2f61cf2
1 parent a2112eb
commit 2f61cf2
Show file tree

Hide file tree

Showing 19 changed files with 74 additions and 41 deletions.
diff --git a/docs/docs-ref-autogen/word_1_6/word/word.document.yml b/docs/docs-ref-autogen/word_1_6/word/word.document.yml
@@ -661,10 +661,10 @@ methods:
       return:
         type: '<xref uid="word!Word.StyleCollection:class" />'
         description: ''
-  - name: importStylesFromJson(stylesJson)
+  - name: 'importStylesFromJson(stylesJson, importedStylesConflictBehavior)'
     uid: 'word!Word.Document#importStylesFromJson:member(1)'
     package: word!
-    fullName: importStylesFromJson(stylesJson)
+    fullName: 'importStylesFromJson(stylesJson, importedStylesConflictBehavior)'
     summary: Import styles from a JSON-formatted string.
     remarks: >-
       \[ [API set: WordApi 1.6](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
@@ -696,11 +696,18 @@ methods:
     isPreview: false
     isDeprecated: false
     syntax:
-      content: 'importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult<string[]>;'
+      content: >-
+        importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior):
+        OfficeExtension.ClientResult<string[]>;
       parameters:
         - id: stylesJson
           description: Required. A JSON-formatted string representing the styles.
           type: string
+        - id: importedStylesConflictBehavior
+          description: >-
+            Optional. Specifies how to handle any imported styles with the same name as existing styles in the current
+            document.
+          type: Word.ImportedStylesConflictBehavior
       return:
         type: '<xref uid="office!OfficeExtension.ClientResult:class" />&lt;string[]&gt;'
         description: ''

diff --git a/docs/docs-ref-autogen/word_1_7/word/word.document.yml b/docs/docs-ref-autogen/word_1_7/word/word.document.yml
@@ -678,10 +678,10 @@ methods:
       return:
         type: '<xref uid="word!Word.StyleCollection:class" />'
         description: ''
-  - name: importStylesFromJson(stylesJson)
+  - name: 'importStylesFromJson(stylesJson, importedStylesConflictBehavior)'
     uid: 'word!Word.Document#importStylesFromJson:member(1)'
     package: word!
-    fullName: importStylesFromJson(stylesJson)
+    fullName: 'importStylesFromJson(stylesJson, importedStylesConflictBehavior)'
     summary: Import styles from a JSON-formatted string.
     remarks: >-
       \[ [API set: WordApi 1.6](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
@@ -713,11 +713,18 @@ methods:
     isPreview: false
     isDeprecated: false
     syntax:
-      content: 'importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult<string[]>;'
+      content: >-
+        importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior):
+        OfficeExtension.ClientResult<string[]>;
       parameters:
         - id: stylesJson
           description: Required. A JSON-formatted string representing the styles.
           type: string
+        - id: importedStylesConflictBehavior
+          description: >-
+            Optional. Specifies how to handle any imported styles with the same name as existing styles in the current
+            document.
+          type: Word.ImportedStylesConflictBehavior
       return:
         type: '<xref uid="office!OfficeExtension.ClientResult:class" />&lt;string[]&gt;'
         description: ''

diff --git a/docs/docs-ref-autogen/word_1_8/word/word.document.yml b/docs/docs-ref-autogen/word_1_8/word/word.document.yml
@@ -678,10 +678,10 @@ methods:
       return:
         type: '<xref uid="word!Word.StyleCollection:class" />'
         description: ''
-  - name: importStylesFromJson(stylesJson)
+  - name: 'importStylesFromJson(stylesJson, importedStylesConflictBehavior)'
     uid: 'word!Word.Document#importStylesFromJson:member(1)'
     package: word!
-    fullName: importStylesFromJson(stylesJson)
+    fullName: 'importStylesFromJson(stylesJson, importedStylesConflictBehavior)'
     summary: Import styles from a JSON-formatted string.
     remarks: >-
       \[ [API set: WordApi 1.6](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
@@ -713,11 +713,18 @@ methods:
     isPreview: false
     isDeprecated: false
     syntax:
-      content: 'importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult<string[]>;'
+      content: >-
+        importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior):
+        OfficeExtension.ClientResult<string[]>;
       parameters:
         - id: stylesJson
           description: Required. A JSON-formatted string representing the styles.
           type: string
+        - id: importedStylesConflictBehavior
+          description: >-
+            Optional. Specifies how to handle any imported styles with the same name as existing styles in the current
+            document.
+          type: Word.ImportedStylesConflictBehavior
       return:
         type: '<xref uid="office!OfficeExtension.ClientResult:class" />&lt;string[]&gt;'
         description: ''

diff --git a/docs/docs-ref-autogen/word_1_9/word/word.document.yml b/docs/docs-ref-autogen/word_1_9/word/word.document.yml
@@ -678,10 +678,10 @@ methods:
       return:
         type: '<xref uid="word!Word.StyleCollection:class" />'
         description: ''
-  - name: importStylesFromJson(stylesJson)
+  - name: 'importStylesFromJson(stylesJson, importedStylesConflictBehavior)'
     uid: 'word!Word.Document#importStylesFromJson:member(1)'
     package: word!
-    fullName: importStylesFromJson(stylesJson)
+    fullName: 'importStylesFromJson(stylesJson, importedStylesConflictBehavior)'
     summary: Import styles from a JSON-formatted string.
     remarks: >-
       \[ [API set: WordApi 1.6](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
@@ -713,11 +713,18 @@ methods:
     isPreview: false
     isDeprecated: false
     syntax:
-      content: 'importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult<string[]>;'
+      content: >-
+        importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior):
+        OfficeExtension.ClientResult<string[]>;
       parameters:
         - id: stylesJson
           description: Required. A JSON-formatted string representing the styles.
           type: string
+        - id: importedStylesConflictBehavior
+          description: >-
+            Optional. Specifies how to handle any imported styles with the same name as existing styles in the current
+            document.
+          type: Word.ImportedStylesConflictBehavior
       return:
         type: '<xref uid="office!OfficeExtension.ClientResult:class" />&lt;string[]&gt;'
         description: ''

diff --git a/docs/docs-ref-autogen/word_online/word/word.document.yml b/docs/docs-ref-autogen/word_online/word/word.document.yml
@@ -678,10 +678,10 @@ methods:
       return:
         type: '<xref uid="word!Word.StyleCollection:class" />'
         description: ''
-  - name: importStylesFromJson(stylesJson)
+  - name: 'importStylesFromJson(stylesJson, importedStylesConflictBehavior)'
     uid: 'word!Word.Document#importStylesFromJson:member(1)'
     package: word!
-    fullName: importStylesFromJson(stylesJson)
+    fullName: 'importStylesFromJson(stylesJson, importedStylesConflictBehavior)'
     summary: Import styles from a JSON-formatted string.
     remarks: >-
       \[ [API set: WordApi 1.6](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
@@ -713,11 +713,18 @@ methods:
     isPreview: false
     isDeprecated: false
     syntax:
-      content: 'importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult<string[]>;'
+      content: >-
+        importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior):
+        OfficeExtension.ClientResult<string[]>;
       parameters:
         - id: stylesJson
           description: Required. A JSON-formatted string representing the styles.
           type: string
+        - id: importedStylesConflictBehavior
+          description: >-
+            Optional. Specifies how to handle any imported styles with the same name as existing styles in the current
+            document.
+          type: Word.ImportedStylesConflictBehavior
       return:
         type: '<xref uid="office!OfficeExtension.ClientResult:class" />&lt;string[]&gt;'
         description: ''

diff --git a/docs/includes/word-1_6.md b/docs/includes/word-1_6.md
@@ -4,7 +4,7 @@
 |[Body](/javascript/api/word/word.body)|[getTrackedChanges()](/javascript/api/word/word.body#word-word-body-gettrackedchanges-member(1))|Gets the collection of the TrackedChange objects in the body.|
 |[ContentControl](/javascript/api/word/word.contentcontrol)|[getTrackedChanges()](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-gettrackedchanges-member(1))|Gets the collection of the TrackedChange objects in the content control.|
 |[Document](/javascript/api/word/word.document)|[getParagraphByUniqueLocalId(id: string)](/javascript/api/word/word.document#word-word-document-getparagraphbyuniquelocalid-member(1))|Gets the paragraph by its unique local ID.|
-||[importStylesFromJson(stylesJson: string)](/javascript/api/word/word.document#word-word-document-importstylesfromjson-member(1))|Import styles from a JSON-formatted string.|
+||[importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior)](/javascript/api/word/word.document#word-word-document-importstylesfromjson-member(1))|Import styles from a JSON-formatted string.|
 ||[onParagraphAdded](/javascript/api/word/word.document#word-word-document-onparagraphadded-member)|Occurs when the user adds new paragraphs.|
 ||[onParagraphChanged](/javascript/api/word/word.document#word-word-document-onparagraphchanged-member)|Occurs when the user changes paragraphs.|
 ||[onParagraphDeleted](/javascript/api/word/word.document#word-word-document-onparagraphdeleted-member)|Occurs when the user deletes paragraphs.|

diff --git a/docs/includes/word-desktop-1.1.md b/docs/includes/word-desktop-1.1.md
@@ -17,7 +17,6 @@
 ||[outsideBorderType](/javascript/api/word/word.bordercollection#word-word-bordercollection-outsidebordertype-member)|Specifies the border type of the outside borders.|
 ||[outsideBorderWidth](/javascript/api/word/word.bordercollection#word-word-bordercollection-outsideborderwidth-member)|Specifies the width of the outside borders.|
 |[Document](/javascript/api/word/word.document)|[compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions)](/javascript/api/word/word.document#word-word-document-compare-member(1))|Displays revision marks that indicate where the specified document differs from another document.|
-||[importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior)](/javascript/api/word/word.document#word-word-document-importstylesfromjson-member(1))|Import styles from a JSON-formatted string.|
 |[DocumentCompareOptions](/javascript/api/word/word.documentcompareoptions)|[addToRecentFiles](/javascript/api/word/word.documentcompareoptions#word-word-documentcompareoptions-addtorecentfiles-member)|True adds the document to the list of recently used files on the File menu.|
 ||[authorName](/javascript/api/word/word.documentcompareoptions#word-word-documentcompareoptions-authorname-member)|The reviewer name associated with the differences generated by the comparison.|
 ||[compareTarget](/javascript/api/word/word.documentcompareoptions#word-word-documentcompareoptions-comparetarget-member)|The target document for the comparison.|

diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop1.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop1.d.ts
@@ -2927,9 +2927,9 @@ export declare namespace Word {
          * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1.
          *
          * @param stylesJson - Required. A JSON-formatted string representing the styles.
-         * 
+         * @param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document.
          */
-        importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult<string[]>;
+        importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult<string[]>;
         /**
          * Import styles from a JSON-formatted string.
          *

diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop2.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop2.d.ts
@@ -2858,9 +2858,9 @@ export declare namespace Word {
          * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1.
          *
          * @param stylesJson - Required. A JSON-formatted string representing the styles.
-         * 
+         * @param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document.
          */
-        importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult<string[]>;
+        importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult<string[]>;
         /**
          * Import styles from a JSON-formatted string.
          *

diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop3.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop3.d.ts
@@ -2425,9 +2425,9 @@ export declare namespace Word {
          * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1.
          *
          * @param stylesJson - Required. A JSON-formatted string representing the styles.
-         * 
+         * @param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document.
          */
-        importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult<string[]>;
+        importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult<string[]>;
         /**
          * Import styles from a JSON-formatted string.
          *

diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_6/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_6/word.d.ts
@@ -2425,9 +2425,9 @@ export declare namespace Word {
          * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1.
          *
          * @param stylesJson - Required. A JSON-formatted string representing the styles.
-         * 
+         * @param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document.
          */
-        importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult<string[]>;
+        importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult<string[]>;
         /**
          * Import styles from a JSON-formatted string.
          *

diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_7/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_7/word.d.ts
@@ -2858,9 +2858,9 @@ export declare namespace Word {
          * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1.
          *
          * @param stylesJson - Required. A JSON-formatted string representing the styles.
-         * 
+         * @param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document.
          */
-        importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult<string[]>;
+        importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult<string[]>;
         /**
          * Import styles from a JSON-formatted string.
          *

diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_8/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_8/word.d.ts
@@ -2927,9 +2927,9 @@ export declare namespace Word {
          * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1.
          *
          * @param stylesJson - Required. A JSON-formatted string representing the styles.
-         * 
+         * @param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document.
          */
-        importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult<string[]>;
+        importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult<string[]>;
         /**
          * Import styles from a JSON-formatted string.
          *

diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_9/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_9/word.d.ts
@@ -3083,9 +3083,9 @@ export declare namespace Word {
          * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1.
          *
          * @param stylesJson - Required. A JSON-formatted string representing the styles.
-         * 
+         * @param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document.
          */
-        importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult<string[]>;
+        importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult<string[]>;
         /**
          * Import styles from a JSON-formatted string.
          *

diff --git a/generate-docs/api-extractor-inputs-word-release/word_online/word-online1.d.ts b/generate-docs/api-extractor-inputs-word-release/word_online/word-online1.d.ts
@@ -3083,9 +3083,9 @@ export declare namespace Word {
          * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1.
          *
          * @param stylesJson - Required. A JSON-formatted string representing the styles.
-         * 
+         * @param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document.
          */
-        importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult<string[]>;
+        importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult<string[]>;
         /**
          * Import styles from a JSON-formatted string.
          *

diff --git a/generate-docs/api-extractor-inputs-word-release/word_online/word-online2.d.ts b/generate-docs/api-extractor-inputs-word-release/word_online/word-online2.d.ts
@@ -3083,9 +3083,9 @@ export declare namespace Word {
          * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1.
          *
          * @param stylesJson - Required. A JSON-formatted string representing the styles.
-         * 
+         * @param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document.
          */
-        importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult<string[]>;
+        importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult<string[]>;
         /**
          * Import styles from a JSON-formatted string.
          *

diff --git a/generate-docs/api-extractor-inputs-word-release/word_online/word-online3.d.ts b/generate-docs/api-extractor-inputs-word-release/word_online/word-online3.d.ts
@@ -3083,9 +3083,9 @@ export declare namespace Word {
          * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1.
          *
          * @param stylesJson - Required. A JSON-formatted string representing the styles.
-         * 
+         * @param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document.
          */
-        importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult<string[]>;
+        importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult<string[]>;
         /**
          * Import styles from a JSON-formatted string.
          *

diff --git a/generate-docs/api-extractor-inputs-word-release/word_online/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_online/word.d.ts
@@ -3083,9 +3083,9 @@ export declare namespace Word {
          * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1.
          *
          * @param stylesJson - Required. A JSON-formatted string representing the styles.
-         * 
+         * @param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document.
          */
-        importStylesFromJson(stylesJson: string, ): OfficeExtension.ClientResult<string[]>;
+        importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult<string[]>;
         /**
          * Import styles from a JSON-formatted string.
          *

diff --git a/generate-docs/tools/version-remover.ts b/generate-docs/tools/version-remover.ts
@@ -62,8 +62,7 @@ if (process.argv[3] === "Mailbox 1.12") {
 
 if (process.argv[3] === "WordApiDesktop 1.1") {
     console.log("Address ImportedStylesConflictBehavior reference when removing WordApiDesktop 1.1");
-    wholeDts = wholeDts.replace(/importedStylesConflictBehavior\?: Word.ImportedStylesConflictBehavior/g, "");
-    wholeDts = wholeDts.replace(/@param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document./g, "");
+    wholeDts = wholeDts.replace(/importedStylesConflictBehavior\?: Word.ImportedStylesConflictBehavior/g, "importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior");
 }
 
 fsx.writeFileSync(process.argv[4], wholeDts);