@gigadrive/network-config 2.0.3 → 2.1.0

package/dist/index.d.mts

@@ -14,6 +14,13 @@ declare const RUNTIME_DEFINITIONS: readonly ["php-84", "php-83", "php-81", "node
 type Runtime = (typeof RUNTIME_DEFINITIONS)[number];
 declare const AVAILABLE_RUNTIMES: Runtime[];
 
+/**
+ * A map of file paths to their corresponding paths in the deployment.
+ *
+ * Left side should be an absolute path on the file system.
+ * Right side should be a relative path in the deployment package.
+ */
+type FilePathMap = Record<string, string>;
 /**
  * The object structure that all config versions will be parsed into.
  * This is done to provide a consistent interface for the rest of the codebase and easily provision the necessary resources, regardless of the config version.
@@ -59,6 +66,20 @@ interface NormalizedConfig {
     entrypoints: Array<NormalizedConfigEntrypoint>;
     routes: Array<NormalizedConfigRoute>;
     services?: Array<NormalizedConfigService>;
+    /**
+     * Settings related to the archive the user uploads to the build workers.
+     */
+    userArchive?: {
+        /**
+         * Overwrite the root of the user-uploaded package. This is mostly used for monorepos to make sure all relevant files are included.
+         */
+        rootOverwrite?: string;
+        /**
+         * Use a whitelist to only include relevant files in monorepos. May be a glob pattern.
+         * @see getFilesForPattern
+         */
+        fileWhitelist?: string[];
+    };
     /**
      * Warning codes to be printed to the output during deployment.
      */
@@ -97,7 +118,7 @@ interface NormalizedConfigEntrypoint {
     streaming?: boolean;
     package?: {
         rootOverwrite?: string;
-        filePathMap?: Record<string, string>;
+        filePathMap?: FilePathMap;
     };
 }
 interface NormalizedConfigRoute {
@@ -140,6 +161,8 @@ type NormalizedConfigRouteMatchRequirements = [] | [
 
 declare const parseConfig: (filePath: string, projectFolder: string) => Promise<NormalizedConfig>;
 
-declare const parseRawConfig: (filePath: string) => Promise<any>;
+declare const parseRawConfig: (filePath: string, { disableVersionCheck }?: {
+    disableVersionCheck?: boolean;
+}) => Promise<any>;
 
-export { ALLOWED_CONFIG_NAMES, AVAILABLE_REGIONS, AVAILABLE_RUNTIMES, type NeonAWSRegion, type NormalizedConfig, type NormalizedConfigEntrypoint, type NormalizedConfigRoute, type NormalizedConfigRouteHandler, type NormalizedConfigRouteMatchRequirements, type NormalizedConfigRouteMethod, type NormalizedConfigService, type NormalizedConfigServicePostgres, type NormalizedConfigServiceRedis, type NormalizedConfigServiceType, type Region, type Runtime, type UpstashAWSRegion, findConfig, parseConfig, parseRawConfig };
+export { ALLOWED_CONFIG_NAMES, AVAILABLE_REGIONS, AVAILABLE_RUNTIMES, type FilePathMap, type NeonAWSRegion, type NormalizedConfig, type NormalizedConfigEntrypoint, type NormalizedConfigRoute, type NormalizedConfigRouteHandler, type NormalizedConfigRouteMatchRequirements, type NormalizedConfigRouteMethod, type NormalizedConfigService, type NormalizedConfigServicePostgres, type NormalizedConfigServiceRedis, type NormalizedConfigServiceType, type Region, type Runtime, type UpstashAWSRegion, findConfig, parseConfig, parseRawConfig };

package/dist/index.d.ts

@@ -14,6 +14,13 @@ declare const RUNTIME_DEFINITIONS: readonly ["php-84", "php-83", "php-81", "node
 type Runtime = (typeof RUNTIME_DEFINITIONS)[number];
 declare const AVAILABLE_RUNTIMES: Runtime[];
 
+/**
+ * A map of file paths to their corresponding paths in the deployment.
+ *
+ * Left side should be an absolute path on the file system.
+ * Right side should be a relative path in the deployment package.
+ */
+type FilePathMap = Record<string, string>;
 /**
  * The object structure that all config versions will be parsed into.
  * This is done to provide a consistent interface for the rest of the codebase and easily provision the necessary resources, regardless of the config version.
@@ -59,6 +66,20 @@ interface NormalizedConfig {
     entrypoints: Array<NormalizedConfigEntrypoint>;
     routes: Array<NormalizedConfigRoute>;
     services?: Array<NormalizedConfigService>;
+    /**
+     * Settings related to the archive the user uploads to the build workers.
+     */
+    userArchive?: {
+        /**
+         * Overwrite the root of the user-uploaded package. This is mostly used for monorepos to make sure all relevant files are included.
+         */
+        rootOverwrite?: string;
+        /**
+         * Use a whitelist to only include relevant files in monorepos. May be a glob pattern.
+         * @see getFilesForPattern
+         */
+        fileWhitelist?: string[];
+    };
     /**
      * Warning codes to be printed to the output during deployment.
      */
@@ -97,7 +118,7 @@ interface NormalizedConfigEntrypoint {
     streaming?: boolean;
     package?: {
         rootOverwrite?: string;
-        filePathMap?: Record<string, string>;
+        filePathMap?: FilePathMap;
     };
 }
 interface NormalizedConfigRoute {
@@ -140,6 +161,8 @@ type NormalizedConfigRouteMatchRequirements = [] | [
 
 declare const parseConfig: (filePath: string, projectFolder: string) => Promise<NormalizedConfig>;
 
-declare const parseRawConfig: (filePath: string) => Promise<any>;
+declare const parseRawConfig: (filePath: string, { disableVersionCheck }?: {
+    disableVersionCheck?: boolean;
+}) => Promise<any>;
 
-export { ALLOWED_CONFIG_NAMES, AVAILABLE_REGIONS, AVAILABLE_RUNTIMES, type NeonAWSRegion, type NormalizedConfig, type NormalizedConfigEntrypoint, type NormalizedConfigRoute, type NormalizedConfigRouteHandler, type NormalizedConfigRouteMatchRequirements, type NormalizedConfigRouteMethod, type NormalizedConfigService, type NormalizedConfigServicePostgres, type NormalizedConfigServiceRedis, type NormalizedConfigServiceType, type Region, type Runtime, type UpstashAWSRegion, findConfig, parseConfig, parseRawConfig };
+export { ALLOWED_CONFIG_NAMES, AVAILABLE_REGIONS, AVAILABLE_RUNTIMES, type FilePathMap, type NeonAWSRegion, type NormalizedConfig, type NormalizedConfigEntrypoint, type NormalizedConfigRoute, type NormalizedConfigRouteHandler, type NormalizedConfigRouteMatchRequirements, type NormalizedConfigRouteMethod, type NormalizedConfigService, type NormalizedConfigServicePostgres, type NormalizedConfigServiceRedis, type NormalizedConfigServiceType, type Region, type Runtime, type UpstashAWSRegion, findConfig, parseConfig, parseRawConfig };