@teamvortexsoftware/vortex-nextjs-15-sdk 0.0.2 → 0.0.4

package/README.md

@@ -38,7 +38,7 @@ lib/
 
 Each route file is just 3 lines:
 ```typescript
-import 'lib/vortex-config';
+import '@/lib/vortex-config';
 import { createVortexRoutes } from '@teamvortexsoftware/vortex-nextjs-15-sdk';
 
 export const { GET, DELETE } = createVortexRoutes().invitation;
@@ -170,7 +170,7 @@ Need custom logic? Create your own routes:
 
 ```typescript
 // app/api/custom-invitation/route.ts
-import 'lib/vortex-config';
+import '@/lib/vortex-config';
 import { handleGetInvitation, createErrorResponse } from '@teamvortexsoftware/vortex-nextjs-15-sdk';
 
 export async function GET(request: NextRequest) {
@@ -189,7 +189,7 @@ export async function GET(request: NextRequest) {
 
 ### Build Errors
 If you see configuration errors during build:
-- Make sure you're importing `'lib/vortex-config'` in your layout
+- Make sure you're importing `'@/lib/vortex-config'` (or `'../lib/vortex-config'`) in your layout
 - Check that your `.env.local` has `VORTEX_API_KEY`
 - Ensure you're using lazy initialization (`configureVortexLazy`)
 

package/bin/vortex-setup.js

@@ -0,0 +1,200 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+
+const VORTEX_ROUTES = [
+  'jwt/route.ts',
+  'invitations/route.ts',
+  'invitations/[invitationId]/route.ts',
+  'invitations/accept/route.ts',
+  'invitations/by-group/[groupType]/[groupId]/route.ts',
+  'invitations/[invitationId]/reinvite/route.ts'
+];
+
+function createRouteTemplates(baseDir) {
+  const configImport = baseDir ? '@/lib/vortex-config' : '@/lib/vortex-config';
+
+  return {
+    'jwt/route.ts': `import '${configImport}';
+import { createVortexRoutes } from '@teamvortexsoftware/vortex-nextjs-15-sdk';
+
+export const { POST } = createVortexRoutes().jwt;
+`,
+
+    'invitations/route.ts': `import '${configImport}';
+import { createVortexRoutes } from '@teamvortexsoftware/vortex-nextjs-15-sdk';
+
+export const { GET } = createVortexRoutes().invitations;
+`,
+
+    'invitations/[invitationId]/route.ts': `import '${configImport}';
+import { createVortexRoutes } from '@teamvortexsoftware/vortex-nextjs-15-sdk';
+
+export const { GET, DELETE } = createVortexRoutes().invitation;
+`,
+
+    'invitations/accept/route.ts': `import '${configImport}';
+import { createVortexRoutes } from '@teamvortexsoftware/vortex-nextjs-15-sdk';
+
+export const { POST } = createVortexRoutes().invitationsAccept;
+`,
+
+    'invitations/by-group/[groupType]/[groupId]/route.ts': `import '${configImport}';
+import { createVortexRoutes } from '@teamvortexsoftware/vortex-nextjs-15-sdk';
+
+export const { GET, DELETE } = createVortexRoutes().invitationsByGroup;
+`,
+
+    'invitations/[invitationId]/reinvite/route.ts': `import '${configImport}';
+import { createVortexRoutes } from '@teamvortexsoftware/vortex-nextjs-15-sdk';
+
+export const { POST } = createVortexRoutes().invitationReinvite;
+`
+  };
+}
+
+const CONFIG_TEMPLATE = `import {
+  configureVortexLazy,
+  createAllowAllAccessControl,
+  type VortexConfig,
+} from '@teamvortexsoftware/vortex-nextjs-15-sdk';
+
+// Configure Vortex with lazy initialization - only runs when first API call is made
+configureVortexLazy(async (): Promise<VortexConfig> => {
+  return {
+    apiKey: process.env.VORTEX_API_KEY!,
+
+    // Required: How to authenticate users for JWT generation
+    authenticateUser: async (request) => {
+      // TODO: Replace this with your authentication logic
+      //
+      // Examples:
+      // - NextAuth.js: const session = await getServerSession(request, authOptions);
+      // - Supabase: const { data: { user } } = await supabase.auth.getUser();
+      // - Custom JWT: const user = await verifyJwtToken(request);
+      //
+      // Expected return format:
+      // return {
+      //   userId: user.id,
+      //   identifiers: [{ type: 'email', value: user.email }],
+      //   groups: [{ type: 'team', id: 'team-123', name: 'My Team' }],
+      // };
+
+      throw new Error('TODO: Implement authenticateUser in lib/vortex-config.ts');
+    },
+
+    // Simple access control - allows all operations (customize for production)
+    ...createAllowAllAccessControl(),
+
+    // For production, replace createAllowAllAccessControl() with custom logic:
+    // canDeleteInvitation: async (request, user, resource) => {
+    //   return user?.role === 'admin';
+    // },
+    // canAccessInvitationsByGroup: async (request, user, resource) => {
+    //   return user?.groups.some(g =>
+    //     g.type === resource?.groupType && g.id === resource?.groupId
+    //   );
+    // },
+    // ... other access control hooks
+  };
+});
+`;
+
+function createDirectory(dirPath) {
+  if (!fs.existsSync(dirPath)) {
+    fs.mkdirSync(dirPath, { recursive: true });
+    console.log(`✓ Created directory: ${dirPath}`);
+  }
+}
+
+function writeFileIfNotExists(filePath, content) {
+  if (fs.existsSync(filePath)) {
+    console.log(`⚠ File already exists, skipping: ${filePath}`);
+    return false;
+  }
+
+  fs.writeFileSync(filePath, content);
+  console.log(`✓ Created file: ${filePath}`);
+  return true;
+}
+
+function main() {
+  console.log('🚀 Setting up Vortex Next.js 15 SDK...\n');
+
+  // Check if we're in a Next.js project
+  if (!fs.existsSync('next.config.js') && !fs.existsSync('next.config.ts') && !fs.existsSync('next.config.mjs')) {
+    console.error('❌ This doesn\'t appear to be a Next.js project. Make sure you\'re in the root directory.');
+    process.exit(1);
+  }
+
+  // Check for app directory - support both root app/ and src/app/
+  let baseDir = '';
+  if (fs.existsSync('app')) {
+    baseDir = '';
+    console.log('✓ Found app directory at project root');
+  } else if (fs.existsSync('src/app')) {
+    baseDir = 'src';
+    console.log('✓ Found app directory in src/');
+  } else {
+    console.error('❌ This setup requires Next.js App Router. Please ensure you have an "app" or "src/app" directory.');
+    process.exit(1);
+  }
+
+  let filesCreated = 0;
+
+  // Create API routes
+  const apiDir = path.join(baseDir, 'app', 'api', 'vortex');
+  createDirectory(apiDir);
+
+  const routeTemplates = createRouteTemplates(baseDir);
+
+  VORTEX_ROUTES.forEach(route => {
+    const filePath = path.join(apiDir, route);
+    const dirPath = path.dirname(filePath);
+
+    createDirectory(dirPath);
+
+    if (writeFileIfNotExists(filePath, routeTemplates[route])) {
+      filesCreated++;
+    }
+  });
+
+  // Create lib directory and config file
+  const libDir = baseDir ? path.join(baseDir, 'lib') : 'lib';
+  createDirectory(libDir);
+  const configPath = path.join(libDir, 'vortex-config.ts');
+
+  if (writeFileIfNotExists(configPath, CONFIG_TEMPLATE)) {
+    filesCreated++;
+  }
+
+  console.log(`\n🎉 Setup complete! Created ${filesCreated} new files.`);
+  console.log('\n📋 Next steps:');
+  console.log('1. Add your VORTEX_API_KEY to .env.local:');
+  console.log('   VORTEX_API_KEY=your_api_key_here');
+
+  const layoutPath = baseDir ? `${baseDir}/app/layout.tsx` : 'app/layout.tsx';
+  const configImportPath = baseDir ? '../lib/vortex-config' : '../lib/vortex-config';
+  const configFilePath = baseDir ? `${baseDir}/lib/vortex-config.ts` : 'lib/vortex-config.ts';
+
+  console.log(`2. Import the config in your ${layoutPath}:`);
+  console.log(`   import '${configImportPath}';`);
+  console.log(`3. Implement the authenticateUser function in ${configFilePath}`);
+  console.log('4. Wrap your app in VortexProvider:');
+  console.log('   <VortexProvider config={{ apiBaseUrl: \'/api/vortex\' }}>');
+
+  console.log('\n✨ Features:');
+  console.log('• Super simple - each route is just 3 lines!');
+  console.log('• Lazy initialization - no database calls during build');
+  console.log('• createAllowAllAccessControl() for easy development');
+  console.log('• Full TypeScript support with IntelliSense');
+
+  console.log('\n📚 See the README for examples and customization options.');
+}
+
+if (require.main === module) {
+  main();
+}
+
+module.exports = { main };

package/package.json

@@ -2,7 +2,7 @@
   "name": "@teamvortexsoftware/vortex-nextjs-15-sdk",
   "description": "Drop-in Next.js module for Vortex API integration",
   "author": "@teamvortexsoftware",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "bin": {
@@ -21,10 +21,10 @@
   ],
   "scripts": {
     "build:stg": "pnpm run distclean && pnpm run build && mkdir -p dist.d/stg && mv dist dist.d/stg && echo && echo 'Build in ./dist.d/stg'",
-    "prepublish:stg": "cp ./LICENSE ./README.md ./dist.d/stg/ && jq '.name = \"@teamvortexsoftware/vortex-nextjs-15-sdk-stg\" | .description = \"Vortex NextJS 15 SDK (STG)\" | del(.scripts.prepack)' ./package.json > ./dist.d/stg/package.json",
+    "prepublish:stg": "cp ./LICENSE ./README.md ./dist.d/stg/ && cp -r ./bin ./dist.d/stg/ && jq '.name = \"@teamvortexsoftware/vortex-nextjs-15-sdk-stg\" | .description = \"Vortex NextJS 15 SDK (STG)\" | del(.devDependencies.\"@teamvortexsoftware/eslint-config\") | del(.devDependencies.\"@teamvortexsoftware/typescript-config\") | .dependencies.\"@teamvortexsoftware/vortex-node-22-sdk\" = \"^0.0.3\" | del(.scripts.prepack)' ./package.json > ./dist.d/stg/package.json",
     "publish:stg": "pnpm run prepublish:stg && npm publish  --userconfig ../../.npmrc --access restricted ./dist.d/stg",
     "build:prod": "pnpm run distclean && pnpm run build && mkdir -p dist.d/prod && mv dist dist.d/prod && echo && echo 'Build in ./dist.d/prod'",
-    "prepublish:prod": "cp ./LICENSE ./README.md ./dist.d/prod/ && jq 'del(.scripts.prepack)' ./package.json > ./dist.d/prod/package.json",
+    "prepublish:prod": "cp ./LICENSE ./README.md ./dist.d/prod/ && cp -r ./bin ./dist.d/prod/ && jq 'del(.devDependencies.\"@teamvortexsoftware/eslint-config\") | del(.devDependencies.\"@teamvortexsoftware/typescript-config\") | .dependencies.\"@teamvortexsoftware/vortex-node-22-sdk\" = \"^0.0.3\" | del(.scripts.prepack)' ./package.json > ./dist.d/prod/package.json",
     "publish:prod": "pnpm run prepublish:prod && npm publish  --userconfig ../../.npmrc --access public ./dist.d/prod",
     "check-types": "tsc --noEmit",
     "distclean": "rm -rf ./dist ./dist.d",
@@ -49,8 +49,6 @@
   "devDependencies": {
     "@eslint/js": "^9.24.0",
     "@jest/globals": "29.7.0",
-    "@teamvortexsoftware/eslint-config": "workspace:*",
-    "@teamvortexsoftware/typescript-config": "workspace:*",
     "eslint": "^9.24.0",
     "jest": "29.7.0",
     "typescript-eslint": "^8.30.1",
@@ -59,7 +57,7 @@
     "typescript": "^5.0.0"
   },
   "dependencies": {
-    "@teamvortexsoftware/vortex-node-22-sdk": "workspace:*"
+    "@teamvortexsoftware/vortex-node-22-sdk": "^0.0.3"
   },
   "peerDependencies": {
     "next": ">=13.0.0"