versioned-d.ts-tools 0.1.0 → 0.2.0

package/README.md

@@ -23,16 +23,64 @@ 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] [API set name] [output file name] [optional config file]
 ```
 
-**Example:**
+**Examples:**
+
 ```bash
+# Basic usage
 version-remover excel.d.ts "ExcelApi 1.8" excel_1_7.d.ts
+
+# With configuration file for custom replacements
+version-remover excel.d.ts "ExcelApi 1.8" excel_1_7.d.ts 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.
 
+#### 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.
+
+**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.
@@ -42,6 +90,7 @@ whats-new [host name] [new d.ts] [old d.ts] [output file name (minus extension)]
 ```
 
 **Example:**
+
 ```bash
 whats-new Excel excel_1_9.d.ts excel_1_8.d.ts excel_whats_new
 ```

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 {};