mn-sms 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 The mn-sms contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,249 @@
-# Temporary Holding Version
+# mn-sms
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+**English** · [Монгол](README.mn.md)
+
+Send SMS through the Mongolian mobile operators' own gateways — **Unitel**, **Mobicom**,
+**Skytel** and **G-Mobile** — from one client. You give it a number and a message; it works
+out which operator owns the number and calls that operator's gateway.
+
+- Zero dependencies. Node 18+ (uses the built-in `fetch`). ESM and CommonJS, typed.
+- Routes by the official number ranges, not by guessing from the first two digits.
+- Reads each gateway's real verdict: three of the four answer HTTP `200` for a refused send.
+- Never puts a credential in a result, an error message or a log line.
+
+> **This is not an SMS reseller.** There is no shared account behind this package. You need
+> your own contract with each operator you want to send through — see
+> [What you need from the operators](#what-you-need-from-the-operators).
+
+## Install
+
+```bash
+npm install mn-sms
+```
+
+## Usage
+
+```ts
+import { createSmsClient } from "mn-sms";
+
+const sms = createSmsClient({
+  // Configure only the operators you have an account with.
+  unitel: { apiKey: process.env.UNITEL_API_KEY! },
+  skytel: { id: process.env.SKYTEL_ID!, src: process.env.SKYTEL_SRC! },
+  mobicom: {
+    baseUrl: process.env.MOBICOM_BASE_URL!,
+    serviceName: process.env.MOBICOM_SERVICE_NAME!,
+    username: process.env.MOBICOM_USERNAME!,
+    from: process.env.MOBICOM_FROM!,
+  },
+  gmobile: {
+    username: process.env.GMOBILE_USERNAME!,
+    password: process.env.GMOBILE_PASSWORD!,
+    from: process.env.GMOBILE_FROM!,
+  },
+});
+
+const result = await sms.send({ to: "99112233", message: "Таны код: 1234" });
+
+if (!result.ok) {
+  console.error(result.gateway, result.error?.code, result.error?.message);
+}
+```
+
+Or let it read the environment (variable names are in [.env.example](.env.example)):
+
+```ts
+import { configFromEnv, createSmsClient } from "mn-sms";
+
+const sms = createSmsClient(configFromEnv());
+```
+
+### `send()` never throws
+
+Every outcome comes back as a result, so success and failure can be logged the same way:
+
+```ts
+{
+  ok: false,
+  to: "91112233",            // normalized to 8 digits
+  operator: "skytel",        // who owns the number
+  gateway: "skytel",         // which gateway was called
+  statusCode: 200,           // yes, 200 — see below
+  request: { method, url, params },   // what was sent, WITHOUT credentials
+  response: "ERROR: 202 not authenticated",   // the gateway's own words
+  error: {
+    code: "rejected",
+    gatewayCode: "202",
+    message: "not authenticated — wrong id, or the calling IP is not on the Allowed IP List",
+  },
+}
+```
+
+| `error.code` | Meaning | Network call made? |
+| --- | --- | --- |
+| `invalid_number` | Not an 8-digit Mongolian subscriber number. | no |
+| `unallocated_number` | 8 digits, but in no operator's range. | no |
+| `unsupported_operator` | The number is ONDO's; no gateway for it here. | no |
+| `not_configured` | The number's operator has a gateway, but you passed no config for it. | no |
+| `empty_message` | — | no |
+| `message_too_long` | Over the routed gateway's limit (160 for Skytel and G-Mobile). | no |
+| `rejected` | The gateway answered and refused. `gatewayCode` and `response` say why. | yes |
+| `timeout` | No answer within `timeoutMs`. ⚠️ **Delivery state is unknown** — the SMS may still arrive. Think before retrying an OTP. | yes |
+| `network` | The request never completed (DNS, connection refused, bad base URL). | yes |
+
+`sms.check({ to, message })` runs the "no network call" rows on their own and returns the
+error or `null` — useful for validating a form before you spend a send.
+
+### Phone numbers
+
+`to` is the 8-digit subscriber number. `+976`, `976`, `00976`, spaces and dashes are
+stripped for you. The helpers are exported if you want them on their own:
+
+```ts
+import { gatewayFor, normalizePhone, operatorFor } from "mn-sms";
+
+normalizePhone("+976 9911-2233"); // "99112233"
+operatorFor("55501234");          // "mobicom"  (55 0–4 is Unitel, 55 5–9 is Mobicom)
+gatewayFor("60112233");           // null       (ONDO — no gateway)
+```
+
+### Ported numbers
+
+Mongolia has number portability, and a ported number keeps its original range. Range
+routing will send it to the operator it *left*, which refuses it. There is no public
+ported-number database to check, so when you know the real operator, say so:
+
+```ts
+await sms.send({ to: "99112233", message: "…", operator: "unitel" });
+```
+
+### Message length and cost
+
+A single SMS holds **160** Latin characters but only **70** once it contains one Cyrillic
+letter, and a longer message is split into parts that are each billed. Two helpers deal
+with that. Neither is applied by `send()` — the text you pass is the text that is sent.
+
+```ts
+import { countSegments, toLatin } from "mn-sms";
+
+countSegments("Сайн байна уу? Таны захиалга баталгаажлаа. Хүргэлт маргааш 14 цагт очно. Баярлалаа!");
+// { encoding: "UCS-2", length: 83, segments: 2, perSegment: 67 }
+
+const text = toLatin("Сайн байна уу? Таны захиалга баталгаажлаа. Хүргэлт маргааш 14 цагт очно. Баярлалаа!");
+// "Sain baina uu? Tanii zahialga batalgaajlaa. Hurgelt margaash 14 tsagt ochno. Bayarlalaa!"
+countSegments(text);
+// { encoding: "GSM-7", length: 88, segments: 1, perSegment: 160 }
+
+await sms.send({ to: "99112233", message: text });
+```
+
+`toLatin` writes Mongolian the way it is commonly typed in SMS (`ө` and `ү` → `u`,
+`ы` → `ii`, `х` → `h`), and also replaces the punctuation that silently forces the
+expensive encoding: curly quotes, long dashes, `…`, `№`, `₮`. Pass `{ map: { ө: "o" } }`
+to change a spelling.
+
+`countSegments` is the GSM standard's arithmetic, not an operator's invoice — ask your
+operator how they count. And Skytel and G-Mobile refuse anything over 160 characters
+outright, whatever the encoding.
+
+### Options
+
+```ts
+createSmsClient(config, {
+  timeoutMs: 20_000,   // default; the ceiling Skytel documents
+  fetch: myFetch,      // inject for tests, or to go through a proxy
+});
+```
+
+## What you need from the operators
+
+The short version. The full account of each gateway — its wire format, every refusal code,
+and what is and is not documented — is in **[docs/operators.md](docs/operators.md)**.
+
+**1. A contract and a sender number, per operator.** Each operator sells its own "special
+number" (тусгай дугаар) service to registered organisations. You sign with each one
+separately and receive a sender short number plus API access. The sender is fixed to your
+account: you cannot choose it per message.
+
+**2. Your server's public IP on each operator's allowlist.** This is the requirement that
+catches everyone. All four gateways check the IP the request comes from, and a request from
+anywhere else is refused even with correct credentials. In practice:
+
+- You need a **static egress IP**. Serverless platforms and autoscaled clusters that leave
+  through changing addresses will not work without a NAT gateway or fixed proxy.
+- It will **not work from your laptop** unless that IP is registered too.
+- Moving to a new server or cloud means updating four allowlists *before* you cut over.
+
+**3. One operator's gateway only reaches that operator's subscribers.** Skytel documents this
+(`ERROR: 206`); plan for it everywhere. To reach every Mongolian mobile number you need all
+four accounts, which is exactly what this package's routing is for.
+
+| | Unitel | Skytel | Mobicom | G-Mobile |
+| --- | --- | --- | --- | --- |
+| Credentials | API key | registration `id` | `username` + `servicename` | `username` + `password` |
+| Sender | set in portal | `src` | `from` | `from` |
+| IP allowlist | self-service (portal → API key → Hosts) | self-service (portal → Allowed IP List) | ask Mobicom | ask G-Mobile |
+| Transport | HTTPS, POST JSON | HTTPS, GET | HTTP, GET | HTTP, GET |
+| Accepted answer | HTTP 2xx | body `OK` | body `Sent` | body `0: Accepted for delivery` |
+| Refusal | non-2xx | `ERROR: <code> …` under 200 | anything else | `error1`…`error6` under 200 |
+| Max length | not documented | 160 chars | not documented | 160 chars |
+| Cyrillic | same endpoint | separate endpoint (handled for you) | same endpoint | same endpoint |
+| Numbers | 88 89 86 80, 50/55 0–4 | 90 91 96, parts of 69 | 99 95 94 85, 50/55 5–9 | 98 0–1 & 8–9, 93 97 83 0–1, 87 00–11 |
+
+**ONDO** (60, 66, 8181) has number ranges but no gateway in this package. Sends to those
+numbers return `unsupported_operator`.
+
+### Things worth knowing before production
+
+- **Mobicom and G-Mobile are plain HTTP.** Your credentials and every message body cross the
+  network unencrypted. That is the operators' endpoint, not a choice made here.
+- **`ok: true` means the gateway accepted the message, not that the handset received it.**
+  None of these send APIs returns a message id or a delivery report.
+- **There is no rate limiting or deduplication in this package.** A public OTP endpoint
+  needs its own per-number cooldown, or it is an open tap on your SMS bill.
+- **Long Cyrillic messages cost more.** See [Message length and cost](#message-length-and-cost).
+
+## Using one gateway directly
+
+Each operator is exported on its own if you do not want routing:
+
+```ts
+import { createSkytelGateway, resolveTransport } from "mn-sms";
+
+const skytel = createSkytelGateway({ id, src }, resolveTransport());
+await skytel.send("91112233", "hello"); // takes an already-normalized number
+```
+
+[docs/gateways.http](docs/gateways.http) has the raw HTTP requests, for probing a gateway
+with no code at all.
+
+## Development
+
+```bash
+npm install
+npm test          # node:test, with a stubbed fetch — nothing is ever sent
+npm run typecheck
+npm run build     # dist/ — ESM, CJS and type declarations
+```
+
+There are no live-gateway tests: a real send costs money, reaches a real subscriber and only
+works from an allowlisted IP.
+
+### Releasing
+
+Pushing a `v*` tag publishes to npm from GitHub Actions
+([.github/workflows/publish.yml](.github/workflows/publish.yml)). The tag must match the
+version in `package.json`:
+
+```bash
+npm version patch     # bumps package.json, commits, tags
+git push --follow-tags
+```
+
+The workflow needs an `NPM_TOKEN` repository secret (an npm automation token with publish
+rights). It publishes with [provenance](https://docs.npmjs.com/generating-provenance-statements),
+which npm only accepts from a public repository.
+
+## License
+
+MIT

package/README.mn.md

@@ -0,0 +1,255 @@
+# mn-sms
+
+[English](README.md) · **Монгол**
+
+Монголын үүрэн холбооны операторуудын — **Юнител**, **Мобиком**, **Скайтел**,
+**Жи-Мобайл** — өөрсдийнх нь SMS гарцаар нэг клиентээс мессеж илгээнэ. Та дугаар болон
+текстээ өгөхөд тухайн дугаар аль операторынх болохыг тодорхойлж, тэр операторын гарц руу
+хүсэлт илгээдэг.
+
+- Гадны сан огт ашиглаагүй. Node 18+ (суурь `fetch`-ийг ашиглана). ESM болон CommonJS,
+  TypeScript төрөлтэй.
+- Дугаарын эхний хоёр оронгоор таамаглахгүй, албан ёсны дугаарын хуваарилалтаар чиглүүлнэ.
+- Гарц бүрийн жинхэнэ хариуг уншина: дөрвөн гарцын гурав нь татгалзсан үедээ ч HTTP `200`
+  буцаадаг.
+- Нэвтрэх мэдээллийг үр дүн, алдааны мессеж, лог руу хэзээ ч гаргахгүй.
+
+> **Энэ бол SMS зуучлагч үйлчилгээ биш.** Энэ сангийн ард дундын ямар ч бүртгэл байхгүй.
+> Мессеж илгээх оператор бүртэйгээ та өөрөө гэрээ байгуулсан байх шаардлагатай —
+> [Операторуудаас юу авах шаардлагатай вэ](#операторуудаас-юу-авах-шаардлагатай-вэ) хэсгийг
+> үзнэ үү.
+
+## Суулгах
+
+```bash
+npm install mn-sms
+```
+
+## Ашиглах
+
+```ts
+import { createSmsClient } from "mn-sms";
+
+const sms = createSmsClient({
+  // Зөвхөн гэрээтэй операторуудаа тохируулна.
+  unitel: { apiKey: process.env.UNITEL_API_KEY! },
+  skytel: { id: process.env.SKYTEL_ID!, src: process.env.SKYTEL_SRC! },
+  mobicom: {
+    baseUrl: process.env.MOBICOM_BASE_URL!,
+    serviceName: process.env.MOBICOM_SERVICE_NAME!,
+    username: process.env.MOBICOM_USERNAME!,
+    from: process.env.MOBICOM_FROM!,
+  },
+  gmobile: {
+    username: process.env.GMOBILE_USERNAME!,
+    password: process.env.GMOBILE_PASSWORD!,
+    from: process.env.GMOBILE_FROM!,
+  },
+});
+
+const result = await sms.send({ to: "99112233", message: "Таны код: 1234" });
+
+if (!result.ok) {
+  console.error(result.gateway, result.error?.code, result.error?.message);
+}
+```
+
+Эсвэл орчны хувьсагчаас уншуулж болно (хувьсагчийн нэрс [.env.example](.env.example)-д бий):
+
+```ts
+import { configFromEnv, createSmsClient } from "mn-sms";
+
+const sms = createSmsClient(configFromEnv());
+```
+
+### `send()` хэзээ ч exception шидэхгүй
+
+Амжилттай, амжилтгүй аль ч тохиолдолд үр дүнг объект хэлбэрээр буцаана. Тиймээс хоёуланг
+нь нэг ижил аргаар бүртгэж болно:
+
+```ts
+{
+  ok: false,
+  to: "91112233",            // 8 оронтой болгож цэвэрлэсэн дугаар
+  operator: "skytel",        // дугаарыг эзэмшигч оператор
+  gateway: "skytel",         // хүсэлт очсон гарц
+  statusCode: 200,           // тийм, 200 — доор тайлбарласан
+  request: { method, url, params },   // илгээсэн хүсэлт, нэвтрэх мэдээлэлГҮЙ
+  response: "ERROR: 202 not authenticated",   // гарцын хариу, яг байгаагаар нь
+  error: {
+    code: "rejected",
+    gatewayCode: "202",
+    message: "not authenticated — wrong id, or the calling IP is not on the Allowed IP List",
+  },
+}
+```
+
+| `error.code` | Утга | Сүлжээгээр хүсэлт явсан уу? |
+| --- | --- | --- |
+| `invalid_number` | Монголын 8 оронтой дугаар биш. | үгүй |
+| `unallocated_number` | 8 оронтой боловч аль ч операторын хуваарилалтад байхгүй. | үгүй |
+| `unsupported_operator` | ОНДО-гийн дугаар; энэ санд гарц нь байхгүй. | үгүй |
+| `not_configured` | Операторын гарц бий, гэхдээ та тохиргоог нь өгөөгүй. | үгүй |
+| `empty_message` | Текст хоосон. | үгүй |
+| `message_too_long` | Тухайн гарцын хязгаараас урт (Скайтел, Жи-Мобайл: 160). | үгүй |
+| `rejected` | Гарц хариу өгсөн боловч татгалзсан. Шалтгааныг `gatewayCode`, `response`-оос харна. | тийм |
+| `timeout` | `timeoutMs` хугацаанд хариу ирээгүй. ⚠️ **Илгээгдсэн эсэх нь тодорхойгүй** — мессеж хүрсэн байж магадгүй. OTP-г дахин илгээхээсээ өмнө бодоорой. | тийм |
+| `network` | Хүсэлт дуусаагүй (DNS, холболт татгалзсан, буруу хаяг). | тийм |
+
+`sms.check({ to, message })` нь "үгүй" гэсэн мөрүүдийн шалгалтыг дангаар нь хийж, алдаа эсвэл
+`null` буцаана. Мессеж үрэхээс өмнө формоо шалгахад тохиромжтой.
+
+### Утасны дугаар
+
+`to` нь 8 оронтой дугаар. `+976`, `976`, `00976`, хоосон зай, зураасыг автоматаар арилгана.
+Туслах функцуудыг тусад нь ашиглаж болно:
+
+```ts
+import { gatewayFor, normalizePhone, operatorFor } from "mn-sms";
+
+normalizePhone("+976 9911-2233"); // "99112233"
+operatorFor("55501234");          // "mobicom"  (55 0–4 нь Юнител, 55 5–9 нь Мобиком)
+gatewayFor("60112233");           // null       (ОНДО — гарц байхгүй)
+```
+
+### Дугаараа хадгалан шилжсэн хэрэглэгч
+
+Монголд дугаараа хадгалан оператор солих боломжтой бөгөөд шилжсэн дугаар анхны
+хуваарилалтдаа хэвээр үлддэг. Тиймээс хуваарилалтаар чиглүүлэхэд мессеж *хуучин*
+оператор руу нь очиж, татгалзсан хариу авна. Шилжсэн дугаарын нээлттэй сан байхгүй тул
+жинхэнэ операторыг нь мэдэж байвал өөрөө зааж өгнө:
+
+```ts
+await sms.send({ to: "99112233", message: "…", operator: "unitel" });
+```
+
+### Мессежийн урт ба өртөг
+
+Нэг SMS-д латин үсгээр **160** тэмдэгт багтдаг бол ганц кирилл үсэг орсон даруйд ердөө
+**70** болдог. Үүнээс урт мессеж хэд хэдэн хэсэгт хуваагдаж, хэсэг бүр тусдаа тооцогдоно.
+Үүнд зориулсан хоёр туслах функц бий. `send()` эдгээрийг автоматаар ажиллуулахгүй — таны
+өгсөн текст яг тэр чигээрээ илгээгдэнэ.
+
+```ts
+import { countSegments, toLatin } from "mn-sms";
+
+countSegments("Сайн байна уу? Таны захиалга баталгаажлаа. Хүргэлт маргааш 14 цагт очно. Баярлалаа!");
+// { encoding: "UCS-2", length: 83, segments: 2, perSegment: 67 }
+
+const text = toLatin("Сайн байна уу? Таны захиалга баталгаажлаа. Хүргэлт маргааш 14 цагт очно. Баярлалаа!");
+// "Sain baina uu? Tanii zahialga batalgaajlaa. Hurgelt margaash 14 tsagt ochno. Bayarlalaa!"
+countSegments(text);
+// { encoding: "GSM-7", length: 88, segments: 1, perSegment: 160 }
+
+await sms.send({ to: "99112233", message: text });
+```
+
+`toLatin` нь монгол үгийг SMS-д түгээмэл бичдэг галигаар хөрвүүлнэ (`ө`, `ү` → `u`,
+`ы` → `ii`, `х` → `h`). Мөн үнэтэй кодчилол руу чимээгүй шилжүүлдэг тэмдэгтүүдийг сольдог:
+муруй хашилт, урт зураас, `…`, `№`, `₮`. Галигийг өөрчлөх бол `{ map: { ө: "o" } }` гэж
+дамжуулна.
+
+`countSegments` нь GSM стандартын тооцоо болохоос операторын нэхэмжлэх биш — хэрхэн
+тоолдгийг оператороосоо лавлаарай. Скайтел, Жи-Мобайл хоёр кодчиллоос үл хамааран 160
+тэмдэгтээс урт мессежийг шууд буцаадаг.
+
+### Тохиргоо
+
+```ts
+createSmsClient(config, {
+  timeoutMs: 20_000,   // анхны утга; Скайтелийн зааварт буй дээд хязгаар
+  fetch: myFetch,      // тест хийх эсвэл proxy-оор дамжуулахад
+});
+```
+
+## Операторуудаас юу авах шаардлагатай вэ
+
+Доорх нь товч хувилбар. Гарц бүрийн хүсэлтийн хэлбэр, татгалзлын код бүр, юу нь
+баримтжсан, юу нь баримтжаагүй тухай дэлгэрэнгүйг
+**[docs/operators.mn.md](docs/operators.mn.md)** файлаас үзнэ үү.
+
+**1. Оператор бүртэй гэрээ байгуулж, тусгай дугаар авна.** Оператор бүр бүртгэлтэй
+байгууллагад "тусгай дугаар"-ын үйлчилгээг тус тусдаа худалддаг. Оператор тус бүртэй
+гэрээ хийж, илгээгчийн богино дугаар болон API-ийн эрхээ авна. Илгээгчийн дугаар таны
+бүртгэлд бэхлэгдсэн байдаг тул мессеж бүрт өөрөөр сонгох боломжгүй.
+
+**2. Серверийнхээ гадаад IP хаягийг оператор бүрт бүртгүүлнэ.** Хүн бүр яг энэ шаардлага
+дээр гацдаг. Дөрвөн гарц бүгд хүсэлт ирсэн IP хаягийг шалгадаг бөгөөд бүртгэлгүй хаягаас
+ирсэн хүсэлтийг нэвтрэх мэдээлэл зөв байсан ч буцаана.
+
+| Оператор | IP хаягаа хэрхэн бүртгүүлэх | Бүртгэлгүй хаягаас илгээвэл |
+| --- | --- | --- |
+| Юнител | Өөрөө, порталаас: Settings → API key → Hosts | татгалзана |
+| Скайтел | Өөрөө, порталаас: Change configurations → Allowed IP List (цэгтэй таслалаар тусгаарлана) | `ERROR: 202 not authenticated` |
+| Мобиком | Мобикомд хүсэлт гаргаж бүртгүүлнэ | татгалзана |
+| Жи-Мобайл | Жи-Мобайлд хүсэлт гаргаж бүртгүүлнэ | `error3` |
+
+Бодит байдал дээр энэ нь:
+
+- **Тогтмол гадаад IP хаяг** хэрэгтэй. Гарах хаяг нь солигддог serverless платформ,
+  автоматаар өргөждөг кластер зэрэг нь NAT gateway эсвэл тогтмол proxy-гүйгээр ажиллахгүй.
+- IP нь бүртгэлгүй бол **таны компьютерээс ажиллахгүй**.
+- Шинэ сервер эсвэл клауд руу нүүхдээ дөрвөн операторын жагсаалтыг *нүүхээсээ өмнө*
+  шинэчилнэ.
+
+**3. Нэг операторын гарц зөвхөн өөрийн хэрэглэгчид рүү хүргэнэ.** Скайтел үүнийг заавартаа
+бичсэн байдаг (`ERROR: 206`); бусдыг ч мөн адил гэж тооцоорой. Монголын бүх гар утасны
+дугаарт хүрэхийн тулд дөрвөн операторт дөрвүүлэнд нь бүртгэлтэй байх хэрэгтэй бөгөөд энэ
+сангийн чиглүүлэлт яг үүнд зориулагдсан.
+
+| | Юнител | Скайтел | Мобиком | Жи-Мобайл |
+| --- | --- | --- | --- | --- |
+| Нэвтрэх мэдээлэл | API key | бүртгэлийн дугаар `id` | `username` + `servicename` | `username` + `password` |
+| Илгээгч | порталд тохируулна | `src` | `from` | `from` |
+| Холболт | HTTPS, POST JSON | HTTPS, GET | HTTP, GET | HTTP, GET |
+| Амжилттай хариу | HTTP 2xx | `OK` | `Sent` | `0: Accepted for delivery` |
+| Татгалзсан хариу | 2xx биш | 200 дотор `ERROR: <код> …` | бусад бүх хариу | 200 дотор `error1`…`error6` |
+| Дээд урт | баримтжаагүй | 160 тэмдэгт | баримтжаагүй | 160 тэмдэгт |
+| Кирилл | нэг endpoint | тусдаа endpoint (автоматаар сонгоно) | нэг endpoint | нэг endpoint |
+| Дугаар | 88 89 86 80, 50/55 0–4 | 90 91 96, 69-ийн хэсэг | 99 95 94 85, 50/55 5–9 | 98 0–1 ба 8–9, 93 97 83 0–1, 87 00–11 |
+
+**ОНДО** (60, 66, 8181) дугаарын хуваарилалттай боловч энэ санд гарц нь байхгүй. Эдгээр
+дугаар руу илгээхэд `unsupported_operator` буцна.
+
+### Бодит орчинд гаргахаас өмнө мэдэх зүйлс
+
+- **Мобиком, Жи-Мобайл хоёр энгийн HTTP ашигладаг.** Таны нэвтрэх мэдээлэл болон мессеж
+  бүрийн агуулга сүлжээгээр шифрлэгдээгүй дамжина. Энэ нь операторын гарцын онцлог болохоос
+  энэ сангийн сонголт биш.
+- **`ok: true` гэдэг нь гарц мессежийг хүлээн авсан гэсэн үг, утсанд хүрсэн гэсэн үг биш.**
+  Эдгээр API-ийн аль нь ч мессежийн дугаар эсвэл хүргэлтийн тайлан буцаадаггүй.
+- **Энэ санд илгээлтийн хязгаарлалт, давхардал шалгалт байхгүй.** Нийтэд нээлттэй OTP
+  endpoint нь дугаар тус бүрт хүлээх хугацаатай байх ёстой, эс бөгөөс таны SMS-ийн
+  төлбөрийг хэн ч өсгөж чадна.
+- **Урт кирилл мессеж илүү үнэтэй.** [Мессежийн урт ба өртөг](#мессежийн-урт-ба-өртөг)
+  хэсгийг үзнэ үү.
+
+## Нэг гарцыг шууд ашиглах
+
+Чиглүүлэлт хэрэггүй бол оператор бүрийг тусад нь ашиглаж болно:
+
+```ts
+import { createSkytelGateway, resolveTransport } from "mn-sms";
+
+const skytel = createSkytelGateway({ id, src }, resolveTransport());
+await skytel.send("91112233", "hello"); // 8 оронтой болгосон дугаар авна
+```
+
+[docs/gateways.http](docs/gateways.http) файлд гарцуудыг кодгүйгээр шалгах түүхий HTTP
+хүсэлтүүд бий.
+
+## Хөгжүүлэлт
+
+```bash
+npm install
+npm test          # node:test, fetch-ийг орлуулсан — юу ч илгээгдэхгүй
+npm run typecheck
+npm run build     # dist/ — ESM, CJS, төрлийн тодорхойлолт
+```
+
+Бодит гарц руу илгээдэг тест байхгүй: жинхэнэ илгээлт мөнгө зарцуулж, бодит хэрэглэгчид
+хүрдэг бөгөөд зөвхөн бүртгэлтэй IP хаягаас л ажилладаг.
+
+## Лиценз
+
+MIT