eimzo-sign-core 0.1.0 → 0.1.2

package/README.md

@@ -1,62 +1,137 @@
 # eimzo-sign-core
 
-E-IMZO (O'zbekiston ARM) bilan imzolashning **framework-agnostik yadrosi**.
-Vue / React / vanilla — farqi yo'q.
+E-IMZO bilan imzolash mantig'i — **oynasiz**, framework'siz.
+UI'ni o'zingiz qurasiz. Vue / React / oddiy JS — farqi yo'q.
 
-## Kafolatlar
+Tayyor Vue oyna kerak bo'lsa: [`eimzo-sign-vue`](https://www.npmjs.com/package/eimzo-sign-vue).
 
-- Har CAPIWS chaqiruvida **timeout** (osilib qolmaydi).
-- `signBatch` kalitni **bir marta** yuklaydi — parol bir marta so'raladi.
-- Har imzodan keyin **seriya raqami** tanlangan sertifikatga tekshiriladi
-  (`E_SERIAL_MISMATCH`).
-- Sessiya tugagach yuklangan kalit holati JS'da **saqlanmaydi**.
-- `console` ga **hech narsa yozilmaydi** — barchasi `onAudit(event)` orqali,
-  faqat `serial` / `docId` (shaxsiy ma'lumot emas).
-- Barcha rad etishlar `EimzoError` — barqaror `.code` bilan.
+---
 
-## Foydalanish
+## O'rnatish
+
+```sh
+npm i eimzo-sign-core
+```
+
+---
+
+## Ishlatish
 
 ```ts
 import { EimzoClient } from 'eimzo-sign-core'
 
 const eimzo = new EimzoClient({
-  apiKeys: [['example.uz', process.env.EIMZO_KEY!]],
-  timeoutMs: 30_000,
-  onAudit: (e) => auditLog.write(e),
+  apiKeys: [['example.uz', import.meta.env.VITE_EIMZO_KEY]],   // .env dan
 })
 
-await eimzo.install()                    // versiya + API kalitlari
-const certs = await eimzo.listCerts()    // Cert[]
+// 1. E-IMZO ga ulanish
+await eimzo.install()
+
+// 2. Sertifikatlar ro'yxati
+const certs = await eimzo.listCerts()
+
+// 3. Imzolash
+const res = await eimzo.sign(certs[0], 'Salom dunyo')
+console.log(res.pkcs7_64)          // imzo — serverga shuni yuborasiz
+```
+
+### Bir nechta hujjat
+
+Kalit **bir marta** yuklanadi (bitta parol):
+
+```ts
 const items = await eimzo.signBatch(certs[0], [
-  { id: 'doc-1', content: xml1 },
-  { id: 'doc-2', content: xml2 },
+  { id: 'a', content: xml1 },
+  { id: 'b', content: xml2 },
+  { id: 'c', content: xml3 },
 ], {
-  signal: abortController.signal,
-  onProgress: (p) => console.debug(p.done, '/', p.total),
+  onProgress: (p) => console.log(`${p.done}/${p.total}`),
 })
-// items: ({ id, ok:true, pkcs7_64, signature_hex, signer_serial_number } | { id, ok:false, error })[]
+
+for (const it of items) {
+  if (it.ok) await api.send(it)          // { id, pkcs7_64, signature_hex, signer_serial_number }
+  else console.warn(it.id, it.error.code) // bittasi xato bo'lsa qolganlari davom etadi
+}
 ```
 
-## API
+### Xatolarni ushlash
 
-| Metod | Qaytadi |
+```ts
+import { EimzoError } from 'eimzo-sign-core'
+
+try {
+  await eimzo.install()
+} catch (e) {
+  if (EimzoError.is(e, 'E_NOT_INSTALLED')) alert('E-IMZO dasturini ishga tushiring')
+  else if (EimzoError.is(e, 'E_VERSION_LOW')) alert('E-IMZO ni yangilang')
+  else throw e
+}
+```
+
+---
+
+## Metodlar
+
+| Metod | Nima qiladi |
 |---|---|
-| `install()` | `{ major, minor }` — yoki `E_NOT_INSTALLED` / `E_VERSION_LOW` / `E_API_KEY_REJECTED` |
-| `checkVersion()` | `{ major, minor }` |
-| `listCerts()` | `Cert[]` (normallashtirilgan; `raw` — vendor obyekti) |
-| `isIdCardPlugged()` | `boolean` (timeout'da `false`) |
-| `signBatch(cert, docs, opts?)` | `BatchSignItem[]` |
-| `sign(cert, content, opts?)` | `BatchSignItem` |
-| `EimzoClient.idCardCert()` | ID-karta uchun belgili `Cert` |
+| `install()` | Versiyani tekshiradi, API kalitlarini o'rnatadi. Boshida bir marta. |
+| `listCerts()` | Sertifikatlar ro'yxati (`Cert[]`) |
+| `isIdCardPlugged()` | ID-karta o'quvchi ulanganmi (`boolean`) |
+| `sign(cert, matn)` | Bitta hujjatni imzolaydi |
+| `signBatch(cert, docs, opts?)` | Bir nechta hujjatni bitta kalit bilan imzolaydi |
+| `EimzoClient.idCardCert()` | ID-karta uchun "sertifikat" obyekti |
+
+Yordamchilar: `sortCerts` (amaldagilar tepada), `certIsUsable`, `certIsExpired`,
+`certExpiresSoon`, `dedupeCerts`.
+
+### `signBatch` natijasi
+
+```ts
+[
+  { id: 'a', ok: true,  pkcs7_64, signature_hex, signer_serial_number },
+  { id: 'b', ok: false, error: EimzoError },
+]
+```
+
+---
+
+## Sozlamalar
+
+```ts
+new EimzoClient({
+  apiKeys: [['domen', 'kalit']],   // majburiy — E-IMZO beradi
+  timeoutMs: 30_000,               // har chaqiruv uchun kutish
+  onAudit: (e) => log(e),          // kuzatuv; kutubxona console ga yozmaydi
+})
+```
+
+---
+
+## Xato kodlari
+
+`error.code` (matnni emas):
+
+`E_NOT_INSTALLED` · `E_VERSION_LOW` · `E_API_KEY_REJECTED` · `E_NO_CERTS` ·
+`E_KEY_LOAD_CANCELLED` · `E_SERIAL_MISMATCH` · `E_SIGN_FAILED` · `E_TIMEOUT` ·
+`E_CANCELLED` · `E_TRANSPORT` · `E_MISCONFIGURED`
+
+---
+
+## Nima kafolatlanadi
+
+- Har chaqiruvda timeout bor — osilib qolmaydi.
+- `signBatch` da parol bir marta so'raladi.
+- Har imzodan keyin sertifikat raqami tekshiriladi (`E_SERIAL_MISMATCH`).
+- Kutubxona `console` ga hech narsa yozmaydi — hammasi `onAudit` orqali,
+  faqat `serial` va `docId` (shaxsiy ma'lumot emas).
+
+**Serverda tekshiring** — bu kutubxona imzo yasaydi, autentifikatsiya qilmaydi.
 
-Yordamchilar: `certIsExpired`, `certIsNotYetValid`, `certIsUsable`,
-`certExpiresSoon`, `sortCerts`, `dedupeCerts`.
+---
 
 ## Vendored SDK
 
-`src/vendor/` — E-IMZO rasmiy brauzer SDK'si, 3 qatorlik bundler-moslik patchi
-bilan. Manba, versiya, SHA-256 va yangilash tartibi:
-[`src/vendor/VENDOR.md`](src/vendor/VENDOR.md).
+`src/vendor/` — E-IMZO rasmiy brauzer SDK'si (3–4 qatorlik bundler-moslik patchi bilan).
+Manba, versiya, SHA-256: [`src/vendor/VENDOR.md`](src/vendor/VENDOR.md).
 
-> SSR: `install()` modul yuklanganda `window.location` ni o'qiydi — faqat
-> brauzerda import qiling.
+> Faqat brauzerda import qiling (SSR emas).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eimzo-sign-core",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Framework-agnostik E-IMZO (O'zbekiston ARM) imzolash yadrosi: tiplangan xatolar, timeout, audit hook, serial tekshiruvi. Ishlab chiqarish muhiti uchun.",
   "license": "MIT",
   "keywords": [