[sluggo] Add types for sluggo

types/sluggo/.npmignore

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

types/sluggo/index.d.ts

@@ -0,0 +1,23 @@
+declare namespace sluggo {
+    interface Options {
+        /**
+         * The separator character to use. Defaults to "-".
+         */
+        separator?: string | undefined;
+        /**
+         * A string or list of strings to permit in the output.
+         */
+        allow?: string | string[] | undefined;
+    }
+}
+
+/**
+ * Generates a slug.
+ * @param input The string to generate a slug for.
+ * @param options Customize the slug generator's behavior.
+ * @returns The generated slug.
+ */
+declare function sluggo(input: string, options?: sluggo.Options): string;
+
+export = sluggo;
+export as namespace sluggo;

types/sluggo/package.json

@@ -0,0 +1,17 @@
+{
+    "private": true,
+    "name": "@types/sluggo",
+    "version": "1.0.9999",
+    "projects": [
+        "https://github.com/apostrophecms/sluggo"
+    ],
+    "devDependencies": {
+        "@types/sluggo": "workspace:."
+    },
+    "owners": [
+        {
+            "name": "Reece Dunham",
+            "githubUsername": "RDIL"
+        }
+    ]
+}

types/sluggo/sluggo-tests.ts

@@ -0,0 +1,7 @@
+import sluggo = require("sluggo");
+
+sluggo("i ♥ unicode"); // $ExpectType string
+
+sluggo("unicode ♥ is ☢"); // $ExpectType string
+
+sluggo("unicode ♥ is ☢", { allow: "♥" }); // $ExpectType string

types/sluggo/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",
+        "sluggo-tests.ts"
+    ]
+}