@auth-gate/core 0.10.0 → 0.11.0

package/dist/index.d.cts

@@ -690,6 +690,10 @@ declare class ConfigurationError extends AuthGateError {
 
 /**
  * Connection details for the AuthGate API.
+ *
+ * Both fields are optional at the type level because they can be provided
+ * via environment variables (`AUTHGATE_URL`, `AUTHGATE_API_KEY`). The CLI
+ * auto-loads `.env` and `.env.local` before importing the config file.
  */
 type AuthGateConnection = {
     baseUrl?: string;
@@ -697,13 +701,57 @@ type AuthGateConnection = {
 };
 /**
  * Project-level config shape for `authgate.config.ts`.
- * Used by both `@auth-gate/rbac` and `@auth-gate/billing` CLIs.
+ *
+ * Used by both the `@auth-gate/rbac` and `@auth-gate/billing` CLIs to
+ * connect to the AuthGate API when syncing roles, permissions, plans, and
+ * features. The config file is auto-discovered in the project root.
  *
  * The CLI auto-loads `.env` and `.env.local` before importing this file,
- * so you can reference `process.env` or use a typed env module directly.
+ * so you can reference `process.env` directly.
+ */
+interface AuthGateProjectConfig {
+    /**
+     * Connection details for the AuthGate API.
+     *
+     * If omitted, the CLI falls back to `AUTHGATE_URL` and `AUTHGATE_API_KEY`
+     * environment variables.
+     */
+    connection?: AuthGateConnection;
+    /**
+     * Path to the RBAC config file (`authgate.rbac.ts`).
+     *
+     * Overrides auto-discovery. Useful in monorepos where the RBAC config
+     * lives in a different directory than the project root.
+     *
+     * @example `"./packages/api/authgate.rbac.ts"`
+     */
+    rbacConfig?: string;
+    /**
+     * Path to the Billing config file (`authgate.billing.ts`).
+     *
+     * Overrides auto-discovery. Useful in monorepos where the billing config
+     * lives in a different directory than the project root.
+     *
+     * @example `"./packages/api/authgate.billing.ts"`
+     */
+    billingConfig?: string;
+}
+/**
+ * Define your project-level AuthGate configuration.
  *
- * @example
+ * Create an `authgate.config.ts` file in your project root and export
+ * the result of this function as the default export. This gives you
+ * type safety and IDE autocomplete for the config.
+ *
+ * The CLI auto-loads `.env` and `.env.local` before importing the
+ * config, so `process.env` values are available.
+ *
+ * @param config - The project configuration object.
+ * @returns The same config object (identity function for type inference).
+ *
+ * @example Minimal setup (env vars provide connection details)
  * ```ts
+ * // authgate.config.ts
  * import { defineConfig } from "@auth-gate/core";
  *
  * export default defineConfig({
@@ -713,20 +761,33 @@ type AuthGateConnection = {
  *   },
  * });
  * ```
- */
-interface AuthGateProjectConfig {
-    /** Connection details for the AuthGate API. */
-    connection?: AuthGateConnection;
-    /** Path to the RBAC config file (overrides auto-discovery). */
-    rbacConfig?: string;
-    /** Path to the Billing config file (overrides auto-discovery). */
-    billingConfig?: string;
-}
-/**
- * Define your project-level AuthGate config. Use this in `authgate.config.ts`.
  *
- * Provides type safety and IDE autocomplete for the config file.
- * This is an identity function — it returns the config as-is.
+ * @example Monorepo with custom config paths
+ * ```ts
+ * // authgate.config.ts
+ * import { defineConfig } from "@auth-gate/core";
+ *
+ * export default defineConfig({
+ *   connection: {
+ *     baseUrl: process.env.AUTHGATE_URL,
+ *     apiKey: process.env.AUTHGATE_API_KEY,
+ *   },
+ *   rbacConfig: "./packages/api/authgate.rbac.ts",
+ *   billingConfig: "./packages/api/authgate.billing.ts",
+ * });
+ * ```
+ *
+ * @example Then sync with the CLI
+ * ```sh
+ * # Scaffold the config file
+ * npx @auth-gate/rbac init --config
+ *
+ * # Sync RBAC roles & permissions
+ * npx @auth-gate/rbac sync --apply
+ *
+ * # Sync billing plans & features
+ * npx @auth-gate/billing sync --apply
+ * ```
  */
 declare function defineConfig(config: AuthGateProjectConfig): AuthGateProjectConfig;
 

package/dist/index.d.ts

@@ -690,6 +690,10 @@ declare class ConfigurationError extends AuthGateError {
 
 /**
  * Connection details for the AuthGate API.
+ *
+ * Both fields are optional at the type level because they can be provided
+ * via environment variables (`AUTHGATE_URL`, `AUTHGATE_API_KEY`). The CLI
+ * auto-loads `.env` and `.env.local` before importing the config file.
  */
 type AuthGateConnection = {
     baseUrl?: string;
@@ -697,13 +701,57 @@ type AuthGateConnection = {
 };
 /**
  * Project-level config shape for `authgate.config.ts`.
- * Used by both `@auth-gate/rbac` and `@auth-gate/billing` CLIs.
+ *
+ * Used by both the `@auth-gate/rbac` and `@auth-gate/billing` CLIs to
+ * connect to the AuthGate API when syncing roles, permissions, plans, and
+ * features. The config file is auto-discovered in the project root.
  *
  * The CLI auto-loads `.env` and `.env.local` before importing this file,
- * so you can reference `process.env` or use a typed env module directly.
+ * so you can reference `process.env` directly.
+ */
+interface AuthGateProjectConfig {
+    /**
+     * Connection details for the AuthGate API.
+     *
+     * If omitted, the CLI falls back to `AUTHGATE_URL` and `AUTHGATE_API_KEY`
+     * environment variables.
+     */
+    connection?: AuthGateConnection;
+    /**
+     * Path to the RBAC config file (`authgate.rbac.ts`).
+     *
+     * Overrides auto-discovery. Useful in monorepos where the RBAC config
+     * lives in a different directory than the project root.
+     *
+     * @example `"./packages/api/authgate.rbac.ts"`
+     */
+    rbacConfig?: string;
+    /**
+     * Path to the Billing config file (`authgate.billing.ts`).
+     *
+     * Overrides auto-discovery. Useful in monorepos where the billing config
+     * lives in a different directory than the project root.
+     *
+     * @example `"./packages/api/authgate.billing.ts"`
+     */
+    billingConfig?: string;
+}
+/**
+ * Define your project-level AuthGate configuration.
  *
- * @example
+ * Create an `authgate.config.ts` file in your project root and export
+ * the result of this function as the default export. This gives you
+ * type safety and IDE autocomplete for the config.
+ *
+ * The CLI auto-loads `.env` and `.env.local` before importing the
+ * config, so `process.env` values are available.
+ *
+ * @param config - The project configuration object.
+ * @returns The same config object (identity function for type inference).
+ *
+ * @example Minimal setup (env vars provide connection details)
  * ```ts
+ * // authgate.config.ts
  * import { defineConfig } from "@auth-gate/core";
  *
  * export default defineConfig({
@@ -713,20 +761,33 @@ type AuthGateConnection = {
  *   },
  * });
  * ```
- */
-interface AuthGateProjectConfig {
-    /** Connection details for the AuthGate API. */
-    connection?: AuthGateConnection;
-    /** Path to the RBAC config file (overrides auto-discovery). */
-    rbacConfig?: string;
-    /** Path to the Billing config file (overrides auto-discovery). */
-    billingConfig?: string;
-}
-/**
- * Define your project-level AuthGate config. Use this in `authgate.config.ts`.
  *
- * Provides type safety and IDE autocomplete for the config file.
- * This is an identity function — it returns the config as-is.
+ * @example Monorepo with custom config paths
+ * ```ts
+ * // authgate.config.ts
+ * import { defineConfig } from "@auth-gate/core";
+ *
+ * export default defineConfig({
+ *   connection: {
+ *     baseUrl: process.env.AUTHGATE_URL,
+ *     apiKey: process.env.AUTHGATE_API_KEY,
+ *   },
+ *   rbacConfig: "./packages/api/authgate.rbac.ts",
+ *   billingConfig: "./packages/api/authgate.billing.ts",
+ * });
+ * ```
+ *
+ * @example Then sync with the CLI
+ * ```sh
+ * # Scaffold the config file
+ * npx @auth-gate/rbac init --config
+ *
+ * # Sync RBAC roles & permissions
+ * npx @auth-gate/rbac sync --apply
+ *
+ * # Sync billing plans & features
+ * npx @auth-gate/billing sync --apply
+ * ```
  */
 declare function defineConfig(config: AuthGateProjectConfig): AuthGateProjectConfig;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@auth-gate/core",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "type": "module",
   "exports": {
     ".": {