netlify-cli 19.1.0 → 19.1.3

package/dist/commands/api/api.d.ts

@@ -0,0 +1,4 @@
+import { OptionValues } from 'commander';
+import BaseCommand from '../base-command.js';
+export declare const apiCommand: (apiMethod: string, options: OptionValues, command: BaseCommand) => Promise<void>;
+//# sourceMappingURL=api.d.ts.map

package/dist/commands/api/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../src/commands/api/api.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAIxC,OAAO,WAAW,MAAM,oBAAoB,CAAA;AAE5C,eAAO,MAAM,UAAU,cAAqB,MAAM,WAAW,YAAY,WAAW,WAAW,kBAqC9F,CAAA"}

package/dist/commands/api/api.js

@@ -0,0 +1,40 @@
+import AsciiTable from 'ascii-table';
+import { methods } from 'netlify';
+import { chalk, error, exit, log, logJson } from '../../utils/command-helpers.js';
+export const apiCommand = async (apiMethod, options, command) => {
+    const { api } = command.netlify;
+    if (options.list) {
+        const table = new AsciiTable(`Netlify API Methods`);
+        table.setHeading('API Method', 'Docs Link');
+        methods.forEach((method) => {
+            const { operationId } = method;
+            table.addRow(operationId, `https://open-api.netlify.com/#operation/${operationId}`);
+        });
+        log(table.toString());
+        log();
+        log('Above is a list of available API methods');
+        log(`To run a method use "${chalk.cyanBright('netlify api methodName')}"`);
+        exit();
+    }
+    if (!apiMethod) {
+        error(`You must provide an API method. Run "netlify api --list" to see available methods`);
+    }
+    if (!api[apiMethod] || typeof api[apiMethod] !== 'function') {
+        error(`"${apiMethod}"" is not a valid api method. Run "netlify api --list" to see available methods`);
+    }
+    let payload;
+    if (options.data) {
+        payload = typeof options.data === 'string' ? JSON.parse(options.data) : options.data;
+    }
+    else {
+        payload = {};
+    }
+    try {
+        const apiResponse = await api[apiMethod](payload);
+        logJson(apiResponse);
+    }
+    catch (error_) {
+        error(error_);
+    }
+};
+//# sourceMappingURL=api.js.map

package/dist/commands/api/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../../../src/commands/api/api.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,aAAa,CAAA;AAEpC,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AAEjC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAA;AAGjF,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,EAAE,SAAiB,EAAE,OAAqB,EAAE,OAAoB,EAAE,EAAE;IACjG,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,OAAO,CAAA;IAE/B,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACjB,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,qBAAqB,CAAC,CAAA;QACnD,KAAK,CAAC,UAAU,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;QAC3C,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACzB,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAA;YAC9B,KAAK,CAAC,MAAM,CAAC,WAAW,EAAE,2CAA2C,WAAW,EAAE,CAAC,CAAA;QACrF,CAAC,CAAC,CAAA;QACF,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;QACrB,GAAG,EAAE,CAAA;QACL,GAAG,CAAC,0CAA0C,CAAC,CAAA;QAC/C,GAAG,CAAC,wBAAwB,KAAK,CAAC,UAAU,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAA;QAC1E,IAAI,EAAE,CAAA;IACR,CAAC;IAED,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,KAAK,CAAC,mFAAmF,CAAC,CAAA;IAC5F,CAAC;IAED,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,OAAO,GAAG,CAAC,SAAS,CAAC,KAAK,UAAU,EAAE,CAAC;QAC5D,KAAK,CAAC,IAAI,SAAS,iFAAiF,CAAC,CAAA;IACvG,CAAC;IAED,IAAI,OAAO,CAAA;IACX,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACjB,OAAO,GAAG,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAA;IACtF,CAAC;SAAM,CAAC;QACN,OAAO,GAAG,EAAE,CAAA;IACd,CAAC;IACD,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,MAAM,GAAG,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAA;QACjD,OAAO,CAAC,WAAW,CAAC,CAAA;IACtB,CAAC;IAAC,OAAO,MAAM,EAAE,CAAC;QAChB,KAAK,CAAC,MAAM,CAAC,CAAA;IACf,CAAC;AACH,CAAC,CAAA"}

package/dist/commands/api/index.d.ts

@@ -0,0 +1,3 @@
+import BaseCommand from '../base-command.js';
+export declare const createApiCommand: (program: BaseCommand) => BaseCommand;
+//# sourceMappingURL=index.d.ts.map

package/dist/commands/api/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/commands/api/index.ts"],"names":[],"mappings":"AACA,OAAO,WAAW,MAAM,oBAAoB,CAAA;AAE5C,eAAO,MAAM,gBAAgB,YAAa,WAAW,gBAgB/C,CAAA"}

package/dist/commands/api/index.js

@@ -0,0 +1,14 @@
+import { chalk } from '../../utils/command-helpers.js';
+export const createApiCommand = (program) => program
+    .command('api')
+    .argument('[apiMethod]', 'Open API method to run')
+    .description(`Run any Netlify API method
+For more information on available methods checkout https://open-api.netlify.com/ or run '${chalk.grey('netlify api --list')}'`)
+    .option('-d, --data <data>', 'Data to use')
+    .option('--list', 'List out available API methods', false)
+    .addExamples(['netlify api --list', `netlify api getSite --data '{ "site_id": "123456" }'`])
+    .action(async (apiMethod, options, command) => {
+    const { apiCommand } = await import('./api.js');
+    await apiCommand(apiMethod, options, command);
+});
+//# sourceMappingURL=index.js.map

package/dist/commands/api/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/commands/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,gCAAgC,CAAA;AAGtD,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,OAAoB,EAAE,EAAE,CACvD,OAAO;KACJ,OAAO,CAAC,KAAK,CAAC;KACd,QAAQ,CAAC,aAAa,EAAE,wBAAwB,CAAC;KACjD,WAAW,CACV;2FACqF,KAAK,CAAC,IAAI,CAC7F,oBAAoB,CACrB,GAAG,CACL;KACA,MAAM,CAAC,mBAAmB,EAAE,aAAa,CAAC;KAC1C,MAAM,CAAC,QAAQ,EAAE,gCAAgC,EAAE,KAAK,CAAC;KACzD,WAAW,CAAC,CAAC,oBAAoB,EAAE,sDAAsD,CAAC,CAAC;KAC3F,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE;IAC5C,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,CAAA;IAC/C,MAAM,UAAU,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;AAC/C,CAAC,CAAC,CAAA"}

package/dist/commands/base-command.d.ts

@@ -0,0 +1,85 @@
+import { Project } from '@netlify/build-info';
+import { resolveConfig } from '@netlify/config';
+import { Command, Help } from 'commander';
+import { FeatureFlags } from '../utils/feature-flags.js';
+import { type NetlifyOptions } from './types.js';
+type Analytics = {
+    startTime: bigint;
+    payload?: Record<string, unknown>;
+};
+/** Base command class that provides tracking and config initialization */
+export default class BaseCommand extends Command {
+    #private;
+    /** The netlify object inside each command with the state */
+    netlify: NetlifyOptions;
+    analytics: Analytics;
+    project: Project;
+    /**
+     * The working directory that is used for reading the `netlify.toml` file and storing the state.
+     * In a monorepo context this must not be the process working directory and can be an absolute path to the
+     * Package/Site that should be worked in.
+     */
+    workingDir: string;
+    /**
+     * The workspace root if inside a mono repository.
+     * Must not be the repository root!
+     */
+    jsWorkspaceRoot?: string;
+    /** The current workspace package we should execute the commands in  */
+    workspacePackage?: string;
+    featureFlags: FeatureFlags;
+    siteId?: string;
+    accountId?: string;
+    /**
+     * IMPORTANT this function will be called for each command!
+     * Don't do anything expensive in there.
+     */
+    createCommand(name: string): BaseCommand;
+    /** don't show help options on command overview (mostly used on top commands like `addons` where options only apply on children) */
+    noHelpOptions(): this;
+    /** The examples list for the command (used inside doc generation and help page) */
+    examples: string[];
+    /** Set examples for the command  */
+    addExamples(examples: string[]): this;
+    /** Overrides the help output of commander with custom styling */
+    createHelp(): Help;
+    /** Will be called on the end of an action to track the metrics */
+    onEnd(error_?: unknown): Promise<void>;
+    authenticate(tokenFromFlag?: string): Promise<string | undefined>;
+    expensivelyAuthenticate(): Promise<string | undefined>;
+    /** Adds some data to the analytics payload */
+    setAnalyticsPayload(payload: Record<string, unknown>): void;
+    /**
+     * Initializes the options and parses the configuration needs to be called on start of a command function
+     */
+    private init;
+    /** Find and resolve the Netlify configuration */
+    getConfig(config: {
+        cwd: string;
+        token?: string | null;
+        offline?: boolean;
+        /** An optional path to the netlify configuration file e.g. netlify.toml */
+        configFilePath?: string;
+        packagePath?: string;
+        repositoryRoot?: string;
+        host?: string;
+        pathPrefix?: string;
+        scheme?: string;
+    }): ReturnType<typeof resolveConfig>;
+    /**
+     * get a path inside the `.netlify` project folder resolving with the workspace package
+     */
+    getPathInProject(...paths: string[]): string;
+    /**
+     * Returns the context that should be used in case one hasn't been explicitly
+     * set. The default context is `dev` most of the time, but some commands may
+     * wish to override that.
+     */
+    getDefaultContext(): 'production' | 'dev';
+    /**
+     * Retrieve feature flags for this site
+     */
+    getFeatureFlag<T = null | boolean | string>(flagName: string): T;
+}
+export {};
+//# sourceMappingURL=base-command.d.ts.map

package/dist/commands/base-command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-command.d.ts","sourceRoot":"","sources":["../../src/commands/base-command.ts"],"names":[],"mappings":"AAKA,OAAO,EAAiB,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAE5D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C,OAAO,EAAE,OAAO,EAAE,IAAI,EAAU,MAAM,WAAW,CAAA;AAwBjD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAQxD,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,YAAY,CAAA;AAEhD,KAAK,SAAS,GAAG;IACf,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC,CAAA;AAuGD,0EAA0E;AAC1E,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,OAAO;;IAC9C,4DAA4D;IAE5D,OAAO,EAAE,cAAc,CAAA;IACvB,SAAS,EAAE,SAAS,CAAyC;IAE7D,OAAO,EAAE,OAAO,CAAA;IAEhB;;;;OAIG;IAGH,UAAU,SAAgB;IAE1B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,uEAAuE;IACvE,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB,YAAY,EAAE,YAAY,CAAK;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;;OAGG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW;IAwCxC,mIAAmI;IACnI,aAAa;IAKb,mFAAmF;IACnF,QAAQ,EAAE,MAAM,EAAE,CAAK;IACvB,oCAAoC;IACpC,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE;IAK9B,iEAAiE;IACjE,UAAU,IAAI,IAAI;IAgIlB,kEAAkE;IAC5D,KAAK,CAAC,MAAM,CAAC,EAAE,OAAO;IAwBtB,YAAY,CAAC,aAAa,CAAC,EAAE,MAAM;IAQnC,uBAAuB;IA4D7B,8CAA8C;IAC9C,mBAAmB,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAOpD;;OAEG;YACW,IAAI;IAmMlB,iDAAiD;IAC3C,SAAS,CAAC,MAAM,EAAE;QACtB,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACrB,OAAO,CAAC,EAAE,OAAO,CAAA;QACjB,2EAA2E;QAC3E,cAAc,CAAC,EAAE,MAAM,CAAA;QACvB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,cAAc,CAAC,EAAE,MAAM,CAAA;QACvB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC;IAgDpC;;OAEG;IACH,gBAAgB,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM;IAI5C;;;;OAIG;IACH,iBAAiB,IAAI,YAAY,GAAG,KAAK;IAIzC;;OAEG;IACH,cAAc,CAAC,CAAC,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,CAAC;CAGjE"}