tiny-ok-message 0.1.0

package/README.md

@@ -0,0 +1,73 @@
+![banner](https://github.com/user-attachments/assets/320dfbd4-3714-48d0-bbf6-ddc435fa662e)
+![npm](https://img.shields.io/npm/v/tiny-ok-message)
+![downloads](https://img.shields.io/npm/dw/tiny-ok-message)
+![license](https://img.shields.io/npm/l/tiny-ok-message)
+![Security Policy](https://img.shields.io/badge/security-policy-brightgreen)
+![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/tiny-ok-message)
+
+# tiny-ok-message
+An intentionally small, fetch-based package that is useful for quick API-client experiments.
+
+### 📦 Installation
+
+```console
+npm install tiny-ok-message
+```
+
+### 📘 Features
+
+1. One small exported helper: `getOkMessage`
+2. Accepts a typed input object shaped as `{ message: string }`
+3. Calls the DummyJSON HTTP 200 endpoint with a URL-encoded message
+4. Returns a typed response shaped as `{ status: string; message: string }`
+5. TypeScript ready with generated declaration files
+6. ESM package output through `dist`
+7. Unit tested with Jest and `ts-jest`
+
+### 🔤 Example Usage
+
+```ts
+/* node modules */
+import { getOkMessage } from 'tiny-ok-message';
+
+/* example */
+async function run() {
+  const response = await getOkMessage({ message: 'hello world' });
+  console.log(response);
+}
+await run();
+```
+
+Expected response shape:
+
+```ts
+{ status: "200", message: "hello world" }
+```
+
+### 📗 Test Coverage
+
+```console
+PASS src/messages/test/get-ok-message.test.ts
+  getOkMessage
+    ✓ fetches the OK message from DummyJSON
+    ✓ throws when the request fails
+```
+
+```console
+-------------------|---------|----------|---------|---------|-------------------
+File               | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
+-------------------|---------|----------|---------|---------|-------------------
+All files          |     100 |      100 |     100 |     100 |
+ get-ok-message.ts |     100 |      100 |     100 |     100 |
+-------------------|---------|----------|---------|---------|-------------------
+```
+
+### 🔒 Security & Privacy
+
+1. This package is open source and designed as a tiny API helper for the public DummyJSON HTTP endpoint. It does not collect, store, sell, rent, trade, monetize, or process personal data for its own purposes.
+2. The package only makes HTTP requests as part of its documented behavior. Any data handled by the package is limited to the `message` value explicitly provided by the consuming application.
+3. This package does not include analytics, tracking, telemetry, advertising, hidden background services, install scripts, or project-owned data collection systems.
+
+### ❤️ Support
+
+Like this project? Support it with a GitHub star. Cheers and happy coding.

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./messages/get-ok-message.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from "./messages/get-ok-message.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC"}

package/dist/messages/get-ok-message.d.ts

@@ -0,0 +1,9 @@
+export type GetOkMessageProps = {
+    message: string;
+};
+export type OkMessageResponse = {
+    status: string;
+    message: string;
+};
+export declare function getOkMessage({ message }: GetOkMessageProps): Promise<OkMessageResponse>;
+//# sourceMappingURL=get-ok-message.d.ts.map

package/dist/messages/get-ok-message.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-ok-message.d.ts","sourceRoot":"","sources":["../../src/messages/get-ok-message.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,wBAAsB,YAAY,CAAC,EACjC,OAAO,EACR,EAAE,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAShD"}

package/dist/messages/get-ok-message.js

@@ -0,0 +1,9 @@
+export async function getOkMessage({ message }) {
+    const encodedMessage = encodeURIComponent(message);
+    const response = await fetch(`https://dummyjson.com/http/200/${encodedMessage}`);
+    if (!response.ok) {
+        throw new Error(`Failed to fetch OK message. Status: ${response.status}`);
+    }
+    return response.json();
+}
+//# sourceMappingURL=get-ok-message.js.map

package/dist/messages/get-ok-message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-ok-message.js","sourceRoot":"","sources":["../../src/messages/get-ok-message.ts"],"names":[],"mappings":"AASA,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,EACjC,OAAO,EACW;IAClB,MAAM,cAAc,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;IACnD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,kCAAkC,cAAc,EAAE,CAAC,CAAC;IAEjF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,uCAAuC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED,OAAO,QAAQ,CAAC,IAAI,EAAgC,CAAC;AACvD,CAAC"}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "tiny-ok-message",
+  "description": "A tiny TypeScript helper for fetching an OK response message from DummyJSON.",
+  "keywords": [
+    "dummyjson",
+    "ok-message",
+    "typescript",
+    "api-client",
+    "fetch",
+    "http",
+    "utility"
+  ],
+  "license": "MIT",
+  "version": "0.1.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf -v ./coverage ./dist",
+    "prepublishOnly": "npm run build",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage --verbose"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "ts-jest": "^29.4.6",
+    "typescript": "^5.9.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/NPM-Workbench/tiny-ok-message.git"
+  },
+  "bugs": {
+    "url": "https://github.com/NPM-Workbench/tiny-ok-message/issues"
+  },
+  "homepage": "https://github.com/NPM-Workbench/tiny-ok-message#readme"
+}