refactor!: migrate to TypeScript and enhance API (#143)

.gitignore

@@ -62,3 +62,4 @@ docs/
 temp/
 .vscode/
 jsdoc/
+dist/

README.md

@@ -5,7 +5,6 @@
 [![OpenSSF
 Scorecard](https://api.securityscorecards.dev/projects/github.com/NodeSecure/github/badge?style=for-the-badge)](https://api.securityscorecards.dev/projects/github.com/NodeSecure/github)
 ![MIT](https://img.shields.io/github/license/NodeSecure/github.svg?style=for-the-badge)
-![known vulnerabilities](https://img.shields.io/snyk/vulnerabilities/github/NodeSecure/github?style=for-the-badge)
 ![build](https://img.shields.io/github/actions/workflow/status/NodeSecure/github/node.js.yml?style=for-the-badge)
 
 Download and (optionaly) extract github repository archive.
@@ -34,12 +33,6 @@ console.log(utils.location);
 
 const scanner = await github.downloadAndExtract("NodeSecure.scanner");
 console.log(scanner.location);
-
-const contributors = await github.getContributorsLastActivities(
-  "NodeSecure",
-  "scanner"
-);
-console.log(contributors);
 ```
 
 ## API
@@ -66,15 +59,6 @@ export interface DownloadOptions {
   token?: string;
 }
 
-export type ExtractOptions = DownloadOptions & {
-  /**
-   * Remove the tar.gz archive after a succesfull extraction
-   *
-   * @default true
-   */
-  removeArchive?: boolean;
-};
-
 export interface DownloadResult {
   /** Archive or repository location on disk */
   location: string;
@@ -84,41 +68,24 @@ export interface DownloadResult {
   organization: string;
 }
 
-export interface GetContributorsLastActivities {
-  token?: string;
-}
-
-export interface GetContributorsLastActivitiesResult {
-  [key: string]: {
-    repository: string;
-    actualRepo: boolean;
-    lastActivity: string;
-  }[];
-}
 export function download(
   repo: string,
   options?: DownloadOptions
 ): Promise<DownloadResult>;
+
+export interface DownloadExtractOptions extends DownloadOptions {
+  /**
+   * Remove the tar.gz archive after a succesfull extraction
+   *
+   * @default true
+   */
+  removeArchive?: boolean;
+}
+
 export function downloadAndExtract(
   repo: string,
-  options?: ExtractOptions
+  options?: DownloadExtractOptions
 ): Promise<DownloadResult>;
-export function getContributorsLastActivities(
-  owner: string,
-  repository: string,
-  options?: GetContributorsLastActivities
-): Promise<GetContributorsLastActivitiesResult | null>;
-export function setToken(githubToken: string): void;
-```
-
-### Private repositories
-
-To work with private repositories you can either setup a `GITHUB_TOKEN` system variable or use `setToken` method:
-
-```js
-import * as github from "@nodesecure/github";
-
-github.setToken("...");
 ```
 
 ## Contributors ✨

eslint.config.mjs

@@ -0,0 +1,3 @@
+import { typescriptConfig } from "@openally/config.eslint";
+
+export default typescriptConfig();

package.json

@@ -3,10 +3,13 @@
   "version": "1.2.0",
   "description": "Download repository from github",
   "type": "module",
-  "exports": "./index.js",
+  "exports": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "scripts": {
-    "prepublishOnly": "pkg-ok",
-    "test": "node -r dotenv --test",
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "lint": "eslint src",
+    "test": "glob -c \"tsx --test\" \"./test/**/*.spec.ts\"",
     "coverage": "c8 -r html npm test"
   },
   "repository": {
@@ -20,8 +23,7 @@
     "archive"
   ],
   "files": [
-    "index.js",
-    "index.d.ts"
+    "dist"
   ],
   "author": "GENTILHOMME Thomas <[email protected]>",
   "license": "MIT",
@@ -34,12 +36,15 @@
     "tar-fs": "^3.0.5"
   },
   "devDependencies": {
-    "@nodesecure/eslint-config": "^1.9.0",
+    "@openally/config.eslint": "^1.0.0",
+    "@openally/config.typescript": "^1.0.3",
     "@slimio/is": "^2.0.0",
+    "@types/node": "^22.3.0",
+    "@types/tar-fs": "^2.0.4",
     "c8": "^10.1.2",
-    "dotenv": "^16.0.2",
     "eslint": "^9.5.0",
-    "pkg-ok": "^3.0.0"
+    "tsx": "^4.17.0",
+    "typescript": "^5.5.4"
   },
   "engines": {
     "node": ">=18"