@zindua/sdk 1.2.0 → 1.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -2,8 +2,11 @@
2
2
 
3
3
  Official **server-side** SDK for [Zindua](https://zindua.run): one API for transactional **email** and **WhatsApp** (`POST /api/v1/send`).
4
4
 
5
+ **npm:** [https://www.npmjs.com/package/@zindua/sdk](https://www.npmjs.com/package/@zindua/sdk) (this URL does not change when we ship new versions)
6
+
5
7
  | Resource | Link |
6
8
  |----------|------|
9
+ | npm package | [npmjs.com/package/@zindua/sdk](https://www.npmjs.com/package/@zindua/sdk) |
7
10
  | Website | [zindua.run](https://zindua.run) |
8
11
  | Developer documentation | [zindua.run/developers](https://zindua.run/developers) |
9
12
  | HTTP / cURL (no SDK) | [zindua.run/developers#http](https://zindua.run/developers#http) |
@@ -199,6 +202,13 @@ Full reference: [HTTP / cURL](https://zindua.run/developers#http).
199
202
 
200
203
  ---
201
204
 
205
+ ## Releases and versioning
206
+
207
+ - The registry page [npmjs.com/package/@zindua/sdk](https://www.npmjs.com/package/@zindua/sdk) is **permanent**.
208
+ - Each release only updates the **version** (`1.2.0`, `1.2.1`, `1.3.0`, …) using [semver](https://semver.org/).
209
+ - Consumers pin in `package.json`: `"@zindua/sdk": "^1.2.0"`, or run `npm update @zindua/sdk` for the latest compatible version.
210
+ - Maintainers: bump `version` in `package.json`, sync `SDK_VERSION` in `src/client.ts`, then `npm publish --access public` from this folder (see `PUBLISHING.md`).
211
+
202
212
  ## Local development (monorepo)
203
213
 
204
214
  ```bash
package/dist/client.js CHANGED
@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.Zindua = void 0;
4
4
  const errors_1 = require("./errors");
5
5
  const validate_1 = require("./validate");
6
- const SDK_VERSION = "1.2.0";
6
+ const SDK_VERSION = "1.2.1";
7
7
  const USER_AGENT = `Zindua-JS/${SDK_VERSION}`;
8
8
  function buildPayload(options, channel) {
9
9
  const to = (0, validate_1.validateRecipient)(options.to, channel);
package/package.json CHANGED
@@ -1,18 +1,10 @@
1
1
  {
2
2
  "name": "@zindua/sdk",
3
- "version": "1.2.0",
3
+ "version": "1.2.1",
4
4
  "description": "Official Zindua SDK for Node.js — transactional email and WhatsApp via POST /api/v1/send.",
5
- "author": "Zindua <https://zindua.run>",
5
+ "author": "Zindua",
6
6
  "license": "MIT",
7
7
  "homepage": "https://zindua.run/developers#sdks",
8
- "repository": {
9
- "type": "git",
10
- "url": "git+https://github.com/bbasabana/zindua.git",
11
- "directory": "packages/zindua-js"
12
- },
13
- "bugs": {
14
- "url": "https://github.com/bbasabana/zindua/issues"
15
- },
16
8
  "keywords": [
17
9
  "zindua",
18
10
  "email",