@hobenakicoffee/libraries 0.0.12 → 0.0.13

package/README.md

@@ -1,10 +1,8 @@
 # @hobenakicoffee/libraries
 
-Framework-agnostic shared libraries for “হবে নাকি Coffee?” projects.
+Framework-agnostic shared constants and utilities for “হবে নাকি Coffee?” projects.
 
-## Quick start
-
-Install the package from npm:
+## Installation
 
 ```bash
 npm install @hobenakicoffee/libraries
@@ -16,12 +14,43 @@ yarn add @hobenakicoffee/libraries
 bun add @hobenakicoffee/libraries
 ```
 
-Use it in your app:
+## Usage
+
+This package exposes three entry points:
+
+- `@hobenakicoffee/libraries` (re-exports constants)
+- `@hobenakicoffee/libraries/constants`
+- `@hobenakicoffee/libraries/utils`
+
+Examples:
 
 ```ts
-import { SOME_CONSTANT } from "@hobenakicoffee/libraries";
+import { PaymentStatuses, ServiceTypes } from "@hobenakicoffee/libraries";
+
+import { SupporterPlatforms } from "@hobenakicoffee/libraries/constants";
+
+import {
+  formatAmount,
+  formatDate,
+  getUserPageLink,
+} from "@hobenakicoffee/libraries/utils";
 ```
 
+## API at a glance
+
+### Constants and types
+
+| Entrypoint                            | Runtime exports                                                                                                                                              | Type exports                                                                                                            |
+| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------- |
+| `@hobenakicoffee/libraries`           | Re-exports all constants from `@hobenakicoffee/libraries/constants`                                                                                          | Re-exports all types from `@hobenakicoffee/libraries/constants`                                                         |
+| `@hobenakicoffee/libraries/constants` | `Visibility`, `productInfo`, `companyInfo`, `PaymentTypes`, `PaymentStatuses`, `PaymentProviders`, `PaymentDirections`, `SupporterPlatforms`, `ServiceTypes` | `Visibility`, `PaymentType`, `PaymentStatus`, `PaymentProvider`, `PaymentDirection`, `SupporterPlatform`, `ServiceType` |
+
+### Utilities
+
+| Entrypoint                        | Function exports                                                                                                                                                                                                                       |
+| --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `@hobenakicoffee/libraries/utils` | `formatAmount`, `formatSignedAmount`, `formatDate`, `formatToPlainText`, `formatMetadataKey`, `getSocialUrl`, `getUserPageLink`, `openInNewWindow`, `shareToFacebook`, `shareToInstagram`, `shareToLinkedIn`, `shareToX`, `printQrSvg` |
+
 ## Local development
 
 Install dependencies:
@@ -30,27 +59,26 @@ Install dependencies:
 bun install
 ```
 
-Common tasks:
+Available scripts:
 
 ```bash
+# Build the library
+bun run build
+
 # Run in watch mode during development
 bun run dev
 
-# Run type checking
-bun run typecheck
-
 # Run tests
 bun run test
 
 # Run tests in watch mode
 bun run test:watch
-```
 
-Build artifacts:
+# Run type checking
+bun run typecheck
 
-```bash
-# Build the library
-bun run build
+# Alias for typecheck
+bun run lint
 
 # Clean build artifacts
 bun run clean
@@ -58,10 +86,28 @@ bun run clean
 
 ## Project structure
 
-```
+```text
 src/
-  index.ts          # Main entry point
-  constants/        # Shared constants
+  index.ts
+  constants/
+    common.ts
+    legal.ts
+    payment.ts
+    platforms.ts
+    services.ts
+    index.ts
+  utils/
+    format-amount.ts
+    format-date.ts
+    format-plain-text.ts
+    get-social-handle.ts
+    get-user-page-link.ts
+    open-to-new-window.ts
+    post-to-facebook.ts
+    post-to-instagram.ts
+    post-to-linkedin.ts
+    post-to-x.ts
+    qr-svg-utils.ts
     index.ts
 ```
 
@@ -70,15 +116,10 @@ src/
 Publishing is automated on push to the `main` branch via GitHub Actions. Ensure:
 
 - `package.json` version is updated.
-- `NPM_TOKEN` secret is set in the repo with publish permissions.
+- `NPM_TOKEN` secret is configured with publish permissions.
 
 For local publish (if needed):
 
 ```bash
 npm publish --access public
 ```
-
-## Notes
-
-- This project uses Bun for development and builds.
-- To generate supabase types, follow https://supabase.com/docs/guides/api/rest/generating-types

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hobenakicoffee/libraries",
-  "version": "0.0.12",
+  "version": "0.0.13",
   "type": "module",
   "types": "src/index.ts",
   "exports": {

package/src/constants/payment.test.ts

@@ -4,12 +4,16 @@ import {
   PaymentStatuses,
   PaymentTypes,
   PaymentDirections,
+  PayoutProviders,
+  WithdrawalStatuses,
 } from "./payment";
 import type {
   PaymentProvider,
   PaymentStatus,
   PaymentType,
   PaymentDirection,
+  PayoutProvider,
+  WithdrawalStatus,
 } from "./payment";
 
 describe("PaymentStatuses", () => {
@@ -64,7 +68,15 @@ describe("PaymentStatuses", () => {
 
 describe("PaymentTypes", () => {
   test("should contain all expected keys", () => {
-    const expectedKeys = ["SUBSCRIPTION", "ONE_TIME", "PAYOUT"];
+    const expectedKeys = [
+      "SUBSCRIPTION",
+      "ONE_TIME",
+      "PAYOUT",
+      "WITHDRAW_LOCK",
+      "WITHDRAW_RELEASE",
+      "WITHDRAW_COMPLETE",
+      "MANUAL_ADJUSTMENT",
+    ];
     expect(Object.keys(PaymentTypes)).toEqual(expectedKeys);
   });
 
@@ -72,6 +84,10 @@ describe("PaymentTypes", () => {
     expect(PaymentTypes.SUBSCRIPTION).toBe("subscription");
     expect(PaymentTypes.ONE_TIME).toBe("one-time");
     expect(PaymentTypes.PAYOUT).toBe("payout");
+    expect(PaymentTypes.WITHDRAW_LOCK).toBe("withdraw_lock");
+    expect(PaymentTypes.WITHDRAW_RELEASE).toBe("withdraw_release");
+    expect(PaymentTypes.WITHDRAW_COMPLETE).toBe("withdraw_complete");
+    expect(PaymentTypes.MANUAL_ADJUSTMENT).toBe("manual_adjustment");
   });
 
   test("should be read-only at compile time", () => {
@@ -86,8 +102,8 @@ describe("PaymentTypes", () => {
     expect(validType).toBe("subscription");
   });
 
-  test("should have 3 payment types", () => {
-    expect(Object.keys(PaymentTypes).length).toBe(3);
+  test("should have 7 payment types", () => {
+    expect(Object.keys(PaymentTypes).length).toBe(7);
   });
 
   test("all values should be lowercase or kebab-case strings", () => {
@@ -99,6 +115,61 @@ describe("PaymentTypes", () => {
   });
 });
 
+describe("PayoutProviders", () => {
+  test("should contain all expected provider keys", () => {
+    const expectedKeys = ["BKASH", "NAGAD", "ROCKET", "BANK"];
+    expect(Object.keys(PayoutProviders)).toEqual(expectedKeys);
+  });
+
+  test("should have correct values for each provider", () => {
+    expect(PayoutProviders.BKASH).toBe("bkash");
+    expect(PayoutProviders.NAGAD).toBe("nagad");
+    expect(PayoutProviders.ROCKET).toBe("rocket");
+    expect(PayoutProviders.BANK).toBe("bank");
+  });
+
+  test("PayoutProvider type should accept valid provider values", () => {
+    const validProvider: PayoutProvider = "bkash";
+    expect(validProvider).toBe("bkash");
+  });
+
+  test("should have 4 payout providers", () => {
+    expect(Object.keys(PayoutProviders).length).toBe(4);
+  });
+});
+
+describe("WithdrawalStatuses", () => {
+  test("should contain all expected status keys", () => {
+    const expectedKeys = [
+      "REQUESTED",
+      "APPROVED",
+      "PROCESSING",
+      "PAID",
+      "REJECTED",
+      "FAILED",
+    ];
+    expect(Object.keys(WithdrawalStatuses)).toEqual(expectedKeys);
+  });
+
+  test("should have correct values for each status", () => {
+    expect(WithdrawalStatuses.REQUESTED).toBe("requested");
+    expect(WithdrawalStatuses.APPROVED).toBe("approved");
+    expect(WithdrawalStatuses.PROCESSING).toBe("processing");
+    expect(WithdrawalStatuses.PAID).toBe("paid");
+    expect(WithdrawalStatuses.REJECTED).toBe("rejected");
+    expect(WithdrawalStatuses.FAILED).toBe("failed");
+  });
+
+  test("WithdrawalStatus type should accept valid status values", () => {
+    const validStatus: WithdrawalStatus = "processing";
+    expect(validStatus).toBe("processing");
+  });
+
+  test("should have 6 withdrawal statuses", () => {
+    expect(Object.keys(WithdrawalStatuses).length).toBe(6);
+  });
+});
+
 describe("PaymentProviders", () => {
   test("should contain all expected provider keys", () => {
     const expectedKeys = [

package/src/constants/payment.ts

@@ -2,6 +2,10 @@ export const PaymentTypes = {
   SUBSCRIPTION: "subscription",
   ONE_TIME: "one-time",
   PAYOUT: "payout",
+  WITHDRAW_LOCK: "withdraw_lock",
+  WITHDRAW_RELEASE: "withdraw_release",
+  WITHDRAW_COMPLETE: "withdraw_complete",
+  MANUAL_ADJUSTMENT: "manual_adjustment",
 } as const;
 
 export type PaymentType = (typeof PaymentTypes)[keyof typeof PaymentTypes];
@@ -43,3 +47,25 @@ export const PaymentDirections = {
 
 export type PaymentDirection =
   (typeof PaymentDirections)[keyof typeof PaymentDirections];
+
+export const PayoutProviders = {
+  BKASH: "bkash",
+  NAGAD: "nagad",
+  ROCKET: "rocket",
+  BANK: "bank",
+} as const;
+
+export type PayoutProvider =
+  (typeof PayoutProviders)[keyof typeof PayoutProviders];
+
+export const WithdrawalStatuses = {
+  REQUESTED: "requested",
+  APPROVED: "approved",
+  PROCESSING: "processing",
+  PAID: "paid",
+  REJECTED: "rejected",
+  FAILED: "failed",
+} as const;
+
+export type WithdrawalStatus =
+  (typeof WithdrawalStatuses)[keyof typeof WithdrawalStatuses];