@netlify/zip-it-and-ship-it 9.35.1 → 9.37.0

package/dist/main.d.ts

@@ -5,6 +5,8 @@ import { RuntimeName } from './runtimes/runtime.js';
 export { Config, FunctionConfig } from './config.js';
 export { zipFunction, zipFunctions, ZipFunctionOptions, ZipFunctionsOptions } from './zip.js';
 export { ArchiveFormat, ARCHIVE_FORMAT } from './archive.js';
+export type { TrafficRules } from './rate_limit.js';
+export type { ExtendedRoute, Route } from './utils/routes.js';
 export { NodeBundlerName, NODE_BUNDLER } from './runtimes/node/bundlers/types.js';
 export { RuntimeName, RUNTIME } from './runtimes/runtime.js';
 export { ModuleFormat, MODULE_FORMAT } from './runtimes/node/utils/module_format.js';

package/dist/manifest.d.ts

@@ -1,14 +1,15 @@
 import type { InvocationMode } from './function.js';
 import type { TrafficRules } from './rate_limit.js';
 import type { FunctionResult } from './utils/format_result.js';
-import type { Route } from './utils/routes.js';
+import type { ExtendedRoute, Route } from './utils/routes.js';
 interface ManifestFunction {
     buildData?: Record<string, unknown>;
     invocationMode?: InvocationMode;
     mainFile: string;
     name: string;
     path: string;
-    routes?: Route[];
+    routes?: ExtendedRoute[];
+    excludedRoutes?: Route[];
     runtime: string;
     runtimeVersion?: string;
     schedule?: string;

package/dist/runtimes/node/in_source_config/index.d.ts

@@ -2,19 +2,24 @@ import type { ArgumentPlaceholder, Expression, SpreadElement, JSXNamespacedName
 import { z } from 'zod';
 import { FunctionConfig } from '../../../config.js';
 import { InvocationMode } from '../../../function.js';
-import { Route } from '../../../utils/routes.js';
+import { ExtendedRoute, Route } from '../../../utils/routes.js';
 import type { ModuleFormat } from '../utils/module_format.js';
 export declare const IN_SOURCE_CONFIG_MODULE = "@netlify/functions";
 export interface StaticAnalysisResult {
     config: InSourceConfig;
+    excludedRoutes?: Route[];
     inputModuleFormat?: ModuleFormat;
     invocationMode?: InvocationMode;
-    routes?: Route[];
+    routes?: ExtendedRoute[];
     runtimeAPIVersion?: number;
 }
 interface FindISCDeclarationsOptions {
     functionName: string;
 }
+declare const httpMethod: z.ZodEnum<["GET", "POST", "PUT", "PATCH", "OPTIONS", "DELETE", "HEAD"]>;
+declare const httpMethods: z.ZodEffects<z.ZodEnum<["GET", "POST", "PUT", "PATCH", "OPTIONS", "DELETE", "HEAD"]>, "GET" | "POST" | "PUT" | "PATCH" | "OPTIONS" | "DELETE" | "HEAD", unknown>;
+export type HttpMethod = z.infer<typeof httpMethod>;
+export type HttpMethods = z.infer<typeof httpMethods>;
 export declare const inSourceConfig: z.ZodObject<z.objectUtil.extendShape<Pick<{
     externalNodeModules: z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
     generator: z.ZodCatch<z.ZodOptional<z.ZodString>>;
@@ -40,8 +45,9 @@ export declare const inSourceConfig: z.ZodObject<z.objectUtil.extendShape<Pick<{
         readonly ESM: "esm";
     }>>>;
 }, "name" | "externalNodeModules" | "generator" | "includedFiles" | "ignoredNodeModules" | "nodeBundler" | "nodeVersion" | "schedule" | "timeout">, {
-    method: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodEffects<z.ZodEnum<["GET", "POST", "PUT", "PATCH", "OPTIONS", "DELETE", "HEAD"]>, "GET" | "POST" | "PUT" | "PATCH" | "OPTIONS" | "DELETE" | "HEAD", unknown>, z.ZodArray<z.ZodEffects<z.ZodEnum<["GET", "POST", "PUT", "PATCH", "OPTIONS", "DELETE", "HEAD"]>, "GET" | "POST" | "PUT" | "PATCH" | "OPTIONS" | "DELETE" | "HEAD", unknown>, "many">]>, any[], unknown>>;
-    path: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>, any[], string | string[]>>;
+    method: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodEffects<z.ZodEnum<["GET", "POST", "PUT", "PATCH", "OPTIONS", "DELETE", "HEAD"]>, "GET" | "POST" | "PUT" | "PATCH" | "OPTIONS" | "DELETE" | "HEAD", unknown>, z.ZodArray<z.ZodEffects<z.ZodEnum<["GET", "POST", "PUT", "PATCH", "OPTIONS", "DELETE", "HEAD"]>, "GET" | "POST" | "PUT" | "PATCH" | "OPTIONS" | "DELETE" | "HEAD", unknown>, "many">]>, ("GET" | "POST" | "PUT" | "PATCH" | "OPTIONS" | "DELETE" | "HEAD")[], unknown>>;
+    path: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>, string[], string | string[]>>;
+    excludedPath: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>, string[], string | string[]>>;
     preferStatic: z.ZodCatch<z.ZodOptional<z.ZodBoolean>>;
     rateLimit: z.ZodCatch<z.ZodOptional<z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
         action: z.ZodOptional<z.ZodEnum<["rate_limit", "rewrite"]>>;
@@ -69,7 +75,7 @@ export declare const inSourceConfig: z.ZodObject<z.objectUtil.extendShape<Pick<{
     }>>>;
 }>, "strip", z.ZodTypeAny, {
     name?: string | undefined;
-    path?: any[] | undefined;
+    path?: string[] | undefined;
     externalNodeModules?: string[] | undefined;
     generator?: string | undefined;
     includedFiles?: string[] | undefined;
@@ -78,8 +84,9 @@ export declare const inSourceConfig: z.ZodObject<z.objectUtil.extendShape<Pick<{
     nodeVersion?: string | undefined;
     schedule?: string | undefined;
     timeout?: number | undefined;
+    method?: ("GET" | "POST" | "PUT" | "PATCH" | "OPTIONS" | "DELETE" | "HEAD")[] | undefined;
+    excludedPath?: string[] | undefined;
     preferStatic?: boolean | undefined;
-    method?: any[] | undefined;
     rateLimit?: {
         windowLimit: number;
         windowSize: number;
@@ -99,8 +106,9 @@ export declare const inSourceConfig: z.ZodObject<z.objectUtil.extendShape<Pick<{
     nodeVersion?: unknown;
     schedule?: unknown;
     timeout?: unknown;
-    preferStatic?: unknown;
     method?: unknown;
+    excludedPath?: string | string[] | undefined;
+    preferStatic?: unknown;
     rateLimit?: unknown;
 }>;
 export type InSourceConfig = z.infer<typeof inSourceConfig>;
@@ -132,7 +140,7 @@ export declare const augmentFunctionConfig: (mainFile: string, tomlConfig: Funct
     nodeModuleFormat?: "cjs" | "esm" | undefined;
 } & {
     name?: string | undefined;
-    path?: any[] | undefined;
+    path?: string[] | undefined;
     externalNodeModules?: string[] | undefined;
     generator?: string | undefined;
     includedFiles?: string[] | undefined;
@@ -141,8 +149,9 @@ export declare const augmentFunctionConfig: (mainFile: string, tomlConfig: Funct
     nodeVersion?: string | undefined;
     schedule?: string | undefined;
     timeout?: number | undefined;
+    method?: ("GET" | "POST" | "PUT" | "PATCH" | "OPTIONS" | "DELETE" | "HEAD")[] | undefined;
+    excludedPath?: string[] | undefined;
     preferStatic?: boolean | undefined;
-    method?: any[] | undefined;
     rateLimit?: {
         windowLimit: number;
         windowSize: number;

package/dist/runtimes/node/in_source_config/index.js

@@ -4,6 +4,7 @@ import { z } from 'zod';
 import { functionConfig } from '../../../config.js';
 import { INVOCATION_MODE } from '../../../function.js';
 import { rateLimit } from '../../../rate_limit.js';
+import { ensureArray } from '../../../utils/ensure_array.js';
 import { FunctionBundlingUserError } from '../../../utils/error.js';
 import { getRoutes } from '../../../utils/routes.js';
 import { RUNTIME } from '../../runtime.js';
@@ -13,8 +14,8 @@ import { getImports } from '../parser/imports.js';
 import { safelyParseSource, safelyReadSource } from '../parser/index.js';
 import { parse as parseSchedule } from './properties/schedule.js';
 export const IN_SOURCE_CONFIG_MODULE = '@netlify/functions';
-const ensureArray = (input) => (Array.isArray(input) ? input : [input]);
-const httpMethods = z.preprocess((input) => (typeof input === 'string' ? input.toUpperCase() : input), z.enum(['GET', 'POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE', 'HEAD']));
+const httpMethod = z.enum(['GET', 'POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE', 'HEAD']);
+const httpMethods = z.preprocess((input) => (typeof input === 'string' ? input.toUpperCase() : input), httpMethod);
 const path = z.string().startsWith('/', { message: "Must start with a '/'" });
 export const inSourceConfig = functionConfig
     .pick({
@@ -39,6 +40,10 @@ export const inSourceConfig = functionConfig
         .union([path, z.array(path)], { errorMap: () => ({ message: 'Must be a string or array of strings' }) })
         .transform(ensureArray)
         .optional(),
+    excludedPath: z
+        .union([path, z.array(path)], { errorMap: () => ({ message: 'Must be a string or array of strings' }) })
+        .transform(ensureArray)
+        .optional(),
     preferStatic: z.boolean().optional().catch(undefined),
     rateLimit: rateLimit.optional().catch(undefined),
 });
@@ -91,12 +96,12 @@ export const parseSource = (source, { functionName }) => {
         const { data, error, success } = inSourceConfig.safeParse(configExport);
         if (success) {
             result.config = data;
-            result.routes = getRoutes({
-                functionName,
+            result.excludedRoutes = getRoutes(functionName, data.excludedPath);
+            result.routes = getRoutes(functionName, data.path).map((route) => ({
+                ...route,
                 methods: data.method ?? [],
-                path: data.path,
-                preferStatic: data.preferStatic,
-            });
+                prefer_static: data.preferStatic || undefined,
+            }));
         }
         else {
             // TODO: Handle multiple errors.

package/dist/utils/ensure_array.d.ts

@@ -0,0 +1 @@
+export declare const ensureArray: <T>(input: T | T[]) => T[];

package/dist/utils/ensure_array.js

@@ -0,0 +1 @@
+export const ensureArray = (input) => (Array.isArray(input) ? input : [input]);

package/dist/utils/format_result.d.ts

@@ -1,8 +1,9 @@
 import { FunctionArchive } from '../function.js';
 import { RuntimeName } from '../runtimes/runtime.js';
-import type { Route } from './routes.js';
+import type { ExtendedRoute, Route } from './routes.js';
 export type FunctionResult = Omit<FunctionArchive, 'runtime'> & {
-    routes?: Route[];
+    routes?: ExtendedRoute[];
+    excludedRoutes?: Route[];
     runtime: RuntimeName;
     schedule?: string;
     runtimeAPIVersion?: number;

package/dist/utils/format_result.js

@@ -5,6 +5,7 @@ export const formatZipResult = (archive) => {
         ...archive,
         staticAnalysisResult: undefined,
         routes: archive.staticAnalysisResult?.routes,
+        excludedRoutes: archive.staticAnalysisResult?.excludedRoutes,
         runtime: archive.runtime.name,
         schedule: archive.staticAnalysisResult?.config?.schedule ?? archive?.config?.schedule,
         runtimeAPIVersion: archive.staticAnalysisResult?.runtimeAPIVersion,

package/dist/utils/routes.d.ts

@@ -1,21 +1,16 @@
 export type Route = {
     pattern: string;
-    methods: string[];
-    prefer_static?: boolean;
 } & ({
     literal: string;
 } | {
     expression: string;
 });
-interface GetRoutesOptions {
-    functionName: string;
-    methods: string[];
-    path: unknown;
-    preferStatic?: boolean;
-}
+export type ExtendedRoute = Route & {
+    methods?: string[];
+    prefer_static?: boolean;
+};
 /**
  * Takes a `path` declaration, normalizes it into an array, and processes the
  * individual elements to obtain an array of `Route` expressions.
  */
-export declare const getRoutes: ({ functionName, methods, path: pathOrPaths, preferStatic, }: GetRoutesOptions) => Route[];
-export {};
+export declare const getRoutes: (functionName: string, pathOrPaths: unknown) => ExtendedRoute[];

package/dist/utils/routes.js

@@ -14,7 +14,7 @@ const isPathLiteral = (path) => {
  * Takes an element from a `path` declaration and returns a Route element that
  * represents it.
  */
-const getRoute = ({ functionName, methods, path, preferStatic }) => {
+const getRoute = (functionName, path) => {
     if (typeof path !== 'string') {
         throw new FunctionBundlingUserError(`'path' property must be a string, found '${JSON.stringify(path)}'`, {
             functionName,
@@ -28,7 +28,7 @@ const getRoute = ({ functionName, methods, path, preferStatic }) => {
         });
     }
     if (isPathLiteral(path)) {
-        return { pattern: path, literal: path, methods, prefer_static: preferStatic || undefined };
+        return { pattern: path, literal: path };
     }
     try {
         const pattern = new ExtendedURLPattern({ pathname: path });
@@ -39,7 +39,7 @@ const getRoute = ({ functionName, methods, path, preferStatic }) => {
         // trailing slash, so that a declaration of `path: "/foo"` matches requests
         // for both `/foo` and `/foo/`.
         const normalizedRegex = `^${regex}\\/?$`;
-        return { pattern: path, expression: normalizedRegex, methods, prefer_static: preferStatic || undefined };
+        return { pattern: path, expression: normalizedRegex };
     }
     catch {
         throw new FunctionBundlingUserError(`'${path}' is not a valid path according to the URLPattern specification`, {
@@ -52,18 +52,11 @@ const getRoute = ({ functionName, methods, path, preferStatic }) => {
  * Takes a `path` declaration, normalizes it into an array, and processes the
  * individual elements to obtain an array of `Route` expressions.
  */
-export const getRoutes = ({ functionName, methods, path: pathOrPaths, preferStatic = false, }) => {
+export const getRoutes = (functionName, pathOrPaths) => {
     if (!pathOrPaths) {
         return [];
     }
     const paths = [...new Set(Array.isArray(pathOrPaths) ? pathOrPaths : [pathOrPaths])];
-    const routes = paths
-        .map((path) => getRoute({
-        functionName,
-        methods,
-        path,
-        preferStatic,
-    }))
-        .filter(nonNullable);
+    const routes = paths.map((path) => getRoute(functionName, path)).filter(nonNullable);
     return routes;
 };

package/dist/zip.d.ts

@@ -20,7 +20,8 @@ export type ZipFunctionsOptions = ZipFunctionOptions & {
     internalSrcFolder?: string;
 };
 export declare const zipFunctions: (relativeSrcFolders: string | string[], destFolder: string, { archiveFormat, basePath, config, configFileDirectories, featureFlags: inputFeatureFlags, manifest, parallelLimit, repositoryRoot, systemLog, debug, internalSrcFolder, }?: ZipFunctionsOptions) => Promise<(Omit<import("./function.js").FunctionArchive, "runtime"> & {
-    routes?: import("./utils/routes.js").Route[] | undefined;
+    routes?: import("./main.js").ExtendedRoute[] | undefined;
+    excludedRoutes?: import("./main.js").Route[] | undefined;
     runtime: import("./main.js").RuntimeName;
     schedule?: string | undefined;
     runtimeAPIVersion?: number | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/zip-it-and-ship-it",
-  "version": "9.35.1",
+  "version": "9.37.0",
   "description": "Zip it and ship it",
   "main": "./dist/main.js",
   "type": "module",
@@ -105,5 +105,5 @@
   "engines": {
     "node": "^14.18.0 || >=16.0.0"
   },
-  "gitHead": "e4464a74add778cb61ff06702ef3a43367a930c3"
+  "gitHead": "10e722ebad2755434933ef205672e290d810259b"
 }