@infrascan/shared-types 0.6.1 → 0.7.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @infrascan/shared-types
 
+## 0.7.0
+
+### Minor Changes
+
+- [#123](https://github.com/infrascan/infrascan/pull/123) [`d05dc6ffe36f6b219964407b63b002520cf89795`](https://github.com/infrascan/infrascan/commit/d05dc6ffe36f6b219964407b63b002520cf89795) Thanks [@lfarrel6](https://github.com/lfarrel6)! - Introduce informational node support
+
+## 0.6.2
+
+### Patch Changes
+
+- [#110](https://github.com/infrascan/infrascan/pull/110) [`6238e6eb0cd1299607dd788ab385215a1aee3c39`](https://github.com/infrascan/infrascan/commit/6238e6eb0cd1299607dd788ab385215a1aee3c39) Thanks [@lfarrel6](https://github.com/lfarrel6)! - Improve typescript interfaces — correct api for s3 connector to better adhere to interface, tidy up type imports for shared types lib
+
 ## 0.6.1
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@infrascan/shared-types",
-  "version": "0.6.1",
+  "version": "0.7.0",
   "description": "Shared types for multiple infrascan packages",
   "main": "src/index.ts",
   "scripts": {
@@ -15,6 +15,6 @@
     "@aws-sdk/types": "3.609.0",
     "eslint-config-custom": "*",
     "tsconfig": "*",
-    "typescript": "^5.1.6"
+    "typescript": "^5.4.5"
   }
-}
+}

package/src/graph.ts

@@ -1,4 +1,4 @@
-import { BaseState } from "./scan";
+import type { BaseState } from "./scan";
 
 /**
  * A node returned from a state selector before its been formatted for a graphing library
@@ -24,9 +24,9 @@ export interface SelectedEdge {
 }
 
 // Create Read/Write types inspired by kysely
-export type ElementType<ReadType, WriteType> = {
-  readonly _read: ReadType;
-  readonly _write: WriteType;
+export type ElementType<RType, WType> = {
+  readonly _read: RType;
+  readonly _write: WType;
 };
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -56,18 +56,6 @@ export interface Node extends BaseState<unknown> {
   outgoingEdges: ElementRecord<string, Edge, string>;
 }
 
-export interface NodeOld {
-  id: string;
-  name: string;
-  metadata: Record<string, unknown>;
-  service?: string;
-  type?: string;
-  parent?: ElementType<Node, string>;
-  children?: ElementRecord<string, Node, string>;
-  incomingEdges: ElementRecord<string, Edge, string>;
-  outgoingEdges: ElementRecord<string, Edge, string>;
-}
-
 export interface Edge {
   id: string;
   name?: string;

package/src/plugins.ts

@@ -1,5 +1,5 @@
-import { Graph } from "./graph";
-import { AwsContext } from "./api";
+import type { Graph } from "./graph";
+import type { AwsContext } from "./api";
 
 // All supported events to trigger a plugin
 export type GraphPluginEvents =

package/src/scan.ts

@@ -1,4 +1,4 @@
-import { AwsContext, Connector } from "./api";
+import type { AwsContext, Connector } from "./api";
 
 export interface CommandCallMetadata {
   account: string;
@@ -35,22 +35,36 @@ export interface Coordinates {
   z?: number;
 }
 
+/**
+ * Indicates how the node should be consumed.
+ *
+ * - Informational nodes are not likely to be useful when rendered, but may include useful insights for infrastructure comprehension. Informational nodes are unlikely to have edges.
+ * - Visual nodes should be considered a superset of informational nodes - they convey information and can be rendered in an obvious way.
+ */
+export type NodeClass = "informational" | "visual";
+
 /**
  * Details about the nodes position in the graph and how it relates to other components
  */
 export interface GraphInfo {
   /**
    * The unique ID of the node in the graph
+   * @deprecated Use Resource.id instead
    */
   id: string;
   /**
    * The human readable name of the node in the graph
+   * @deprecated Use Resource.name instead
    */
   label: string;
   /**
    * The type of the node, used for assigning an icon in the graph
    */
   nodeType: string;
+  /**
+   * Indicates if the node is intended to be rendered or used for infrastructure comprehension.
+   */
+  nodeClass: NodeClass;
   /**
    * The ID of the parent node, optional.
    */
@@ -155,6 +169,57 @@ export interface DNS {
 
 export type PublicIpStatus = "enabled" | "disabled";
 
+export type AddressFamily = "ipv4" | "ipv6";
+
+export interface ReservedAddresses {
+  family: AddressFamily;
+  cidrBlock: string;
+  cidrBlockAssociationSets?: [
+    {
+      associationId: string;
+      cidrBlock: string;
+      state: string;
+      stateMessage: string;
+    },
+  ];
+  firstAddress?: string;
+  lastAddress?: string;
+}
+
+export interface IpRange {
+  family?: AddressFamily;
+  cidrBlock?: string;
+  description?: string;
+}
+
+export interface ReferencedAwsSecurityGroup {
+  description?: string;
+  securityGroupId?: string;
+  securityGroupName?: string;
+  referencedAccountId?: string;
+  referencedVpcId?: string;
+  vpcPeeringStatus?: string;
+  vpcPeeringConnectionId?: string;
+}
+
+export interface PrefixLists {
+  description?: string;
+  prefixListId?: string;
+}
+
+export interface AwsNetworkingRules {
+  referencedSecurityGroups?: ReferencedAwsSecurityGroup[];
+  prefixLists?: PrefixLists[];
+}
+
+export interface NetworkRule {
+  fromPort?: number;
+  toPort?: number;
+  protocol?: string;
+  permittedIpRanges?: IpRange[];
+  awsConfig?: AwsNetworkingRules;
+}
+
 /**
  * The network information for a scanned resource which aims to cover both resources being assigned an address
  * and the networking resource itself (VPC, subnet)
@@ -185,26 +250,12 @@ export interface Network {
   /**
    * The IP ranges reserved for a networking resource (VPC, subnet)
    */
-  reservedAddresses?: [
-    {
-      family: "ipv4" | "ipv6";
-      cidrBlock: string;
-      cidrBlockAssociationSets?: [
-        {
-          associationId: string;
-          cidrBlock: string;
-          state: string;
-          stateMessage: string;
-        },
-      ];
-      firstAddress: string;
-      lastAddress: string;
-    },
-  ];
+  reservedAddresses?: ReservedAddresses[];
   /**
    * The information relating to a specific subnet
    */
   subnet?: {
+    state?: string;
     ipv6Only?: boolean;
     availableAddressCount?: number;
   };
@@ -223,6 +274,7 @@ export interface Network {
     interfaceId?: string;
     macAddress?: string;
   };
+  rules?: NetworkRule[];
 }
 
 /**

package/tsconfig.json

@@ -3,6 +3,7 @@
   "compilerOptions": {
     "baseUrl": "src",
     "noEmit": true,
-    "module": "Node16"
+    "module": "Node16",
+    "verbatimModuleSyntax": true
   }
 }

package/.eslintrc.js

@@ -1,9 +0,0 @@
-module.exports = {
-  extends: ["custom"],
-  root: true,
-  parserOptions: {
-    project: "./tsconfig.json",
-    tsconfigRootDir: __dirname
-  },
-  ignorePatterns: [".eslintrc.js"]
-}

package/typedoc.json

@@ -1,4 +0,0 @@
-{
-  "extends": ["../../typedoc.base.json"],
-  "entryPoints": ["src/index.ts"],
-}