@a-tech.jo/auth-sdk 1.0.0 → 1.0.2

package/README.md

@@ -0,0 +1,129 @@
+# `@a-tech/auth-sdk`
+
+A full-stack, customizable authentication SDK providing seamless login, registration, and session management for A-Tech applications.
+
+---
+
+## Quick Start & Integration
+
+### 1. Import Global Styles
+Import the pre-compiled CSS file in your root `layout.tsx` or `_app.tsx`:
+
+```tsx
+import "@a-tech/auth-sdk/styles.css";
+
+```
+
+---
+
+### 2. Wrap Application with `AuthProvider`
+
+Encapsulate your component tree with the `AuthProvider` to manage global authentication state and token expiration.
+
+```tsx
+import { AuthProvider } from "@a-tech/auth-sdk";
+
+export default function RootLayout({ children }: { children: React.ReactNode }) {
+  return (
+    <html lang="en">
+      <body>
+        <AuthProvider "local" config="{{" environment: }}>
+          {children}
+        </AuthProvider>
+      </body>
+    </html>
+  );
+}
+
+```
+
+#### Available Environment Configurations
+
+| Environment | Key | Description |
+| --- | --- | --- |
+| **Local** | `"local"` | Targets `http://localhost:3000` / local backend services |
+| **Staging** | `"stage"` | Targets staging auth backend (`https://auth.atech-workspace.com`) |
+| **Production** | `"production"` | *(Default)* Targets production auth services |
+
+---
+
+### 3. Embed Authentication Component
+
+Render the pre-built, responsive authentication card supporting mode toggling (Login, Register, Forgot Password).
+
+```tsx
+import { SDKAuthContainer } from "@a-tech/auth-sdk";
+
+export default function AuthPage() {
+  const handleSuccess = (data: { user: any; token: string }) => {
+    console.log("Authenticated successfully:", data);
+  };
+
+  return (
+    <div className="flex min-h-screen items-center justify-center">
+      <SDKAuthContainer initialMode="login" onSuccess="{handleSuccess}"/>
+    </div>
+  );
+}
+
+```
+
+---
+
+### 4. Access User Session (`useAuth` Hook)
+
+Access the current user profile, JWT token, and session utilities anywhere within the `AuthProvider` scope:
+
+```tsx
+import { useAuth } from "@a-tech/auth-sdk";
+
+export default function Dashboard() {
+  const { user, token, logout, isExpired } = useAuth();
+
+  if (!token || isExpired) {
+    return <p>Please sign in to access this page.</p>;
+  }
+
+  return (
+    <div>
+      <h1>Welcome back, {user?.firstName}!</h1>
+      <p>Logged in as: {user?.email}</p>
+      <button onClick={logout}>Sign Out</button>
+    </div>
+  );
+}
+
+```
+
+---
+
+## How to Update & Publish New Versions
+
+When publishing an update to npm, follow standard Semantic Versioning guidelines:
+
+### 1. Bump Package Version
+
+Choose the appropriate command based on the scope of your changes:
+
+```bash
+# Patch update (Bug fixes: e.g., 1.0.0 -> 1.0.1)
+npm version patch
+
+# Minor update (New backward-compatible features: e.g., 1.0.0 -> 1.1.0)
+npm version minor
+
+# Major update (Breaking changes: e.g., 1.0.0 -> 2.0.0)
+npm version major
+
+```
+
+### 2. Clean, Build, and Publish
+
+Run a fresh build and publish to npm using your Granular Access Token:
+
+```bash
+# Clean build artifacts and build fresh distribution package
+rm -rf dist *.tgz && npm run build
+
+# Publish to npm using your access token
+echo "//registry.npmjs.org/:_authToken=YOUR_NPM_TOKEN" > .npmrc && npm publish --access public ; rm -f .npmrc

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@a-tech.jo/auth-sdk",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "A-Tech Authentication SDK for React and Next.js",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -30,7 +30,8 @@
     "example": "npm run dev --workspace=example",
     "pack": "npm pack",
     "clean": "rm -rf dist node_modules/.cache *.tgz example/.next",
-    "prepublishOnly": "npm run clean && npm run build"
+    "prepublishOnly": "npm run clean && npm run build",
+    "publish": "npm publish --access public"
   },
   "peerDependencies": {
     "react": ">=18.0.0",