@hobenakicoffee/libraries 0.0.2 → 0.0.4

package/README.md

@@ -1,14 +1,36 @@
 # @hobenakicoffee/libraries
 
-Necessary public libraries for "হবে নাকি Coffee?" projects. Framework-agnostic and reusable.
+Framework-agnostic shared libraries for “হবে নাকি Coffee?” projects.
 
-## Installation
+## Quick start
+
+Install the package from npm:
+
+```bash
+npm install @hobenakicoffee/libraries
+# or
+pnpm add @hobenakicoffee/libraries
+# or
+yarn add @hobenakicoffee/libraries
+# or
+bun add @hobenakicoffee/libraries
+```
+
+Use it in your app:
+
+```ts
+import { SOME_CONSTANT } from "@hobenakicoffee/libraries";
+```
+
+## Local development
+
+Install dependencies:
 
 ```bash
 bun install
 ```
 
-## Development
+Common tasks:
 
 ```bash
 # Run in watch mode during development
@@ -24,7 +46,7 @@ bun run test
 bun run test:watch
 ```
 
-## Building
+Build artifacts:
 
 ```bash
 # Build the library
@@ -34,15 +56,7 @@ bun run build
 bun run clean
 ```
 
-## Publishing
-
-The library will automatically build before publishing:
-
-```bash
-npm publish
-```
-
-## Project Structure
+## Project structure
 
 ```
 src/
@@ -51,8 +65,20 @@ src/
     index.ts
 ```
 
-This project was created using `bun init` in bun v1.2.15. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
+## Release & publish
+
+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.
+
+For local publish (if needed):
+
+```bash
+npm publish --access public
+```
 
-## Resources
+## Notes
 
-To generate supabase types, [follow this documentation](https://supabase.com/docs/guides/api/rest/generating-types)
+- This project uses Bun for development and builds.
+- To generate supabase types, follow https://supabase.com/docs/guides/api/rest/generating-types

package/{src/constants/index.ts → dist/index.js}

@@ -1,4 +1,5 @@
-export const SupporterPlatforms = {
+// src/constants/index.ts
+var SupporterPlatforms = {
   FACEBOOK: "facebook",
   X: "x",
   INSTAGRAM: "instagram",
@@ -16,20 +17,17 @@ export const SupporterPlatforms = {
   MEDIUM: "medium",
   DEVTO: "devto",
   BEHANCE: "behance",
-  DRIBBBLE: "dribbble",
-} as const;
-
-export type SupporterPlatform =
-  (typeof SupporterPlatforms)[keyof typeof SupporterPlatforms];
-
-export const PaymentStatuses = {
+  DRIBBBLE: "dribbble"
+};
+var PaymentStatuses = {
   PENDING: "pending",
   COMPLETED: "completed",
   FAILED: "failed",
   CANCELLED: "cancelled",
   REFUNDED: "refunded",
-  REVIEWING: "reviewing",
-} as const;
-
-export type PaymentStatus =
-  (typeof PaymentStatuses)[keyof typeof PaymentStatuses];
+  REVIEWING: "reviewing"
+};
+export {
+  SupporterPlatforms,
+  PaymentStatuses
+};

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "@hobenakicoffee/libraries",
-  "version": "0.0.2",
-  "module": "src/index.ts",
+  "version": "0.0.4",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
   "type": "module",
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build": "bun build src/index.ts --outdir dist --target node",
     "dev": "bun --watch src/index.ts",
@@ -18,5 +22,8 @@
   },
   "peerDependencies": {
     "typescript": "^5"
+  },
+  "publishConfig": {
+    "access": "public"
   }
 }

package/.github/workflows/publish.yml

@@ -1,39 +0,0 @@
-name: Publish to npm
-
-on:
-  push:
-    tags:
-      - "v*.*.*"
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      id-token: write
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Setup Bun
-        uses: oven-sh/setup-bun@v1
-        with:
-          bun-version: latest
-
-      - name: Install dependencies
-        run: bun install
-
-      - name: Run tests
-        run: bun run test
-
-      - name: Build
-        run: bun run build
-
-      - name: Setup Node.js for npm publish
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          registry-url: https://registry.npmjs.org/
-
-      - name: Publish
-        run: npm publish --access public

package/bun.lock

@@ -1,25 +0,0 @@
-{
-  "lockfileVersion": 1,
-  "workspaces": {
-    "": {
-      "name": "libraries",
-      "devDependencies": {
-        "@types/bun": "latest",
-      },
-      "peerDependencies": {
-        "typescript": "^5",
-      },
-    },
-  },
-  "packages": {
-    "@types/bun": ["@types/bun@1.3.6", "", { "dependencies": { "bun-types": "1.3.6" } }, "sha512-uWCv6FO/8LcpREhenN1d1b6fcspAB+cefwD7uti8C8VffIv0Um08TKMn98FynpTiU38+y2dUO55T11NgDt8VAA=="],
-
-    "@types/node": ["@types/node@25.0.10", "", { "dependencies": { "undici-types": "~7.16.0" } }, "sha512-zWW5KPngR/yvakJgGOmZ5vTBemDoSqF3AcV/LrO5u5wTWyEAVVh+IT39G4gtyAkh3CtTZs8aX/yRM82OfzHJRg=="],
-
-    "bun-types": ["bun-types@1.3.6", "", { "dependencies": { "@types/node": "*" } }, "sha512-OlFwHcnNV99r//9v5IIOgQ9Uk37gZqrNMCcqEaExdkVq3Avwqok1bJFmvGMCkCE0FqzdY8VMOZpfpR3lwI+CsQ=="],
-
-    "typescript": ["typescript@5.9.3", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw=="],
-
-    "undici-types": ["undici-types@7.16.0", "", {}, "sha512-Zz+aZWSj8LE6zoxD+xrjh4VfkIG8Ya6LvYkZqtUQGJPZjYl53ypCaUwWqo7eI0x66KBGeRo+mlBEkMSeSZ38Nw=="],
-  }
-}

package/src/constants/index.test.ts

@@ -1,114 +0,0 @@
-import { describe, expect, test } from "bun:test";
-import { SupporterPlatforms, PaymentStatuses } from "./index";
-import type { SupporterPlatform, PaymentStatus } from "./index";
-
-describe("SupporterPlatforms", () => {
-  test("should contain all expected platform keys", () => {
-    const expectedKeys = [
-      "FACEBOOK",
-      "X",
-      "INSTAGRAM",
-      "YOUTUBE",
-      "GITHUB",
-      "LINKEDIN",
-      "TWITCH",
-      "TIKTOK",
-      "THREADS",
-      "WHATSAPP",
-      "TELEGRAM",
-      "DISCORD",
-      "REDDIT",
-      "PINTEREST",
-      "MEDIUM",
-      "DEVTO",
-      "BEHANCE",
-      "DRIBBBLE",
-    ];
-
-    expect(Object.keys(SupporterPlatforms)).toEqual(expectedKeys);
-  });
-
-  test("should have correct values for each platform", () => {
-    expect(SupporterPlatforms.FACEBOOK).toBe("facebook");
-    expect(SupporterPlatforms.X).toBe("x");
-    expect(SupporterPlatforms.INSTAGRAM).toBe("instagram");
-    expect(SupporterPlatforms.YOUTUBE).toBe("youtube");
-    expect(SupporterPlatforms.GITHUB).toBe("github");
-    expect(SupporterPlatforms.LINKEDIN).toBe("linkedin");
-    expect(SupporterPlatforms.TWITCH).toBe("twitch");
-    expect(SupporterPlatforms.TIKTOK).toBe("tiktok");
-    expect(SupporterPlatforms.THREADS).toBe("threads");
-    expect(SupporterPlatforms.WHATSAPP).toBe("whatsapp");
-    expect(SupporterPlatforms.TELEGRAM).toBe("telegram");
-    expect(SupporterPlatforms.DISCORD).toBe("discord");
-    expect(SupporterPlatforms.REDDIT).toBe("reddit");
-    expect(SupporterPlatforms.PINTEREST).toBe("pinterest");
-    expect(SupporterPlatforms.MEDIUM).toBe("medium");
-    expect(SupporterPlatforms.DEVTO).toBe("devto");
-    expect(SupporterPlatforms.BEHANCE).toBe("behance");
-    expect(SupporterPlatforms.DRIBBBLE).toBe("dribbble");
-  });
-
-  test("should be read-only at compile time", () => {
-    // TypeScript prevents modification at compile time with 'as const'
-    // This test verifies the structure is correct
-    expect(Object.isFrozen(SupporterPlatforms)).toBe(false);
-    expect(typeof SupporterPlatforms).toBe("object");
-  });
-
-  test("SupporterPlatform type should accept valid platform values", () => {
-    const validPlatform: SupporterPlatform = "facebook";
-    expect(validPlatform).toBe("facebook");
-  });
-
-  test("should have 18 platforms", () => {
-    expect(Object.keys(SupporterPlatforms).length).toBe(18);
-  });
-});
-
-describe("PaymentStatuses", () => {
-  test("should contain all expected status keys", () => {
-    const expectedKeys = [
-      "PENDING",
-      "COMPLETED",
-      "FAILED",
-      "CANCELLED",
-      "REFUNDED",
-      "REVIEWING",
-    ];
-
-    expect(Object.keys(PaymentStatuses)).toEqual(expectedKeys);
-  });
-
-  test("should have correct values for each status", () => {
-    expect(PaymentStatuses.PENDING).toBe("pending");
-    expect(PaymentStatuses.COMPLETED).toBe("completed");
-    expect(PaymentStatuses.FAILED).toBe("failed");
-    expect(PaymentStatuses.CANCELLED).toBe("cancelled");
-    expect(PaymentStatuses.REFUNDED).toBe("refunded");
-    expect(PaymentStatuses.REVIEWING).toBe("reviewing");
-  });
-
-  test("should be read-only at compile time", () => {
-    // TypeScript prevents modification at compile time with 'as const'
-    // This test verifies the structure is correct
-    expect(Object.isFrozen(PaymentStatuses)).toBe(false);
-    expect(typeof PaymentStatuses).toBe("object");
-  });
-
-  test("PaymentStatus type should accept valid status values", () => {
-    const validStatus: PaymentStatus = "completed";
-    expect(validStatus).toBe("completed");
-  });
-
-  test("should have 6 payment statuses", () => {
-    expect(Object.keys(PaymentStatuses).length).toBe(6);
-  });
-
-  test("all values should be lowercase strings", () => {
-    Object.values(PaymentStatuses).forEach((status) => {
-      expect(status).toBe(status.toLowerCase() as PaymentStatus);
-      expect(typeof status).toBe("string");
-    });
-  });
-});

package/src/index.ts

@@ -1 +0,0 @@
-export * from "./constants";

package/tsconfig.json

@@ -1,29 +0,0 @@
-{
-  "compilerOptions": {
-    // Environment setup & latest features
-    "lib": ["ESNext"],
-    "target": "ESNext",
-    "module": "Preserve",
-    "moduleDetection": "force",
-    "jsx": "react-jsx",
-    "allowJs": true,
-
-    // Bundler mode
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "verbatimModuleSyntax": true,
-    "noEmit": true,
-
-    // Best practices
-    "strict": true,
-    "skipLibCheck": true,
-    "noFallthroughCasesInSwitch": true,
-    "noUncheckedIndexedAccess": true,
-    "noImplicitOverride": true,
-
-    // Some stricter flags (disabled by default)
-    "noUnusedLocals": false,
-    "noUnusedParameters": false,
-    "noPropertyAccessFromIndexSignature": false
-  }
-}