🤖 Merge PR DefinitelyTyped#73555 Add type definitions for emailjs-utf7 by @cyberbobs

Co-authored-by: Boris Moiseev <[email protected]>

Author: cyberbobs

types/emailjs-utf7/.npmignore

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

types/emailjs-utf7/emailjs-utf7-tests.ts

@@ -0,0 +1,42 @@
+import { decode, encode, encodeAll, imapDecode, imapEncode } from "emailjs-utf7";
+
+// @ts-expect-error
+encode();
+encode("testing", "testmask"); // $ExpectType string
+encode("testing"); // $ExpectType string
+// @ts-expect-error
+encode(5);
+// @ts-expect-error
+encode(true);
+
+// @ts-expect-error
+encodeAll();
+encodeAll("testing"); // $ExpectType string
+// @ts-expect-error
+encodeAll(5);
+// @ts-expect-error
+encodeAll(true);
+
+// @ts-expect-error
+decode();
+decode("BCgEMAQxBDsEPgQ9BEs"); // $ExpectType string
+// @ts-expect-error
+decode(5);
+// @ts-expect-error
+decode(true);
+
+// @ts-expect-error
+imapEncode();
+imapEncode("testing"); // $ExpectType string
+// @ts-expect-error
+imapEncode(5);
+// @ts-expect-error
+imapEncode(true);
+
+// @ts-expect-error
+imapDecode();
+imapDecode("&BCgEMAQxBDsEPgQ9BEs-"); // $ExpectType string
+// @ts-expect-error
+imapDecode(5);
+// @ts-expect-error
+imapDecode(true);

types/emailjs-utf7/index.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Encodes string to UTF-7, see RFC 2152
+ * @param str String to encode
+ * @param mask (optional) Characters to encode, defaults to RFC 2152 Set D
+ */
+export function encode(str: string, mask?: string): string;
+
+/**
+ * Encodes string to UTF-7 with all optionals, see RFC 2152
+ * @param str String to encode
+ */
+export function encodeAll(str: string): string;
+
+/**
+ * Decodes UTF-7 string, see RFC 2152
+ * @param str String to decode
+ */
+export function decode(str: string): string;
+
+/**
+ * Encodes string to UTF-7 with all optionals, see RFC 3501
+ *
+ * All printable ASCII chars except for & must be represented by themselves.
+ * We replace subsequent non-representable chars with their escape sequence.
+ *
+ * @param str String to encode
+ */
+export function imapEncode(str: string): string;
+
+/**
+ * Decodes UTF-7 string, see RFC 3501
+ * @param str String to decode
+ */
+export function imapDecode(str: string): string;

types/emailjs-utf7/package.json

@@ -0,0 +1,17 @@
+{
+    "private": true,
+    "name": "@types/emailjs-utf7",
+    "version": "4.0.9999",
+    "projects": [
+        "https://github.com/emailjs/emailjs-utf7"
+    ],
+    "devDependencies": {
+        "@types/emailjs-utf7": "workspace:."
+    },
+    "owners": [
+        {
+            "name": "Boris Moiseev",
+            "githubUsername": "cyberbobs"
+        }
+    ]
+}

types/emailjs-utf7/tsconfig.json

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