diff --git a/doc-uml/famix-typescript-model.puml b/doc-uml/famix-typescript-model.puml index 3a63df5..07ee8bc 100644 --- a/doc-uml/famix-typescript-model.puml +++ b/doc-uml/famix-typescript-model.puml @@ -526,75 +526,11 @@ class ParameterConcretization extends Entity { +concreteParameter: PrimitiveType +concretizations: Set } -+isFQNNode(node: Node): boolean -+buildStageMethodMap(sourceFile: SourceFile): Map -+buildMethodPositionMap(sourceFile: SourceFile): Map -+getFQN(node: Node | FQNNode): string -+getUniqueFQN(node: Node): string | undefined -+getNameOfNode(a: Node): string -+getParameters(a: Node): string -+getFQNUnresolvedInheritedClassOrInterface(unresolvedInheritedClassOrInterface: ExpressionWithTypeArguments): string -+resetProcessFunctions(): void -+isSourceFileAModule(sourceFile: SourceFile): boolean -+getModulePath(importDecl: ImportDeclaration): string -+getImplementedOrExtendedInterfaces(interfaces: InterfaceDeclaration[], subClass: ClassDeclaration | InterfaceDeclaration): (InterfaceDeclaration | ExpressionWithTypeArguments)[] -+processFiles(sourceFiles: SourceFile[]): void -+processFile(f: SourceFile): void -+isAmbient(node: ModuleDeclaration): boolean -+isNamespace(node: ModuleDeclaration): boolean -+processModule(m: ModuleDeclaration): Famix.Module -+processAliases(m: ContainerTypes, fmxScope: ScopedTypes): void -+processClasses(m: SourceFile | ModuleDeclaration, fmxScope: Famix.Module | Famix.ScriptEntity): void -+getArrowFunctionClasses(f: ArrowFunction): ClassDeclaration[] -+getClassesDeclaredInArrowFunctions(s: SourceFile | ModuleDeclaration): ClassDeclaration[] -+processInterfaces(m: SourceFile | ModuleDeclaration, fmxScope: Famix.Module | Famix.ScriptEntity): void -+processVariables(m: ContainerTypes, fmxScope: Famix.Module | Famix.ScriptEntity | Famix.Method | Famix.Accessor | Famix.Function): void -+processEnums(m: ContainerTypes, fmxScope: ScopedTypes): void -+processFunctions(m: ContainerTypes, fmxScope: ScopedTypes): void -+processModules(m: SourceFile | ModuleDeclaration, fmxScope: Famix.Module | Famix.ScriptEntity): void -+processAlias(a: TypeAliasDeclaration): Famix.Alias -+processClass(c: ClassDeclaration): Famix.Class | Famix.ParametricClass -+processInterface(i: InterfaceDeclaration): Famix.Interface | Famix.ParametricInterface -+processStructuredType(c: ClassDeclaration | InterfaceDeclaration, fmxScope: Famix.Class | Famix.Interface | Famix.ParametricClass | Famix.ParametricInterface): void -+processProperty(p: PropertyDeclaration | PropertySignature): Famix.Property -+processMethod(m: MethodDeclaration | MethodSignature | ConstructorDeclaration | GetAccessorDeclaration | SetAccessorDeclaration): Famix.Method | Famix.Accessor -+processFunction(f: ArrowFunction | FunctionDeclaration | FunctionExpression): Famix.Function -+processFunctionExpressions(f: MethodDeclaration | FunctionDeclaration | ConstructorDeclaration | GetAccessorDeclaration | SetAccessorDeclaration, fmxScope: Famix.Method | Famix.Accessor | Famix.Function): void -+processParameters(m: ArrowFunction | MethodDeclaration | MethodSignature | FunctionDeclaration | FunctionExpression | ConstructorDeclaration | GetAccessorDeclaration | SetAccessorDeclaration, fmxScope: Famix.Method | Famix.Accessor | Famix.Function): void -+processParameterAsProperty(param: ParameterDeclaration, classDecl: ClassDeclaration | ClassExpression): Famix.Property -+convertParameterToPropertyRepresentation(param: ParameterDeclaration): { name: string; type: string; scope: Scope; isReadonly: boolean; } -+processParameter(paramDecl: ParameterDeclaration): Famix.Parameter -+processTypeParameters(e: ArrowFunction | MethodDeclaration | MethodSignature | FunctionDeclaration | FunctionExpression | ... 4 more ... | InterfaceDeclaration, fmxScope: Famix.Method | Famix.ArrowFunction | Famix.ParametricClass | Famix.ParametricInterface | Famix.Accessor | Famix.Function): void -+processTypeParameter(tp: TypeParameterDeclaration): Famix.TypeParameter -+processVariableStatement(v: VariableStatement): Famix.Variable[] -+processVariable(v: VariableDeclaration): Famix.Variable -+processEnum(e: EnumDeclaration): Famix.Enum -+processEnumValue(v: EnumMember): Famix.EnumValue -+processDecorators(e: MethodDeclaration | PropertyDeclaration | GetAccessorDeclaration | SetAccessorDeclaration | ParameterDeclaration | ClassDeclaration, fmxScope: Famix.Class | Famix.Property | Famix.Method | Famix.ParametricClass | Famix.Accessor | Famix.Parameter): void -+processDecorator(d: Decorator, e: MethodDeclaration | PropertyDeclaration | GetAccessorDeclaration | SetAccessorDeclaration | ParameterDeclaration | ClassDeclaration): Famix.Decorator -+processComments(e: SourceFile | VariableDeclaration | ArrowFunction | MethodDeclaration | MethodSignature | ... 16 more ... | VariableStatement, fmxScope: Famix.NamedEntity): void -+processComment(c: CommentRange, fmxScope: Famix.NamedEntity): Famix.Comment -+processAccesses(accessMap: Map): void -+processNodeForAccesses(n: Identifier, id: number): void -+processImportClausesForImportEqualsDeclarations(sourceFiles: SourceFile[], exports: ReadonlyMap[]): void -+processImportClausesForModules(modules: SourceFile[], exports: ReadonlyMap[]): void -+isInExports(exports: ReadonlyMap[], importedEntityName: string): boolean -+processInheritances(classes: ClassDeclaration[], interfaces: InterfaceDeclaration[]): void -+processInvocations(methodsAndFunctionsWithId: Map): void -+processNodeForInvocations(nodeReferencingInvocable: Identifier, invocable: InvocableType, id: number): void -+processConcretizations(classes: ClassDeclaration[], interfaces: InterfaceDeclaration[], functions: Map): void interface SearchParameters { +searchArray: string[] +targetArray: string[] +start?: number | undefined } -+indexOfSplitArray(params: SearchParameters): number -+getSubTypeName(fmxNamedEntity: Famix.NamedEntity): "Class" | "Interface" | "Function" | "Enum" | "EnumValue" | "Alias" | "Variable" | "Type" | "Method" | "Decorator" | "Accessor" | "Parameter" | "Property" | "NamedEntity" -+computeSignature(text: string): string -+findAncestor(node: Identifier): Node -+findTypeAncestor(element: Node): Node | undefined -+arraysAreEqual(array1: string[], array2: string[]): boolean -+replaceLastBetweenTags(input: string, replacement: string): string class EntityDictionary { +famixRep: FamixRepository -fmxAliasMap: Map @@ -626,15 +562,15 @@ class EntityDictionary { +createOrGetFamixInterface(inter: InterfaceDeclaration): Famix.Interface | Famix.ParametricInterface +createOrGetFamixConcreteElement(concreteElement: ParametricVariantType, concreteElementDeclaration: ConcreteElementTSMorphType, concreteArguments: TypeNode[]): ParametricVariantType +createFamixProperty(property: PropertyDeclaration | PropertySignature): Famix.Property - +createOrGetFamixMethod(method: MethodDeclaration | MethodSignature | ConstructorDeclaration | GetAccessorDeclaration | SetAccessorDeclaration, currentCC: { [key: string]: number; }): Famix.Method | Famix.ParametricMethod | Famix.Accessor - +createOrGetFamixFunction(func: FunctionDeclaration | FunctionExpression, currentCC: { [key: string]: number; }): Famix.Function | Famix.ParametricFunction + +createOrGetFamixMethod(method: ConstructorDeclaration | MethodSignature | GetAccessorDeclaration | SetAccessorDeclaration | MethodDeclaration, currentCC: { [key: string]: number; }): Famix.Method | Famix.ParametricMethod | Famix.Accessor + +createOrGetFamixFunction(func: FunctionExpression | FunctionDeclaration, currentCC: { [key: string]: number; }): Famix.Function | Famix.ParametricFunction +createOrGetFamixParameter(param: ParameterDeclaration): Famix.Parameter +createFamixTypeParameter(tp: TypeParameterDeclaration): Famix.TypeParameter +createOrGetFamixVariable(variable: VariableDeclaration): Famix.Variable +createOrGetFamixEntityTyping(entity: Famix.BehavioralEntity | Famix.StructuralEntity, type: Famix.Type): Famix.EntityTyping +createOrGetFamixEnum(enumEntity: EnumDeclaration): Famix.Enum +createFamixEnumValue(enumMember: EnumMember): Famix.EnumValue - +createOrGetFamixDecorator(decorator: Decorator, decoratedEntity: MethodDeclaration | PropertyDeclaration | GetAccessorDeclaration | SetAccessorDeclaration | ParameterDeclaration | ClassDeclaration): Famix.Decorator + +createOrGetFamixDecorator(decorator: Decorator, decoratedEntity: PropertyDeclaration | GetAccessorDeclaration | SetAccessorDeclaration | ParameterDeclaration | ClassDeclaration | MethodDeclaration): Famix.Decorator +createFamixComment(comment: CommentRange, fmxScope: Famix.NamedEntity, isJSDoc: boolean): Famix.Comment +createOrGetFamixType(typeNameArg: string, tsMorphType: Type | undefined, element: TSMorphTypeDeclaration): Famix.Type +createOrGetFamixParametricType(typeName: string, element: TSMorphParametricType): Famix.Type @@ -651,17 +587,11 @@ class EntityDictionary { +createFamixParameterConcretization(concretization: Famix.Concretization): Famix.ParameterConcretization | undefined +createFamixConcretizationClassOrInterfaceSpecialisation(element: ClassDeclaration | InterfaceDeclaration): void +createFamixConcretizationGenericInstantiation(cls: ClassDeclaration): void - +createFamixConcretizationFunctionInstantiation(element: MethodDeclaration | FunctionDeclaration): void + +createFamixConcretizationFunctionInstantiation(element: FunctionDeclaration | MethodDeclaration): void +createFamixConcretizationInterfaceClass(cls: ClassDeclaration): void +createFamixConcretizationTypeInstanciation(element: ClassDeclaration | InterfaceDeclaration): void +convertToRelativePath(absolutePath: string, absolutePathProject: string): string } -+isPrimitiveType(typeName: string): boolean -+initFQN(sourceElement: TSMorphObjectType, famixElement: Famix.SourcedEntity): void -+isTypeContext(sourceElement: TSMorphObjectType): boolean -+getInterfaceOrClassDeclarationFromExpression(expression: ExpressionWithTypeArguments): ClassDeclaration | InterfaceDeclaration | undefined -+resolveSymbolToInterfaceOrClassDeclaration(symbol: TSMorphSymbol): ClassDeclaration | InterfaceDeclaration | undefined -+getPrimitiveTypeName(type: Type): string | undefined class FamixRepository { -elements: Set -famixClasses: Set @@ -707,7 +637,6 @@ class FamixRepository { +removeEntitiesBySourceFile(sourceFile: string): FamixBaseElement[] +removeRelatedAssociations(entities: FamixBaseElement[]): void } -+convertToRelativePath(absolutePath: string, absolutePathProject: string): string enum SourceFileChangeType { Create Update @@ -722,7 +651,6 @@ class Importer { +updateFamixModelIncrementally(sourceFileChangeMap: Map): void -processReferences(sourceFiles: SourceFile[], allExistingSourceFiles: SourceFile[]): void } -+initFamixRep(project: Project): void abstract class FamixBaseElement { +id: number +{abstract} getJSON(): string diff --git a/package-lock.json b/package-lock.json index 62090da..2899f54 100644 --- a/package-lock.json +++ b/package-lock.json @@ -30,7 +30,7 @@ "globals": "^16.0.0", "jest": "^29.7.0", "jscpd": "^4.0.5", - "tplant": "^3.1.0", + "tplant": "^3.0.0", "ts-jest": "^29.2.6", "ts-node": "^10.9.2", "typedoc": "^0.28.0", @@ -4915,73 +4915,6 @@ "dev": true, "license": "MIT" }, - "node_modules/node-nailgun-client": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/node-nailgun-client/-/node-nailgun-client-0.1.2.tgz", - "integrity": "sha512-OC611lR0fsDUSptwnhBf8d3sj4DZ5fiRKfS2QaGPe0kR3Dt9YoZr1MY7utK0scFPTbXuQdSBBbeoKYVbME1q5g==", - "dev": true, - "license": "Apache v2", - "dependencies": { - "commander": "^2.8.1" - }, - "bin": { - "node-nailgun-client": "index.js" - } - }, - "node_modules/node-nailgun-client/node_modules/commander": { - "version": "2.20.3", - "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", - "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/node-nailgun-server": { - "version": "0.1.4", - "resolved": "https://registry.npmjs.org/node-nailgun-server/-/node-nailgun-server-0.1.4.tgz", - "integrity": "sha512-e0Hbh6XPb/7GqATJ45BePaUEO5AwR7InRW/pGeMKHH1cqPMBFCeqdBNfvi+bkVLnsbYOOQE+pAek9nmNoD8sYw==", - "dev": true, - "license": "Apache-2.0", - "dependencies": { - "commander": "^2.8.1" - }, - "bin": { - "node-nailgun-server": "index.js" - } - }, - "node_modules/node-nailgun-server/node_modules/commander": { - "version": "2.20.3", - "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", - "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", - "dev": true, - "license": "MIT" - }, - "node_modules/node-plantuml": { - "version": "0.9.0", - "resolved": "https://registry.npmjs.org/node-plantuml/-/node-plantuml-0.9.0.tgz", - "integrity": "sha512-bUnntTGjbpYu1pvXZI/GS6ctcXf3AOMqJxBMO8vFzTT5RwH8Cj/J5Ca6Dy+PEfMiMDdSBCFKSGnvYyBvYnucXg==", - "dev": true, - "hasInstallScript": true, - "license": "MIT", - "dependencies": { - "commander": "^2.8.1", - "node-nailgun-client": "^0.1.0", - "node-nailgun-server": "^0.1.4", - "plantuml-encoder": "^1.2.5" - }, - "bin": { - "puml": "index.js" - }, - "engines": { - "node": ">= 6.x" - } - }, - "node_modules/node-plantuml/node_modules/commander": { - "version": "2.20.3", - "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", - "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", - "dev": true, - "license": "MIT" - }, "node_modules/node-releases": { "version": "2.0.56", "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.56.tgz", @@ -5972,23 +5905,19 @@ "license": "MIT" }, "node_modules/tplant": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/tplant/-/tplant-3.1.3.tgz", - "integrity": "sha512-2LuWRFmpoipfme0c1B8GWZSHm9KEJKIyqC+u7qZUdQSwk0UyycTDD+fvtTJ9PosRrGLoSehnsfhJzX2gOckLig==", + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/tplant/-/tplant-3.0.0.tgz", + "integrity": "sha512-7rlQ4vRQrs12Y/PVUizIOzcSNbm4H/Iiplojyl3JLyaxsC675o6X2j1t+zsJt+zpmoZ+0ZJzSoxLrvUKsudYZQ==", "dev": true, - "license": "GPL-3.0", + "license": "ISC", "dependencies": { "commander": "^6.1.0", "glob": "^7.1.6", - "node-plantuml": "0.9.0", "plantuml-encoder": "^1.4.0", - "typescript": "5.2.2" + "typescript": "^4.0.3" }, "bin": { "tplant": "dist/index.js" - }, - "engines": { - "node": ">=16.0.0" } }, "node_modules/tplant/node_modules/commander": { @@ -6002,9 +5931,9 @@ } }, "node_modules/tplant/node_modules/typescript": { - "version": "5.2.2", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.2.2.tgz", - "integrity": "sha512-mI4WrpHsbCIcwT9cF4FZvr80QUeKvsUsUvKDoR+X/7XHQH98xYD8YHZg7ANtz2GtZt/CBq2QJ0thkGJMHfqc1w==", + "version": "4.9.5", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.5.tgz", + "integrity": "sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g==", "dev": true, "license": "Apache-2.0", "bin": { @@ -6012,7 +5941,7 @@ "tsserver": "bin/tsserver" }, "engines": { - "node": ">=14.17" + "node": ">=4.2.0" } }, "node_modules/ts-api-utils": { diff --git a/package.json b/package.json index 7c44daf..3aea564 100644 --- a/package.json +++ b/package.json @@ -50,7 +50,7 @@ "globals": "^16.0.0", "jest": "^29.7.0", "jscpd": "^4.0.5", - "tplant": "^3.1.0", + "tplant": "^3.0.0", "ts-jest": "^29.2.6", "ts-node": "^10.9.2", "typedoc": "^0.28.0",