@infrascan/fs-connector 0.2.1 → 0.2.3

package/README.md

@@ -2,19 +2,37 @@
 
 Infrascan connectors act as the plumbing between the Infrascan SDK and wherever you persist your scan state.
 
-The FS connector uses the local filesystem. This library exposes a single builder function which takes a base path to use as the directory. 
+The Fs connector uses the local filesystem. This library exposes a single builder function which takes a base path to use as the directory. 
 
 All state files are written into the directory in the format: `<account>-<region>-<service>-<function>.json`.
 
 ## Quickstart
 
 ```js
+import Infrascan from "@infrascan/sdk";
 import buildFsConnector from "@infrascan/fs-connector";
-import { performScan } from "@infrascan/sdk";
+import { registerAwsScanners } from "@infrascan/aws";
 import { fromIni } from "@aws-sdk/credential-providers";
 
+const credentials = fromIni({ profile: "dev" });
+const regions = ["us-east-1","us-west-1"];
+const services = ["SNS","Lambda","S3"];
+
 const connector = buildFsConnector('state');
+const infrascan = registerAwsScanners(new Infrascan());
 
-const credentials = fromIni({ profile: "dev" });
-await performScan(credentials, connector);
+infrascan.performScan(
+  credentials,
+  connector
+).then(function (scanMetadata) {
+  console.log("Scan Complete!", scanMetadata);
+  return infrascan.generateGraph(
+    scanMetadata,
+    connector
+  );
+}).then(function (graphData) {
+  console.log("Graph generated!", graphData);
+}).catch(function (err) {
+  console.error("Failed to scan", err);
+});
 ```

package/dist/index.d.mts

@@ -0,0 +1,26 @@
+import { Connector } from '@infrascan/shared-types';
+
+/**
+ * Config for the file system resolver.
+ */
+type FsResolverConfig = {
+    /**
+     * Pretty print state when writing to the fs.
+     */
+    prettyPrint?: boolean;
+    /**
+     * Force creation of the target directory. Note: this will enable recursive creation.
+     */
+    createTargetDirectory?: boolean;
+};
+declare const DEFAULT_CONFIG: Required<FsResolverConfig>;
+/**
+ * Connector to store state in the local file system
+ * @param {string} basePath Directory to store Infrascan scan and graph state in
+ * @param {FsResolverConfig} config Configuration for the FS Connector
+ * @returns {Connector} Infrascan Connector
+ * @throws {Error} Errors from readDir, and readFile calls.
+ */
+declare function buildFsConnector(basePath: string, config?: FsResolverConfig): Connector;
+
+export { DEFAULT_CONFIG, FsResolverConfig, buildFsConnector as default };

package/dist/index.d.ts

@@ -0,0 +1,26 @@
+import { Connector } from '@infrascan/shared-types';
+
+/**
+ * Config for the file system resolver.
+ */
+type FsResolverConfig = {
+    /**
+     * Pretty print state when writing to the fs.
+     */
+    prettyPrint?: boolean;
+    /**
+     * Force creation of the target directory. Note: this will enable recursive creation.
+     */
+    createTargetDirectory?: boolean;
+};
+declare const DEFAULT_CONFIG: Required<FsResolverConfig>;
+/**
+ * Connector to store state in the local file system
+ * @param {string} basePath Directory to store Infrascan scan and graph state in
+ * @param {FsResolverConfig} config Configuration for the FS Connector
+ * @returns {Connector} Infrascan Connector
+ * @throws {Error} Errors from readDir, and readFile calls.
+ */
+declare function buildFsConnector(basePath: string, config?: FsResolverConfig): Connector;
+
+export { DEFAULT_CONFIG, FsResolverConfig, buildFsConnector as default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@infrascan/fs-connector",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "Connector for the Infrascan SDK to read and write state to the local filesystem",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -25,6 +25,7 @@
     "clean": true,
     "cjsInterop": true,
     "splitting": false,
+    "dts": true,
     "entry": [
       "index.ts"
     ],
@@ -34,11 +35,17 @@
     ],
     "target": "node18"
   },
-  "keywords": [],
+  "keywords": [
+    "AWS",
+    "Infrastructure Diagram",
+    "Infrastructure Graph",
+    "Cloud Infrastructure",
+    "Connector"
+  ],
   "author": "Liam Farrelly <liam@l3f7.dev> (https://whoisli.am/)",
   "license": "MPL-2.0",
   "devDependencies": {
-    "@infrascan/shared-types": "^0.2.1",
+    "@infrascan/shared-types": "^0.2.2",
     "eslint-config-custom": "*",
     "tsconfig": "*",
     "typescript": "^5.1.6"