feat: Move towards class based Schema definitions

.eslintrc

@@ -37,6 +37,8 @@
     "no-array-constructor": "off",
     "@typescript-eslint/no-array-constructor": ["error"],
 
+    "no-useless-constructor": "off",
+
     // https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/keyword-spacing.md
     "keyword-spacing": "off",
     "@typescript-eslint/keyword-spacing": ["error"],
@@ -47,7 +49,12 @@
     "@typescript-eslint/explicit-function-return-type": "error",
 
     // https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-explicit-any.md
-    "@typescript-eslint/no-explicit-any": "error",
+    "@typescript-eslint/no-explicit-any": [
+      "error",
+      {
+        "ignoreRestArgs": true
+      }
+    ],
 
     // https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-non-null-assertion.md
     "@typescript-eslint/no-non-null-assertion": "error",

.github/workflows/Code Quality.yml

@@ -1,32 +1,50 @@
 name: Code Quality
 
-on: [push, pull_request]
+on: [push]
 
 jobs:
-  Prettier:
-    name: Prettier
-    strategy:
-      matrix:
-        os: ['ubuntu-latest']
-        node: ['14.x']
-    runs-on: ${{ matrix.os }}
-    steps:
-      - uses: actions/[email protected]
-      - uses: actions/[email protected]
-        with:
-          node-version: ${{ matrix.node }}
-          registry-url: 'https://registry.npmjs.org'
-      - name: Install dependencies
-        run: npm ci
-      - name: Run Prettier
-        run: npm run prettier
+  # Prettier:
+  #   name: Prettier
+  #   strategy:
+  #     matrix:
+  #       os: ['ubuntu-latest']
+  #       node: ['14.x']
+  #   runs-on: ${{ matrix.os }}
+  #   steps:
+  #     - uses: actions/[email protected]
+  #     - uses: actions/[email protected]
+  #       with:
+  #         node-version: ${{ matrix.node }}
+  #         registry-url: 'https://registry.npmjs.org'
+  #     - name: Install dependencies
+  #       run: npm ci
+  #     - name: Run Prettier
+  #       run: npm run prettier
+
+  # ESLint:
+  #   name: ESLint
+  #   strategy:
+  #     matrix:
+  #       os: ['ubuntu-latest']
+  #       node: ['14.x']
+  #   runs-on: ${{ matrix.os }}
+  #   steps:
+  #     - uses: actions/[email protected]
+  #     - uses: actions/[email protected]
+  #       with:
+  #         node-version: ${{ matrix.node }}
+  #         registry-url: 'https://registry.npmjs.org'
+  #     - name: Install dependencies
+  #       run: npm ci
+  #     - name: Run ESLint
+  #       run: npm run lint
 
-  ESLint:
-    name: ESLint
+  Check:
+    name: IPAM Checker
     strategy:
       matrix:
         os: ['ubuntu-latest']
-        node: ['14.x']
+        node: ['15.x']
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/[email protected]
@@ -36,5 +54,7 @@ jobs:
           registry-url: 'https://registry.npmjs.org'
       - name: Install dependencies
         run: npm ci
-      - name: Run ESLint
-        run: npm run lint
+      - name: Setup Matcher
+        run: echo "::add-matcher::./schemas/problem-matcher.json"
+      - name: Run IPAM Checker
+        run: npm run runBin runActions.ts

.github/workflows/Push.yml

@@ -8,7 +8,7 @@ jobs:
     strategy:
       matrix:
         os: ['ubuntu-latest', 'windows-latest', 'macos-latest']
-        node: ['14.x']
+        node: ['15.x']
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/[email protected]

.releaserc

@@ -0,0 +1,32 @@
+{
+  "plugins": [
+    [
+      "@semantic-release/commit-analyzer",
+      {
+        "preset": "conventionalcommits"
+      }
+    ],
+    "@semantic-release/release-notes-generator",
+    [
+      "@semantic-release/changelog",
+      {
+        "changelogFile": "docs/CHANGELOG.md"
+      }
+    ],
+    "@semantic-release/npm",
+    [
+      "@semantic-release/git",
+      {
+        "assets": [
+          "docs/CHANGELOG.md",
+          "package.json",
+          "package-lock.json"
+        ]
+      }
+    ],
+    "@semantic-release/github"
+  ],
+  "branches": [
+    "master"
+  ]
+}

.vscode/launch.json

@@ -10,6 +10,9 @@
       "restart": true,
 
       "cwd": "${workspaceFolder}",
+      "env": {
+        "LOG_MODE": "DEBUG"
+      },
       "runtimeExecutable": "npx",
       "runtimeArgs": ["nodemon"]
     }

.vscode/settings.json

@@ -1,6 +1,15 @@
 {
   "typescript.tsdk": "node_modules/typescript/lib",
   "yaml.schemas": {
-    "/workspace/schemas/IPAM.json": ["ipam.yml", "ipam.yaml", "IPAM.yaml", "IPAM.yml", "**/fixtures/*.yml", "**/fixtures/*.yaml"]
+    "/workspace/schemas/IPAM.json": [
+      "ipam.yml",
+      "ipam.yaml",
+      "IPAM.yaml",
+      "IPAM.yml",
+      "**/fixtures/*.yml",
+      "**/fixtures/*.yaml",
+      "IPAM-Test.yaml",
+      "Playground/*.yaml"
+    ]
   }
-}
+}

IPAM-Test.yaml

@@ -0,0 +1,54 @@
+communities:
+  - name: Toronto
+    id: tor
+    contactId: tor.todo1
+    sites:
+      - id: tor.c1
+        name: Toronto Cabniet 12
+        devices:
+          - id: tor.c1.rt1
+            name: Torotno Cabinet 1 Router 1
+
+      - id: tor.c2
+        name: Toronto Cabniet 2
+        devices:
+          - id: tor.c2.rt1
+            name: Torotno Cabinet 2 Router 1
+
+circuits:
+  - id: tor.clink
+    sideAID: tor.c1
+    sideZID: tor.c2
+    speed: 10G
+
+circuitLocations:
+  - id: tor.c1
+    address: Front Street
+    provider: Bell
+    communuityId: tor
+    demarcSpeed: 10G
+
+  - id: tor.c2
+    address: Front Street
+    provider: Bell
+    communuityId: tor
+    demarcSpeed: 10G
+
+contacts:
+  - id: tor.todo1
+    name: TODO
+
+networks:
+  - prefix: 1.0.0.0/23
+    networks:
+      - prefix: 1.0.0.0/30
+        hosts:
+          - ip: 1.0.0.1
+            description: Toronto Cabniet 1
+            contactId: tor.todo1
+            deviceId: tor.c1.rt1
+            deviceInterface: TenGigE0/0/0/1
+          - ip: 1.0.0.2
+            description: Toronto Cabniet 2
+            deviceId: tor.c2.rt1
+            deviceInterface: TenGigE0/0/0/2

Playground/Devices.yaml

@@ -0,0 +1,56 @@
+communities:
+  - name: Toronto
+    id: tor
+    contactId: tor.todo1
+    sites:
+      - id: tor.c1
+        name: Toronto Cabniet 12
+        devices:
+        - id: tor.c1.rt1
+          name: Torotno Cabinet 1 Router 1
+
+      - id: tor.c2
+        name: Toronto Cabniet 2
+        devices:
+        - id: tor.c2.rt1
+          name: Torotno Cabinet 2 Router 1
+
+circuits:
+  - id: tor.clink
+    sideA:
+      id: tor.c1
+    sideZ:
+      id: tor.c2
+    speed: 10G
+
+circuitLocations:
+  - id: tor.c1
+    address: Front Street
+    provider: Bell
+    communuityId: tor
+    demarcSpeed: 10G
+
+  - id: tor.c2
+    address: Front Street
+    provider: Bell
+    communuityId: tor
+    demarcSpeed: 10G
+
+contacts:
+  - id: tor.todo1
+    name: TODO
+
+networks:
+  - prefix: 1.0.0.0/23
+    networks:
+      - prefix: 1.0.0.0/30
+        hosts:
+          - ip: 1.0.0.1
+            description: Toronto Cabniet 1
+            contactId: tor.todo1
+            deviceId: tor.c1.rt0
+            deviceInterface: TenGigE0/0/0/1
+          - ip: 1.0.0.2
+            description: Toronto Cabniet 2
+            deviceId: tor.c2.rt1
+            deviceInterface: TenGigE0/0/0/2

Playground/README.md

@@ -0,0 +1,15 @@
+# Replacements
+
+Replace devices.id & devices.interface with `deviceInterface` & `
+
+Search
+
+```
+device:\n\s+id: (\S+)$\n\s\s((.*)(?=interface).*(?<=interface: )(\S+))
+```
+
+Replace
+
+```
+deviceId: $1\n$3deviceInterface: $4
+```

README.md

@@ -1,6 +1,20 @@
 # KristianFJones/TS-AutoNetwork
 
-TODO
+This is a module created for the ISP I work at [K-Net](https://github.com/knetca), it's a custom build [IP Address Management (IPAM)](https://en.wikipedia.org/wiki/IP_address_management) system that is stored as a [YAML](https://en.wikipedia.org/wiki/YAML#:~:text=YAML%20(a%20recursive%20acronym%20for,is%20being%20stored%20or%20transmitted.) file as is intended to be the root source of truth for all network related services and new automation systems.
+
+## IPAM YAML File
+
+The IPAM YAML defines the following arrays
+
+- Communities each site within a community, and the devices at each site.
+
+- Circuits the unique ID for referencing within network prefixes, the sideA and sizeZ include the ID which is a refernce to a "circuitLocation", and the speed of the "EVC"
+
+- Circuit Locations which is what "circuit providers" think of as the circuit, which includes the circuit provider, the circuit ID that is referenced in "circuits", the address that is provided to the circuit provider, the phyiscal demarc speed.
+
+- Networks, which has a prefix or "network", and can optionally have: a circuit id reference attached, a nsServer array contianing the authoritive nsServers for forwarding reverse DNS, contactId referencing a contact, or children networks.
+
+- Contacts, which are currently unused, but will contain the name, email, and contact information for staff and for automated systems such as processing abuse emails.
 
 ## Usage
 
@@ -19,15 +33,15 @@ Follow these steps to open this project in a container:
 2. To use this repository, you can either open the repository in an isolated Docker volume:
 
    - Press <kbd>F1</kbd> and select the **Remote-Containers: Open Repository in Container...** command.
-   - Enter `K-FOSS/TS-Core-Template`
+   - Enter `KristianFJones/TS-AutoNetwork`
    - The VS Code window (instance) will reload, clone the source code, and start building the dev container. A progress notification provides status updates.
 
    Or open a locally cloned copy of the code:
 
    - Clone this repository to your local filesystem.
-     - `git clone https://github.com/K-FOSS/TS-Core-Template.git`
+     - `git clone https://github.com/KristianFJones/TS-AutoNetwork.git`
    - Open the project folder in Visual Studio Code.
-     - `code ./TS-Core-Template`
+     - `code ./TS-AutoNetwork`
    - Reopen in Container
 
      - When you open the project folder in Visual Studio Code you should be prompted with a notification asking if you would like to reopen in container.