@infrascan/shared-types 0.2.0 → 0.2.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @infrascan/shared-types
 
+## 0.2.1
+
+### Patch Changes
+
+- [#36](https://github.com/infrascan/infrascan/pull/36) [`f7700f1`](https://github.com/infrascan/infrascan/commit/f7700f11568e413ba2ccefc990fc683bdfdeb01d) Thanks [@lfarrel6](https://github.com/lfarrel6)! - Simplify shared-types package - remove unneeded aws client dependencies. Patch downstream packages.
+
 ## 0.2.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@infrascan/shared-types",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Shared types for multiple infrascan packages",
   "main": "src/index.ts",
   "scripts": {
@@ -9,24 +9,6 @@
   "keywords": [],
   "author": "Liam Farrelly <liam@l3f7.dev> (https://whoisli.am/)",
   "license": "MPL-2.0",
-  "dependencies": {
-    "@aws-sdk/client-apigatewayv2": "3.428.0",
-    "@aws-sdk/client-auto-scaling": "3.428.0",
-    "@aws-sdk/client-cloudfront": "3.428.0",
-    "@aws-sdk/client-cloudwatch-logs": "3.428.0",
-    "@aws-sdk/client-dynamodb": "3.428.0",
-    "@aws-sdk/client-ec2": "3.428.0",
-    "@aws-sdk/client-ecs": "3.428.0",
-    "@aws-sdk/client-elastic-load-balancing-v2": "3.428.0",
-    "@aws-sdk/client-iam": "3.428.0",
-    "@aws-sdk/client-lambda": "3.428.0",
-    "@aws-sdk/client-rds": "3.428.0",
-    "@aws-sdk/client-route-53": "3.428.0",
-    "@aws-sdk/client-s3": "3.428.0",
-    "@aws-sdk/client-sns": "3.428.0",
-    "@aws-sdk/client-sqs": "3.428.0",
-    "@aws-sdk/client-sts": "3.428.0"
-  },
   "devDependencies": {
     "@aws-sdk/types": "3.428.0",
     "eslint-config-custom": "*",

package/src/api.ts

@@ -1,9 +1,7 @@
 import type { AwsCredentialIdentityProvider } from "@aws-sdk/types";
 
-import type { Service } from "./services";
-import type { BaseEdgeResolver } from "./config";
 import type { GraphEdge, GraphNode } from "./graph";
-
+import type { BaseEdgeResolver } from "./config";
 
 /**
  * Callback to store state from a specific function call
@@ -22,7 +20,7 @@ export type ServiceScanCompleteCallbackFn = (
   /**
    * The service being scanned
    */
-  service: Service | "IAM",
+  service: string,
   /**
    * The specific function called during scanning
    */
@@ -53,7 +51,7 @@ export type ResolveStateForServiceFunction = (
   /**
    * The scanned service e.g. Lambda
    */
-  service: Service,
+  service: string,
   /**
    * The specific function called during the scan e.g. GetFunction
    */
@@ -70,7 +68,7 @@ export interface Connector {
   onServiceScanCompleteCallback: ServiceScanCompleteCallbackFn;
   resolveStateForServiceFunction: ResolveStateForServiceFunction;
   getGlobalStateForServiceFunction: GetGlobalStateForServiceFunction;
-};
+}
 
 type ClientBuilder<T, P extends Provider> = (
   credentials: AwsCredentialIdentityProvider,
@@ -80,17 +78,16 @@ type ClientBuilder<T, P extends Provider> = (
 type GetterFn<T, P extends Provider> = (
   client: T,
   stateConnector: Connector,
-  context: ProviderContextMap[P]
+  context: ProviderContextMap[P],
 ) => Promise<void>;
 
 type GetNodeFn<T extends Provider> = (
   stateConnector: Connector,
-  context: ProviderContextMap[T]
+  context: ProviderContextMap[T],
 ) => Promise<GraphNode[]>;
 
 type GetEdgeFn = (stateConnector: Connector) => Promise<GraphEdge[]>;
 
-
 export type Provider = "aws";
 
 export type AwsContext = {
@@ -100,18 +97,21 @@ export type AwsContext = {
 };
 
 type ProviderContextMap = {
-  aws: AwsContext
-}
+  aws: AwsContext;
+};
 
 export type ProviderContext<T extends Provider> = {
   provider: T;
   context: ProviderContextMap[T];
 };
 
-type FormatNodeFn<P extends Provider> = (node: GraphNode, context: ProviderContextMap[P]) => GraphNode;
+type FormatNodeFn<P extends Provider> = (
+  node: GraphNode,
+  context: ProviderContextMap[P],
+) => GraphNode;
 type FormatEdgeFn<P extends Provider> = (
   node: GraphEdge,
-  context: ProviderContextMap[P]
+  context: ProviderContextMap[P],
 ) => GraphEdge;
 
 export type EntityRoleData = {
@@ -135,4 +135,4 @@ export interface ServiceModule<T, P extends Provider> {
   getEdges?: GetEdgeFn;
   formatEdge?: FormatEdgeFn<P>;
   getIamRoles?: GetIamRoleFn;
-};
+}

package/src/index.ts

@@ -1,18 +1,3 @@
-import {
-  GlobalServiceClients,
-  RegionalServiceClients,
-  ServiceClients,
-} from "./services";
-import type { GlobalService, RegionalService, Service } from "./services";
-
-export {
-  ServiceClients,
-  GlobalServiceClients,
-  RegionalServiceClients,
-  GlobalService,
-  RegionalService,
-  Service,
-};
 export * from "./api";
 export * from "./config";
 export * from "./graph";

package/src/services.ts

@@ -1,64 +0,0 @@
-import * as S3 from "@aws-sdk/client-s3";
-import * as CloudFront from "@aws-sdk/client-cloudfront";
-import * as Route53 from "@aws-sdk/client-route-53";
-
-import * as ApiGatewayV2 from "@aws-sdk/client-apigatewayv2";
-import * as AutoScaling from "@aws-sdk/client-auto-scaling";
-import * as CloudWatchLogs from "@aws-sdk/client-cloudwatch-logs";
-import * as DynamoDB from "@aws-sdk/client-dynamodb";
-import * as EC2 from "@aws-sdk/client-ec2";
-import * as ECS from "@aws-sdk/client-ecs";
-import * as ElasticLoadBalancingV2 from "@aws-sdk/client-elastic-load-balancing-v2";
-import * as Lambda from "@aws-sdk/client-lambda";
-import * as RDS from "@aws-sdk/client-rds";
-import * as SNS from "@aws-sdk/client-sns";
-import * as SQS from "@aws-sdk/client-sqs";
-
-/**
- * Clients for Global Services
- */
-export const GlobalServiceClients = {
-  S3,
-  CloudFront,
-  Route53,
-};
-
-/**
- * Clients for Regional Services
- */
-export const RegionalServiceClients = {
-  ApiGatewayV2,
-  AutoScaling,
-  CloudWatchLogs,
-  DynamoDB,
-  EC2,
-  ECS,
-  ElasticLoadBalancingV2,
-  Lambda,
-  RDS,
-  SNS,
-  SQS,
-};
-
-/**
- * Clients for every service
- */
-export const ServiceClients = {
-  ...GlobalServiceClients,
-  ...RegionalServiceClients,
-};
-
-/**
- * Type for Global Services
- */
-export type GlobalService = keyof typeof GlobalServiceClients;
-
-/**
- * Type for Regional Services
- */
-export type RegionalService = keyof typeof RegionalServiceClients;
-
-/**
- * Type for any support service
- */
-export type Service = GlobalService | RegionalService;