@netlify/zip-it-and-ship-it 5.3.0 → 5.4.0-isc-listfunctions

package/dist/function.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 import { Stats } from 'fs';
 import type { FunctionConfig } from './config';
+import { ISCValues } from './runtimes/node/in_source_config';
 import type { Runtime, ZipFunctionResult } from './runtimes/runtime';
 declare type FunctionArchive = ZipFunctionResult & {
     mainFile: string;
@@ -16,6 +17,7 @@ interface SourceFile {
     srcDir: string;
     srcPath: string;
     stat: Stats;
+    inSourceConfig?: ISCValues;
 }
 declare type FunctionSource = SourceFile & {
     config: FunctionConfig;

package/dist/main.d.ts

@@ -6,6 +6,7 @@ interface ListedFunction {
     mainFile: string;
     runtime: RuntimeName;
     extension: string;
+    schedule?: string;
 }
 declare type ListedFunctionFile = ListedFunction & {
     srcFile: string;
@@ -15,9 +16,14 @@ interface ListFunctionsOptions {
     config?: Config;
     featureFlags?: FeatureFlags;
 }
-declare const listFunctions: (relativeSrcFolders: string | string[], { featureFlags: inputFeatureFlags }?: {
-    featureFlags?: FeatureFlags;
+declare const listFunctions: (relativeSrcFolders: string | string[], { featureFlags: inputFeatureFlags, config }?: {
+    featureFlags?: FeatureFlags | undefined;
+    config?: Config | undefined;
 }) => Promise<ListedFunction[]>;
+declare const listFunction: (mainFile: string, { featureFlags: inputFeatureFlags, config }?: {
+    featureFlags?: FeatureFlags | undefined;
+    config?: Config | undefined;
+}) => Promise<ListedFunction | undefined>;
 declare const listFunctionsFiles: (relativeSrcFolders: string | string[], { basePath, config, featureFlags: inputFeatureFlags }?: ListFunctionsOptions) => Promise<ListedFunctionFile[]>;
-export { listFunctions, listFunctionsFiles };
+export { listFunctions, listFunction, listFunctionsFiles };
 export { zipFunction, zipFunctions } from './zip';

package/dist/main.js

@@ -20,23 +20,35 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.zipFunctions = exports.zipFunction = exports.listFunctionsFiles = exports.listFunctions = void 0;
+exports.zipFunctions = exports.zipFunction = exports.listFunctionsFiles = exports.listFunction = exports.listFunctions = void 0;
 const path_1 = require("path");
 const feature_flags_1 = require("./feature_flags");
 const runtimes_1 = require("./runtimes");
 const fs_1 = require("./utils/fs");
 // List all Netlify Functions main entry files for a specific directory
-const listFunctions = function (relativeSrcFolders, { featureFlags: inputFeatureFlags } = {}) {
+const listFunctions = function (relativeSrcFolders, { featureFlags: inputFeatureFlags, config } = {}) {
     return __awaiter(this, void 0, void 0, function* () {
         const featureFlags = (0, feature_flags_1.getFlags)(inputFeatureFlags);
         const srcFolders = (0, fs_1.resolveFunctionsDirectories)(relativeSrcFolders);
         const paths = yield (0, fs_1.listFunctionsDirectories)(srcFolders);
-        const functions = yield (0, runtimes_1.getFunctionsFromPaths)(paths, { featureFlags });
+        const functions = yield (0, runtimes_1.getFunctionsFromPaths)(paths, { featureFlags, config });
         const listedFunctions = [...functions.values()].map(getListedFunction);
         return listedFunctions;
     });
 };
 exports.listFunctions = listFunctions;
+// List one Netlify Functions main entry file for a specific directory
+const listFunction = function (mainFile, { featureFlags: inputFeatureFlags, config } = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const featureFlags = (0, feature_flags_1.getFlags)(inputFeatureFlags);
+        const func = yield (0, runtimes_1.getFunctionFromPath)(mainFile, { featureFlags, config });
+        if (!func) {
+            return;
+        }
+        return getListedFunction(func);
+    });
+};
+exports.listFunction = listFunction;
 // List all Netlify Functions files for a specific directory
 const listFunctionsFiles = function (relativeSrcFolders, { basePath, config, featureFlags: inputFeatureFlags } = {}) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -49,14 +61,14 @@ const listFunctionsFiles = function (relativeSrcFolders, { basePath, config, fea
     });
 };
 exports.listFunctionsFiles = listFunctionsFiles;
-const getListedFunction = function ({ runtime, name, mainFile, extension }) {
-    return { name, mainFile, runtime: runtime.name, extension };
+const getListedFunction = function ({ runtime, name, mainFile, extension, config, inSourceConfig, }) {
+    var _a;
+    return { name, mainFile, runtime: runtime.name, extension, schedule: (_a = inSourceConfig === null || inSourceConfig === void 0 ? void 0 : inSourceConfig.schedule) !== null && _a !== void 0 ? _a : config.schedule };
 };
 const getListedFunctionFiles = function (func, options) {
     return __awaiter(this, void 0, void 0, function* () {
         const srcFiles = yield getSrcFiles(Object.assign(Object.assign({}, func), options));
-        const { name, mainFile, runtime } = func;
-        return srcFiles.map((srcFile) => ({ srcFile, name, mainFile, runtime: runtime.name, extension: (0, path_1.extname)(srcFile) }));
+        return srcFiles.map((srcFile) => (Object.assign(Object.assign({}, getListedFunction(func)), { srcFile, extension: (0, path_1.extname)(srcFile) })));
     });
 };
 const getSrcFiles = function (_a) {

package/dist/runtimes/go/index.js

@@ -35,22 +35,25 @@ const detectGoFunction = ({ fsCache, path }) => __awaiter(void 0, void 0, void 0
 });
 const findFunctionsInPaths = function ({ featureFlags, fsCache, paths }) {
     return __awaiter(this, void 0, void 0, function* () {
-        const functions = yield Promise.all(paths.map((path) => __awaiter(this, void 0, void 0, function* () {
-            const runtime = yield (0, detect_runtime_1.detectBinaryRuntime)({ fsCache, path });
-            if (runtime === 'go') {
-                return processBinary({ fsCache, path });
-            }
-            if (featureFlags.buildGoSource !== true) {
-                return;
-            }
-            const goSourceFile = yield detectGoFunction({ fsCache, path });
-            if (goSourceFile) {
-                return processSource({ fsCache, mainFile: goSourceFile, path });
-            }
-        })));
+        const functions = yield Promise.all(paths.map((path) => getFunctionAtPath(path, { featureFlags, fsCache })));
         return functions.filter(non_nullable_1.nonNullable);
     });
 };
+const getFunctionAtPath = function (path, { featureFlags, fsCache }) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const runtime = yield (0, detect_runtime_1.detectBinaryRuntime)({ fsCache, path });
+        if (runtime === 'go') {
+            return processBinary({ fsCache, path });
+        }
+        if (featureFlags.buildGoSource !== true) {
+            return;
+        }
+        const goSourceFile = yield detectGoFunction({ fsCache, path });
+        if (goSourceFile) {
+            return processSource({ fsCache, mainFile: goSourceFile, path });
+        }
+    });
+};
 const processBinary = ({ fsCache, path }) => __awaiter(void 0, void 0, void 0, function* () {
     const stat = (yield (0, fs_1.cachedLstat)(fsCache, path));
     const extension = (0, path_1.extname)(path);
@@ -96,6 +99,6 @@ const zipFunction = function ({ config, destFolder, filename, mainFile, srcDir,
         return { config, path: destPath };
     });
 };
-const runtime = { findFunctionsInPaths, name: 'go', zipFunction };
+const runtime = { findFunctionsInPaths, getFunctionAtPath, name: 'go', zipFunction };
 exports.default = runtime;
 //# sourceMappingURL=index.js.map

package/dist/runtimes/index.d.ts

@@ -10,4 +10,11 @@ declare const getFunctionsFromPaths: (paths: string[], { config, dedupe, feature
     dedupe?: boolean | undefined;
     featureFlags?: FeatureFlags | undefined;
 }) => Promise<FunctionMap>;
-export { getFunctionsFromPaths };
+/**
+ * Gets a list of functions found in a list of paths.
+ */
+declare const getFunctionFromPath: (path: string, { config, featureFlags }?: {
+    config?: Config | undefined;
+    featureFlags?: FeatureFlags | undefined;
+}) => Promise<FunctionSource | undefined>;
+export { getFunctionsFromPaths, getFunctionFromPath };

package/dist/runtimes/index.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFunctionsFromPaths = void 0;
+exports.getFunctionFromPath = exports.getFunctionsFromPaths = void 0;
 const path_1 = require("path");
 const config_1 = require("../config");
 const feature_flags_1 = require("../feature_flags");
@@ -42,23 +42,24 @@ const findFunctionsInRuntime = function ({ dedupe = false, featureFlags, fsCache
         return { functions: augmentedFunctions, remainingPaths };
     });
 };
+// An object to cache filesystem operations. This allows different functions
+// to perform IO operations on the same file (i.e. getting its stats or its
+// contents) without duplicating work.
+const makeFsCache = () => ({});
+// The order of this array determines the priority of the runtimes. If a path
+// is used by the first time, it won't be made available to the subsequent
+// runtimes.
+const RUNTIMES = [node_1.default, go_1.default, rust_1.default];
 /**
  * Gets a list of functions found in a list of paths.
  */
 const getFunctionsFromPaths = (paths, { config, dedupe = false, featureFlags = feature_flags_1.defaultFlags, } = {}) => __awaiter(void 0, void 0, void 0, function* () {
-    // An object to cache filesystem operations. This allows different functions
-    // to perform IO operations on the same file (i.e. getting its stats or its
-    // contents) without duplicating work.
-    const fsCache = {};
-    // The order of this array determines the priority of the runtimes. If a path
-    // is used by the first time, it won't be made available to the subsequent
-    // runtimes.
-    const runtimes = [node_1.default, go_1.default, rust_1.default];
+    const fsCache = makeFsCache();
     // We cycle through the ordered array of runtimes, passing each one of them
     // through `findFunctionsInRuntime`. For each iteration, we collect all the
     // functions found plus the list of paths that still need to be evaluated,
     // using them as the input for the next iteration until the last runtime.
-    const { functions } = yield runtimes.reduce((aggregate, runtime) => __awaiter(void 0, void 0, void 0, function* () {
+    const { functions } = yield RUNTIMES.reduce((aggregate, runtime) => __awaiter(void 0, void 0, void 0, function* () {
         const { functions: aggregateFunctions, remainingPaths: aggregatePaths } = yield aggregate;
         const { functions: runtimeFunctions, remainingPaths: runtimePaths } = yield findFunctionsInRuntime({
             dedupe,
@@ -79,4 +80,19 @@ const getFunctionsFromPaths = (paths, { config, dedupe = false, featureFlags = f
     return new Map(functionsWithConfig);
 });
 exports.getFunctionsFromPaths = getFunctionsFromPaths;
+/**
+ * Gets a list of functions found in a list of paths.
+ */
+const getFunctionFromPath = (path, { config, featureFlags = feature_flags_1.defaultFlags } = {}) => __awaiter(void 0, void 0, void 0, function* () {
+    const fsCache = makeFsCache();
+    for (const runtime of RUNTIMES) {
+        // eslint-disable-next-line no-await-in-loop
+        const func = yield runtime.getFunctionAtPath(path, { fsCache, featureFlags });
+        if (func) {
+            return Object.assign(Object.assign({}, func), { runtime, config: (0, config_1.getConfigForFunction)({ config, func: Object.assign(Object.assign({}, func), { runtime }) }) });
+        }
+    }
+    return undefined;
+});
+exports.getFunctionFromPath = getFunctionFromPath;
 //# sourceMappingURL=index.js.map

package/dist/runtimes/node/finder.d.ts

@@ -1,6 +1,4 @@
-import { SourceFile } from '../../function';
-declare const findFunctionsInPaths: ({ paths }: {
-    paths: string[];
-}) => Promise<SourceFile[]>;
-declare const getFunctionAtPath: (srcPath: string) => Promise<SourceFile | undefined>;
+import { FindFunctionsInPathsFunction, GetFunctionAtPathFunction } from '../runtime';
+declare const findFunctionsInPaths: FindFunctionsInPathsFunction;
+declare const getFunctionAtPath: GetFunctionAtPathFunction;
 export { findFunctionsInPaths, getFunctionAtPath };

package/dist/runtimes/node/finder.js

@@ -18,6 +18,7 @@ const path_1 = require("path");
 const util_1 = require("util");
 const locate_path_1 = __importDefault(require("locate-path"));
 const non_nullable_1 = require("../../utils/non_nullable");
+const in_source_config_1 = require("./in_source_config");
 const pLstat = (0, util_1.promisify)(fs_1.lstat);
 // List of extensions that this runtime will look for, in order of precedence.
 const allowedExtensions = ['.js', '.zip', '.cjs', '.mjs', '.ts'];
@@ -30,9 +31,9 @@ const sortByExtension = (fA, fB) => {
     const indexB = allowedExtensions.indexOf(fB.extension);
     return indexB - indexA;
 };
-const findFunctionsInPaths = function ({ paths }) {
+const findFunctionsInPaths = function ({ paths, fsCache, featureFlags }) {
     return __awaiter(this, void 0, void 0, function* () {
-        const functions = yield Promise.all(paths.map(getFunctionAtPath));
+        const functions = yield Promise.all(paths.map((path) => getFunctionAtPath(path, { fsCache, featureFlags })));
         // It's fine to mutate the array since its scope is local to this function.
         const sortedFunctions = functions.filter(non_nullable_1.nonNullable).sort((fA, fB) => {
             // We first sort the functions array to put directories first. This is so
@@ -63,10 +64,11 @@ const getFunctionAtPath = function (srcPath) {
         if (mainFile === undefined) {
             return;
         }
+        const iscValues = yield (0, in_source_config_1.findISCDeclarationsInPath)(mainFile);
         const extension = (0, path_1.extname)(srcPath);
         const srcDir = stat.isDirectory() ? srcPath : (0, path_1.dirname)(srcPath);
         const name = (0, path_1.basename)(srcPath, (0, path_1.extname)(srcPath));
-        return { extension, filename, mainFile, name, srcDir, srcPath, stat };
+        return { extension, filename, mainFile, name, srcDir, srcPath, stat, inSourceConfig: iscValues };
     });
 };
 exports.getFunctionAtPath = getFunctionAtPath;

package/dist/runtimes/node/index.js

@@ -138,6 +138,7 @@ const zipWithFunctionWithFallback = (_a) => __awaiter(void 0, void 0, void 0, fu
 });
 const runtime = {
     findFunctionsInPaths: finder_1.findFunctionsInPaths,
+    getFunctionAtPath: finder_1.getFunctionAtPath,
     getSrcFiles: getSrcFilesWithBundler,
     name: 'js',
     zipFunction: zipWithFunctionWithFallback,

package/dist/runtimes/runtime.d.ts

@@ -11,6 +11,10 @@ declare type FindFunctionsInPathsFunction = (args: {
     fsCache: FsCache;
     paths: string[];
 }) => Promise<SourceFile[]>;
+declare type GetFunctionAtPathFunction = (path: string, args: {
+    featureFlags: FeatureFlags;
+    fsCache: FsCache;
+}) => Promise<SourceFile | undefined>;
 declare type GetSrcFilesFunction = (args: {
     basePath?: string;
     config: FunctionConfig;
@@ -38,8 +42,9 @@ declare type ZipFunction = (args: {
 } & FunctionSource) => Promise<ZipFunctionResult>;
 interface Runtime {
     findFunctionsInPaths: FindFunctionsInPathsFunction;
+    getFunctionAtPath: GetFunctionAtPathFunction;
     getSrcFiles?: GetSrcFilesFunction;
     name: RuntimeName;
     zipFunction: ZipFunction;
 }
-export { FindFunctionsInPathsFunction, GetSrcFilesFunction, Runtime, RuntimeName, ZipFunction, ZipFunctionResult };
+export { FindFunctionsInPathsFunction, GetSrcFilesFunction, Runtime, RuntimeName, ZipFunction, ZipFunctionResult, GetFunctionAtPathFunction, };

package/dist/runtimes/rust/index.js

@@ -41,22 +41,28 @@ const detectRustFunction = ({ fsCache, path }) => __awaiter(void 0, void 0, void
 });
 const findFunctionsInPaths = function ({ featureFlags, fsCache, paths, }) {
     return __awaiter(this, void 0, void 0, function* () {
-        const functions = yield Promise.all(paths.map((path) => __awaiter(this, void 0, void 0, function* () {
-            const runtime = yield (0, detect_runtime_1.detectBinaryRuntime)({ fsCache, path });
-            if (runtime === 'rs') {
-                return processBinary({ fsCache, path });
-            }
-            if (featureFlags.buildRustSource !== true) {
-                return;
-            }
-            const rustSourceFile = yield detectRustFunction({ fsCache, path });
-            if (rustSourceFile) {
-                return processSource({ fsCache, mainFile: rustSourceFile, path });
-            }
+        const functions = yield Promise.all(paths.map((path) => getFunctionAtPath(path, {
+            featureFlags,
+            fsCache,
         })));
         return functions.filter(non_nullable_1.nonNullable);
     });
 };
+const getFunctionAtPath = function (path, { featureFlags, fsCache, }) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const runtime = yield (0, detect_runtime_1.detectBinaryRuntime)({ fsCache, path });
+        if (runtime === 'rs') {
+            return processBinary({ fsCache, path });
+        }
+        if (featureFlags.buildRustSource !== true) {
+            return;
+        }
+        const rustSourceFile = yield detectRustFunction({ fsCache, path });
+        if (rustSourceFile) {
+            return processSource({ fsCache, mainFile: rustSourceFile, path });
+        }
+    });
+};
 const processBinary = ({ fsCache, path }) => __awaiter(void 0, void 0, void 0, function* () {
     const stat = (yield (0, fs_1.cachedLstat)(fsCache, path));
     const filename = (0, path_1.basename)(path);
@@ -116,6 +122,6 @@ const zipFunction = function ({ config, destFolder, filename, mainFile, runtime,
         return { config, path: destPath };
     });
 };
-const runtime = { findFunctionsInPaths, name: 'rs', zipFunction };
+const runtime = { findFunctionsInPaths, getFunctionAtPath, name: 'rs', zipFunction };
 exports.default = runtime;
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/zip-it-and-ship-it",
-  "version": "5.3.0",
+  "version": "5.4.0-isc-listfunctions",
   "description": "Zip it and ship it",
   "main": "./dist/main.js",
   "bin": {
@@ -93,7 +93,7 @@
   },
   "devDependencies": {
     "@babel/types": "^7.15.6",
-    "@netlify/eslint-config-node": "^4.0.0",
+    "@netlify/eslint-config-node": "^4.0.1",
     "@types/archiver": "^5.1.1",
     "@types/end-of-stream": "^1.4.1",
     "@types/resolve": "^1.20.1",