🤖 Merge PR DefinitelyTyped#74858 [licensee] Add type definitions for licensee by @JamieMagee

Author: JamieMagee

types/licensee/.npmignore

@@ -0,0 +1,5 @@
+*
+!**/*.d.ts
+!**/*.d.cts
+!**/*.d.mts
+!**/*.d.*.ts

types/licensee/index.d.ts

@@ -0,0 +1,55 @@
+declare function licensee(
+    configuration: licensee.Configuration,
+    path: string,
+    callback: (error: Error | null, results?: licensee.Result[]) => void,
+): void;
+
+declare namespace licensee {
+    interface LicensesConfiguration {
+        spdx?: string[] | undefined;
+        blueOak?: string | undefined;
+        osi?: boolean | undefined;
+    }
+
+    interface IgnoreScope {
+        scope: string;
+    }
+
+    interface IgnorePrefix {
+        prefix: string;
+    }
+
+    interface IgnoreAuthor {
+        author: string;
+    }
+
+    type IgnoreRule = IgnoreScope | IgnorePrefix | IgnoreAuthor;
+
+    interface Configuration {
+        licenses: LicensesConfiguration;
+        packages?: Record<string, string> | undefined;
+        corrections?: boolean | undefined;
+        ignore?: IgnoreRule[] | undefined;
+        productionOnly?: boolean | undefined;
+        filterPackages?: ((dependencies: any[]) => any[]) | undefined;
+    }
+
+    interface Result {
+        name: string;
+        version: string;
+        license: string;
+        author: any;
+        contributors: any;
+        repository: any;
+        homepage: string;
+        parent: any;
+        path: string;
+        approved: boolean;
+        corrected?: "manual" | "automatic" | undefined;
+        ignored?: boolean | undefined;
+        package?: boolean | undefined;
+        duplicates?: Result[] | undefined;
+    }
+}
+
+export = licensee;

types/licensee/licensee-tests.ts

@@ -0,0 +1,67 @@
+import licensee = require("licensee");
+
+const configuration: licensee.Configuration = {
+    licenses: {
+        spdx: ["MIT", "BSD-2-Clause", "BSD-3-Clause", "Apache-2.0"],
+    },
+    packages: {
+        optimist: "<=0.6.1",
+    },
+    corrections: true,
+    ignore: [
+        { scope: "kemitchell" },
+        { prefix: "commonform-" },
+        { author: "Kyle E. Mitchell" },
+    ],
+};
+
+licensee(configuration, "/path/to/package", (error, results) => {
+    if (error) {
+        return;
+    }
+    if (results) {
+        const result: licensee.Result = results[0];
+    }
+});
+
+const exampleResult: licensee.Result = {
+    name: "example",
+    version: "1.0.0",
+    license: "MIT",
+    author: null,
+    contributors: null,
+    repository: null,
+    homepage: "",
+    parent: null,
+    path: "/path",
+    approved: true,
+};
+
+// $ExpectType string
+exampleResult.name;
+
+// $ExpectType string
+exampleResult.version;
+
+// $ExpectType string
+exampleResult.license;
+
+// $ExpectType boolean
+exampleResult.approved;
+
+const blueOakConfig: licensee.Configuration = {
+    licenses: {
+        blueOak: "bronze",
+    },
+};
+
+const osiConfig: licensee.Configuration = {
+    licenses: {
+        spdx: ["CC-BY-4.0"],
+        blueOak: "gold",
+        osi: true,
+    },
+    productionOnly: true,
+};
+
+licensee(osiConfig, ".", (err, results) => {});

types/licensee/package.json

@@ -0,0 +1,17 @@
+{
+    "private": true,
+    "name": "@types/licensee",
+    "version": "12.0.9999",
+    "projects": [
+        "https://github.com/jslicense/licensee.js"
+    ],
+    "devDependencies": {
+        "@types/licensee": "workspace:."
+    },
+    "owners": [
+        {
+            "name": "Jamie Magee",
+            "githubUsername": "JamieMagee"
+        }
+    ]
+}

types/licensee/tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+        "module": "node16",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "strictFunctionTypes": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "licensee-tests.ts"
+    ]
+}