Add comprehensive README with project overview and usage examples

Author: olasunkanmiraymond

README.md

@@ -0,0 +1,52 @@
+# TypeScript Code Extractor and Analyzer
+
+This project provides a robust toolkit for extracting, analyzing, and mapping TypeScript code structures.
+
+The TypeScript Code Extractor and Analyzer is a comprehensive solution designed to parse and analyze TypeScript codebases. It offers a set of tools to extract detailed information about classes, interfaces, functions, and other TypeScript constructs, enabling developers to gain deep insights into their codebase structure and dependencies.
+
+Key features include:
+
+- Extraction of class metadata, including methods, properties, interfaces, and enums
+- Function and method analysis, including parameter extraction and return type inference
+- Interface and enum information extraction
+- Dependency graph generation for TypeScript files
+
+## Repository Structure
+
+```
+.
+├── src/
+│   ├── core/
+│   ├── Example/
+│   ├── http/
+│   ├── infrastructure/
+│   ├── interfaces/
+│   ├── logger/
+│   ├── result/
+│   ├── services/
+│   └── utils/
+├── CHANGELOG.md
+├── jest.config.js
+├── package.json
+├── README.md
+└── tsconfig.json
+```
+
+### Code Analysis
+
+To analyze a TypeScript codebase:
+
+```typescript
+import { TypeScriptCodeMapper } from "./src/services/typescript-code-mapper.service";
+
+const codeMapper = new TypeScriptCodeMapper();
+
+// Build a codebase map
+const codebaseMap = await codeMapper.buildCodebaseMap();
+
+// Extract class metadata
+const classInfo = codeMapper.extractClassMetaData(classNode, sourceFile);
+
+// Build a dependency graph
+const dependencies = codeMapper.buildDependencyGraph(sourceFile);
+```

src/core/constants.ts

@@ -1,9 +1,3 @@
-export const MEMORY_CACHE_OPTIONS = {
-  serviceName: "SharedKernel",
-  accountName: "UserSession",
-  sessionTTL: 24 * 60 * 60 * 1000,
-};
-
 export enum RequestHeader {
   AUTHORIZATION = "authorization",
   CONTENT_TYPE = "Content-Type",

src/http/http-service.ts

@@ -1,9 +1,9 @@
+import { IRequestOptions } from "./../../dist/interfaces/generic.interface.d";
 import * as https from "https";
 import { ClientRequest } from "http";
 import { IHttpClient } from "./http-service.interface";
 import { ApplicationLogger } from "../logger/logger-service";
 import { HTTP_VERBS, RequestHeader } from "../core/constants";
-import { IRequestOptions } from "../interfaces";
 /**
  * A custom HTTP client implementation that provides a set of methods for sending HTTP requests.
  * This client supports GET, POST, PUT, and DELETE requests, and allows for optional request options and payload.

src/index.ts

@@ -7,5 +7,6 @@ export * from "./result";
 export * from "./interfaces";
 export * from "./utils";
 export * from "./core";
+export * from "./services";
 
 getCodeBase();

src/interfaces/generic.interface.ts

@@ -1,17 +1,3 @@
-import { RequestHeader } from "../core/constants";
-
-export type HeadersType = {
-  [key in keyof RequestHeader]: string;
-};
-
-export interface IRequestOptions {
-  hostname: string;
-  path: string;
-  method: string;
-  headers?: any;
-  jwtToken?: string;
-}
-
 import ts from "typescript";
 
 export interface IFunctionInfo {

src/interfaces/index.ts

@@ -1 +1,2 @@
 export * from "./generic.interface";
+export * from "./ts.code.mapper.interface";

src/services/index.ts

@@ -0,0 +1 @@
+export * from "./typescript-code-mapper.service";