@verifyhash/slugify-lite 0.1.0 → 0.1.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2026 <OWNER-NAME PLACEHOLDER>
+Copyright (c) 2026 verifyhash
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -5,6 +5,16 @@ string into a clean URL slug: `"Héllo, World!"` → `"hello-world"`. One Common
 file (`index.js`), no install step, no I/O, no runtime `require` of anything —
 drop it into any project and `require` it.
 
+## Install
+
+```bash
+npm install @verifyhash/slugify-lite
+```
+
+Published as [`@verifyhash/slugify-lite`](https://www.npmjs.com/package/@verifyhash/slugify-lite);
+source lives in the [verifyhash/libs](https://github.com/verifyhash/libs) monorepo.
+Zero runtime dependencies — you can also vendor the folder directly.
+
 ## Who it's for
 
 JavaScript/Node developers who need slugs for URLs, filenames, anchor IDs, or

package/index.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Type declarations for @verifyhash/slugify-lite — zero-dependency,
+ * zero-network string -> URL slug: Latin-1/accent transliteration via a
+ * pinned in-repo map, custom separator, word-boundary maxLength truncation,
+ * and custom replacement overrides.
+ *
+ * The module's export IS the slugify function (CommonJS `export =`), with
+ * `.slugify` and `.default` self-references for destructuring / ESM-interop
+ * imports, and `.charMap` exposing the built-in transliteration table.
+ *
+ * Honest limit: only common accented Latin characters are romanized;
+ * non-Latin scripts (Cyrillic, Greek, Arabic, CJK, emoji, …) are stripped,
+ * not transliterated.
+ */
+
+declare const slugify: slugify.SlugifyFunction;
+
+declare namespace slugify {
+  /** Options for slugify(). */
+  interface SlugifyOptions {
+    /** Character(s) used to join words (default '-'). */
+    separator?: string;
+    /** Lowercase the result (default true). */
+    lowercase?: boolean;
+    /**
+     * Maximum slug length; truncation happens on a word boundary — never
+     * mid-word, never leaving a trailing separator.
+     */
+    maxLength?: number;
+    /**
+     * Custom single-character -> string replacement map, merged OVER the
+     * built-in transliteration map.
+     */
+    replacements?: Record<string, string>;
+  }
+
+  interface SlugifyFunction {
+    /**
+     * Convert a string to a URL slug, e.g. 'Héllo, World!' -> 'hello-world'.
+     * null/undefined input returns ''; any other non-string is String()-coerced.
+     */
+    (input: string | null | undefined, options?: SlugifyOptions): string;
+    /** Self-reference so `const { slugify } = require('@verifyhash/slugify-lite')` works. */
+    slugify: SlugifyFunction;
+    /** ESM-interop self-reference (`import slugify from '@verifyhash/slugify-lite'`). */
+    default: SlugifyFunction;
+    /** Frozen copy of the built-in transliteration map (single char -> ASCII). */
+    readonly charMap: Readonly<Record<string, string>>;
+  }
+}
+
+export = slugify;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verifyhash/slugify-lite",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Zero-dependency, zero-network string-to-URL-slug library for Node.js: Latin-1/accent transliteration via a pinned in-repo map, custom separator, word-boundary maxLength truncation, and custom replacement overrides.",
   "keywords": [
     "slug",
@@ -12,6 +12,7 @@
     "zero-dependency"
   ],
   "main": "index.js",
+  "types": "index.d.ts",
   "scripts": {
     "test": "node test/index.test.js"
   },
@@ -19,7 +20,8 @@
   "files": [
     "index.js",
     "README.md",
-    "LICENSE"
+    "LICENSE",
+    "index.d.ts"
   ],
   "publishConfig": {
     "access": "public"