woodsportal-client-sdk 1.1.0

package/CHANGELOG.md

@@ -0,0 +1,44 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+## 1.1.0 (2026-02-13)
+
+
+### Features
+
+* add production-grade npm package setup ([11d1e22](https://github.com/Digital-Woods/digitalwoods.io-woodsportal-client-sdk/commit/11d1e2276b03cd2b0dcfe3d480b77013ec8006eb))
+
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Initial release of WoodsPortal Client SDK
+- Authentication APIs (login, logout, preLogin, verifyEmail, forgetPassword, resetPassword)
+- User management APIs (me, profile, changePassword)
+- Pipeline and Object listing APIs
+- Breadcrumb utilities
+- URL generation and routing utilities
+- Token management and refresh functionality
+- SDK initialization function
+
+### Changed
+- N/A
+
+### Deprecated
+- N/A
+
+### Removed
+- N/A
+
+### Fixed
+- N/A
+
+### Security
+- N/A

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2025, Digital Woods
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,540 @@
+# WoodsPortal Client SDK
+
+[![npm version](https://img.shields.io/npm/v/woodsportal-client-sdk.svg)](https://www.npmjs.com/package/woodsportal-client-sdk)
+[![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](https://opensource.org/licenses/ISC)
+[![Node.js Version](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen.svg)](https://nodejs.org/)
+
+Official TypeScript/JavaScript SDK for WoodsPortal API. This SDK provides a comprehensive client library for interacting with WoodsPortal services including authentication, user management, pipelines, objects, and more.
+
+## Features
+
+- 🔐 **Authentication** - Complete authentication flow including login, logout, password reset, and email verification
+- 👤 **User Management** - User profile management and password changes
+- 📊 **Pipelines & Objects** - List and manage pipelines and objects
+- 🍞 **Breadcrumbs** - Built-in breadcrumb utilities for navigation
+- 🔗 **URL Utilities** - URL generation and routing helpers
+- 🔄 **Token Management** - Automatic token refresh and management
+- 📦 **TypeScript Support** - Full TypeScript definitions included
+- 🌳 **Tree-shakeable** - Optimized for modern bundlers
+
+## Installation
+
+```bash
+npm install woodsportal-client-sdk
+```
+
+or
+
+```bash
+yarn add woodsportal-client-sdk
+```
+
+or
+
+```bash
+pnpm add woodsportal-client-sdk
+```
+
+## Quick Start
+
+### Basic Setup
+
+```typescript
+import { initialize, api } from 'woodsportal-client-sdk';
+
+// Initialize the SDK with your configuration
+initialize({
+  baseURL: 'https://api.woodsportal.com',
+  timeout: 30000,
+  hubId: 'your-hub-id', // Optional
+  devPortalId: 'your-dev-portal-id', // Optional
+});
+
+// Use the API
+const { login, isLoading } = api.login({
+  onSuccess: (data) => {
+    console.log('Login successful!', data);
+  },
+  onError: (error) => {
+    console.error('Login failed:', error);
+  },
+});
+
+// Perform login
+await login({
+  username: 'user@example.com',
+  password: 'your-password',
+});
+```
+
+## Configuration
+
+### Initialize SDK
+
+The SDK must be initialized before use. Call `initialize()` with your configuration:
+
+```typescript
+import { initialize } from 'woodsportal-client-sdk';
+
+initialize({
+  baseURL: 'https://api.woodsportal.com', // Required: Your API base URL
+  timeout: 30000, // Optional: Request timeout in milliseconds (default: 50000)
+  hubId: 'your-hub-id', // Optional: Hub ID for API requests
+  devPortalId: 'your-dev-portal-id', // Optional: Dev Portal ID
+  headers: { // Optional: Custom headers
+    'X-Custom-Header': 'value',
+  },
+  routes: { // Optional: Route configuration
+    unauthorized: '/login',
+    login: '/login',
+  },
+  skipCurrentPublicPath: () => false, // Optional: Function to skip auth error handling
+  onLogout: async () => { // Optional: Logout handler
+    // Handle logout
+  },
+});
+```
+
+## API Reference
+
+### Authentication
+
+#### Login
+
+```typescript
+import { api } from 'woodsportal-client-sdk';
+
+const { login, isLoading } = api.login({
+  onSuccess: (data) => {
+    // Handle successful login
+    // Tokens are automatically stored
+  },
+  onError: (error) => {
+    // Handle error
+  },
+  onLoadingChange: (loading) => {
+    // Handle loading state
+  },
+});
+
+await login({
+  username: 'user@example.com',
+  password: 'password123',
+});
+```
+
+#### Pre-Login
+
+```typescript
+const { preLogin, isLoading } = api.preLogin({
+  onSuccess: (data) => {
+    // Handle pre-login response
+  },
+});
+
+await preLogin({
+  username: 'user@example.com',
+});
+```
+
+#### Logout
+
+```typescript
+const { logout, isLoading } = api.logout({
+  onSuccess: () => {
+    // Handle successful logout
+    // Cookies are automatically cleared
+  },
+});
+
+await logout();
+```
+
+#### Verify Email
+
+```typescript
+const { verifyEmail, isLoading } = api.verifyEmail({
+  onSuccess: (data) => {
+    // Email verified successfully
+  },
+});
+
+await verifyEmail({
+  token: 'verification-token',
+});
+```
+
+#### Forget Password
+
+```typescript
+const { forgetPassword, isLoading } = api.forgetPassword({
+  onSuccess: (data) => {
+    // Password reset email sent
+  },
+});
+
+await forgetPassword({
+  email: 'user@example.com',
+});
+```
+
+#### Reset Password
+
+```typescript
+// Step 1: Verify reset token
+const { resetPasswordVerifyToken, isLoading } = api.resetPasswordVerifyToken({
+  onSuccess: (data) => {
+    // Token verified, proceed to reset
+  },
+});
+
+await resetPasswordVerifyToken({
+  token: 'reset-token',
+});
+
+// Step 2: Reset password
+const { resetPassword } = api.resetPassword({
+  onSuccess: (data) => {
+    // Password reset successful
+  },
+});
+
+await resetPassword({
+  newPassword: 'newPassword123',
+  confirmPassword: 'newPassword123',
+});
+```
+
+### User Management
+
+#### Get Current User
+
+```typescript
+const { me, isLoading } = api.me({
+  onSuccess: (user) => {
+    console.log('Current user:', user);
+  },
+});
+
+await me();
+```
+
+#### Get User Profile
+
+```typescript
+const { profile, isLoading } = api.profile({
+  onSuccess: (profile) => {
+    console.log('User profile:', profile);
+  },
+});
+
+await profile();
+```
+
+#### Change Password
+
+```typescript
+const { changePassword, isLoading } = api.changePassword({
+  onSuccess: () => {
+    // Password changed successfully
+  },
+});
+
+await changePassword({
+  currentPassword: 'oldPassword123',
+  newPassword: 'newPassword123',
+  confirmPassword: 'newPassword123',
+});
+```
+
+### Pipelines
+
+```typescript
+const { pipelines, isLoading } = api.pipelines({
+  onSuccess: (data) => {
+    console.log('Pipelines:', data);
+  },
+});
+
+await pipelines({
+  // Optional query parameters
+  queryParams: {
+    page: 1,
+    limit: 10,
+  },
+});
+```
+
+### Objects
+
+```typescript
+const { objects, isLoading } = api.objects({
+  onSuccess: (data) => {
+    console.log('Objects:', data);
+  },
+});
+
+await objects({
+  // Optional query parameters
+  queryParams: {
+    page: 1,
+    limit: 10,
+  },
+});
+```
+
+### Token Management
+
+The SDK automatically handles token refresh. You can also manually check token status:
+
+```typescript
+import { api } from 'woodsportal-client-sdk';
+
+// Check if user is authenticated
+const isAuthenticated = api.isAuthenticateApp();
+
+// Check if access token is expired
+const isExpired = api.isExpiresAccessToken();
+
+// Get current access token
+const token = api.getAccessToken();
+
+// Get refresh token
+const refreshToken = api.getRefreshToken();
+```
+
+### Breadcrumbs
+
+```typescript
+import { breadcrumbsDetails } from 'woodsportal-client-sdk';
+
+// Get breadcrumbs from URL
+const breadcrumbs = breadcrumbsDetails.getBreadcrumbs();
+
+// Get table title
+const { tableTitle, singularTableTitle } = breadcrumbsDetails.getTableTitle(
+  'component-name',
+  'Title',
+  'Tickets'
+);
+
+// Get form title
+const { dialogTitle } = breadcrumbsDetails.getFormTitle(
+  'type',
+  'Title',
+  'addNew'
+);
+```
+
+### URL Utilities
+
+```typescript
+import { url } from 'woodsportal-client-sdk';
+
+// Generate link
+const link = url.useMakeLink('/path', { param: 'value' });
+
+// Update link
+const updatedLink = url.useUpdateLink('/path', { param: 'new-value' });
+```
+
+### Route Parameters
+
+```typescript
+import { routeParam } from 'woodsportal-client-sdk';
+
+// Get route details
+const routeDetails = routeParam.getRouteDetails();
+
+// Get parameter details
+const paramDetails = routeParam.getParamDetails('param-name');
+```
+
+## TypeScript Support
+
+The SDK is written in TypeScript and includes full type definitions. All types are exported for your convenience:
+
+```typescript
+import type {
+  HttpClientConfig,
+  LoginPayload,
+  PreLoginPayload,
+  VerifyEmailPayload,
+  ResetPasswordPayload,
+  ForgetPasswordPayload,
+  ChangePasswordPayload,
+  MutationOptions,
+} from 'woodsportal-client-sdk';
+```
+
+## Error Handling
+
+All API methods support error handling through the `onError` callback:
+
+```typescript
+const { login } = api.login({
+  onSuccess: (data) => {
+    // Success handler
+  },
+  onError: (error) => {
+    // Error handler
+    console.error('Error:', error);
+    
+    // Access error details
+    if (error.response) {
+      console.error('Status:', error.response.status);
+      console.error('Data:', error.response.data);
+    }
+  },
+});
+```
+
+## Loading States
+
+All mutation methods return an `isLoading` state:
+
+```typescript
+const { login, isLoading } = api.login();
+
+// isLoading is a boolean that indicates if the request is in progress
+console.log('Loading:', isLoading);
+
+await login({ username: 'user', password: 'pass' });
+```
+
+## Examples
+
+### React Example
+
+```typescript
+import { useState, useEffect } from 'react';
+import { initialize, api } from 'woodsportal-client-sdk';
+
+function App() {
+  useEffect(() => {
+    // Initialize SDK
+    initialize({
+      baseURL: 'https://api.woodsportal.com',
+    });
+  }, []);
+
+  const handleLogin = async () => {
+    const { login } = api.login({
+      onSuccess: (data) => {
+        console.log('Logged in!', data);
+      },
+      onError: (error) => {
+        console.error('Login error:', error);
+      },
+    });
+
+    await login({
+      username: 'user@example.com',
+      password: 'password',
+    });
+  };
+
+  return (
+    <button onClick={handleLogin}>
+      Login
+    </button>
+  );
+}
+```
+
+### Node.js Example
+
+```typescript
+import { initialize, api } from 'woodsportal-client-sdk';
+
+// Initialize SDK
+initialize({
+  baseURL: 'https://api.woodsportal.com',
+});
+
+// Login
+const { login } = api.login({
+  onSuccess: async (data) => {
+    console.log('Login successful');
+    
+    // Fetch user profile
+    const { me } = api.me({
+      onSuccess: (user) => {
+        console.log('User:', user);
+      },
+    });
+    
+    await me();
+  },
+});
+
+await login({
+  username: 'user@example.com',
+  password: 'password',
+});
+```
+
+## Building from Source
+
+```bash
+# Clone the repository
+git clone https://github.com/Digital-Woods/digitalwoods.io-woodsportal-client-sdk.git
+cd digitalwoods.io-woodsportal-client-sdk
+
+# Install dependencies
+npm install
+
+# Build the project
+npm run build
+
+# Run tests
+npm test
+
+# Run linting
+npm run lint
+```
+
+## Development
+
+```bash
+# Development mode with watch
+npm run dev
+
+# Run tests in watch mode
+npm run test:watch
+
+# Check code formatting
+npm run format:check
+
+# Fix code formatting
+npm run format
+
+# Type checking
+npm run type-check
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## License
+
+ISC License
+
+Copyright (c) 2025, Digital Woods
+
+See [LICENSE](LICENSE) file for details.
+
+## Support
+
+For issues, questions, or contributions, please visit our [GitHub repository](https://github.com/Digital-Woods/digitalwoods.io-woodsportal-client-sdk/issues).
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for a list of changes and version history.

package/dist/apis/authentication.d.ts

@@ -0,0 +1,36 @@
+import type { LoginPayload, MutationOptions, PreLoginPayload, ForgetPasswordPayload, VerifyEmailPayload, ResetPasswordVerifyTokenPayload, ResetPasswordPayload } from '../types';
+export declare function preLogin(options?: MutationOptions<any, any>): {
+    mutate: (payload?: PreLoginPayload | undefined) => Promise<any>;
+    login: (payload?: PreLoginPayload | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+export declare function login(options?: MutationOptions<any, any>): {
+    mutate: (payload?: LoginPayload | undefined) => Promise<any>;
+    login: (payload?: LoginPayload | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+export declare function verifyEmail(options?: MutationOptions<any, any>): {
+    mutate: (payload?: VerifyEmailPayload | undefined) => Promise<any>;
+    verifyEmail: (payload?: VerifyEmailPayload | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+export declare function resetPasswordVerifyToken(options?: MutationOptions<any, any>): {
+    mutate: (payload?: ResetPasswordVerifyTokenPayload | undefined) => Promise<any>;
+    resetPasswordVerifyToken: (payload?: ResetPasswordVerifyTokenPayload | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+export declare function resetPassword(options?: MutationOptions<any, any>): {
+    mutate: (payload?: ResetPasswordPayload | undefined) => Promise<any>;
+    resetPassword: (payload?: ResetPasswordPayload | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+export declare function forgetPassword(options?: MutationOptions<any, any>): {
+    mutate: (payload?: ForgetPasswordPayload | undefined) => Promise<any>;
+    forgetPassword: (payload?: ForgetPasswordPayload | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+export declare function logout(options?: MutationOptions<any, any>): {
+    mutate: (payload?: unknown) => Promise<any>;
+    logout: (payload?: unknown) => Promise<any>;
+    isLoading: () => boolean;
+};