versioned-d.ts-tools 0.1.0 → 0.3.0

package/README.md

@@ -23,27 +23,80 @@ npm install versioned-d.ts-tools
 Removes specific API versions from TypeScript definition files.
 
 ```bash
-version-remover [source d.ts] [API set name] [output file name]
+version-remover [source d.ts] [output file name] [version string] [optional config file]
 ```
 
-**Example:**
+**Examples:**
+
 ```bash
-version-remover excel.d.ts "ExcelApi 1.8" excel_1_7.d.ts
+# Basic usage
+version-remover excel.d.ts excel_1_7.d.ts "Api set: ExcelApi 1.8"
+
+# With configuration file for custom replacements
+version-remover excel.d.ts excel_1_18.d.ts "Api set: ExcelApi 1.19" my-excel-config.json
 ```
 
-This tool removes all declarations marked with the specified API set version from the source `.d.ts` file and creates a new file with the remaining declarations.
+This tool removes all declarations marked with the specified version string from the source `.d.ts` file and creates a new file with the remaining declarations.
+
+#### Configuration File
+
+You can provide an optional JSON configuration file to specify additional text replacements that should be applied after removing the API version. This is useful for cleaning up type unions or references that become invalid after removing certain APIs.
+
+Some API versions (like "Api set: ExcelApi 1.19", "Api set: ExcelApi 1.11", "Api set: Mailbox 1.14", etc.) may require custom replacements to handle type union cleanups and parameter removals. You'll need to create configuration files for these scenarios based on your specific needs.
+
+You can provide an optional JSON configuration file to specify additional text replacements that should be applied after removing the API version. This is useful for cleaning up type unions or references that become invalid after removing certain APIs.
+
+**Configuration file format:**
+
+```json
+{
+  "replacements": [
+    {
+      "find": "old text to find",
+      "replace": "replacement text",
+      "description": "Optional description of what this replacement does"
+    },
+    {
+      "find": "/regex pattern/g",
+      "replace": "replacement",
+      "isRegex": true,
+      "description": "Example regex replacement"
+    }
+  ]
+}
+```
+
+**Example configuration:**
+
+```json
+{
+  "replacements": [
+    {
+      "find": "type CardLayoutSection = CardLayoutListSection | CardLayoutTableSection | CardLayoutTwoColumnSection;",
+      "replace": "type CardLayoutSection = CardLayoutListSection | CardLayoutTableSection;",
+      "description": "Remove CardLayoutTwoColumnSection from union type"
+    },
+    {
+      "find": "icon?: string | EntityCompactLayoutIcons;",
+      "replace": "icon?: string;",
+      "description": "Remove EntityCompactLayoutIcons from icon property"
+    }
+  ]
+}
+```
 
 ### whats-new
 
 Compares two TypeScript definition files and generates a markdown report of the differences.
 
 ```bash
-whats-new [host name] [new d.ts] [old d.ts] [output file name (minus extension)]
+whats-new [new d.ts] [old d.ts] [output file name (minus extension)] [relative path]
 ```
 
 **Example:**
+
 ```bash
-whats-new Excel excel_1_9.d.ts excel_1_8.d.ts excel_whats_new
+whats-new excel_1_9.d.ts excel_1_8.d.ts excel_whats_new javascript/api/excel/excel.
 ```
 
 This generates a `excel_whats_new.md` file containing a markdown table showing what's new between the two versions.

package/dist/dts-utilities.d.ts

@@ -1,41 +1,41 @@
-declare enum ClassType {
-    Class = "Class",
-    Interface = "Interface",
-    Enum = "Enum"
-}
-declare enum FieldType {
-    Property = "Property",
-    Method = "Method",
-    Event = "Event",
-    Enum = "Enum"
-}
-declare class FieldStruct {
-    declarationString: string;
-    comment: string;
-    type: FieldType;
-    name: string;
-    constructor(decString: string, commentString: string, fieldType: FieldType, fieldName: string);
-}
-declare class ClassStruct {
-    declarationString: string;
-    comment: string;
-    type: ClassType;
-    fields: FieldStruct[];
-    constructor(decString: any, commentString: string, classType: ClassType);
-    copyWithoutFields(): ClassStruct;
-    sortFields(): void;
-    getClassName(): string;
-}
-export declare class APISet {
-    api: ClassStruct[];
-    constructor();
-    addClass(clas: ClassStruct): void;
-    containsClass(clas: ClassStruct): boolean;
-    containsField(clas: ClassStruct, field: FieldStruct): boolean;
-    diff(other: APISet): APISet;
-    getAsDTS(): string;
-    getAsMarkdown(relativePath: string): string;
-    sort(): void;
-}
-export declare function parseDTS(fileName: string, fileContents: string): APISet;
-export {};
+declare enum ClassType {
+    Class = "Class",
+    Interface = "Interface",
+    Enum = "Enum"
+}
+declare enum FieldType {
+    Property = "Property",
+    Method = "Method",
+    Event = "Event",
+    Enum = "Enum"
+}
+declare class FieldStruct {
+    declarationString: string;
+    comment: string;
+    type: FieldType;
+    name: string;
+    constructor(decString: string, commentString: string, fieldType: FieldType, fieldName: string);
+}
+declare class ClassStruct {
+    declarationString: string;
+    comment: string;
+    type: ClassType;
+    fields: FieldStruct[];
+    constructor(decString: any, commentString: string, classType: ClassType);
+    copyWithoutFields(): ClassStruct;
+    sortFields(): void;
+    getClassName(): string;
+}
+export declare class APISet {
+    api: ClassStruct[];
+    constructor();
+    addClass(clas: ClassStruct): void;
+    containsClass(clas: ClassStruct): boolean;
+    containsField(clas: ClassStruct, field: FieldStruct): boolean;
+    diff(other: APISet): APISet;
+    getAsDTS(): string;
+    getAsMarkdown(relativePath: string): string;
+    sort(): void;
+}
+export declare function parseDTS(fileName: string, fileContents: string): APISet;
+export {};