@bagelink/workspace 1.7.33 → 1.7.37

package/README.md

@@ -79,7 +79,66 @@ export default defineWorkspace(configs)
 
 ## Usage
 
-### 1. Configure Vite (`vite.config.ts`)
+### 1. Add Type Definitions
+
+Add to your project's `env.d.ts`:
+
+```typescript
+/// <reference types="@bagelink/workspace/env" />
+```
+
+This provides TypeScript types for injected environment variables.
+
+### 2. Configure Vite (`vite.config.ts`)
+
+**Recommended: Use the Vite plugin (keeps your config clean and standard)**
+
+```typescript
+import { defineConfig } from 'vite'
+import vue from '@vitejs/plugin-vue'
+import { bagelink } from '@bagelink/workspace/vite'
+import workspace from './bgl.config'
+
+export default defineConfig({
+  plugins: [
+    vue(),
+    bagelink({ workspace }),
+  ],
+})
+```
+
+The plugin automatically:
+- Configures proxy based on `bgl.config.ts`
+- Sets up `@` alias pointing to `./src`
+- Sets up `@shared` alias (in monorepos)
+- Keeps your vite.config.ts clean and extensible
+
+**Advanced: Custom options**
+
+```typescript
+import { defineConfig } from 'vite'
+import vue from '@vitejs/plugin-vue'
+import { bagelink } from '@bagelink/workspace/vite'
+import { fileURLToPath } from 'node:url'
+import workspace from './bgl.config'
+
+export default defineConfig({
+  plugins: [
+    vue(),
+    bagelink({
+      workspace,
+      config: {
+        sharedPath: '../packages/shared',
+        additionalAliases: {
+          '@utils': fileURLToPath(new URL('./src/utils', import.meta.url))
+        }
+      }
+    }),
+  ],
+})
+```
+
+**Legacy: Manual proxy setup**
 
 ```typescript
 import { defineConfig } from 'vite'
@@ -98,7 +157,47 @@ export default defineConfig(({ mode }) => {
 })
 ```
 
-### 2. Add scripts to `package.json`
+### 3. Use Configuration in Your App
+
+**Access config at runtime with `useWorkspace()`:**
+
+```typescript
+import { useWorkspace } from '@bagelink/workspace'
+
+// In your app setup
+const { proxy, host, mode } = useWorkspace()
+const auth = initAuth({ baseURL: proxy })
+
+// Or get full API URL
+import { getApiUrl } from '@bagelink/workspace'
+const apiUrl = getApiUrl() // 'https://project.bagel.to/api'
+```
+
+**Vue component example:**
+
+```vue
+<script setup lang="ts">
+import { useWorkspace } from '@bagelink/workspace'
+import { initAuth } from '@bagelink/auth'
+
+const { proxy, host, mode } = useWorkspace()
+const auth = initAuth({ baseURL: proxy })
+
+console.log('API Host:', host)
+console.log('Environment:', mode)
+</script>
+```
+
+**Access raw environment variables:**
+
+```typescript
+// These are injected at build time by the bagelink plugin
+const proxy = import.meta.env.VITE_BGL_PROXY        // '/api'
+const host = import.meta.env.VITE_BGL_HOST          // 'https://project.bagel.to'
+const openapi = import.meta.env.VITE_BGL_OPENAPI_URL // optional
+```
+
+### 4. Add scripts to `package.json`
 
 ```json
 {
@@ -110,7 +209,7 @@ export default defineConfig(({ mode }) => {
 }
 ```
 
-### 3. Generate Netlify Config
+### 5. Generate Netlify Config
 
 ```typescript
 import { writeNetlifyConfig } from '@bagelink/workspace'
@@ -409,7 +508,41 @@ Show CLI help.
 
 ## API
 
-### `defineWorkspace(configs)`
+### Runtime Functions
+
+#### `useWorkspace()`
+
+Get workspace configuration at runtime. Config is injected as environment variables during build.
+
+```typescript
+import { useWorkspace } from '@bagelink/workspace'
+
+const { proxy, host, openapiUrl, mode } = useWorkspace()
+```
+
+**Returns:**
+```typescript
+interface RuntimeWorkspaceConfig {
+  proxy: string           // '/api'
+  host: string           // 'https://project.bagel.to'
+  openapiUrl?: string    // optional
+  mode: 'localhost' | 'development' | 'production'
+}
+```
+
+#### `getApiUrl()`
+
+Get the full API URL by combining host and proxy.
+
+```typescript
+import { getApiUrl } from '@bagelink/workspace'
+
+const apiUrl = getApiUrl() // 'https://project.bagel.to/api'
+```
+
+### Configuration Functions
+
+#### `defineWorkspace(configs)`
 
 Define workspace configuration for all environments.
 

package/bin/bgl.ts

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+import { resolve } from 'node:path'
 import process from 'node:process'
 import { isWorkspace } from '../src/detect.js'
 import { runDev } from '../src/dev.js'
@@ -17,11 +18,19 @@ async function main() {
 				|| subcommand === '-w'
 				|| args.includes('--workspace')
 				|| args.includes('-w')
+
+		// Support 'bgl init .' or 'bgl init <path>'
+		let targetPath = process.cwd()
+		if (subcommand && !subcommand.startsWith('-')) {
+			// If subcommand is not a flag, treat it as a path
+			targetPath = subcommand === '.' ? process.cwd() : resolve(process.cwd(), subcommand)
+		}
+
 		if (createWorkspace) {
 			await initWorkspace()
 		}
 		else {
-			await generateWorkspaceConfig()
+			await generateWorkspaceConfig(targetPath)
 		}
 	}
 	else if (command === 'add') {
@@ -110,7 +119,8 @@ SDK Commands:
 Bagel Workspace CLI
 
 Usage:
-  bgl init                  Generate bgl.config.ts for single project
+  bgl init [path]           Generate bgl.config.ts for single project
+                            Examples: bgl init, bgl init ., bgl init ./my-app
   bgl init --workspace      Create a new workspace with multiple projects
   bgl add <name>            Add a new project to workspace
   bgl list                  List all projects in workspace

package/dist/bin/bgl.cjs

@@ -1,10 +1,10 @@
 #!/usr/bin/env node
 'use strict';
 
+const node_path = require('node:path');
 const process = require('node:process');
-const workspace = require('../shared/workspace.OuHxYc4s.cjs');
+const workspace = require('../shared/workspace.CamNrnD_.cjs');
 require('node:fs');
-require('node:path');
 require('prompts');
 require('node:child_process');
 
@@ -16,10 +16,14 @@ const [, , command, subcommand, ...args] = process__default.argv;
 async function main() {
   if (command === "init") {
     const createWorkspace = subcommand === "--workspace" || subcommand === "-w" || args.includes("--workspace") || args.includes("-w");
+    let targetPath = process__default.cwd();
+    if (subcommand && !subcommand.startsWith("-")) {
+      targetPath = subcommand === "." ? process__default.cwd() : node_path.resolve(process__default.cwd(), subcommand);
+    }
     if (createWorkspace) {
       await workspace.initWorkspace();
     } else {
-      await workspace.generateWorkspaceConfig();
+      await workspace.generateWorkspaceConfig(targetPath);
     }
   } else if (command === "add") {
     const projectName = subcommand;
@@ -92,7 +96,8 @@ SDK Commands:
 Bagel Workspace CLI
 
 Usage:
-  bgl init                  Generate bgl.config.ts for single project
+  bgl init [path]           Generate bgl.config.ts for single project
+                            Examples: bgl init, bgl init ., bgl init ./my-app
   bgl init --workspace      Create a new workspace with multiple projects
   bgl add <name>            Add a new project to workspace
   bgl list                  List all projects in workspace

package/dist/bin/bgl.mjs

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
+import { resolve } from 'node:path';
 import process from 'node:process';
-import { k as initWorkspace, g as generateWorkspaceConfig, j as addProject, l as listProjects, i as isWorkspace, e as setupLint, h as generateSDKForWorkspace, f as generateSDK, r as runDev } from '../shared/workspace.CcKgYZPx.mjs';
+import { k as initWorkspace, g as generateWorkspaceConfig, j as addProject, l as listProjects, i as isWorkspace, e as setupLint, h as generateSDKForWorkspace, f as generateSDK, r as runDev } from '../shared/workspace.PLrsjsJ2.mjs';
 import 'node:fs';
-import 'node:path';
 import 'prompts';
 import 'node:child_process';
 
@@ -10,10 +10,14 @@ const [, , command, subcommand, ...args] = process.argv;
 async function main() {
   if (command === "init") {
     const createWorkspace = subcommand === "--workspace" || subcommand === "-w" || args.includes("--workspace") || args.includes("-w");
+    let targetPath = process.cwd();
+    if (subcommand && !subcommand.startsWith("-")) {
+      targetPath = subcommand === "." ? process.cwd() : resolve(process.cwd(), subcommand);
+    }
     if (createWorkspace) {
       await initWorkspace();
     } else {
-      await generateWorkspaceConfig();
+      await generateWorkspaceConfig(targetPath);
     }
   } else if (command === "add") {
     const projectName = subcommand;
@@ -86,7 +90,8 @@ SDK Commands:
 Bagel Workspace CLI
 
 Usage:
-  bgl init                  Generate bgl.config.ts for single project
+  bgl init [path]           Generate bgl.config.ts for single project
+                            Examples: bgl init, bgl init ., bgl init ./my-app
   bgl init --workspace      Create a new workspace with multiple projects
   bgl add <name>            Add a new project to workspace
   bgl list                  List all projects in workspace

package/dist/index.cjs

@@ -3,9 +3,11 @@
 const node_fs = require('node:fs');
 const node_path = require('node:path');
 const process = require('node:process');
-const workspace = require('./shared/workspace.OuHxYc4s.cjs');
+const workspace = require('./shared/workspace.CamNrnD_.cjs');
+const vite = require('./shared/workspace.DfLGMczD.cjs');
 require('prompts');
 require('node:child_process');
+require('node:url');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
 
@@ -71,38 +73,21 @@ function mergeConfigs(base, override) {
   };
 }
 
-function createViteProxy(config) {
-  const proxy = {};
-  if (config.proxy && config.host) {
-    proxy[config.proxy] = {
-      target: config.host,
-      changeOrigin: true,
-      rewrite: (path) => path.replace(new RegExp(`^${config.proxy}`), ""),
-      secure: true
-    };
-  }
-  if (config.host) {
-    proxy["/files"] = {
-      target: config.host,
-      changeOrigin: true,
-      secure: true
-    };
-  }
-  return proxy;
+function useWorkspace() {
+  const proxy = undefined.VITE_BGL_PROXY || "/api";
+  const host = undefined.VITE_BGL_HOST || "";
+  const openapiUrl = undefined.VITE_BGL_OPENAPI_URL;
+  const mode = undefined.MODE || "development";
+  return {
+    proxy,
+    host,
+    openapiUrl,
+    mode
+  };
 }
-function createCustomProxy(paths, target, options = {}) {
-  const proxy = {};
-  for (const path of paths) {
-    proxy[path] = {
-      target,
-      changeOrigin: options.changeOrigin ?? true,
-      secure: options.secure ?? true,
-      ...options.rewrite === true && {
-        rewrite: (p) => p.replace(new RegExp(`^${path}`), "")
-      }
-    };
-  }
-  return proxy;
+function getApiUrl() {
+  const { host, proxy } = useWorkspace();
+  return `${host}${proxy}`;
 }
 
 function defineWorkspace(configs) {
@@ -126,7 +111,7 @@ function createWorkspace(options = {}) {
      * Create Vite proxy configuration
      */
     createProxy(config) {
-      return createViteProxy(config);
+      return vite.createViteProxy(config);
     },
     /**
      * Generate Netlify configuration file
@@ -164,9 +149,12 @@ exports.runDev = workspace.runDev;
 exports.setBuildEnvVars = workspace.setBuildEnvVars;
 exports.setupLint = workspace.setupLint;
 exports.writeNetlifyConfig = workspace.writeNetlifyConfig;
-exports.createCustomProxy = createCustomProxy;
-exports.createViteProxy = createViteProxy;
+exports.bagelink = vite.bagelink;
+exports.createCustomProxy = vite.createCustomProxy;
+exports.createViteProxy = vite.createViteProxy;
 exports.createWorkspace = createWorkspace;
 exports.defineWorkspace = defineWorkspace;
+exports.getApiUrl = getApiUrl;
 exports.mergeConfigs = mergeConfigs;
 exports.resolveConfig = resolveConfig;
+exports.useWorkspace = useWorkspace;

package/dist/index.d.cts

@@ -1,45 +1,6 @@
-type WorkspaceEnvironment = 'localhost' | 'development' | 'production';
-interface WorkspaceConfig {
-    /**
-     * The host URL of the backend API server
-     * @example 'http://localhost:8000' | 'https://project.bagel.to'
-     */
-    host: string;
-    /**
-     * The proxy path to use for API requests
-     * @default '/api'
-     */
-    proxy: string;
-    /**
-     * Optional OpenAPI specification URL for SDK generation
-     */
-    openapi_url?: string;
-}
-interface WorkspaceOptions {
-    /**
-     * Root directory of the workspace
-     * @default process.cwd()
-     */
-    root?: string;
-    /**
-     * Path to the config file relative to root
-     * @default 'bgl.config.ts'
-     */
-    configFile?: string;
-    /**
-     * Enable interactive config generation if no config is found
-     * @default true
-     */
-    interactive?: boolean;
-}
-interface ProxyConfig {
-    [path: string]: {
-        target: string;
-        changeOrigin: boolean;
-        rewrite?: (path: string) => string;
-        secure: boolean;
-    };
-}
+import { W as WorkspaceConfig, a as WorkspaceEnvironment, b as WorkspaceOptions, P as ProxyConfig } from './shared/workspace.CSNgk3PR.cjs';
+export { B as BagelinkPluginOptions, c as bagelink } from './shared/workspace.CSNgk3PR.cjs';
+import 'vite';
 
 /**
  * Load and resolve bgl.config.ts with cascading support
@@ -63,16 +24,17 @@ declare function generateWorkspaceConfigSync(projectId: string, root?: string, c
 
 /**
  * Generate netlify.toml redirect configuration
+ * Uses environment variables for flexibility across environments
  */
 declare function generateNetlifyRedirect(config: WorkspaceConfig): string;
 /**
  * Generate complete netlify.toml file
  */
-declare function generateNetlifyConfig(config: WorkspaceConfig, additionalConfig?: string): string;
+declare function generateNetlifyConfig(config: WorkspaceConfig, additionalConfig?: string, useTemplate?: boolean): string;
 /**
  * Write netlify.toml file to disk
  */
-declare function writeNetlifyConfig(config: WorkspaceConfig, outPath?: string, additionalConfig?: string): void;
+declare function writeNetlifyConfig(config: WorkspaceConfig, outPath?: string, additionalConfig?: string, useTemplate?: boolean): void;
 /**
  * Set environment variables for build process
  */
@@ -91,6 +53,54 @@ declare function createCustomProxy(paths: string[], target: string, options?: {
     secure?: boolean;
 }): ProxyConfig;
 
+/**
+ * Runtime workspace configuration
+ * Provides access to workspace config injected at build time
+ */
+interface RuntimeWorkspaceConfig {
+    /** API proxy path (e.g., '/api') */
+    proxy: string;
+    /** API host URL (e.g., 'https://project.bagel.to') */
+    host: string;
+    /** OpenAPI specification URL (if configured) */
+    openapiUrl?: string;
+    /** Current environment mode */
+    mode: 'localhost' | 'development' | 'production';
+}
+/**
+ * Get workspace configuration at runtime
+ * Config is injected as environment variables during build
+ *
+ * @example
+ * ```ts
+ * import { useWorkspace } from '@bagelink/workspace'
+ *
+ * const { proxy, host } = useWorkspace()
+ * const auth = initAuth({ baseURL: proxy })
+ * ```
+ *
+ * @example In Vue component
+ * ```vue
+ * <script setup>
+ * import { useWorkspace } from '@bagelink/workspace'
+ *
+ * const { proxy, host, mode } = useWorkspace()
+ * </script>
+ * ```
+ */
+declare function useWorkspace(): RuntimeWorkspaceConfig;
+/**
+ * Get the full API URL by combining host and proxy
+ *
+ * @example
+ * ```ts
+ * import { getApiUrl } from '@bagelink/workspace'
+ *
+ * const apiUrl = getApiUrl() // 'https://project.bagel.to/api'
+ * ```
+ */
+declare function getApiUrl(): string;
+
 /**
  * Detect if current directory is a workspace root
  */
@@ -165,5 +175,5 @@ declare function createWorkspace(options?: WorkspaceOptions): {
     clearCache(): void;
 };
 
-export { addProject, createCustomProxy, createViteProxy, createWorkspace, defineWorkspace, generateNetlifyConfig, generateNetlifyRedirect, generateSDK, generateSDKForWorkspace, generateWorkspaceConfig, generateWorkspaceConfigSync, getWorkspaceInfo, initWorkspace, isWorkspace, listProjects, mergeConfigs, resolveConfig, runDev, setBuildEnvVars, setupLint, writeNetlifyConfig };
-export type { ProxyConfig, WorkspaceConfig, WorkspaceEnvironment, WorkspaceOptions };
+export { ProxyConfig, WorkspaceConfig, WorkspaceEnvironment, WorkspaceOptions, addProject, createCustomProxy, createViteProxy, createWorkspace, defineWorkspace, generateNetlifyConfig, generateNetlifyRedirect, generateSDK, generateSDKForWorkspace, generateWorkspaceConfig, generateWorkspaceConfigSync, getApiUrl, getWorkspaceInfo, initWorkspace, isWorkspace, listProjects, mergeConfigs, resolveConfig, runDev, setBuildEnvVars, setupLint, useWorkspace, writeNetlifyConfig };
+export type { RuntimeWorkspaceConfig };

package/dist/index.d.mts

@@ -1,45 +1,6 @@
-type WorkspaceEnvironment = 'localhost' | 'development' | 'production';
-interface WorkspaceConfig {
-    /**
-     * The host URL of the backend API server
-     * @example 'http://localhost:8000' | 'https://project.bagel.to'
-     */
-    host: string;
-    /**
-     * The proxy path to use for API requests
-     * @default '/api'
-     */
-    proxy: string;
-    /**
-     * Optional OpenAPI specification URL for SDK generation
-     */
-    openapi_url?: string;
-}
-interface WorkspaceOptions {
-    /**
-     * Root directory of the workspace
-     * @default process.cwd()
-     */
-    root?: string;
-    /**
-     * Path to the config file relative to root
-     * @default 'bgl.config.ts'
-     */
-    configFile?: string;
-    /**
-     * Enable interactive config generation if no config is found
-     * @default true
-     */
-    interactive?: boolean;
-}
-interface ProxyConfig {
-    [path: string]: {
-        target: string;
-        changeOrigin: boolean;
-        rewrite?: (path: string) => string;
-        secure: boolean;
-    };
-}
+import { W as WorkspaceConfig, a as WorkspaceEnvironment, b as WorkspaceOptions, P as ProxyConfig } from './shared/workspace.CSNgk3PR.mjs';
+export { B as BagelinkPluginOptions, c as bagelink } from './shared/workspace.CSNgk3PR.mjs';
+import 'vite';
 
 /**
  * Load and resolve bgl.config.ts with cascading support
@@ -63,16 +24,17 @@ declare function generateWorkspaceConfigSync(projectId: string, root?: string, c
 
 /**
  * Generate netlify.toml redirect configuration
+ * Uses environment variables for flexibility across environments
  */
 declare function generateNetlifyRedirect(config: WorkspaceConfig): string;
 /**
  * Generate complete netlify.toml file
  */
-declare function generateNetlifyConfig(config: WorkspaceConfig, additionalConfig?: string): string;
+declare function generateNetlifyConfig(config: WorkspaceConfig, additionalConfig?: string, useTemplate?: boolean): string;
 /**
  * Write netlify.toml file to disk
  */
-declare function writeNetlifyConfig(config: WorkspaceConfig, outPath?: string, additionalConfig?: string): void;
+declare function writeNetlifyConfig(config: WorkspaceConfig, outPath?: string, additionalConfig?: string, useTemplate?: boolean): void;
 /**
  * Set environment variables for build process
  */
@@ -91,6 +53,54 @@ declare function createCustomProxy(paths: string[], target: string, options?: {
     secure?: boolean;
 }): ProxyConfig;
 
+/**
+ * Runtime workspace configuration
+ * Provides access to workspace config injected at build time
+ */
+interface RuntimeWorkspaceConfig {
+    /** API proxy path (e.g., '/api') */
+    proxy: string;
+    /** API host URL (e.g., 'https://project.bagel.to') */
+    host: string;
+    /** OpenAPI specification URL (if configured) */
+    openapiUrl?: string;
+    /** Current environment mode */
+    mode: 'localhost' | 'development' | 'production';
+}
+/**
+ * Get workspace configuration at runtime
+ * Config is injected as environment variables during build
+ *
+ * @example
+ * ```ts
+ * import { useWorkspace } from '@bagelink/workspace'
+ *
+ * const { proxy, host } = useWorkspace()
+ * const auth = initAuth({ baseURL: proxy })
+ * ```
+ *
+ * @example In Vue component
+ * ```vue
+ * <script setup>
+ * import { useWorkspace } from '@bagelink/workspace'
+ *
+ * const { proxy, host, mode } = useWorkspace()
+ * </script>
+ * ```
+ */
+declare function useWorkspace(): RuntimeWorkspaceConfig;
+/**
+ * Get the full API URL by combining host and proxy
+ *
+ * @example
+ * ```ts
+ * import { getApiUrl } from '@bagelink/workspace'
+ *
+ * const apiUrl = getApiUrl() // 'https://project.bagel.to/api'
+ * ```
+ */
+declare function getApiUrl(): string;
+
 /**
  * Detect if current directory is a workspace root
  */
@@ -165,5 +175,5 @@ declare function createWorkspace(options?: WorkspaceOptions): {
     clearCache(): void;
 };
 
-export { addProject, createCustomProxy, createViteProxy, createWorkspace, defineWorkspace, generateNetlifyConfig, generateNetlifyRedirect, generateSDK, generateSDKForWorkspace, generateWorkspaceConfig, generateWorkspaceConfigSync, getWorkspaceInfo, initWorkspace, isWorkspace, listProjects, mergeConfigs, resolveConfig, runDev, setBuildEnvVars, setupLint, writeNetlifyConfig };
-export type { ProxyConfig, WorkspaceConfig, WorkspaceEnvironment, WorkspaceOptions };
+export { ProxyConfig, WorkspaceConfig, WorkspaceEnvironment, WorkspaceOptions, addProject, createCustomProxy, createViteProxy, createWorkspace, defineWorkspace, generateNetlifyConfig, generateNetlifyRedirect, generateSDK, generateSDKForWorkspace, generateWorkspaceConfig, generateWorkspaceConfigSync, getApiUrl, getWorkspaceInfo, initWorkspace, isWorkspace, listProjects, mergeConfigs, resolveConfig, runDev, setBuildEnvVars, setupLint, useWorkspace, writeNetlifyConfig };
+export type { RuntimeWorkspaceConfig };