aamoji 0.0.0

package/README.md

@@ -0,0 +1,62 @@
+# aamoji
+
+Return an ASCII representation for each emoji.
+
+## Install
+
+```sh
+npm install aamoji
+```
+
+## Usage
+
+```js
+const aamoji = require('aamoji');
+
+aamoji('😀');          // ':D'
+aamoji('❤️');          // '<3'
+aamoji('👍');          // '(b)'
+aamoji('🦄');          // '(unicorn)'
+
+// Unknown emoji returns itself by default.
+aamoji('🫥');          // '🫥'
+aamoji('🫥', '?');     // '?'  (with fallback)
+
+// Replace every known emoji inside a string.
+aamoji.replace('hello 😀 world ❤️');
+// 'hello :D world <3'
+
+// Check whether a mapping exists.
+aamoji.has('😀');      // true
+
+// Get the full map.
+aamoji.all();          // { '😀': ':D', ... }
+```
+
+## API
+
+### `aamoji(emoji, fallback?)`
+
+Returns the ASCII string for `emoji`. If the emoji is not in the map, returns
+`fallback` when provided, otherwise the original emoji.
+
+### `aamoji.replace(str)`
+
+Replaces every known emoji in `str` with its ASCII equivalent. Unknown
+characters are left untouched.
+
+### `aamoji.has(emoji)`
+
+Returns `true` if the emoji has a mapping.
+
+### `aamoji.all()`
+
+Returns a shallow copy of the full emoji-to-ASCII map.
+
+### `aamoji.map`
+
+The underlying map object (do not mutate).
+
+## License
+
+MIT

package/ascii-map.js

@@ -0,0 +1,235 @@
+'use strict';
+
+// Mapping of common emojis to ASCII representations.
+const asciiMap = {
+  '😀': ':D',
+  '😃': ':D',
+  '😄': ':D',
+  '😁': '=D',
+  '😆': 'XD',
+  '😅': '^_^;',
+  '🤣': 'XDD',
+  '😂': ":')",
+  '🙂': ':)',
+  '🙃': '(:',
+  '😉': ';)',
+  '😊': ':)',
+  '😇': 'O:)',
+  '🥰': '<3',
+  '😍': ':*)',
+  '🤩': '*_*',
+  '😘': ':-*',
+  '😗': ':*',
+  '😚': ':*',
+  '😙': ':*',
+  '😋': ':P',
+  '😛': ':P',
+  '😜': ';P',
+  '🤪': 'xP',
+  '😝': 'xP',
+  '🤑': '$_$',
+  '🤗': '>:)',
+  '🤔': ':?',
+  '🤐': ':X',
+  '🤨': ':/',
+  '😐': ':|',
+  '😑': '-_-',
+  '😶': ':x',
+  '😏': ';)',
+  '😒': ':/',
+  '🙄': '-_-',
+  '😬': ':E',
+  '🤥': ':-)',
+  '😌': 'u_u',
+  '😔': ':(',
+  '😪': '-.-',
+  '🤤': ":'P",
+  '😴': 'Zzz',
+  '😷': ':-#',
+  '🤒': ':-S',
+  '🤕': ':-S',
+  '🤢': ':-&',
+  '🤮': ':-X',
+  '🤧': ':-{',
+  '🥵': '>_<',
+  '🥶': '*_*',
+  '🥴': '@_@',
+  '😵': 'X_X',
+  '🤯': 'O_O!',
+  '🤠': ':-D',
+  '🥳': ':D*',
+  '😎': 'B)',
+  '🤓': '8)',
+  '🧐': ':-?',
+  '😕': ':/',
+  '😟': ':(',
+  '🙁': ':(',
+  '☹️': ':(',
+  '😮': ':o',
+  '😯': ':o',
+  '😲': ':O',
+  '😳': ':$',
+  '🥺': ":'(",
+  '😦': 'D:',
+  '😧': 'D:',
+  '😨': 'D:',
+  '😰': "D':",
+  '😥': ":'(",
+  '😢': ":'(",
+  '😭': ":'((",
+  '😱': 'D:<',
+  '😖': '>_<',
+  '😣': '>_<',
+  '😞': ':(',
+  '😓': ":'|",
+  '😩': 'X(',
+  '😫': 'X(',
+  '🥱': '(=_=)',
+  '😤': '>:|',
+  '😡': '>:(',
+  '😠': '>:(',
+  '🤬': '#@!',
+  '😈': '}:)',
+  '👿': '}:(',
+  '💀': 'X_X',
+  '☠️': 'X_X',
+  '💩': '~~',
+  '🤡': ':o)',
+  '👹': '>:E',
+  '👺': '>:(',
+  '👻': 'Boo!',
+  '👽': '(o.o)',
+  '👾': '[o_o]',
+  '🤖': '[:|]',
+  '❤️': '<3',
+  '🧡': '<3',
+  '💛': '<3',
+  '💚': '<3',
+  '💙': '<3',
+  '💜': '<3',
+  '🖤': '</3',
+  '🤍': '<3',
+  '🤎': '<3',
+  '💔': '</3',
+  '❣️': '<3!',
+  '💕': '<3<3',
+  '💞': '<3~',
+  '💓': '<3*',
+  '💗': '<3+',
+  '💖': '*<3*',
+  '💘': '<-3',
+  '💝': '[<3]',
+  '👍': '(b)',
+  '👎': '(n)',
+  '👌': '(ok)',
+  '✌️': '(v)',
+  '🤞': '(x)',
+  '🤙': '(call)',
+  '👋': '(wave)',
+  '🙌': '\\o/',
+  '👏': '*clap*',
+  '🙏': '_/\\_',
+  '💪': '(flex)',
+  '🤝': '(shake)',
+  '✊': '(fist)',
+  '👊': '(punch)',
+  '☀️': '(*)',
+  '🌙': '(C',
+  '⭐': '*',
+  '🌟': '*+*',
+  '✨': '*~*',
+  '⚡': '/\\/',
+  '🔥': '(fire)',
+  '💧': "o'",
+  '🌈': '(rainbow)',
+  '☁️': '(cloud)',
+  '☔': '(rain)',
+  '❄️': '*snow*',
+  '⛄': '(snowman)',
+  '🌍': '(O)',
+  '🌎': '(O)',
+  '🌏': '(O)',
+  '🍎': '(apple)',
+  '🍊': '(orange)',
+  '🍌': '(banana)',
+  '🍓': '(strawberry)',
+  '🍉': '(watermelon)',
+  '🍇': '(grapes)',
+  '🍕': '(pizza)',
+  '🍔': '(burger)',
+  '🍟': '(fries)',
+  '🌮': '(taco)',
+  '🍣': '(sushi)',
+  '🍩': '(donut)',
+  '🍪': '(cookie)',
+  '🎂': '(cake)',
+  '☕': '(coffee)',
+  '🍺': '(beer)',
+  '🍷': '(wine)',
+  '🐶': '(dog)',
+  '🐱': '(cat)',
+  '🐭': '(mouse)',
+  '🐰': '(bunny)',
+  '🦊': '(fox)',
+  '🐻': '(bear)',
+  '🐼': '(panda)',
+  '🐨': '(koala)',
+  '🐯': '(tiger)',
+  '🦁': '(lion)',
+  '🐮': '(cow)',
+  '🐷': '(pig)',
+  '🐸': '(frog)',
+  '🐵': '(monkey)',
+  '🙈': 'see-no',
+  '🙉': 'hear-no',
+  '🙊': 'speak-no',
+  '🦄': '(unicorn)',
+  '🐔': '(chicken)',
+  '🐧': '(penguin)',
+  '🐦': '(bird)',
+  '🐝': '(bee)',
+  '🦋': '(butterfly)',
+  '🐢': '(turtle)',
+  '🐍': '~S~',
+  '🐙': '(octopus)',
+  '🐳': '(whale)',
+  '🐬': '(dolphin)',
+  '🐟': '><(((>',
+  '🚗': '(car)',
+  '🚕': '(taxi)',
+  '🚌': '(bus)',
+  '🚑': '(ambulance)',
+  '🚒': '(firetruck)',
+  '🚲': '(bike)',
+  '✈️': '(plane)',
+  '🚀': '(rocket)',
+  '🛸': '(ufo)',
+  '⚽': '(o)',
+  '🏀': '(O)',
+  '🎮': '(gamepad)',
+  '🎲': '[::]',
+  '🎵': '(note)',
+  '🎶': '(notes)',
+  '🎸': '(guitar)',
+  '🎤': '(mic)',
+  '📱': '[phone]',
+  '💻': '[laptop]',
+  '⌨️': '[keyboard]',
+  '🖥️': '[pc]',
+  '📷': '[camera]',
+  '💡': '(idea)',
+  '🔑': '-o<',
+  '🔒': '[lock]',
+  '✉️': '[mail]',
+  '📦': '[box]',
+  '✅': '[x]',
+  '❌': '[X]',
+  '⚠️': '(!)',
+  '❓': '(?)',
+  '❗': '(!)',
+  '💯': '100',
+  '🎉': '*party*',
+  '🎁': '[gift]'
+};
+
+module.exports = asciiMap;

package/index.js

@@ -0,0 +1,76 @@
+'use strict';
+
+const asciiMap = require('./ascii-map.js');
+
+function escapeRegex(str) {
+  return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+}
+
+// Build a single regex matching any mapped emoji. Sort by length descending so
+// multi-codepoint emojis (e.g. '❤️' = U+2764 + U+FE0F) match before shorter
+// variants ('❤').
+const replaceRegex = new RegExp(
+  Object.keys(asciiMap)
+    .sort((a, b) => b.length - a.length)
+    .map(escapeRegex)
+    .join('|'),
+  'g'
+);
+
+/**
+ * Convert a single emoji to its ASCII representation.
+ *
+ * @param {string} emoji - The emoji character.
+ * @param {string} [fallback] - Optional fallback when the emoji is unknown.
+ *                              Defaults to the original emoji string.
+ * @returns {string} ASCII representation, or the fallback if not mapped.
+ */
+function aamoji(emoji, fallback) {
+  if (typeof emoji !== 'string') {
+    throw new TypeError('aamoji: expected a string');
+  }
+  if (Object.prototype.hasOwnProperty.call(asciiMap, emoji)) {
+    return asciiMap[emoji];
+  }
+  return fallback === undefined ? emoji : fallback;
+}
+
+/**
+ * Replace every known emoji in a string with its ASCII equivalent.
+ *
+ * @param {string} input - Source string that may contain emojis.
+ * @returns {string} String with mapped emojis replaced by ASCII.
+ */
+function replace(input) {
+  if (typeof input !== 'string') {
+    throw new TypeError('aamoji.replace: expected a string');
+  }
+  return input.replace(replaceRegex, (match) => asciiMap[match]);
+}
+
+/**
+ * Check whether an emoji has an ASCII mapping.
+ *
+ * @param {string} emoji
+ * @returns {boolean}
+ */
+function has(emoji) {
+  return Object.prototype.hasOwnProperty.call(asciiMap, emoji);
+}
+
+/**
+ * Get a shallow copy of the full emoji-to-ASCII map.
+ *
+ * @returns {Record<string, string>}
+ */
+function all() {
+  return { ...asciiMap };
+}
+
+aamoji.replace = replace;
+aamoji.has = has;
+aamoji.all = all;
+aamoji.map = asciiMap;
+
+module.exports = aamoji;
+module.exports.default = aamoji;

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "aamoji",
+  "version": "0.0.0",
+  "description": "Returns an ASCII representation for each emoji.",
+  "main": "index.js",
+  "exports": {
+    ".": "./index.js"
+  },
+  "files": [
+    "index.js",
+    "ascii-map.js",
+    "README.md"
+  ],
+  "keywords": [
+    "emoji",
+    "ascii",
+    "aamoji",
+    "ascii-art",
+    "emoticon"
+  ],
+  "license": "MIT",
+  "scripts": {
+    "test": "node test.js"
+  }
+}