sidekick-server-2 0.1.1

package/README.md

@@ -0,0 +1,223 @@
+# SideKick Server
+
+A reusable Node.js server library with built-in authentication, organization management, and payment integration. Built with Express, TypeScript, and MySQL.
+
+## Features
+
+- 🔐 **Authentication System** - JWT-based authentication with OTP support
+- 👥 **Organization Management** - Multi-tenant organization structure with invitations
+- 💳 **Payment Integration** - Razorpay integration for subscription plans
+- 🌍 **CORS Configuration** - Flexible CORS setup
+- 📧 **Email Support** - Nodemailer integration
+- 🔌 **Extensible** - Add custom routes and middleware
+
+## Installation
+
+```bash
+npm install sidekick-server
+```
+
+### Peer Dependencies
+
+You need to install these peer dependencies in your project:
+
+```bash
+npm install express cors mysql2
+```
+
+## Quick Start
+
+```typescript
+import mysql from 'mysql2/promise';
+import { initSideKick } from 'sidekick-server';
+import { APP_INFO_ACCOUNT_TYPE } from 'sidekick-server/dist/utils/enums.js';
+
+// Create database connection pool
+const dbPool = mysql.createPool({
+  host: 'localhost',
+  user: 'root',
+  password: 'your-password',
+  database: 'your-database',
+  waitForConnections: true,
+  connectionLimit: 10,
+  queueLimit: 0,
+});
+
+// Initialize SideKick server
+const server = initSideKick({
+  database: dbPool,
+  appInfo: {
+    appName: 'My App',
+    appDescription: 'My awesome application',
+    version: '1.0.0',
+    CLIENT_URL: 'http://localhost:3000',
+    account_type_txt: {
+      singular: 'Team',
+      plural: 'Teams',
+      value: APP_INFO_ACCOUNT_TYPE.TEAM,
+    },
+  },
+  cors: {
+    allowedOrigins: ['http://localhost:3000', 'https://myapp.com'],
+  },
+  jwt: {
+    secret: 'your-jwt-secret',
+    expiresIn: '24h',
+  },
+});
+
+// Start the server
+const PORT = process.env.PORT || 3000;
+server.listen(PORT, () => {
+  console.log(`Server running on port ${PORT}`);
+});
+```
+
+## Configuration
+
+### SideKickConfig
+
+| Property       | Type                  | Required | Description                 |
+| -------------- | --------------------- | -------- | --------------------------- |
+| `database`     | `Pool`                | Yes      | MySQL2 connection pool      |
+| `appInfo`      | `AppInfo`             | Yes      | Application information     |
+| `cors`         | `CorsConfig`          | Yes      | CORS configuration          |
+| `jwt`          | `JwtConfig`           | Yes      | JWT configuration           |
+| `customRoutes` | `CustomRoutesHandler` | No       | Custom route handler        |
+| `port`         | `number`              | No       | Port number (for reference) |
+
+### AppInfo
+
+```typescript
+{
+  appName: string;
+  appDescription: string;
+  version: string;
+  logo?: string;              // SVG or image URL
+  primaryThemeColor?: string; // Hex color
+  CLIENT_URL: string;         // Frontend URL
+  account_type_txt: {
+    singular: string;
+    plural: string;
+    value: typeof APP_INFO_ACCOUNT_TYPE.TEAM;
+  };
+}
+```
+
+### Custom Routes
+
+You can add custom routes to extend the server functionality:
+
+```typescript
+const server = initSideKick({
+  // ... other config
+  customRoutes: (app) => {
+    app.get('/custom-endpoint', (req, res) => {
+      res.json({ message: 'Custom route!' });
+    });
+
+    app.post('/custom-action', async (req, res) => {
+      // Your custom logic
+      res.json({ success: true });
+    });
+  },
+});
+```
+
+## Built-in Routes
+
+The library includes the following routes:
+
+### Public Routes (No Authentication Required)
+
+- `POST /send-otp` - Send OTP for verification
+- `POST /user-registration` - Register new user
+- `POST /login` - User login
+- `POST /reset-password` - Reset password
+- `GET /get-plans` - Get available subscription plans
+
+### Protected Routes (Authentication Required)
+
+- `GET /check-session` - Verify session
+- `POST /organization` - Create organization
+- `GET /org-member` - Get organization members
+- `POST /invitation` - Send invitation
+- `GET /get-countries` - Get countries list
+- `POST /payment-gateway` - Payment gateway integration
+- `GET /purchased-plans` - Get purchased plans
+
+## Environment Variables
+
+While the library doesn't use `.env` files directly, you may want to use them in your application:
+
+```env
+PORT=3000
+DB_HOST=localhost
+DB_USER=root
+DB_PASSWORD=your-password
+DB_NAME=your-database
+JWT_SECRET=your-jwt-secret
+CLIENT_URL=http://localhost:3000
+```
+
+## TypeScript Support
+
+The library is written in TypeScript and includes type definitions. Import types as needed:
+
+```typescript
+import { SideKickConfig, AppInfo, CorsConfig, JwtConfig, CustomRoutesHandler, DatabaseConnection } from 'sidekick-server';
+```
+
+## Development
+
+If you want to contribute or modify the library:
+
+```bash
+# Clone the repository
+git clone <repository-url>
+
+# Install dependencies
+npm install
+
+# Install peer dependencies for development
+npm install express cors mysql2
+
+# Build the library
+npm run build
+
+# Run in development mode
+npm run dev
+```
+
+## Local Testing with Yalc
+
+For local testing before publishing to npm, use [yalc](https://github.com/wclr/yalc):
+
+```bash
+# Install yalc globally (if not already installed)
+npm install -g yalc
+
+# In the library directory
+npm run build:yalc
+# or
+yalc publish
+
+# In your test project
+yalc add sidekick-server
+npm install
+
+# After making changes to the library
+npm run build:yalc  # Automatically builds and pushes to yalc
+
+# To remove from test project
+yalc remove sidekick-server
+npm install
+```
+
+## License
+
+ISC
+
+## Author
+
+Trinesh Lokhande

package/dist/ai/index.d.ts

@@ -0,0 +1,2 @@
+export * from './perplexity-ai.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/ai/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ai/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC"}

package/dist/ai/index.js

@@ -0,0 +1,2 @@
+export * from './perplexity-ai.js';
+//# sourceMappingURL=index.js.map

package/dist/ai/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/ai/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC"}

package/dist/ai/perplexity-ai.d.ts

@@ -0,0 +1,3 @@
+declare const queryPerplexity: (prompt: string) => Promise<any>;
+export { queryPerplexity };
+//# sourceMappingURL=perplexity-ai.d.ts.map

package/dist/ai/perplexity-ai.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"perplexity-ai.d.ts","sourceRoot":"","sources":["../../src/ai/perplexity-ai.ts"],"names":[],"mappings":"AAIA,QAAA,MAAM,eAAe,GAAU,QAAQ,MAAM,iBAwB5C,CAAC;AAEF,OAAO,EAAE,eAAe,EAAE,CAAC"}

package/dist/ai/perplexity-ai.js

@@ -0,0 +1,28 @@
+import axios from 'axios';
+import { getSecretValue } from '../secret.js';
+import logger from '../utils/error-logger.js';
+const queryPerplexity = async (prompt) => {
+    const url = 'https://api.perplexity.ai/chat/completions'; // Perplexity chat endpoint
+    const data = {
+        model: 'sonar',
+        messages: [
+            { role: 'system', content: 'You are a Grammar checker' },
+            { role: 'user', content: prompt },
+        ],
+    };
+    const apiKey = getSecretValue('perplexityApiKey');
+    const headers = {
+        Authorization: `Bearer ${apiKey}`,
+        Accept: 'application/json',
+    };
+    try {
+        const response = await axios.post(url, data, { headers });
+        return response.data;
+    }
+    catch (error) {
+        logger.error('Error querying Perplexity API:', error.response?.data || error.message);
+        throw error;
+    }
+};
+export { queryPerplexity };
+//# sourceMappingURL=perplexity-ai.js.map

package/dist/ai/perplexity-ai.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"perplexity-ai.js","sourceRoot":"","sources":["../../src/ai/perplexity-ai.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,MAAM,MAAM,0BAA0B,CAAC;AAE9C,MAAM,eAAe,GAAG,KAAK,EAAE,MAAc,EAAE,EAAE;IAC/C,MAAM,GAAG,GAAG,4CAA4C,CAAC,CAAC,2BAA2B;IAErF,MAAM,IAAI,GAAG;QACX,KAAK,EAAE,OAAO;QACd,QAAQ,EAAE;YACR,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,2BAA2B,EAAE;YACxD,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE;SAClC;KACF,CAAC;IAEF,MAAM,MAAM,GAAG,cAAc,CAAC,kBAAkB,CAAC,CAAC;IAClD,MAAM,OAAO,GAAG;QACd,aAAa,EAAE,UAAU,MAAM,EAAE;QACjC,MAAM,EAAE,kBAAkB;KAC3B,CAAC;IAEF,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QAC1D,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QACpB,MAAM,CAAC,KAAK,CAAC,gCAAgC,EAAE,KAAK,CAAC,QAAQ,EAAE,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;QACtF,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAEF,OAAO,EAAE,eAAe,EAAE,CAAC"}

package/dist/app-config.d.ts

@@ -0,0 +1,13 @@
+import { AppInfo } from './types.js';
+export declare const APP_INFO_ACCOUNT_TYPE: {
+    TEAM: string;
+    ORG: string;
+};
+export declare let appInfo: AppInfo;
+/**
+ * Set application configuration
+ * @param config - Application information configuration
+ */
+export declare const setAppConfig: (config: AppInfo) => void;
+export declare const setAccountType: (type?: Partial<typeof APP_INFO_ACCOUNT_TYPE>) => void;
+//# sourceMappingURL=app-config.d.ts.map

package/dist/app-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-config.d.ts","sourceRoot":"","sources":["../src/app-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC,eAAO,MAAM,qBAAqB;;;CAGjC,CAAC;AAGF,eAAO,IAAI,OAAO,EAAE,OAcnB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,YAAY,GAAI,QAAQ,OAAO,KAAG,IAE9C,CAAC;AAEF,eAAO,MAAM,cAAc,GAAI,OAAO,OAAO,CAAC,OAAO,qBAAqB,CAAC,SAG1E,CAAC"}

package/dist/app-config.js

@@ -0,0 +1,33 @@
+export const APP_INFO_ACCOUNT_TYPE = {
+    TEAM: 'team',
+    ORG: 'org',
+};
+// Default app info (can be overridden via setAppConfig)
+export let appInfo = {
+    appId: 'gamma_tech',
+    appName: 'Gamma Tech',
+    appDescription: 'Gamma Tech is a software company that provides a range of services to help businesses grow and succeed.',
+    version: '2.0.1',
+    logo: '<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-notebook-text-icon lucide-notebook-text"><path d="M2 6h4"/><path d="M2 10h4"/><path d="M2 14h4"/><path d="M2 18h4"/><rect width="16" height="20" x="4" y="2" rx="2"/><path d="M9.5 8h5"/><path d="M9.5 12H16"/><path d="M9.5 16H14"/></svg>',
+    primaryThemeColor: '#00c950',
+    CLIENT_URL: 'http://localhost:5173',
+    supportEmail: 'support@gammatech.com',
+    account_type_txt: {
+        singular: 'Team',
+        plural: 'Teams',
+        value: APP_INFO_ACCOUNT_TYPE.TEAM,
+    },
+};
+/**
+ * Set application configuration
+ * @param config - Application information configuration
+ */
+export const setAppConfig = (config) => {
+    appInfo = config;
+};
+export const setAccountType = (type) => {
+    if (!type)
+        return;
+    Object.assign(APP_INFO_ACCOUNT_TYPE, type);
+};
+//# sourceMappingURL=app-config.js.map

package/dist/app-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-config.js","sourceRoot":"","sources":["../src/app-config.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,IAAI,EAAE,MAAM;IACZ,GAAG,EAAE,KAAK;CACX,CAAC;AAEF,wDAAwD;AACxD,MAAM,CAAC,IAAI,OAAO,GAAY;IAC5B,KAAK,EAAE,YAAY;IACnB,OAAO,EAAE,YAAY;IACrB,cAAc,EAAE,yGAAyG;IACzH,OAAO,EAAE,OAAO;IAChB,IAAI,EAAE,ubAAub;IAC7b,iBAAiB,EAAE,SAAS;IAC5B,UAAU,EAAE,uBAAuB;IACnC,YAAY,EAAE,uBAAuB;IACrC,gBAAgB,EAAE;QAChB,QAAQ,EAAE,MAAM;QAChB,MAAM,EAAE,OAAO;QACf,KAAK,EAAE,qBAAqB,CAAC,IAAI;KAClC;CACF,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,MAAe,EAAQ,EAAE;IACpD,OAAO,GAAG,MAAM,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,IAA4C,EAAE,EAAE;IAC7E,IAAI,CAAC,IAAI;QAAE,OAAO;IAClB,MAAM,CAAC,MAAM,CAAC,qBAAqB,EAAE,IAAI,CAAC,CAAC;AAC7C,CAAC,CAAC"}

package/dist/cors-config.d.ts

@@ -0,0 +1,9 @@
+import cors from 'cors';
+/**
+ * Create CORS configuration
+ * @param allowedOrigins - Array of allowed origin URLs
+ * @returns CORS options object
+ */
+declare const corsConfig: (allowedOrigins: string[]) => cors.CorsOptions;
+export default corsConfig;
+//# sourceMappingURL=cors-config.d.ts.map

package/dist/cors-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cors-config.d.ts","sourceRoot":"","sources":["../src/cors-config.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB;;;;GAIG;AACH,QAAA,MAAM,UAAU,GAAI,gBAAgB,MAAM,EAAE,KAAG,IAAI,CAAC,WAiBnD,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/cors-config.js

@@ -0,0 +1,24 @@
+/**
+ * Create CORS configuration
+ * @param allowedOrigins - Array of allowed origin URLs
+ * @returns CORS options object
+ */
+const corsConfig = (allowedOrigins) => {
+    const corsOptions = {
+        origin: (origin, callback) => {
+            // Allow requests with no origin (like curl, mobile apps, or same-origin requests)
+            if (!origin) {
+                return callback(null, true);
+            }
+            if (allowedOrigins.length === 0 || (origin && allowedOrigins.includes(origin))) {
+                callback(null, true); // Allow request
+            }
+            else {
+                callback(new Error(`CORS Error: This ${origin || 'empty'} origin is not allowed.`)); // Block request
+            }
+        },
+    };
+    return corsOptions;
+};
+export default corsConfig;
+//# sourceMappingURL=cors-config.js.map

package/dist/cors-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cors-config.js","sourceRoot":"","sources":["../src/cors-config.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,UAAU,GAAG,CAAC,cAAwB,EAAoB,EAAE;IAChE,MAAM,WAAW,GAAqB;QACpC,MAAM,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE;YAC3B,kFAAkF;YAClF,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC9B,CAAC;YAED,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,MAAM,IAAI,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;gBAC/E,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,gBAAgB;YACxC,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,IAAI,KAAK,CAAC,oBAAoB,MAAM,IAAI,OAAO,yBAAyB,CAAC,CAAC,CAAC,CAAC,gBAAgB;YACvG,CAAC;QACH,CAAC;KACF,CAAC;IAEF,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/db-connection.d.ts

@@ -0,0 +1,13 @@
+import { Pool } from 'mysql2/promise';
+/**
+ * Set the database connection pool
+ * @param pool - MySQL2 connection pool provided by the user
+ */
+export declare const setDatabaseConnection: (pool: Pool) => void;
+/**
+ * Get the database connection pool
+ * @throws Error if database connection is not set
+ */
+export declare const getDatabaseConnection: () => Pool;
+export default getDatabaseConnection;
+//# sourceMappingURL=db-connection.d.ts.map

package/dist/db-connection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"db-connection.d.ts","sourceRoot":"","sources":["../src/db-connection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAKtC;;;GAGG;AACH,eAAO,MAAM,qBAAqB,GAAI,MAAM,IAAI,KAAG,IAElD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,qBAAqB,QAAO,IAKxC,CAAC;AAGF,eAAe,qBAAqB,CAAC"}

package/dist/db-connection.js

@@ -0,0 +1,22 @@
+// Database connection pool - must be set via setDatabaseConnection before use
+let dbConnectionPool = null;
+/**
+ * Set the database connection pool
+ * @param pool - MySQL2 connection pool provided by the user
+ */
+export const setDatabaseConnection = (pool) => {
+    dbConnectionPool = pool;
+};
+/**
+ * Get the database connection pool
+ * @throws Error if database connection is not set
+ */
+export const getDatabaseConnection = () => {
+    if (!dbConnectionPool) {
+        throw new Error('Database connection not initialized. Call setDatabaseConnection() first.');
+    }
+    return dbConnectionPool;
+};
+// Default export for backward compatibility
+export default getDatabaseConnection;
+//# sourceMappingURL=db-connection.js.map

package/dist/db-connection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"db-connection.js","sourceRoot":"","sources":["../src/db-connection.ts"],"names":[],"mappings":"AAEA,8EAA8E;AAC9E,IAAI,gBAAgB,GAAgB,IAAI,CAAC;AAEzC;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,IAAU,EAAQ,EAAE;IACxD,gBAAgB,GAAG,IAAI,CAAC;AAC1B,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAS,EAAE;IAC9C,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,0EAA0E,CAAC,CAAC;IAC9F,CAAC;IACD,OAAO,gBAAgB,CAAC;AAC1B,CAAC,CAAC;AAEF,4CAA4C;AAC5C,eAAe,qBAAqB,CAAC"}

package/dist/error-handler.d.ts

@@ -0,0 +1,3 @@
+import { NextFunction, Request, Response } from 'express';
+export declare const errorHandler: (err: Error, req: Request, res: Response, next: NextFunction) => void;
+//# sourceMappingURL=error-handler.d.ts.map

package/dist/error-handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-handler.d.ts","sourceRoot":"","sources":["../src/error-handler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAI1D,eAAO,MAAM,YAAY,GAAI,KAAK,KAAK,EAAE,KAAK,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,SAavF,CAAC"}

package/dist/error-handler.js

@@ -0,0 +1,15 @@
+import logger from './utils/error-logger.js';
+import { throwErrorInResponseIfErrorIsNotCustom } from './utils/response-utils.js';
+export const errorHandler = (err, req, res, next) => {
+    logger.error({
+        ...err,
+        message: err.message,
+        stack: err.stack,
+    }); // optional logging
+    throwErrorInResponseIfErrorIsNotCustom(res, err, {
+        errorMsg: 'An unexpected error occurred.',
+        solution: 'Please try again later.',
+    });
+    next(err);
+};
+//# sourceMappingURL=error-handler.js.map

package/dist/error-handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-handler.js","sourceRoot":"","sources":["../src/error-handler.ts"],"names":[],"mappings":"AACA,OAAO,MAAM,MAAM,yBAAyB,CAAC;AAC7C,OAAO,EAAE,sCAAsC,EAAE,MAAM,2BAA2B,CAAC;AAEnF,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,GAAU,EAAE,GAAY,EAAE,GAAa,EAAE,IAAkB,EAAE,EAAE;IAC1F,MAAM,CAAC,KAAK,CAAC;QACX,GAAG,GAAG;QACN,OAAO,EAAE,GAAG,CAAC,OAAO;QACpB,KAAK,EAAE,GAAG,CAAC,KAAK;KACjB,CAAC,CAAC,CAAC,mBAAmB;IAEvB,sCAAsC,CAAC,GAAG,EAAE,GAAG,EAAE;QAC/C,QAAQ,EAAE,+BAA+B;QACzC,QAAQ,EAAE,yBAAyB;KACpC,CAAC,CAAC;IAEH,IAAI,CAAC,GAAG,CAAC,CAAC;AACZ,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+import http from 'http';
+import { getCurrencySymbol } from './routes/paid-plans/subscription-utils.js';
+import { SideKickConfig } from './types.js';
+/**
+ * Initialize SideKick server with custom configuration
+ * @param config - SideKick configuration object
+ * @returns HTTP server instance (not started - call .listen() to start)
+ */
+export declare const initSideKick: (config: SideKickConfig) => http.Server;
+export type { SideKickConfig, AppInfo, CorsConfig, JwtConfig, CustomRoutesHandler, DatabaseConnection } from './types.js';
+export * from './utils/index.js';
+export * from './routes/orgs/index.js';
+export * from './s3-buckets/index.js';
+export * from './local-cache.js';
+export * from './ai/index.js';
+export { getCurrencySymbol };
+export type { Plan } from './routes/paid-plans/billingsdk-config.js';
+export * from './r2-buckets/index.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AAcxB,OAAO,EAAE,iBAAiB,EAAsD,MAAM,2CAA2C,CAAC;AAElI,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAI5C;;;;GAIG;AACH,eAAO,MAAM,YAAY,GAAI,QAAQ,cAAc,KAAG,IAAI,CAAC,MA0E1D,CAAC;AAGF,YAAY,EAAE,cAAc,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAC1H,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,iBAAiB,EAAE,CAAC;AAC7B,YAAY,EAAE,IAAI,EAAE,MAAM,0CAA0C,CAAC;AACrE,cAAc,uBAAuB,CAAC"}

package/dist/index.js

@@ -0,0 +1,87 @@
+import http from 'http';
+import cors from 'cors';
+import express from 'express';
+import { rateLimit } from 'express-rate-limit';
+import helmet from 'helmet';
+import { setAccountType, setAppConfig } from './app-config.js';
+import corsConfig from './cors-config.js';
+import { setDatabaseConnection } from './db-connection.js';
+import { errorHandler } from './error-handler.js';
+import { setFeatureFlag } from './routes/feature-flags/feature-flags.js';
+import routes from './routes/index.js';
+// import initSocketIO from './socket-config.js';
+import { getCurrencySymbol, setCurrency, setFaqs, setFreePlan, setPremiumPlans } from './routes/paid-plans/subscription-utils.js';
+import { setSecret } from './secret.js';
+import { setEmailConfig } from './utils/email-helper.js';
+import { updateRolesEnum } from './utils/enums.js';
+/**
+ * Initialize SideKick server with custom configuration
+ * @param config - SideKick configuration object
+ * @returns HTTP server instance (not started - call .listen() to start)
+ */
+export const initSideKick = (config) => {
+    // Set configuration
+    setAppConfig(config.appInfo);
+    setAccountType(config.accountType || {});
+    setDatabaseConnection(config.database);
+    const { subscriptions } = config;
+    setCurrency(subscriptions.currency, subscriptions.currencySymbol);
+    setFreePlan(subscriptions.freePlan);
+    setPremiumPlans(subscriptions.premiumPlans);
+    setFaqs(subscriptions.faqs);
+    setEmailConfig(config.emailConfig || null);
+    setSecret(config.secretConfig || {});
+    setFeatureFlag(config.featureFlags || {});
+    updateRolesEnum(config.rolesEnum || {});
+    // Create Express app
+    const expressApp = express();
+    // Create HTTP server
+    const httpServer = http.createServer(expressApp);
+    expressApp.use(express.json({ limit: '10kb' })); // Limit body size to prevent DDoS via large payloads
+    // Security Headers
+    expressApp.use(helmet());
+    // Global Rate Limiting
+    const limiter = rateLimit({
+        windowMs: 15 * 60 * 1000, // 15 minutes
+        limit: 1000, // Limit each IP to 100 requests per windowMs
+        standardHeaders: 'draft-7', // Use standard headers for rate limit info
+        legacyHeaders: false, // Disable the `X-RateLimit-*` headers
+        message: {
+            errorMsg: 'Too many requests from this IP, please try again.',
+            solution: 'Please slow down your requests or contact support if you believe this is an error.',
+        },
+    });
+    expressApp.use(limiter);
+    // Register custom routes if provided
+    if (config.customRoutesPublic) {
+        config.customRoutesPublic(expressApp);
+    }
+    // Configure CORS
+    const corsConfiguration = corsConfig(config.cors.allowedOrigins);
+    // Express middleware
+    expressApp.use(cors(corsConfiguration));
+    // Register routes
+    routes(expressApp);
+    // Register custom routes if provided
+    if (config.customRoutes) {
+        config.customRoutes(expressApp);
+    }
+    // 404 handler for unmatched routes
+    expressApp.use((req, res, next) => {
+        const err = new Error('Invalid API endpoint.');
+        next(err);
+    });
+    // Error handler (must be last)
+    expressApp.use(errorHandler);
+    // Initialize socket io (if needed)
+    // initSocketIO(httpServer, corsConfiguration);
+    return httpServer;
+};
+export * from './utils/index.js';
+export * from './routes/orgs/index.js';
+export * from './s3-buckets/index.js';
+export * from './local-cache.js';
+export * from './ai/index.js';
+export { getCurrencySymbol };
+export * from './r2-buckets/index.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,yCAAyC,CAAC;AACzE,OAAO,MAAM,MAAM,mBAAmB,CAAC;AACvC,iDAAiD;AACjD,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,2CAA2C,CAAC;AAClI,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEnD;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,MAAsB,EAAe,EAAE;IAClE,oBAAoB;IACpB,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC7B,cAAc,CAAC,MAAM,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC;IACzC,qBAAqB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAEvC,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC;IACjC,WAAW,CAAC,aAAa,CAAC,QAAQ,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;IAClE,WAAW,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IACpC,eAAe,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;IAC5C,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAE5B,cAAc,CAAC,MAAM,CAAC,WAAW,IAAI,IAAI,CAAC,CAAC;IAC3C,SAAS,CAAC,MAAM,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC;IACrC,cAAc,CAAC,MAAM,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC;IAC1C,eAAe,CAAC,MAAM,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC;IAExC,qBAAqB;IACrB,MAAM,UAAU,GAAG,OAAO,EAAE,CAAC;IAE7B,qBAAqB;IACrB,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;IAEjD,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,qDAAqD;IAEtG,mBAAmB;IACnB,UAAU,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;IAEzB,uBAAuB;IACvB,MAAM,OAAO,GAAG,SAAS,CAAC;QACxB,QAAQ,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,aAAa;QACvC,KAAK,EAAE,IAAI,EAAE,6CAA6C;QAC1D,eAAe,EAAE,SAAS,EAAE,2CAA2C;QACvE,aAAa,EAAE,KAAK,EAAE,sCAAsC;QAC5D,OAAO,EAAE;YACP,QAAQ,EAAE,mDAAmD;YAC7D,QAAQ,EAAE,oFAAoF;SAC/F;KACF,CAAC,CAAC;IAEH,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAExB,qCAAqC;IACrC,IAAI,MAAM,CAAC,kBAAkB,EAAE,CAAC;QAC9B,MAAM,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;IACxC,CAAC;IAED,iBAAiB;IACjB,MAAM,iBAAiB,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAEjE,qBAAqB;IACrB,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAExC,kBAAkB;IAClB,MAAM,CAAC,UAAU,CAAC,CAAC;IAEnB,qCAAqC;IACrC,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;QACxB,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;IAClC,CAAC;IAED,mCAAmC;IACnC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QAChC,MAAM,GAAG,GAAQ,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QACpD,IAAI,CAAC,GAAG,CAAC,CAAC;IACZ,CAAC,CAAC,CAAC;IAEH,+BAA+B;IAC/B,UAAU,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAE7B,mCAAmC;IACnC,+CAA+C;IAE/C,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAIF,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,iBAAiB,EAAE,CAAC;AAE7B,cAAc,uBAAuB,CAAC"}

package/dist/local-cache.d.ts

@@ -0,0 +1,14 @@
+declare class LocalCache {
+    private lCache;
+    constructor(maxSize: number);
+    get(key: string): Promise<any | undefined>;
+    set(key: string, value: any, ttl?: number): Promise<void>;
+    del(key: string): Promise<void>;
+    size(): Promise<number>;
+    keys(): Promise<string[]>;
+    has(key: string): Promise<boolean>;
+    getAllValues(): Promise<any[]>;
+}
+export declare const getSingletonCacheInstance: (instanceName: string, maxSize: number) => Promise<LocalCache>;
+export {};
+//# sourceMappingURL=local-cache.d.ts.map

package/dist/local-cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"local-cache.d.ts","sourceRoot":"","sources":["../src/local-cache.ts"],"names":[],"mappings":"AAEA,cAAM,UAAU;IACd,OAAO,CAAC,MAAM,CAAwB;gBAE1B,OAAO,EAAE,MAAM;IAMrB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,GAAG,SAAS,CAAC;IAI1C,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQzD,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/B,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC;IAIvB,IAAI,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAIzB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIlC,YAAY,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;CAGrC;AAID,eAAO,MAAM,yBAAyB,GAAU,cAAc,MAAM,EAAE,SAAS,MAAM,wBAMpF,CAAC"}

package/dist/local-cache.js

@@ -0,0 +1,44 @@
+import { LRUCache } from 'lru-cache';
+class LocalCache {
+    lCache;
+    constructor(maxSize) {
+        this.lCache = new LRUCache({
+            max: maxSize || 100,
+        });
+    }
+    async get(key) {
+        return this.lCache.get(key);
+    }
+    async set(key, value, ttl) {
+        if (ttl) {
+            this.lCache.set(key, value, { ttl });
+        }
+        else {
+            this.lCache.set(key, value);
+        }
+    }
+    async del(key) {
+        this.lCache.delete(key);
+    }
+    async size() {
+        return this.lCache.size;
+    }
+    async keys() {
+        return Array.from(this.lCache.keys());
+    }
+    async has(key) {
+        return this.lCache.has(key);
+    }
+    async getAllValues() {
+        return Array.from(this.lCache.values());
+    }
+}
+const cacheInstances = {};
+export const getSingletonCacheInstance = async (instanceName, maxSize) => {
+    if (cacheInstances[instanceName]) {
+        return cacheInstances[instanceName];
+    }
+    cacheInstances[instanceName] = new LocalCache(maxSize);
+    return cacheInstances[instanceName];
+};
+//# sourceMappingURL=local-cache.js.map

package/dist/local-cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"local-cache.js","sourceRoot":"","sources":["../src/local-cache.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAErC,MAAM,UAAU;IACN,MAAM,CAAwB;IAEtC,YAAY,OAAe;QACzB,IAAI,CAAC,MAAM,GAAG,IAAI,QAAQ,CAAc;YACtC,GAAG,EAAE,OAAO,IAAI,GAAG;SACpB,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW;QACnB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,KAAU,EAAE,GAAY;QAC7C,IAAI,GAAG,EAAE,CAAC;YACR,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;QACvC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW;QACnB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,IAAI;QACR,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,IAAI;QACR,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;IACxC,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW;QACnB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IAC1C,CAAC;CACF;AAED,MAAM,cAAc,GAAkC,EAAE,CAAC;AAEzD,MAAM,CAAC,MAAM,yBAAyB,GAAG,KAAK,EAAE,YAAoB,EAAE,OAAe,EAAE,EAAE;IACvF,IAAI,cAAc,CAAC,YAAY,CAAC,EAAE,CAAC;QACjC,OAAO,cAAc,CAAC,YAAY,CAAC,CAAC;IACtC,CAAC;IACD,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC;IACvD,OAAO,cAAc,CAAC,YAAY,CAAC,CAAC;AACtC,CAAC,CAAC"}

package/dist/r2-buckets/get-signed-url.d.ts

@@ -0,0 +1,2 @@
+export declare function getR2SignedFileUrl(key: string): Promise<any>;
+//# sourceMappingURL=get-signed-url.d.ts.map

package/dist/r2-buckets/get-signed-url.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-signed-url.d.ts","sourceRoot":"","sources":["../../src/r2-buckets/get-signed-url.ts"],"names":[],"mappings":"AAQA,wBAAsB,kBAAkB,CAAC,GAAG,EAAE,MAAM,gBAiBnD"}