@memberjunction/server-bootstrap 0.0.1 → 3.0.0

package/README.md

@@ -1,45 +1,162 @@
 # @memberjunction/server-bootstrap
 
-## ⚠️ IMPORTANT NOTICE ⚠️
+MemberJunction 3.0 Server Bootstrap - Encapsulates all server initialization logic into a single, simple function.
 
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
+## Overview
+
+In MemberJunction 3.0, server applications (MJAPI) become **minimal bootstrapping files** (~6 lines of code) that import all functionality from NPM packages. This package provides the `createMJServer()` function that handles all the complex initialization logic.
+
+## Installation
+
+```bash
+npm install @memberjunction/server-bootstrap
+```
+
+## Usage
+
+### Basic Usage (Minimal MJAPI 3.0)
+
+Create your `packages/api/src/index.ts`:
 
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
+```typescript
+import { createMJServer } from '@memberjunction/server-bootstrap';
 
-## Purpose
+// Import generated packages to trigger registration
+import '@mycompany/generated-entities';
+import '@mycompany/generated-actions';
+import '@mycompany/generated-resolvers';
 
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@memberjunction/server-bootstrap`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
+createMJServer().catch(console.error);
+```
 
-## What is OIDC Trusted Publishing?
+**That's it!** Your entire MJAPI application in 6 lines.
 
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
+### With Custom Configuration
 
-## Setup Instructions
+```typescript
+import { createMJServer } from '@memberjunction/server-bootstrap';
 
-To properly configure OIDC trusted publishing for this package:
+createMJServer({
+  // Add custom resolver paths
+  resolverPaths: ['./custom-resolvers/**/*Resolver.{js,ts}'],
 
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
+  // Run custom logic before server starts
+  beforeStart: async () => {
+    console.log('Initializing custom services...');
+    // Your initialization code here
+  },
 
-## DO NOT USE THIS PACKAGE
+  // Run custom logic after server starts
+  afterStart: async () => {
+    console.log('Server is ready!');
+    // Your post-startup code here
+  },
 
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
+  // Configure REST API
+  restApiOptions: {
+    enabled: true,
+    includeEntities: ['Users', 'Companies'],
+    excludeEntities: ['SystemSettings']
+  }
+}).catch(console.error);
+```
 
-## More Information
+## What It Does
 
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
+The `createMJServer()` function handles:
 
----
+1. **Configuration Loading** - Automatically finds and loads `mj.config.cjs` or `.mjrc`
+2. **Generated Package Discovery** - Auto-imports generated entities, actions, forms, and resolvers
+3. **Database Connection** - Sets up connection pooling with configured credentials
+4. **GraphQL Schema Building** - Discovers resolvers and builds the GraphQL schema
+5. **WebSocket Setup** - Configures WebSocket support for GraphQL subscriptions
+6. **REST API Setup** - Registers REST endpoints based on configuration
+7. **Graceful Shutdown** - Handles SIGTERM/SIGINT signals properly
+8. **Scheduled Jobs** - Initializes and starts scheduled job service if enabled
 
-**Maintained for OIDC setup purposes only**
+## Configuration
+
+The function uses your `mj.config.cjs` for all database and server settings:
+
+```javascript
+// mj.config.cjs
+module.exports = {
+  dbHost: process.env.DB_HOST,
+  dbPort: process.env.DB_PORT || 1433,
+  dbDatabase: process.env.DB_DATABASE,
+  dbUsername: process.env.DB_USERNAME,
+  dbPassword: process.env.DB_PASSWORD,
+
+  graphqlPort: process.env.PORT || 4000,
+
+  // 3.0 Code Generation Configuration
+  codeGeneration: {
+    outputMode: 'packages',
+    packageScope: '@mycompany',
+    packages: {
+      entities: {
+        path: './packages/generated-entities',
+        name: '@mycompany/generated-entities'
+      },
+      actions: {
+        path: './packages/generated-actions',
+        name: '@mycompany/generated-actions'
+      },
+      graphqlResolvers: {
+        path: './packages/generated-resolvers',
+        name: '@mycompany/generated-resolvers'
+      }
+    }
+  }
+};
+```
+
+## API Reference
+
+### `createMJServer(options?: MJServerConfig): Promise<void>`
+
+Creates and starts a MemberJunction API server.
+
+#### Parameters
+
+- `options.configPath` - Path to config file (optional, auto-discovers if not provided)
+- `options.resolverPaths` - Additional resolver paths beyond defaults
+- `options.beforeStart` - Hook function to run before server starts
+- `options.afterStart` - Hook function to run after server starts
+- `options.restApiOptions` - REST API configuration options
+
+#### Returns
+
+Promise that resolves when the server is running.
+
+## Migration from 2.x
+
+In MemberJunction 2.x, your MJAPI/src/index.ts had ~34 lines of boilerplate code for database setup, schema building, etc.
+
+**Before (2.x):**
+```typescript
+// 34 lines of configuration, pool setup, schema building, etc.
+import { serve } from '@memberjunction/server';
+// ... lots of setup code ...
+await serve(resolverPaths);
+```
+
+**After (3.0):**
+```typescript
+import { createMJServer } from '@memberjunction/server-bootstrap';
+createMJServer().catch(console.error);
+```
+
+All the complexity is now encapsulated in this package and updated via NPM.
+
+## Benefits
+
+- **Zero-copy updates** - `npm update` brings all improvements automatically
+- **No stale code** - Bootstrap logic stays up-to-date with MJ releases
+- **Minimal surface area** - Fewer lines of code means fewer places for bugs
+- **Standard patterns** - Everyone uses the same initialization flow
+- **Extensible** - Hooks allow custom logic without modifying core
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+import { MJServerOptions } from '@memberjunction/server';
+export interface MJServerConfig {
+    configPath?: string;
+    resolverPaths?: string[];
+    beforeStart?: () => void | Promise<void>;
+    afterStart?: () => void | Promise<void>;
+    restApiOptions?: MJServerOptions['restApiOptions'];
+}
+export declare function createMJServer(options?: MJServerConfig): Promise<void>;
+export type { MJServerOptions } from '@memberjunction/server';
+//# 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,EAAS,eAAe,EAAc,MAAM,wBAAwB,CAAC;AAM5E,MAAM,WAAW,cAAc;IAI7B,UAAU,CAAC,EAAE,MAAM,CAAC;IAMpB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAKzB,WAAW,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAKzC,UAAU,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAKxC,cAAc,CAAC,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC;CACpD;AA+ED,wBAAsB,cAAc,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CA2DhF;AAGD,YAAY,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/index.js

@@ -0,0 +1,62 @@
+import { serve } from '@memberjunction/server';
+import { cosmiconfigSync } from 'cosmiconfig';
+async function discoverAndLoadGeneratedPackages(configResult) {
+    if (!configResult?.config?.codeGeneration?.packages) {
+        console.warn('No codeGeneration.packages configuration found - skipping auto-import of generated packages');
+        return;
+    }
+    const packages = configResult.config.codeGeneration.packages;
+    const packageTypes = ['entities', 'actions', 'angularForms', 'graphqlResolvers'];
+    for (const pkgType of packageTypes) {
+        if (packages[pkgType]?.name) {
+            const pkgName = packages[pkgType].name;
+            try {
+                await import(pkgName);
+                console.log(`✓ Loaded generated package: ${pkgName}`);
+            }
+            catch (error) {
+                if (error.code === 'ERR_MODULE_NOT_FOUND') {
+                    console.log(`ℹ Generated package not found (may not exist yet): ${pkgName}`);
+                }
+                else {
+                    console.warn(`⚠ Error loading generated package ${pkgName}:`, error);
+                }
+            }
+        }
+    }
+}
+export async function createMJServer(options = {}) {
+    console.log('🚀 MemberJunction 3.0 Server Bootstrap');
+    console.log('=====================================\n');
+    console.log('');
+    const explorer = cosmiconfigSync('mj', { searchStrategy: 'global' });
+    const configSearchResult = explorer.search(options.configPath || process.cwd());
+    const configResult = {
+        config: configSearchResult?.config || {},
+        hasUserConfig: configSearchResult && !configSearchResult.isEmpty,
+        configFilePath: configSearchResult?.filepath
+    };
+    console.log('Loading generated packages...');
+    await discoverAndLoadGeneratedPackages(configResult);
+    console.log('');
+    const resolverPaths = options.resolverPaths || [
+        './src/generated/generated.{js,ts}',
+        './dist/generated/generated.{js,ts}',
+        './generated/generated.{js,ts}',
+    ];
+    if (options.beforeStart) {
+        console.log('Running pre-start hook...');
+        await Promise.resolve(options.beforeStart());
+        console.log('');
+    }
+    const serverOptions = {
+        onBeforeServe: options.beforeStart,
+        restApiOptions: options.restApiOptions
+    };
+    console.log('Starting MemberJunction Server...\n');
+    await serve(resolverPaths, undefined, serverOptions);
+    if (options.afterStart) {
+        await Promise.resolve(options.afterStart());
+    }
+}
+//# 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,EAAE,KAAK,EAA+B,MAAM,wBAAwB,CAAC;AAC5E,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAyC9C,KAAK,UAAU,gCAAgC,CAAC,YAAiB;IAC/D,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC;QACpD,OAAO,CAAC,IAAI,CAAC,6FAA6F,CAAC,CAAC;QAC5G,OAAO;IACT,CAAC;IAED,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC;IAI7D,MAAM,YAAY,GAAG,CAAC,UAAU,EAAE,SAAS,EAAE,cAAc,EAAE,kBAAkB,CAAC,CAAC;IAEjF,KAAK,MAAM,OAAO,IAAI,YAAY,EAAE,CAAC;QACnC,IAAI,QAAQ,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC;YAC5B,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC;YACvC,IAAI,CAAC;gBAEH,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC;gBACtB,OAAO,CAAC,GAAG,CAAC,+BAA+B,OAAO,EAAE,CAAC,CAAC;YACxD,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBAEpB,IAAI,KAAK,CAAC,IAAI,KAAK,sBAAsB,EAAE,CAAC;oBAC1C,OAAO,CAAC,GAAG,CAAC,sDAAsD,OAAO,EAAE,CAAC,CAAC;gBAC/E,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,IAAI,CAAC,qCAAqC,OAAO,GAAG,EAAE,KAAK,CAAC,CAAC;gBACvE,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAwCD,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,UAA0B,EAAE;IAC/D,OAAO,CAAC,GAAG,CAAC,wCAAwC,CAAC,CAAC;IACtD,OAAO,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAC;IAIvD,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAChB,MAAM,QAAQ,GAAG,eAAe,CAAC,IAAI,EAAE,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC,CAAC;IACrE,MAAM,kBAAkB,GAAG,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAGhF,MAAM,YAAY,GAAG;QACnB,MAAM,EAAE,kBAAkB,EAAE,MAAM,IAAI,EAAE;QACxC,aAAa,EAAE,kBAAkB,IAAI,CAAC,kBAAkB,CAAC,OAAO;QAChE,cAAc,EAAE,kBAAkB,EAAE,QAAQ;KAC7C,CAAC;IAIF,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;IAC7C,MAAM,gCAAgC,CAAC,YAAY,CAAC,CAAC;IACrD,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAIhB,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI;QAE7C,mCAAmC;QACnC,oCAAoC;QACpC,+BAA+B;KAChC,CAAC;IAGF,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;QACxB,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;QACzC,MAAM,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;QAC7C,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAClB,CAAC;IAGD,MAAM,aAAa,GAAoB;QACrC,aAAa,EAAE,OAAO,CAAC,WAAW;QAClC,cAAc,EAAE,OAAO,CAAC,cAAc;KACvC,CAAC;IASF,OAAO,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAC;IACnD,MAAM,KAAK,CAAC,aAAa,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;IAGrD,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;QACvB,MAAM,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;IAC9C,CAAC;AACH,CAAC"}

package/package.json

@@ -1,10 +1,32 @@
 {
   "name": "@memberjunction/server-bootstrap",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @memberjunction/server-bootstrap",
+  "version": "3.0.0",
+  "description": "MemberJunction Server Bootstrap - Encapsulates all server initialization logic",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc --watch",
+    "clean": "rm -rf dist"
+  },
   "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
+    "memberjunction",
+    "bootstrap",
+    "server"
+  ],
+  "author": "MemberJunction",
+  "license": "MIT",
+  "dependencies": {
+    "@memberjunction/core": "3.0.0",
+    "@memberjunction/server": "3.0.0",
+    "cosmiconfig": "^9.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.2",
+    "typescript": "^5.4.5"
+  },
+  "files": [
+    "dist/**/*"
   ]
 }