versioned-d.ts-tools 0.3.0 → 0.4.1

package/dist/dts-utilities.d.ts

@@ -7,7 +7,8 @@ declare enum FieldType {
     Property = "Property",
     Method = "Method",
     Event = "Event",
-    Enum = "Enum"
+    Enum = "Enum",
+    Function = "Function"
 }
 declare class FieldStruct {
     declarationString: string;

package/dist/dts-utilities.js

@@ -39,6 +39,7 @@ const ts = __importStar(require("typescript"));
 // capturing these because of eccentricities with the compiler ordering
 let topClass = null;
 let lastItem = null;
+let globalFunctionsClass = null;
 var ClassType;
 (function (ClassType) {
     ClassType["Class"] = "Class";
@@ -51,6 +52,7 @@ var FieldType;
     FieldType["Method"] = "Method";
     FieldType["Event"] = "Event";
     FieldType["Enum"] = "Enum";
+    FieldType["Function"] = "Function";
 })(FieldType || (FieldType = {}));
 class FieldStruct {
     constructor(decString, commentString, fieldType, fieldName) {
@@ -167,8 +169,14 @@ class APISet {
                 !clas.getClassName().endsWith("LoadOptions") &&
                 !clas.getClassName().endsWith("Data")) {
                 const className = clas.getClassName();
-                output += "|[" + className + "](/"
-                    + relativePath + className.toLowerCase() + ")|";
+                // Special handling for <global> - no link
+                if (className === "<global>") {
+                    output += "|*" + className + "*|";
+                }
+                else {
+                    output += "|[" + className + "](/"
+                        + relativePath + className.toLowerCase() + ")|";
+                }
                 // Ignore the following:
                 // - String literal overloads.
                 // - `load`, `set`, `track`, `untrack`, and `toJSON` methods
@@ -201,6 +209,14 @@ class APISet {
                             newItemText = newItemText.replace(/\?/g, "");
                             newItemText = newItemText.substring(0, newItemText.indexOf(":"));
                         }
+                        else if (field.type === FieldType.Function) {
+                            // For functions, extract just the function signature
+                            newItemText = newItemText.replace(/export\s+function\s+/g, "");
+                            // Remove the return type if it exists (everything after the last :)
+                            if (newItemText.lastIndexOf(":") > newItemText.indexOf(")")) {
+                                newItemText = newItemText.substring(0, newItemText.lastIndexOf(":"));
+                            }
+                        }
                         else {
                             // Remove the return type.
                             newItemText = newItemText.substring(0, newItemText.lastIndexOf(":"));
@@ -262,14 +278,25 @@ function removeAtLink(commentText) {
     return commentText;
 }
 function buildFieldLink(relativePath, className, field) {
+    // Special handling for global functions - use a different link format
+    if (className === "<global>") {
+        let hostName = relativePath.substring(relativePath.indexOf("/api/") + 5, relativePath.lastIndexOf("/"));
+        let fileName = relativePath.substring(relativePath.lastIndexOf("/") + 1, relativePath.lastIndexOf("."));
+        let anchorPrefix = hostName + "-" + fileName + "-";
+        return "/" + relativePath.substring(0, relativePath.lastIndexOf(".")) + "#" + anchorPrefix + field.name.toLowerCase() + "-function";
+    }
     // Build the standard link anchor format based on host.
     let hostName = relativePath.substring(relativePath.indexOf("/api/") + 5, relativePath.lastIndexOf("/"));
     let fileName = relativePath.substring(relativePath.lastIndexOf("/") + 1, relativePath.lastIndexOf("."));
     let anchorPrefix = hostName + "-" + fileName + "-";
-    let fieldLink = "/" + relativePath + className.toLowerCase() + "#" + anchorPrefix + className.toLowerCase() + "-" + field.name.toLowerCase() + (field.type === FieldType.Method ? "-member(1)" : "-member");
+    let fieldLink = "/" + relativePath + className.toLowerCase() + "#" + anchorPrefix + className.toLowerCase() + "-" + field.name.toLowerCase() + ((field.type === FieldType.Method || field.type === FieldType.Function) ? "-member(1)" : "-member");
     return fieldLink;
 }
 function parseDTS(fileName, fileContents) {
+    // Reset global state for new parse
+    topClass = null;
+    lastItem = null;
+    globalFunctionsClass = null;
     const node = ts.createSourceFile(fileName, fileContents, ts.ScriptTarget.ES2015, true);
     const allClasses = new APISet();
     parseDTSInternal(node, allClasses);
@@ -286,6 +313,9 @@ function parseDTSInternal(node, allClasses) {
         case ts.SyntaxKind.EnumDeclaration:
             parseDTSTopLevelItem(node, allClasses, ClassType.Enum);
             break;
+        case ts.SyntaxKind.FunctionDeclaration:
+            parseDTSGlobalFunctionItem(node, allClasses);
+            break;
         case ts.SyntaxKind.PropertySignature:
             parseDTSFieldItem(node, FieldType.Property);
             break;
@@ -331,4 +361,15 @@ function parseDTSFieldItem(node, type) {
     topClass.fields.push(newField);
     lastItem = newField;
 }
+function parseDTSGlobalFunctionItem(node, allClasses) {
+    // Create a "<global>" class to hold top-level functions if it doesn't exist
+    if (globalFunctionsClass === null) {
+        globalFunctionsClass = new ClassStruct("<global>", "", ClassType.Interface);
+        allClasses.addClass(globalFunctionsClass);
+    }
+    const functionName = node.name ? node.name.getText() : "anonymous";
+    const newFunction = new FieldStruct(node.getText(), "", FieldType.Function, functionName);
+    globalFunctionsClass.fields.push(newFunction);
+    lastItem = newFunction;
+}
 //# sourceMappingURL=dts-utilities.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "versioned-d.ts-tools",
-  "version": "0.3.0",
+  "version": "0.4.1",
   "description": "Tools for managing versioned TypeScript definition files",
   "main": "dist/index.js",
   "bin": {