@junobuild/config 2.10.1 → 2.11.0

package/dist/types/index.d.ts

@@ -17,6 +17,7 @@ export * from './satellite/configs/satellite.config';
 export * from './satellite/constants/emulator.constants';
 export * from './satellite/juno.config';
 export * from './shared/authentication.config';
+export * from './shared/automation.config';
 export * from './shared/feature.config';
 export * from './shared/storage.config';
 export * from './types/cli.config';

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

@@ -1,6 +1,7 @@
 import { type PrincipalText } from '@dfinity/zod-schemas';
 import * as z from 'zod';
 import { type AuthenticationConfig } from '../../shared/authentication.config';
+import { type AutomationConfig } from '../../shared/automation.config';
 import { type StorageConfig } from '../../shared/storage.config';
 import type { CliConfig } from '../../types/cli.config';
 import { type JunoConfigMode } from '../../types/juno.env';
@@ -112,6 +113,23 @@ export declare const SatelliteConfigOptionsSchema: z.ZodUnion<readonly [z.ZodObj
         }, z.core.$strict>>;
         version: z.ZodOptional<z.ZodBigInt>;
     }, z.core.$strict>>;
+    automation: z.ZodOptional<z.ZodObject<{
+        github: z.ZodOptional<z.ZodObject<{
+            repositories: z.ZodArray<z.ZodObject<{
+                owner: z.ZodString;
+                name: z.ZodString;
+                refs: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            }, z.core.$strict>>;
+            accessKeys: z.ZodOptional<z.ZodObject<{
+                scope: z.ZodOptional<z.ZodEnum<{
+                    Write: "Write";
+                    Submit: "Submit";
+                }>>;
+                timeToLive: z.ZodOptional<z.ZodBigInt>;
+            }, z.core.$strict>>;
+        }, z.core.$strict>>;
+        version: z.ZodOptional<z.ZodBigInt>;
+    }, z.core.$strict>>;
     assertions: z.ZodOptional<z.ZodObject<{
         heapMemory: z.ZodOptional<z.ZodUnion<readonly [z.ZodBigInt, z.ZodBoolean]>>;
     }, z.core.$strict>>;
@@ -235,6 +253,23 @@ export declare const SatelliteConfigOptionsSchema: z.ZodUnion<readonly [z.ZodObj
         }, z.core.$strict>>;
         version: z.ZodOptional<z.ZodBigInt>;
     }, z.core.$strict>>;
+    automation: z.ZodOptional<z.ZodObject<{
+        github: z.ZodOptional<z.ZodObject<{
+            repositories: z.ZodArray<z.ZodObject<{
+                owner: z.ZodString;
+                name: z.ZodString;
+                refs: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            }, z.core.$strict>>;
+            accessKeys: z.ZodOptional<z.ZodObject<{
+                scope: z.ZodOptional<z.ZodEnum<{
+                    Write: "Write";
+                    Submit: "Submit";
+                }>>;
+                timeToLive: z.ZodOptional<z.ZodBigInt>;
+            }, z.core.$strict>>;
+        }, z.core.$strict>>;
+        version: z.ZodOptional<z.ZodBigInt>;
+    }, z.core.$strict>>;
     assertions: z.ZodOptional<z.ZodObject<{
         heapMemory: z.ZodOptional<z.ZodUnion<readonly [z.ZodBigInt, z.ZodBoolean]>>;
     }, z.core.$strict>>;
@@ -304,7 +339,7 @@ export declare const SatelliteConfigOptionsSchema: z.ZodUnion<readonly [z.ZodObj
 /**
  * SatelliteConfigOptions interface provides configuration settings that allow for fine-tuning
  * the operational behavior of various aspects of a Satellite, such as storage, datastore,
- * authentication, and deployment assertions.
+ * authentication, automation, and deployment assertions.
  *
  * These options affect specific modules of the Satellite and may require manual application of
  * changes, typically through CLI commands (e.g., `juno config`).
@@ -314,6 +349,7 @@ export declare const SatelliteConfigOptionsSchema: z.ZodUnion<readonly [z.ZodObj
  * @property {StorageConfig} [storage] - Configuration settings for storage management in the Satellite.
  * @property {DatastoreConfig} [datastore] - Configuration settings for datastore management.
  * @property {AuthenticationConfig} [authentication] - Authentication-specific configurations.
+ * @property {AutomationConfig} [automation] - Automation-specific configurations for CI/CD.
  * @property {SatelliteAssertions} [assertions] - Conditions and assertions for deployment or operational checks.
  * @property {ModuleSettings} [settings] - General settings governing module behavior and resource management.
  */
@@ -339,6 +375,13 @@ export interface SatelliteConfigOptions {
      * @optional
      */
     authentication?: AuthenticationConfig;
+    /**
+     * Optional configuration parameters for the behavior of the automation.
+     * Changes to these parameters must be applied manually afterwards, for example with the CLI using `juno config` commands.
+     * @type {AutomationConfig}
+     * @optional
+     */
+    automation?: AutomationConfig;
     /**
      * Optional configurations to override default assertions made by the CLI regarding satellite deployment conditions.
      * @type {SatelliteAssertions}

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

@@ -65,6 +65,23 @@ export declare const JunoConfigSchema: z.ZodObject<{
             }, z.core.$strict>>;
             version: z.ZodOptional<z.ZodBigInt>;
         }, z.core.$strict>>;
+        automation: z.ZodOptional<z.ZodObject<{
+            github: z.ZodOptional<z.ZodObject<{
+                repositories: z.ZodArray<z.ZodObject<{
+                    owner: z.ZodString;
+                    name: z.ZodString;
+                    refs: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                }, z.core.$strict>>;
+                accessKeys: z.ZodOptional<z.ZodObject<{
+                    scope: z.ZodOptional<z.ZodEnum<{
+                        Write: "Write";
+                        Submit: "Submit";
+                    }>>;
+                    timeToLive: z.ZodOptional<z.ZodBigInt>;
+                }, z.core.$strict>>;
+            }, z.core.$strict>>;
+            version: z.ZodOptional<z.ZodBigInt>;
+        }, z.core.$strict>>;
         assertions: z.ZodOptional<z.ZodObject<{
             heapMemory: z.ZodOptional<z.ZodUnion<readonly [z.ZodBigInt, z.ZodBoolean]>>;
         }, z.core.$strict>>;
@@ -188,6 +205,23 @@ export declare const JunoConfigSchema: z.ZodObject<{
             }, z.core.$strict>>;
             version: z.ZodOptional<z.ZodBigInt>;
         }, z.core.$strict>>;
+        automation: z.ZodOptional<z.ZodObject<{
+            github: z.ZodOptional<z.ZodObject<{
+                repositories: z.ZodArray<z.ZodObject<{
+                    owner: z.ZodString;
+                    name: z.ZodString;
+                    refs: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                }, z.core.$strict>>;
+                accessKeys: z.ZodOptional<z.ZodObject<{
+                    scope: z.ZodOptional<z.ZodEnum<{
+                        Write: "Write";
+                        Submit: "Submit";
+                    }>>;
+                    timeToLive: z.ZodOptional<z.ZodBigInt>;
+                }, z.core.$strict>>;
+            }, z.core.$strict>>;
+            version: z.ZodOptional<z.ZodBigInt>;
+        }, z.core.$strict>>;
         assertions: z.ZodOptional<z.ZodObject<{
             heapMemory: z.ZodOptional<z.ZodUnion<readonly [z.ZodBigInt, z.ZodBoolean]>>;
         }, z.core.$strict>>;

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

@@ -0,0 +1,162 @@
+import * as z from 'zod';
+/**
+ * @see AutomationScope
+ */
+export declare const AutomationScopeSchema: z.ZodEnum<{
+    Write: "Write";
+    Submit: "Submit";
+}>;
+/**
+ * Defines the scope of permissions for automation access keys (editor or submitter).
+ * @type AutomationScope
+ */
+export type AutomationScope = z.infer<typeof AutomationScopeSchema>;
+/**
+ * @see AutomationAccessKeysConfig
+ */
+export declare const AutomationAccessKeysConfigSchema: z.ZodObject<{
+    scope: z.ZodOptional<z.ZodEnum<{
+        Write: "Write";
+        Submit: "Submit";
+    }>>;
+    timeToLive: z.ZodOptional<z.ZodBigInt>;
+}, z.core.$strict>;
+/**
+ * Configure the controller behavior for automation.
+ *
+ * @interface AutomationAccessKeysConfig
+ */
+export interface AutomationAccessKeysConfig {
+    /**
+     * The scope of permissions granted to the automation access keys.
+     *
+     * If omitted, defaults to `Write`.
+     */
+    scope?: AutomationScope;
+    /**
+     * Duration for which an automation access key remains valid, expressed in nanoseconds.
+     *
+     * Defaults to 10 minutes. Cannot exceed 1 hour.
+     */
+    timeToLive?: bigint;
+}
+/**
+ * @see AutomationConfigRepository
+ */
+export declare const AutomationConfigRepositorySchema: z.ZodObject<{
+    owner: z.ZodString;
+    name: z.ZodString;
+    refs: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strict>;
+/**
+ * Configure repository access for automation.
+ *
+ * @interface AutomationConfigRepository
+ */
+export interface AutomationConfigRepository {
+    /**
+     * Repository owner (e.g. "octo-org" or "peterpeterparker" for GitHub).
+     *
+     * @type {string}
+     */
+    owner: string;
+    /**
+     * Repository name (e.g, "octo-repo" or "daviddalbusco.com" for GitHub).
+     *
+     * @type {string}
+     */
+    name: string;
+    /**
+     * Optional list of allowed refs (e.g., ["refs/heads/main", "refs/pull/74/merge"]).
+     *
+     * If omitted, all refs are allowed.
+     *
+     * @type {string[]}
+     * @optional
+     */
+    refs?: string[];
+}
+/**
+ * @see AutomationConfigGitHub
+ */
+export declare const AutomationConfigGitHubSchema: z.ZodObject<{
+    repositories: z.ZodArray<z.ZodObject<{
+        owner: z.ZodString;
+        name: z.ZodString;
+        refs: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>>;
+    accessKeys: z.ZodOptional<z.ZodObject<{
+        scope: z.ZodOptional<z.ZodEnum<{
+            Write: "Write";
+            Submit: "Submit";
+        }>>;
+        timeToLive: z.ZodOptional<z.ZodBigInt>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+/**
+ * Configure automation via GitHub Actions.
+ *
+ * @interface AutomationConfigGitHub
+ */
+export interface AutomationConfigGitHub {
+    /**
+     * List of GitHub repositories authorized to authenticate with this Satellite.
+     *
+     * Each repository must specify owner and name.
+     * Optionally restrict to specific refs.
+     *
+     * @type {AutomationConfigRepository[]}
+     */
+    repositories: AutomationConfigRepository[];
+    /**
+     * Optional configuration for the access keys generated by the automation.
+     * If omitted, default behavior applies.
+     *
+     * @type {AutomationAccessKeysConfig}
+     * @optional
+     */
+    accessKeys?: AutomationAccessKeysConfig;
+}
+/**
+ * @see AutomationConfig
+ */
+export declare const AutomationConfigSchema: z.ZodObject<{
+    github: z.ZodOptional<z.ZodObject<{
+        repositories: z.ZodArray<z.ZodObject<{
+            owner: z.ZodString;
+            name: z.ZodString;
+            refs: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        }, z.core.$strict>>;
+        accessKeys: z.ZodOptional<z.ZodObject<{
+            scope: z.ZodOptional<z.ZodEnum<{
+                Write: "Write";
+                Submit: "Submit";
+            }>>;
+            timeToLive: z.ZodOptional<z.ZodBigInt>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    version: z.ZodOptional<z.ZodBigInt>;
+}, z.core.$strict>;
+/**
+ * Configures the Automation options of a Satellite.
+ * @interface AutomationConfig
+ */
+export interface AutomationConfig {
+    /**
+     * Optional configuration for enabling automation through GitHub Actions.
+     *
+     * @type {AutomationConfigGitHub}
+     * @optional
+     */
+    github?: AutomationConfigGitHub;
+    /**
+     * The current version of the config.
+     *
+     * Optional. The CLI will automatically resolve the version and warn you if there's a potential overwrite.
+     * You can provide it if you want to manage versioning manually within your config file.
+     *
+     * @type {bigint}
+     * @optional
+     */
+    version?: bigint;
+}

package/package.json

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