neon 2.1.2 → 2.29.1

package/dist/commands/ip_allow.js

@@ -0,0 +1,137 @@
+import { log } from "../log.js";
+import { projectUpdateRequest } from "../parameters.gen.js";
+import { fillSingleProject } from "../utils/enrichers.js";
+import { writer } from "../writer.js";
+const IP_ALLOW_FIELDS = [
+    "id",
+    "name",
+    "IP_addresses",
+    "protected_branches_only",
+];
+export const command = "ip-allow";
+export const describe = "Manage IP Allow";
+export const builder = (argv) => {
+    return argv
+        .usage("$0 ip-allow <sub-command> [options]")
+        .options({
+        "project-id": {
+            describe: "Project ID",
+            type: "string",
+        },
+    })
+        .middleware(fillSingleProject)
+        .command("list", "List the IP allowlist", (yargs) => yargs, async (args) => {
+        await list(args);
+    })
+        .command("add [ips...]", "Add IP addresses to the IP allowlist", (yargs) => yargs
+        .usage("$0 ip-allow add [ips...]")
+        .positional("ips", {
+        describe: "The list of IP addresses to add",
+        type: "string",
+        default: [],
+        array: true,
+    })
+        .options({
+        "protected-only": {
+            describe: projectUpdateRequest["project.settings.allowed_ips.protected_branches_only"].description,
+            type: "boolean",
+        },
+    }), async (args) => {
+        await add(args);
+    })
+        .command("remove [ips...]", "Remove IP addresses from the IP allowlist", (yargs) => yargs.usage("$0 ip-allow remove [ips...]").positional("ips", {
+        describe: "The list of IP addresses to remove",
+        type: "string",
+        default: [],
+        array: true,
+    }), async (args) => {
+        await remove(args);
+    })
+        .command("reset [ips...]", "Reset the IP allowlist", (yargs) => yargs.usage("$0 ip-allow reset [ips...]").positional("ips", {
+        describe: "The list of IP addresses to reset",
+        type: "string",
+        default: [],
+        array: true,
+    }), async (args) => {
+        await reset(args);
+    });
+};
+export const handler = (args) => {
+    return args;
+};
+const list = async (props) => {
+    const { data } = await props.apiClient.getProject(props.projectId);
+    writer(props).end(parse(data.project), {
+        fields: IP_ALLOW_FIELDS,
+    });
+};
+const add = async (props) => {
+    if (props.ips.length <= 0) {
+        throw new Error(`Enter individual IP addresses, define ranges with a dash, or use CIDR notation for more flexibility.
+       Example: neonctl ip-allow add 192.168.1.1, 192.168.1.20-192.168.1.50, 192.168.1.0/24 --project-id <id>`);
+    }
+    const project = {};
+    const { data } = await props.apiClient.getProject(props.projectId);
+    const existingAllowedIps = data.project.settings?.allowed_ips;
+    project.settings = {
+        allowed_ips: {
+            ips: [...new Set(props.ips.concat(existingAllowedIps?.ips ?? []))],
+            protected_branches_only: props.protectedOnly ??
+                existingAllowedIps?.protected_branches_only ??
+                false,
+        },
+    };
+    const { data: response } = await props.apiClient.updateProject(props.projectId, {
+        project,
+    });
+    writer(props).end(parse(response.project), {
+        fields: IP_ALLOW_FIELDS,
+    });
+};
+const remove = async (props) => {
+    if (props.ips.length <= 0) {
+        throw new Error(`Remove individual IP addresses and ranges. Example: neonctl ip-allow remove 192.168.1.1 --project-id <id>`);
+    }
+    const project = {};
+    const { data } = await props.apiClient.getProject(props.projectId);
+    const existingAllowedIps = data.project.settings?.allowed_ips;
+    project.settings = {
+        allowed_ips: {
+            ips: existingAllowedIps?.ips?.filter((ip) => !props.ips.includes(ip)) ?? [],
+            protected_branches_only: existingAllowedIps?.protected_branches_only ?? false,
+        },
+    };
+    const { data: response } = await props.apiClient.updateProject(props.projectId, {
+        project,
+    });
+    writer(props).end(parse(response.project), {
+        fields: IP_ALLOW_FIELDS,
+    });
+};
+const reset = async (props) => {
+    const project = {};
+    project.settings = {
+        allowed_ips: {
+            ips: props.ips,
+            protected_branches_only: false,
+        },
+    };
+    const { data } = await props.apiClient.updateProject(props.projectId, {
+        project,
+    });
+    writer(props).end(parse(data.project), {
+        fields: IP_ALLOW_FIELDS,
+    });
+    if (props.ips.length <= 0) {
+        log.info(`The IP allowlist has been reset. All databases on project "${data.project.name}" are now exposed to the internet`);
+    }
+};
+const parse = (project) => {
+    const ips = project.settings?.allowed_ips?.ips ?? [];
+    return {
+        id: project.id,
+        name: project.name,
+        IP_addresses: ips,
+        protected_branches_only: project.settings?.allowed_ips?.protected_branches_only ?? false,
+    };
+};