@junobuild/config 2.9.0 → 2.10.0

package/dist/types/console/console.config.d.ts

@@ -1,5 +1,6 @@
 import { type PrincipalText } from '@dfinity/zod-schemas';
 import * as z from 'zod';
+import { type ApiConfig } from '../shared/api.config';
 import { type AuthenticationConfig } from '../shared/authentication.config';
 import { type StorageConfig } from '../shared/storage.config';
 import { type CliConfig } from '../types/cli.config';
@@ -83,11 +84,21 @@ export declare const JunoConsoleConfigSchema: z.ZodUnion<readonly [z.ZodObject<{
                 sessionDuration: z.ZodOptional<z.ZodBigInt>;
             }, z.core.$strict>>;
         }, z.core.$strict>>;
+        github: z.ZodOptional<z.ZodObject<{
+            clientId: z.ZodString;
+            delegation: z.ZodOptional<z.ZodObject<{
+                allowedTargets: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+                sessionDuration: z.ZodOptional<z.ZodBigInt>;
+            }, z.core.$strict>>;
+        }, z.core.$strict>>;
         rules: z.ZodOptional<z.ZodObject<{
             allowedCallers: z.ZodArray<z.ZodString>;
         }, z.core.$strict>>;
         version: z.ZodOptional<z.ZodBigInt>;
     }, z.core.$strict>>;
+    api: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+    }, z.core.$strict>>;
     source: z.ZodOptional<z.ZodString>;
     ignore: z.ZodOptional<z.ZodArray<z.ZodString>>;
     precompress: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
@@ -160,11 +171,21 @@ export declare const JunoConsoleConfigSchema: z.ZodUnion<readonly [z.ZodObject<{
                 sessionDuration: z.ZodOptional<z.ZodBigInt>;
             }, z.core.$strict>>;
         }, z.core.$strict>>;
+        github: z.ZodOptional<z.ZodObject<{
+            clientId: z.ZodString;
+            delegation: z.ZodOptional<z.ZodObject<{
+                allowedTargets: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+                sessionDuration: z.ZodOptional<z.ZodBigInt>;
+            }, z.core.$strict>>;
+        }, z.core.$strict>>;
         rules: z.ZodOptional<z.ZodObject<{
             allowedCallers: z.ZodArray<z.ZodString>;
         }, z.core.$strict>>;
         version: z.ZodOptional<z.ZodBigInt>;
     }, z.core.$strict>>;
+    api: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+    }, z.core.$strict>>;
     source: z.ZodOptional<z.ZodString>;
     ignore: z.ZodOptional<z.ZodArray<z.ZodString>>;
     precompress: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
@@ -216,4 +237,10 @@ export type JunoConsoleConfig = Either<ConsoleId, ConsoleIds> & CliConfig & {
      * @optional
      */
     authentication?: AuthenticationConfig;
+    /**
+     * Optional configuration for the Juno API.
+     * @type {ApiConfig}
+     * @optional
+     */
+    api?: ApiConfig;
 };

package/dist/types/satellite/configs/satellite.config.d.ts

@@ -100,6 +100,13 @@ export declare const SatelliteConfigOptionsSchema: z.ZodUnion<readonly [z.ZodObj
                 sessionDuration: z.ZodOptional<z.ZodBigInt>;
             }, z.core.$strict>>;
         }, z.core.$strict>>;
+        github: z.ZodOptional<z.ZodObject<{
+            clientId: z.ZodString;
+            delegation: z.ZodOptional<z.ZodObject<{
+                allowedTargets: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+                sessionDuration: z.ZodOptional<z.ZodBigInt>;
+            }, z.core.$strict>>;
+        }, z.core.$strict>>;
         rules: z.ZodOptional<z.ZodObject<{
             allowedCallers: z.ZodArray<z.ZodString>;
         }, z.core.$strict>>;
@@ -216,6 +223,13 @@ export declare const SatelliteConfigOptionsSchema: z.ZodUnion<readonly [z.ZodObj
                 sessionDuration: z.ZodOptional<z.ZodBigInt>;
             }, z.core.$strict>>;
         }, z.core.$strict>>;
+        github: z.ZodOptional<z.ZodObject<{
+            clientId: z.ZodString;
+            delegation: z.ZodOptional<z.ZodObject<{
+                allowedTargets: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+                sessionDuration: z.ZodOptional<z.ZodBigInt>;
+            }, z.core.$strict>>;
+        }, z.core.$strict>>;
         rules: z.ZodOptional<z.ZodObject<{
             allowedCallers: z.ZodArray<z.ZodString>;
         }, z.core.$strict>>;

package/dist/types/satellite/juno.config.d.ts

@@ -1,4 +1,5 @@
 import * as z from 'zod';
+import { type ApiConfig } from '../shared/api.config';
 import { type EmulatorConfig } from './configs/emulator.config';
 import { type OrbiterConfig } from './configs/orbiter.config';
 import { type SatelliteConfig } from './configs/satellite.config';
@@ -52,6 +53,13 @@ export declare const JunoConfigSchema: z.ZodObject<{
                     sessionDuration: z.ZodOptional<z.ZodBigInt>;
                 }, z.core.$strict>>;
             }, z.core.$strict>>;
+            github: z.ZodOptional<z.ZodObject<{
+                clientId: z.ZodString;
+                delegation: z.ZodOptional<z.ZodObject<{
+                    allowedTargets: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+                    sessionDuration: z.ZodOptional<z.ZodBigInt>;
+                }, z.core.$strict>>;
+            }, z.core.$strict>>;
             rules: z.ZodOptional<z.ZodObject<{
                 allowedCallers: z.ZodArray<z.ZodString>;
             }, z.core.$strict>>;
@@ -168,6 +176,13 @@ export declare const JunoConfigSchema: z.ZodObject<{
                     sessionDuration: z.ZodOptional<z.ZodBigInt>;
                 }, z.core.$strict>>;
             }, z.core.$strict>>;
+            github: z.ZodOptional<z.ZodObject<{
+                clientId: z.ZodString;
+                delegation: z.ZodOptional<z.ZodObject<{
+                    allowedTargets: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+                    sessionDuration: z.ZodOptional<z.ZodBigInt>;
+                }, z.core.$strict>>;
+            }, z.core.$strict>>;
             rules: z.ZodOptional<z.ZodObject<{
                 allowedCallers: z.ZodArray<z.ZodString>;
             }, z.core.$strict>>;
@@ -348,6 +363,9 @@ export declare const JunoConfigSchema: z.ZodObject<{
             }, z.core.$strict>>;
         }, z.core.$strict>;
     }, z.core.$strict>]>>;
+    api: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+    }, z.core.$strict>>;
 }, z.core.$strict>;
 /**
  * Represents the overall configuration for Juno.
@@ -369,4 +387,10 @@ export interface JunoConfig {
      * Your options for the emulator.
      */
     emulator?: EmulatorConfig;
+    /**
+     * Optional configuration for the Juno API.
+     * @type {ApiConfig}
+     * @optional
+     */
+    api?: ApiConfig;
 }

package/dist/types/shared/api.config.d.ts

@@ -0,0 +1,19 @@
+import * as z from 'zod';
+/**
+ * @see ApiConfig
+ */
+export declare const ApiConfigSchema: z.ZodObject<{
+    url: z.ZodURL;
+}, z.core.$strict>;
+/**
+ * Configuration for the Juno API endpoints. Useful for local development or self-hosting.
+ * @interface ApiConfig
+ */
+export interface ApiConfig {
+    /**
+     * The base URL for the Juno API.
+     * @default https://api.juno.build
+     * @type {string}
+     */
+    url: string;
+}

package/dist/types/shared/authentication.config.d.ts

@@ -91,6 +91,37 @@ export interface AuthenticationConfigGoogle {
      */
     delegation?: AuthenticationConfigDelegation;
 }
+/**
+ * @see AuthenticationConfigGitHub
+ */
+export declare const AuthenticationConfigGitHubSchema: z.ZodObject<{
+    clientId: z.ZodString;
+    delegation: z.ZodOptional<z.ZodObject<{
+        allowedTargets: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        sessionDuration: z.ZodOptional<z.ZodBigInt>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+/**
+ * Configure the sign-in with GitHub.
+ *
+ * @interface AuthenticationConfigGitHub
+ */
+export interface AuthenticationConfigGitHub {
+    /**
+     * The OAuth client ID from your
+     * [GitHub OAuth apps](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps).
+     *
+     * Example: `"Ov99aa88ijrrJJfwXsqW"`
+     *
+     * @type {string}
+     */
+    clientId: string;
+    /**
+     * Optional delegation settings for authentication.
+     * If omitted, the default delegation behavior applies.
+     */
+    delegation?: AuthenticationConfigDelegation;
+}
 /**
  * @see AuthenticationConfigRules
  */
@@ -127,6 +158,13 @@ export declare const AuthenticationConfigSchema: z.ZodObject<{
             sessionDuration: z.ZodOptional<z.ZodBigInt>;
         }, z.core.$strict>>;
     }, z.core.$strict>>;
+    github: z.ZodOptional<z.ZodObject<{
+        clientId: z.ZodString;
+        delegation: z.ZodOptional<z.ZodObject<{
+            allowedTargets: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+            sessionDuration: z.ZodOptional<z.ZodBigInt>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
     rules: z.ZodOptional<z.ZodObject<{
         allowedCallers: z.ZodArray<z.ZodString>;
     }, z.core.$strict>>;
@@ -149,6 +187,12 @@ export interface AuthenticationConfig {
      * @optional
      */
     google?: AuthenticationConfigGoogle;
+    /**
+     * Optional configuration for enabling GitHub authentication method.
+     * @type {AuthenticationConfigGitHub}
+     * @optional
+     */
+    github?: AuthenticationConfigGitHub;
     /**
      * Optional configuration for the rules of the authentication.
      * @type {AuthenticationConfigRules}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@junobuild/config",
-  "version": "2.9.0",
+  "version": "2.10.0",
   "description": "Configuration options for Juno CLI",
   "author": "David Dal Busco (https://daviddalbusco.com)",
   "license": "MIT",