@ipfy/homoglyph 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,51 @@
+export interface HomoglyphCharacter {
+  char: string;
+  index: number;
+  prototype: string;
+  script: string;
+}
+
+export interface HomoglyphFinding {
+  type: string;
+  label: string | null;
+  scripts: string[];
+}
+
+export interface HomoglyphResult {
+  detected: boolean;
+  rejectable: boolean;
+  input: string | null;
+  valueType:
+    | "empty"
+    | "non-string"
+    | "domain"
+    | "email"
+    | "url"
+    | "unparsed";
+  source: "domain" | "email" | "url" | null;
+  domain: string | null;
+  asciiName: string | null;
+  reason: string | null;
+  scripts: string[];
+  characters: HomoglyphCharacter[];
+  findings: HomoglyphFinding[];
+  unicodeVersion: string;
+}
+
+export const UNICODE_VERSION: string;
+export const METADATA_FIELD: string;
+
+export function detect(value: unknown): HomoglyphResult;
+export function warn(input: unknown): HomoglyphResult;
+export function reject(input: unknown): HomoglyphResult;
+
+export interface HomoglyphAPI {
+  detect(value: unknown): HomoglyphResult;
+  warn(input: unknown): HomoglyphResult;
+  reject(input: unknown): HomoglyphResult;
+  unicodeVersion: string;
+  metadataField: string;
+}
+
+declare const Homoglyph: HomoglyphAPI;
+export default Homoglyph;