@applite/js-sdk 0.0.1

package/README.md

@@ -0,0 +1,137 @@
+# @applite/js-sdk
+
+A lightweight JavaScript SDK for interacting with Applite UI customer APIs.
+
+## Installation
+
+```bash
+pnpm add @applite/js-sdk
+```
+
+## Usage
+
+Each method accepts a **single object** that always includes `appId` and `apiKey`, plus fields required by the specific route.
+
+### Instantiate the client
+
+```ts
+import { AppliteUI } from "@applite/js-sdk";
+
+const client = new AppliteUI({
+  baseUrl: "https://api.example.com", // optional, defaults to relative paths
+});
+```
+
+### List customers
+
+```ts
+await client.app.customer.list({
+  appId: "app_123", // required for the URL path
+  apiKey: "api_key_abc", // required for verification
+  plateformType: ["STORE", "TRANSPORT"], // optional filter
+});
+```
+
+### List a few recent customers
+
+```ts
+await client.app.customer.listFew({
+  appId: "app_123",
+  apiKey: "api_key_abc",
+  plateformType: ["STORE"],
+});
+```
+
+### Authenticate or register a customer
+
+```ts
+await client.app.customer.auth({
+  appId: "app_123",
+  apiKey: "api_key_abc",
+  fullname: "Ada Lovelace",
+  telephone: "+2250700000000",
+  email: "ada@example.com", // optional
+  plateform: "STORE", // optional
+});
+```
+
+### Check if a customer exists
+
+```ts
+await client.app.customer.check({
+  appId: "app_123",
+  apiKey: "api_key_abc",
+  telephone: "+2250700000000",
+  plateform: "STORE", // optional
+});
+```
+
+### Get a customer by id
+
+```ts
+await client.app.customer.get({
+  appId: "app_123",
+  apiKey: "api_key_abc",
+  id: "customer_456",
+});
+```
+
+### Update a customer profile
+
+```ts
+await client.app.customer.update({
+  appId: "app_123",
+  apiKey: "api_key_abc",
+  id: "customer_456",
+  fullname: "New Name", // optional
+  email: "new-email@example.com", // optional
+  photoUrl: "https://cdn.example.com/avatar.png", // optional
+  gender: "F", // optional, "M" | "F"
+  dob: "1990-01-01", // optional
+  country: "CI", // optional
+});
+```
+
+### Work with other app modules
+
+Additional helpers map to the remaining API routes using the same single-object parameter style:
+
+```ts
+// List all apps for the authenticated user
+await client.app.info.list({ apiKey: "api_key_abc" });
+
+// Create a product inside the store module
+await client.app.store.product.create({
+  appId: "app_123",
+  apiKey: "api_key_abc",
+  name: "T-shirt",
+  sellerId: "seller_1",
+  categoryId: "cat_1",
+  variants: [{ price: 20, quantity: 5, images: [], valueIds: [] }],
+});
+
+// Record statistics or query balances
+await client.app.stats.create({
+  appId: "app_123",
+  apiKey: "api_key_abc",
+  type: "ORDERS",
+  year: 2024,
+  month: "JANUARY",
+  amount: 10,
+});
+
+await client.app.finance.balance({ appId: "app_123", apiKey: "api_key_abc" });
+
+// Manage welcome screen items
+await client.app.welcomeItem.create({
+  appId: "app_123",
+  apiKey: "api_key_abc",
+  fileUrl: "https://cdn.example.com/banner.png",
+  plateformType: "STORE",
+});
+```
+
+## Scripts
+
+- `pnpm build` – build CJS/ESM bundles with type declarations.
+- `pnpm test` – run the build with declaration output to validate types.