@canonical/react-components 3.9.1 → 3.10.0

package/dist/components/PrefixedInput/PrefixedInput.d.ts

@@ -0,0 +1,13 @@
+import { type ReactElement } from "react";
+import { type InputProps } from "../Input";
+import "./PrefixedInput.scss";
+import { PropsWithSpread } from "../../types";
+export type PrefixedInputProps = PropsWithSpread<{
+    /**
+     * The immutable text that appears at the beginning of the input field.
+     * This text is not editable by the user and visually appears inside the input.
+     */
+    immutableText: string;
+}, Omit<InputProps, "type">>;
+declare const PrefixedInput: ({ immutableText, ...props }: PrefixedInputProps) => ReactElement;
+export default PrefixedInput;

package/dist/components/PrefixedInput/PrefixedInput.js

@@ -0,0 +1,64 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireWildcard(require("react"));
+var _Input = _interopRequireDefault(require("../Input"));
+var _classnames = _interopRequireDefault(require("classnames"));
+require("./PrefixedInput.scss");
+var _useListener = require("../../hooks/useListener");
+const _excluded = ["immutableText"];
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
+function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
+function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
+// export type PrefixedInputProps = Omit<InputProps, "type"> & {
+//   /**
+//    * The immutable text that appears at the beginning of the input field.
+//    * This text is not editable by the user and visually appears inside the input.
+//    */
+//   immutableText: string;
+// };
+
+const PrefixedInput = _ref => {
+  let {
+      immutableText
+    } = _ref,
+    props = _objectWithoutProperties(_ref, _excluded);
+  const prefixTextRef = (0, _react.useRef)(null);
+  const inputWrapperRef = (0, _react.useRef)(null);
+  const updatePadding = (0, _react.useCallback)(() => {
+    var _inputWrapperRef$curr;
+    const prefixElement = prefixTextRef.current;
+    const inputElement = (_inputWrapperRef$curr = inputWrapperRef.current) === null || _inputWrapperRef$curr === void 0 ? void 0 : _inputWrapperRef$curr.querySelector("input");
+    if (prefixElement && inputElement) {
+      // Adjust the left padding of the input to be the same width as the immutable text.
+      // This displays the user input and the unchangeable text together as one combined string.
+      const prefixWidth = prefixElement.getBoundingClientRect().width;
+      inputElement.style.paddingLeft = "".concat(prefixWidth, "px");
+    }
+  }, []);
+  (0, _useListener.useListener)(window, updatePadding, "resize", true);
+  (0, _react.useLayoutEffect)(() => {
+    updatePadding();
+  }, [immutableText, props.label, updatePadding]);
+  return /*#__PURE__*/_react.default.createElement("div", {
+    className: (0, _classnames.default)("prefixed-input", {
+      "prefixed-input--with-label": !!props.label
+    })
+  }, /*#__PURE__*/_react.default.createElement("div", {
+    className: "prefixed-input__text",
+    ref: prefixTextRef
+  }, immutableText), /*#__PURE__*/_react.default.createElement("div", {
+    ref: inputWrapperRef
+  }, /*#__PURE__*/_react.default.createElement(_Input.default, _extends({}, props, {
+    className: (0, _classnames.default)("prefixed-input__input", props.className),
+    type: "text",
+    wrapperClassName: (0, _classnames.default)("prefixed-input__wrapper", props.wrapperClassName)
+  }))));
+};
+var _default = exports.default = PrefixedInput;

package/dist/components/PrefixedInput/PrefixedInput.scss

@@ -0,0 +1,22 @@
+@import "vanilla-framework";
+
+.prefixed-input {
+  position: relative;
+
+  .prefixed-input__input {
+    padding-top: 0.25rem;
+  }
+
+  .prefixed-input__text {
+    padding-left: $spv--large;
+    padding-top: 0.3rem;
+    pointer-events: none;
+    position: absolute;
+  }
+
+  &--with-label {
+    .prefixed-input__text {
+      top: 2.5rem;
+    }
+  }
+}

package/dist/components/PrefixedInput/PrefixedInput.stories.d.ts

@@ -0,0 +1,11 @@
+import type { Meta, StoryObj } from "@storybook/react";
+import PrefixedInput from "./PrefixedInput";
+declare const meta: Meta<typeof PrefixedInput>;
+export default meta;
+type Story = StoryObj<typeof PrefixedInput>;
+export declare const Default: Story;
+export declare const WithLabel: Story;
+export declare const Disabled: Story;
+export declare const WithError: Story;
+export declare const WithHelpText: Story;
+export declare const Required: Story;

package/dist/components/PrefixedInput/PrefixedInput.stories.js

@@ -0,0 +1,58 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.WithLabel = exports.WithHelpText = exports.WithError = exports.Required = exports.Disabled = exports.Default = void 0;
+var _PrefixedInput = _interopRequireDefault(require("./PrefixedInput"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+const meta = {
+  component: _PrefixedInput.default,
+  tags: ["autodocs"]
+};
+var _default = exports.default = meta;
+const Default = exports.Default = {
+  args: {
+    immutableText: "https://",
+    placeholder: "example.com"
+  }
+};
+const WithLabel = exports.WithLabel = {
+  args: {
+    immutableText: "https://",
+    label: "Website URL",
+    placeholder: "example.com"
+  }
+};
+const Disabled = exports.Disabled = {
+  args: {
+    immutableText: "@",
+    label: "Username",
+    placeholder: "username",
+    disabled: true
+  }
+};
+const WithError = exports.WithError = {
+  args: {
+    immutableText: "https://",
+    label: "Website URL",
+    placeholder: "example.com",
+    error: "Invalid URL format"
+  }
+};
+const WithHelpText = exports.WithHelpText = {
+  args: {
+    immutableText: "User ID:",
+    label: "User Identifier",
+    placeholder: " Enter user ID",
+    help: "This will be used to identify your account"
+  }
+};
+const Required = exports.Required = {
+  args: {
+    immutableText: "https://",
+    label: "Website URL",
+    placeholder: "example.com",
+    required: true
+  }
+};

package/dist/components/PrefixedInput/PrefixedInput.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/PrefixedInput/index.d.ts

@@ -0,0 +1 @@
+export { default, type PrefixedInputProps } from "./PrefixedInput";

package/dist/components/PrefixedInput/index.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "default", {
+  enumerable: true,
+  get: function () {
+    return _PrefixedInput.default;
+  }
+});
+var _PrefixedInput = _interopRequireDefault(require("./PrefixedInput"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/dist/components/PrefixedIpInput/PrefixedIpInput.d.ts

@@ -0,0 +1,27 @@
+import { type ReactElement } from "react";
+import { type PrefixedInputProps } from "../PrefixedInput";
+import { PropsWithSpread } from "../../types";
+export type PrefixedIpInputProps = PropsWithSpread<{
+    /**
+     * The CIDR for the subnet (e.g., "192.168.1.0/24" or "2001:db8::/32").
+     * Used to calculate the immutable prefix and available IP range.
+     */
+    cidr: string;
+    /**
+     * The full IP address value (if available).
+     * For IPv4: e.g., "192.168.1.100"
+     * For IPv6: e.g., "2001:db8::1"
+     */
+    ip: string;
+    /**
+     * The name attribute for the input field.
+     */
+    name: string;
+    /**
+     * Callback function that is called when the IP address changes.
+     * Receives the full IP address as a string parameter.
+     */
+    onIpChange: (ip: string) => void;
+}, Omit<PrefixedInputProps, "immutableText" | "maxLength" | "placeholder" | "name">>;
+declare const PrefixedIpInput: ({ cidr, help, onIpChange, ip, name, ...props }: PrefixedIpInputProps) => ReactElement;
+export default PrefixedIpInput;

package/dist/components/PrefixedIpInput/PrefixedIpInput.js

@@ -0,0 +1,65 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _PrefixedInput = _interopRequireDefault(require("../PrefixedInput"));
+var _utils = require("./utils");
+const _excluded = ["cidr", "help", "onIpChange", "ip", "name"];
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
+function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
+function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
+const PrefixedIpInput = _ref => {
+  let {
+      cidr,
+      help,
+      onIpChange,
+      ip,
+      name
+    } = _ref,
+    props = _objectWithoutProperties(_ref, _excluded);
+  const [networkAddress] = cidr.split("/");
+  const isIPV4 = (0, _utils.isIPv4)(networkAddress);
+  const [immutable, editable] = (0, _utils.getImmutableAndEditable)(cidr);
+  const inputValue = isIPV4 ? ip.split(".").slice(immutable.split(".").length).join(".") : ip.replace(immutable, "");
+  const getIPv4MaxLength = () => {
+    const immutableOctetsLength = immutable.split(".").length;
+    const lengths = [15, 11, 7, 3]; // Corresponding to 0-3 immutable octets
+    return lengths[immutableOctetsLength];
+  };
+  const maxLength = isIPV4 ? getIPv4MaxLength() : editable.length;
+  const placeholder = props.disabled ? "" : editable;
+  const setIp = editableValue => {
+    const fullIp = editableValue ? isIPV4 ? "".concat(immutable, ".").concat(editableValue) : "".concat(immutable).concat(editableValue) : "";
+    onIpChange(fullIp);
+  };
+  const handlePaste = e => {
+    e.preventDefault();
+    const pastedText = e.clipboardData.getData("text");
+    if (isIPV4) {
+      const octets = pastedText.split(".");
+      const trimmed = octets.slice(0 - editable.split(".").length);
+      const ip = trimmed.join(".");
+      setIp(ip);
+    } else {
+      const ip = pastedText.replace(immutable, "");
+      setIp(ip);
+    }
+  };
+  return /*#__PURE__*/_react.default.createElement(_PrefixedInput.default, _extends({
+    help: help ? help : /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, " ", isIPV4 ? /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, " ", "The available range in this subnet is", " ", /*#__PURE__*/_react.default.createElement("code", null, immutable, ".", editable, " ")) : /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, " ", "The available IPV6 address range is", " ", /*#__PURE__*/_react.default.createElement("code", null, immutable, editable, " ")), "."),
+    immutableText: isIPV4 ? "".concat(immutable, ".") : immutable,
+    maxLength: maxLength,
+    name: name,
+    onPaste: handlePaste,
+    value: inputValue,
+    onChange: e => {
+      setIp(e.target.value);
+    },
+    placeholder: placeholder
+  }, props));
+};
+var _default = exports.default = PrefixedIpInput;

package/dist/components/PrefixedIpInput/PrefixedIpInput.stories.d.ts

@@ -0,0 +1,13 @@
+import type { Meta, StoryObj } from "@storybook/react";
+import PrefixedIpInput from "./PrefixedIpInput";
+declare const meta: Meta<typeof PrefixedIpInput>;
+export default meta;
+type Story = StoryObj<typeof PrefixedIpInput>;
+export declare const IPv4Default: Story;
+export declare const IPv4WithValue: Story;
+export declare const IPv4WithError: Story;
+export declare const IPv4Disabled: Story;
+export declare const IPv6Default: Story;
+export declare const IPv6WithValue: Story;
+export declare const WithCustomHelp: Story;
+export declare const Required: Story;

package/dist/components/PrefixedIpInput/PrefixedIpInput.stories.js

@@ -0,0 +1,137 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.WithCustomHelp = exports.Required = exports.IPv6WithValue = exports.IPv6Default = exports.IPv4WithValue = exports.IPv4WithError = exports.IPv4Disabled = exports.IPv4Default = void 0;
+var _react = _interopRequireWildcard(require("react"));
+var _PrefixedIpInput = _interopRequireDefault(require("./PrefixedIpInput"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
+const PrefixedIpInputWrapper = args => {
+  const [ip, setIp] = (0, _react.useState)(args.ip);
+  return /*#__PURE__*/_react.default.createElement(_PrefixedIpInput.default, _extends({}, args, {
+    ip: ip,
+    onIpChange: newIp => {
+      var _args$onIpChange;
+      setIp(newIp);
+      (_args$onIpChange = args.onIpChange) === null || _args$onIpChange === void 0 || _args$onIpChange.call(args, newIp);
+    }
+  }));
+};
+const meta = {
+  component: _PrefixedIpInput.default,
+  tags: ["autodocs"],
+  argTypes: {
+    ip: {
+      control: "text"
+    },
+    cidr: {
+      control: "text"
+    },
+    label: {
+      control: "text"
+    },
+    name: {
+      control: "text"
+    },
+    error: {
+      control: "text"
+    },
+    help: {
+      control: "text"
+    },
+    disabled: {
+      control: "boolean"
+    },
+    required: {
+      control: "boolean"
+    }
+  },
+  render: args => /*#__PURE__*/_react.default.createElement(PrefixedIpInputWrapper, args)
+};
+var _default = exports.default = meta;
+const IPv4Default = exports.IPv4Default = {
+  name: "IPv4 default",
+  args: {
+    cidr: "192.168.1.0/24",
+    ip: "",
+    name: "ip-address",
+    label: "IP Address",
+    onIpChange: ip => console.log("IP changed:", ip)
+  }
+};
+const IPv4WithValue = exports.IPv4WithValue = {
+  name: "IPv4 with value",
+  args: {
+    cidr: "192.168.1.0/24",
+    ip: "192.168.1.100",
+    name: "ip-address",
+    label: "IP Address",
+    onIpChange: ip => console.log("IP changed:", ip)
+  }
+};
+const IPv4WithError = exports.IPv4WithError = {
+  name: "IPv4 with error",
+  args: {
+    cidr: "192.168.1.0/24",
+    ip: "192.168.1.256",
+    name: "ip-address",
+    label: "IP Address",
+    error: "Invalid IP address",
+    onIpChange: ip => console.log("IP changed:", ip)
+  }
+};
+const IPv4Disabled = exports.IPv4Disabled = {
+  name: "IPv4 disabled",
+  args: {
+    cidr: "192.168.1.0/24",
+    ip: "192.168.1.50",
+    name: "ip-address",
+    label: "IP Address",
+    disabled: true,
+    onIpChange: ip => console.log("IP changed:", ip)
+  }
+};
+const IPv6Default = exports.IPv6Default = {
+  name: "IPv6 default",
+  args: {
+    cidr: "2001:db8::/32",
+    ip: "",
+    name: "ipv6-address",
+    label: "IPv6 Address",
+    onIpChange: ip => console.log("IP changed:", ip)
+  }
+};
+const IPv6WithValue = exports.IPv6WithValue = {
+  name: "IPv6 with value",
+  args: {
+    cidr: "2001:db8::/32",
+    ip: "2001:db8::1",
+    name: "ipv6-address",
+    label: "IPv6 Address",
+    onIpChange: ip => console.log("IP changed:", ip)
+  }
+};
+const WithCustomHelp = exports.WithCustomHelp = {
+  args: {
+    cidr: "10.0.0.0/16",
+    ip: "",
+    name: "ip-address",
+    label: "IP Address",
+    help: "Enter a custom IP address for this device",
+    onIpChange: ip => console.log("IP changed:", ip)
+  }
+};
+const Required = exports.Required = {
+  args: {
+    cidr: "192.168.0.0/24",
+    ip: "",
+    name: "ip-address",
+    label: "IP Address",
+    required: true,
+    onIpChange: ip => console.log("IP changed:", ip)
+  }
+};

package/dist/components/PrefixedIpInput/PrefixedIpInput.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/PrefixedIpInput/index.d.ts

@@ -0,0 +1,2 @@
+export { default, type PrefixedIpInputProps } from "./PrefixedIpInput";
+export { isIPv4, getIpRangeFromCidr, getFirstValidIp, convertIpToUint32, isIpInSubnet, getImmutableAndEditableOctets, getImmutableAndEditable, } from "./utils";

package/dist/components/PrefixedIpInput/index.js

@@ -0,0 +1,56 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "convertIpToUint32", {
+  enumerable: true,
+  get: function () {
+    return _utils.convertIpToUint32;
+  }
+});
+Object.defineProperty(exports, "default", {
+  enumerable: true,
+  get: function () {
+    return _PrefixedIpInput.default;
+  }
+});
+Object.defineProperty(exports, "getFirstValidIp", {
+  enumerable: true,
+  get: function () {
+    return _utils.getFirstValidIp;
+  }
+});
+Object.defineProperty(exports, "getImmutableAndEditable", {
+  enumerable: true,
+  get: function () {
+    return _utils.getImmutableAndEditable;
+  }
+});
+Object.defineProperty(exports, "getImmutableAndEditableOctets", {
+  enumerable: true,
+  get: function () {
+    return _utils.getImmutableAndEditableOctets;
+  }
+});
+Object.defineProperty(exports, "getIpRangeFromCidr", {
+  enumerable: true,
+  get: function () {
+    return _utils.getIpRangeFromCidr;
+  }
+});
+Object.defineProperty(exports, "isIPv4", {
+  enumerable: true,
+  get: function () {
+    return _utils.isIPv4;
+  }
+});
+Object.defineProperty(exports, "isIpInSubnet", {
+  enumerable: true,
+  get: function () {
+    return _utils.isIpInSubnet;
+  }
+});
+var _PrefixedIpInput = _interopRequireDefault(require("./PrefixedIpInput"));
+var _utils = require("./utils");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/dist/components/PrefixedIpInput/utils.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Checks if a given IP address is a valid IPv4 address.
+ * @param ip The IP address to check
+ * @returns True if the IP is a valid IPv4 address, false otherwise
+ */
+export declare const isIPv4: (ip: string) => boolean;
+/**
+ * Takes a subnet CIDR notation (IPv4) and returns the first and last IP of the subnet.
+ * The network and host addresses are excluded.
+ *
+ * @param cidr The CIDR notation of the subnet
+ * @returns The first and last valid IP addresses as two strings in a list.
+ */
+export declare const getIpRangeFromCidr: (cidr: string) => string[];
+export declare const getFirstValidIp: (ip: string) => string;
+export declare const convertIpToUint32: (ip: string) => number;
+/**
+ * Checks if an IPv4 address is valid for the given subnet.
+ *
+ * @param ip The IPv4 address to check, as a string
+ * @param cidr The subnet's CIDR notation e.g. 192.168.0.0/24
+ * @returns True if the IP is in the subnet, false otherwise
+ */
+export declare const isIpInSubnet: (ip: string, cidr: string) => boolean;
+/**
+ * Separates the immutable and editable octets of an IPv4 subnet range.
+ *
+ * @param startIp The start IP of the subnet
+ * @param endIp The end IP of the subnet
+ * @returns The immutable and editable octects as two strings in a list
+ */
+export declare const getImmutableAndEditableOctets: (startIp: string, endIp: string) => string[];
+/**
+ * Get the immutable and editable parts of an IPv4 or IPv6 subnet.
+ *
+ * @param cidr The CIDR notation of the subnet
+ * @returns The immutable and editable  as two strings in a list
+ */
+export declare const getImmutableAndEditable: (cidr: string) => string[];

package/dist/components/PrefixedIpInput/utils.js

@@ -0,0 +1,125 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isIpInSubnet = exports.isIPv4 = exports.getIpRangeFromCidr = exports.getImmutableAndEditableOctets = exports.getImmutableAndEditable = exports.getFirstValidIp = exports.convertIpToUint32 = void 0;
+/**
+ * Checks if a given IP address is a valid IPv4 address.
+ * @param ip The IP address to check
+ * @returns True if the IP is a valid IPv4 address, false otherwise
+ */
+const isIPv4 = ip => {
+  const ipv4Regex = /^(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}$/;
+  return ipv4Regex.test(ip);
+};
+
+/**
+ * Takes a subnet CIDR notation (IPv4) and returns the first and last IP of the subnet.
+ * The network and host addresses are excluded.
+ *
+ * @param cidr The CIDR notation of the subnet
+ * @returns The first and last valid IP addresses as two strings in a list.
+ */
+exports.isIPv4 = isIPv4;
+const getIpRangeFromCidr = cidr => {
+  // https://gist.github.com/binarymax/6114792
+
+  // Get start IP and number of valid addresses
+  const [startIp, mask] = cidr.split("/");
+  const numberOfAddresses = (1 << 32 - parseInt(mask)) - 1;
+
+  // IPv4 can be represented by an unsigned 32-bit integer, so we can use a Uint32Array to store the IP
+  const buffer = new ArrayBuffer(4); //4 octets
+  const int32 = new Uint32Array(buffer);
+
+  // Convert starting IP to Uint32 and add the number of addresses to get the end IP.
+  // Subtract 1 from the number of addresses to exclude the broadcast address.
+  int32[0] = convertIpToUint32(startIp) + numberOfAddresses - 1;
+
+  // Convert the buffer to a Uint8Array to get the octets, then convert it to an array
+  const arrayApplyBuffer = Array.from(new Uint8Array(buffer));
+
+  // Reverse the octets and join them with "." to get the end IP
+  const endIp = arrayApplyBuffer.reverse().join(".");
+  const firstValidIp = getFirstValidIp(startIp);
+  return [firstValidIp, endIp];
+};
+exports.getIpRangeFromCidr = getIpRangeFromCidr;
+const getFirstValidIp = ip => {
+  const buffer = new ArrayBuffer(4); //4 octets
+  const int32 = new Uint32Array(buffer);
+
+  // add 1 because the first IP is the network address
+  int32[0] = convertIpToUint32(ip) + 1;
+  const arrayApplyBuffer = Array.from(new Uint8Array(buffer));
+  return arrayApplyBuffer.reverse().join(".");
+};
+exports.getFirstValidIp = getFirstValidIp;
+const convertIpToUint32 = ip => {
+  const octets = ip.split(".").map(a => parseInt(a));
+  const buffer = new ArrayBuffer(4);
+  const int32 = new Uint32Array(buffer);
+  int32[0] = (octets[0] << 24) + (octets[1] << 16) + (octets[2] << 8) + octets[3];
+  return int32[0];
+};
+
+/**
+ * Checks if an IPv4 address is valid for the given subnet.
+ *
+ * @param ip The IPv4 address to check, as a string
+ * @param cidr The subnet's CIDR notation e.g. 192.168.0.0/24
+ * @returns True if the IP is in the subnet, false otherwise
+ */
+exports.convertIpToUint32 = convertIpToUint32;
+const isIpInSubnet = (ip, cidr) => {
+  const [startIP, endIP] = getIpRangeFromCidr(cidr);
+  const ipUint32 = convertIpToUint32(ip);
+  const startIPUint32 = convertIpToUint32(startIP);
+  const endIPUint32 = convertIpToUint32(endIP);
+  return ipUint32 >= startIPUint32 && ipUint32 <= endIPUint32;
+};
+
+/**
+ * Separates the immutable and editable octets of an IPv4 subnet range.
+ *
+ * @param startIp The start IP of the subnet
+ * @param endIp The end IP of the subnet
+ * @returns The immutable and editable octects as two strings in a list
+ */
+exports.isIpInSubnet = isIpInSubnet;
+const getImmutableAndEditableOctets = (startIp, endIp) => {
+  const startIpOctetList = startIp.split(".");
+  const endIpOctetList = endIp.split(".");
+  const immutable = [];
+  const editable = [];
+  startIpOctetList.forEach((octet, index) => {
+    if (octet === endIpOctetList[index]) {
+      immutable.push(octet);
+    } else {
+      editable.push("[".concat(octet, "-").concat(endIpOctetList[index], "]"));
+    }
+  });
+  return [immutable.join("."), editable.join(".")];
+};
+
+/**
+ * Get the immutable and editable parts of an IPv4 or IPv6 subnet.
+ *
+ * @param cidr The CIDR notation of the subnet
+ * @returns The immutable and editable  as two strings in a list
+ */
+exports.getImmutableAndEditableOctets = getImmutableAndEditableOctets;
+const getImmutableAndEditable = cidr => {
+  const isIPV4 = isIPv4(cidr.split("/")[0]);
+  if (isIPV4) {
+    const [startIp, endIp] = getIpRangeFromCidr(cidr);
+    return getImmutableAndEditableOctets(startIp, endIp);
+  }
+  const [networkAddress] = cidr.split("/");
+  const immutableIPV6 = networkAddress.substring(0, networkAddress.lastIndexOf(":"));
+  const ipv6PlaceholderColons = 7 - (immutableIPV6.match(/:/g) || []).length; // 7 is the maximum number of colons in an IPv6 address
+  const editableIPV6 = "".concat("0000:".repeat(ipv6PlaceholderColons), "0000");
+  return [immutableIPV6, editableIPV6];
+};
+exports.getImmutableAndEditable = getImmutableAndEditable;