@takodotid/circuit 0.19.0 → 0.21.0

package/src/studio/public/index.html

@@ -0,0 +1,71 @@
+<!doctype html>
+<!-- Circuit Studio. The scripts fill the parts below from /data, and draw again when the server says the config changed. -->
+<html lang="en">
+    <head>
+        <meta charset="utf-8" />
+        <meta name="viewport" content="width=device-width, initial-scale=1" />
+        <title>Circuit Studio</title>
+        <link rel="icon" type="image/svg+xml" href="/favicon.svg" />
+        <!-- Special Gothic is shared with the documentation site, and served from beside this page so Studio works offline. -->
+        <link rel="preload" href="special-gothic-latin.woff2" as="font" type="font/woff2" crossorigin />
+        <link rel="stylesheet" href="style.css" />
+        <script type="module" src="app.js"></script>
+    </head>
+    <body>
+        <header>
+            <a class="brand" href="#graph" aria-label="Circuit Studio, back to the graph"
+                ><span class="wordmark">Circuit</span><span class="product">Studio</span></a
+            >
+            <nav id="views" aria-label="Views">
+                <button data-view="graph">Graph</button>
+                <button data-view="devices">Devices</button>
+                <button data-view="vlans">VLANs</button>
+                <button data-view="addresses">Addresses</button>
+                <button data-view="sessions">BGP</button>
+                <button data-view="cables">Cables</button>
+                <button data-view="tools">Tools</button>
+                <button data-view="compare">Compare</button>
+                <button data-view="problems">Problems<span id="problem-count" class="count"></span></button>
+            </nav>
+            <input id="search" type="search" placeholder="Search the config" aria-label="Search the config" />
+            <div class="status-rail" aria-label="Network status">
+                <span id="summary" class="summary"></span>
+                <span id="live" class="live">connecting</span>
+            </div>
+        </header>
+
+        <pre id="banner" class="banner" hidden></pre>
+
+        <main>
+            <section id="graph-view" class="view">
+                <div class="toolbar">
+                    <nav id="layers" aria-label="Layers"></nav>
+                    <div class="actions">
+                        <button id="fit" title="Fit the drawing to the window">Fit</button>
+                        <button id="lay-out" title="Forget where nodes were moved, and lay them out again">Lay out again</button>
+                        <details class="menu">
+                            <summary>Save image</summary>
+                            <div class="menu-items">
+                                <button id="save-svg" title="Save this layer as an SVG image">SVG</button>
+                                <button id="save-png" title="Save this layer as a PNG image">PNG</button>
+                            </div>
+                        </details>
+                    </div>
+                </div>
+                <div class="stage">
+                    <svg id="canvas" class="canvas" role="img" aria-label="The network">
+                        <g id="viewport">
+                            <g id="edges"></g>
+                            <g id="nodes"></g>
+                        </g>
+                    </svg>
+                    <aside id="panel"></aside>
+                </div>
+            </section>
+
+            <section id="tables-view" class="view" hidden>
+                <div id="tables" class="tables"></div>
+            </section>
+        </main>
+    </body>
+</html>

package/src/studio/public/net.js

@@ -0,0 +1,128 @@
+// @ts-check
+// Address arithmetic for the browser, for both families, as src/core/addr.ts does it for Circuit: addresses as numbers, so IPv4 and IPv6 share one path.
+
+/** @typedef {"ipv4" | "ipv6"} Family */
+/** @typedef {{ family: Family, value: bigint }} Address */
+/** @typedef {{ family: Family, first: bigint, last: bigint, length: number }} Range */
+
+/** @param {Family} family */
+const bitsOf = (family) => (family === "ipv4" ? 32 : 128);
+
+/**
+ * An address as a number, or undefined when the text is not one.
+ *
+ * @param {string} text
+ * @returns {Address | undefined}
+ */
+export function parseAddress(text) {
+    if (!text.includes(":")) {
+        const octets = text.split(".");
+        if (octets.length !== 4 || !octets.every((octet) => /^\d{1,3}$/.test(octet) && Number(octet) <= 255)) return undefined;
+        return { family: "ipv4", value: octets.reduce((value, octet) => (value << 8n) | BigInt(octet), 0n) };
+    }
+
+    const [before, after, extra] = text.split("::");
+    if (extra !== undefined || before === undefined) return undefined;
+
+    /** @param {string | undefined} part */
+    const groupsOf = (part) => (part ? part.split(":") : []);
+    const leading = groupsOf(before);
+    const trailing = groupsOf(after);
+
+    // `::` stands for as many zero groups as make eight.
+    const zeros = after === undefined ? 0 : 8 - leading.length - trailing.length;
+    if (zeros < 0) return undefined;
+    const groups = [...leading, ...Array(zeros).fill("0"), ...trailing];
+    if (groups.length !== 8 || !groups.every((group) => /^[0-9a-fA-F]{1,4}$/.test(group))) return undefined;
+
+    return { family: "ipv6", value: groups.reduce((value, group) => (value << 16n) | BigInt(parseInt(group, 16)), 0n) };
+}
+
+/**
+ * A prefix, or a lone address as the prefix of just itself, as the range of numbers it covers. Undefined when the text is neither.
+ *
+ * @param {string} text
+ * @returns {Range | undefined}
+ */
+export function parseRange(text) {
+    const [addressText, lengthText] = text.split("/");
+    const address = parseAddress(addressText ?? "");
+    if (!address) return undefined;
+
+    const bits = bitsOf(address.family);
+    const length = lengthText === undefined ? bits : Number(lengthText);
+    if (!Number.isInteger(length) || length < 0 || length > bits) return undefined;
+
+    const hostBits = (1n << BigInt(bits - length)) - 1n;
+    const first = address.value & ~hostBits & ((1n << BigInt(bits)) - 1n);
+    return { family: address.family, first, last: first | hostBits, length };
+}
+
+/**
+ * Whether a prefix, or an address, holds an address or a whole other prefix.
+ *
+ * @param {string} outer
+ * @param {string} inner
+ */
+export function covers(outer, inner) {
+    const a = parseRange(outer);
+    const b = parseRange(inner);
+    return Boolean(a && b && a.family === b.family && a.first <= b.first && b.last <= a.last);
+}
+
+/**
+ * The same prefix, however it is written: same family, same length, same network.
+ *
+ * @param {string} a
+ * @param {string} b
+ */
+export function samePrefix(a, b) {
+    const x = parseRange(a);
+    const y = parseRange(b);
+    return Boolean(x && y && x.family === y.family && x.length === y.length && x.first === y.first);
+}
+
+/**
+ * The family of an address or prefix, or undefined when it is not one.
+ *
+ * @param {string} text
+ */
+export const familyOf = (text) => parseRange(text)?.family;
+
+/**
+ * A number back to the address it stands for, with IPv6 written short as RFC 5952 asks.
+ *
+ * @param {bigint} value
+ * @param {Family} family
+ */
+export function formatAddress(value, family) {
+    if (family === "ipv4") return [24n, 16n, 8n, 0n].map((shift) => String((value >> shift) & 255n)).join(".");
+
+    const groups = Array.from({ length: 8 }, (_, index) => ((value >> BigInt(112 - index * 16)) & 0xffffn).toString(16));
+
+    // The longest run of two or more zero groups becomes `::`.
+    let start = -1;
+    let length = 0;
+    for (let at = 0; at < 8;) {
+        let end = at;
+        while (end < 8 && groups[end] === "0") end++;
+        if (end - at > length && end - at > 1) {
+            start = at;
+            length = end - at;
+        }
+        at = end === at ? at + 1 : end;
+    }
+
+    if (start < 0) return groups.join(":");
+    return `${groups.slice(0, start).join(":")}::${groups.slice(start + length).join(":")}`;
+}
+
+/**
+ * The network a prefix or interface address is in, such as `10.0.0.0/24` for `10.0.0.1/24`.
+ *
+ * @param {string} text
+ */
+export function networkOf(text) {
+    const range = parseRange(text);
+    return range ? `${formatAddress(range.first, range.family)}/${range.length}` : text;
+}

package/src/studio/public/special-gothic-license.txt

@@ -0,0 +1,93 @@
+Copyright 2023 The Special Gothic Project Authors (https://github.com/AlistairMcCready/Special-Gothic/)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+https://openfontlicense.org
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.