formattingwhatsapp 1.0.0

package/README.md

@@ -0,0 +1,115 @@
+# Formatting WhatsApp
+
+A fluent, type-safe TypeScript library for formatting WhatsApp messages.
+
+## Features
+
+- **Basic Formatting**: Bold, Italic, Strikethrough, Monospace, Quote.
+- **Lists**: Bullet, Numbered, and Indented lists.
+- **Fluent API**: `MessageBuilder` for chaining commands.
+
+## Installation
+
+```bash
+bun add formattingwhatsapp
+```
+
+## Usage
+
+### Basic Formatting
+
+```typescript
+import { bold, italic, strike, monospace } from 'formattingwhatsapp'
+
+// Example: Sending a simple formatted message
+const message = `${bold('Welcome!')} This is ${italic('my bot')}.`
+
+await sock.sendMessage(chatId, { text: message })
+```
+
+### Combination Formatting
+
+You can combine formatters by nesting functions. The library automatically trims whitespace to ensure WhatsApp recognizes the formatting options.
+
+```typescript
+import { bold, italic, strike } from 'formattingwhatsapp'
+
+// Bold + Italic
+// Output: *_Text_*
+const bi = bold(italic('Text'))
+
+// Bold + Italic + Strikethrough
+// Output: ~*_Text_*~
+const bis = strike(bold(italic('Text')))
+
+await sock.sendMessage(chatId, { text: bis })
+```
+
+### Fluent Message Builder
+
+```typescript
+import { MessageBuilder } from 'formattingwhatsapp'
+
+const message = new MessageBuilder()
+	.bold('Welcome to the Bot!')
+	.newline()
+	.text('Here are your options:')
+	.newline()
+	.bulletList(['Option 1', 'Option 2', 'Option 3'])
+	.newline()
+	.quote('Reply with your choice.')
+	.build()
+
+// Sending the built message
+await sock.sendMessage(chatId, { text: message })
+```
+
+### Fluent Message Builder
+
+```typescript
+import { MessageBuilder, bold, italic } from 'formattingwhatsapp'
+
+const message = new MessageBuilder()
+	.text('Standard text ')
+	.bold(italic('Bold and Italic')) // Nesting works here too!
+	.newline()
+	.text('Standard text again')
+	.build()
+
+await sock.sendMessage(chatId, { text: message })
+```
+
+## API Reference
+
+### Text Formatters
+
+- `bold(text: string): string`
+- `italic(text: string): string`
+- `strike(text: string): string`
+- `monospace(text: string): string`
+- `code(text: string): string`
+- `quote(text: string): string`
+
+### List Formatters
+
+- `bulletList(items: string[], symbol?: string): string`
+- `numberedList(items: string[]): string`
+- `indentedList(items: string[], indent?: string, symbol?: string): string`
+
+### MessageBuilder Methods
+
+- `text(text: string)`
+- `bold(text: string)`
+- `italic(text: string)`
+- `strike(text: string)`
+- `monospace(text: string)`
+- `code(text: string)`
+- `quote(text: string)`
+- `bulletList(items: string[], symbol?: string)`
+- `numberedList(items: string[])`
+- `newline(count?: number)`
+- `build(): string`
+
+## License
+
+ISC

package/dist/builders/message.d.ts

@@ -0,0 +1,56 @@
+export declare class MessageBuilder {
+    private parts;
+    constructor(initialText?: string);
+    /**
+     * Appends raw text to the message.
+     */
+    text(text: string): this;
+    /**
+     * Appends bold text.
+     */
+    bold(text: string): this;
+    /**
+     * Appends italic text.
+     */
+    italic(text: string): this;
+    /**
+     * Appends strikethrough text.
+     */
+    strike(text: string): this;
+    /**
+     * Appends monospace text block.
+     */
+    monospace(text: string): this;
+    /**
+     * Appends an inline code snippet.
+     */
+    code(text: string): this;
+    /**
+     * Appends a quoted block.
+     */
+    quote(text: string): this;
+    /**
+     * Appends a bullet list.
+     */
+    bulletList(items: string[], symbol?: string): this;
+    /**
+     * Appends a numbered list.
+     */
+    numberedList(items: string[]): this;
+    /**
+     * Adds a new line.
+     * @param count Number of new lines to add (default: 1).
+     */
+    newline(count?: number): this;
+    /**
+     * Builds the final message string.
+     */
+    build(): string;
+    /**
+     * Builds the message joined by a specific separator (e.g., newline).
+     * Useful if you built parts separately but want them joined by newlines.
+     * Note: The standard 'text' method just pushes to an array, so often you want to manage newlines manually or use this.
+     * However, standard behavior for this builder is just concatenation.
+     */
+    toString(): string;
+}

package/dist/builders/message.js

@@ -0,0 +1,96 @@
+import { bold, italic, strike, monospace, code, quote } from '../formatters/text.js';
+import { bulletList, numberedList } from '../formatters/list.js';
+export class MessageBuilder {
+    parts = [];
+    constructor(initialText = '') {
+        if (initialText) {
+            this.parts.push(initialText);
+        }
+    }
+    /**
+     * Appends raw text to the message.
+     */
+    text(text) {
+        this.parts.push(text);
+        return this;
+    }
+    /**
+     * Appends bold text.
+     */
+    bold(text) {
+        this.parts.push(bold(text));
+        return this;
+    }
+    /**
+     * Appends italic text.
+     */
+    italic(text) {
+        this.parts.push(italic(text));
+        return this;
+    }
+    /**
+     * Appends strikethrough text.
+     */
+    strike(text) {
+        this.parts.push(strike(text));
+        return this;
+    }
+    /**
+     * Appends monospace text block.
+     */
+    monospace(text) {
+        this.parts.push(monospace(text));
+        return this;
+    }
+    /**
+     * Appends an inline code snippet.
+     */
+    code(text) {
+        this.parts.push(code(text));
+        return this;
+    }
+    /**
+     * Appends a quoted block.
+     */
+    quote(text) {
+        this.parts.push(quote(text));
+        return this;
+    }
+    /**
+     * Appends a bullet list.
+     */
+    bulletList(items, symbol) {
+        this.parts.push(bulletList(items, symbol));
+        return this;
+    }
+    /**
+     * Appends a numbered list.
+     */
+    numberedList(items) {
+        this.parts.push(numberedList(items));
+        return this;
+    }
+    /**
+     * Adds a new line.
+     * @param count Number of new lines to add (default: 1).
+     */
+    newline(count = 1) {
+        this.parts.push('\n'.repeat(count));
+        return this;
+    }
+    /**
+     * Builds the final message string.
+     */
+    build() {
+        return this.parts.join('');
+    }
+    /**
+     * Builds the message joined by a specific separator (e.g., newline).
+     * Useful if you built parts separately but want them joined by newlines.
+     * Note: The standard 'text' method just pushes to an array, so often you want to manage newlines manually or use this.
+     * However, standard behavior for this builder is just concatenation.
+     */
+    toString() {
+        return this.build();
+    }
+}

package/dist/formatters/indent.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Creates an indented list (useful for sub-lists or specific formatting).
+ * @param items The items to list.
+ * @param indent The indentation string (default: '  ').
+ * @param symbol The bullet symbol (default: '-').
+ */
+export declare function indentedList(items: string[], indent?: string, symbol?: string): string;

package/dist/formatters/indent.js

@@ -0,0 +1,11 @@
+/**
+ * Creates an indented list (useful for sub-lists or specific formatting).
+ * @param items The items to list.
+ * @param indent The indentation string (default: '  ').
+ * @param symbol The bullet symbol (default: '-').
+ */
+export function indentedList(items, indent = '  ', symbol = '-') {
+    if (items.length === 0)
+        return '';
+    return items.map(item => `${indent}${symbol} ${item}`).join('\n');
+}

package/dist/formatters/list.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Creates a bulleted list.
+ * @param items The items to list.
+ * @param symbol The bullet symbol to use (default: '-').
+ */
+export declare function bulletList(items: string[], symbol?: string): string;
+/**
+ * Creates a numbered list.
+ * @param items The items to list.
+ */
+export declare function numberedList(items: string[]): string;

package/dist/formatters/list.js

@@ -0,0 +1,19 @@
+/**
+ * Creates a bulleted list.
+ * @param items The items to list.
+ * @param symbol The bullet symbol to use (default: '-').
+ */
+export function bulletList(items, symbol = '-') {
+    if (items.length === 0)
+        return '';
+    return items.map(item => `${symbol} ${item}`).join('\n');
+}
+/**
+ * Creates a numbered list.
+ * @param items The items to list.
+ */
+export function numberedList(items) {
+    if (items.length === 0)
+        return '';
+    return items.map((item, index) => `${index + 1}. ${item}`).join('\n');
+}

package/dist/formatters/text.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Formats text as bold.
+ * @param text The text to bold.
+ */
+export declare function bold(text: string): string;
+/**
+ * Formats text as italic.
+ * @param text The text to italicize.
+ */
+export declare function italic(text: string): string;
+/**
+ * Formats text as strikethrough.
+ * @param text The text to strikethrough.
+ */
+export declare function strike(text: string): string;
+/**
+ * Formats text as monospace (inline code).
+ * @param text The text to format as monospace.
+ */
+export declare function monospace(text: string): string;
+/**
+ * Formats text as inline code.
+ * @param text The text to format as inline code.
+ */
+export declare function code(text: string): string;
+/**
+ * Formats text as a quote or blockquote.
+ * @param text The text to quote.
+ */
+export declare function quote(text: string): string;

package/dist/formatters/text.js

@@ -0,0 +1,42 @@
+/**
+ * Formats text as bold.
+ * @param text The text to bold.
+ */
+export function bold(text) {
+    return `*${text.trim()}*`;
+}
+/**
+ * Formats text as italic.
+ * @param text The text to italicize.
+ */
+export function italic(text) {
+    return `_${text.trim()}_`;
+}
+/**
+ * Formats text as strikethrough.
+ * @param text The text to strikethrough.
+ */
+export function strike(text) {
+    return `~${text.trim()}~`;
+}
+/**
+ * Formats text as monospace (inline code).
+ * @param text The text to format as monospace.
+ */
+export function monospace(text) {
+    return `\`\`\`${text}\`\`\``;
+}
+/**
+ * Formats text as inline code.
+ * @param text The text to format as inline code.
+ */
+export function code(text) {
+    return `\`${text}\``;
+}
+/**
+ * Formats text as a quote or blockquote.
+ * @param text The text to quote.
+ */
+export function quote(text) {
+    return `> ${text}`;
+}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './formatters/text.js';
+export * from './formatters/list.js';
+export * from './formatters/indent.js';
+export * from './builders/message.js';

package/dist/index.js

@@ -0,0 +1,7 @@
+// Export basic formatters
+export * from './formatters/text.js';
+export * from './formatters/list.js';
+export * from './formatters/indent.js';
+// Export builders
+export * from './builders/message.js';
+// Export utils

package/package.json

@@ -0,0 +1,28 @@
+{
+	"name": "formattingwhatsapp",
+	"version": "1.0.0",
+	"description": "A fluent TypeScript library for formatting WhatsApp messages.",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"files": [
+		"dist"
+	],
+	"type": "module",
+	"scripts": {
+		"test": "bun test",
+		"build": "tsc",
+		"prepublishOnly": "bun run build"
+	},
+	"keywords": [
+		"whatsapp",
+		"formatting",
+		"bot",
+		"typescript"
+	],
+	"author": "Zaidan",
+	"license": "ISC",
+	"devDependencies": {
+		"@types/bun": "latest",
+		"typescript": "^5"
+	}
+}