@infrascan/fs-connector 0.2.2 → 0.3.0

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, type 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, type FsResolverConfig, buildFsConnector as default };

package/dist/index.js

@@ -17,13 +17,13 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// index.ts
-var fs_connector_exports = {};
-__export(fs_connector_exports, {
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
   DEFAULT_CONFIG: () => DEFAULT_CONFIG,
   default: () => buildFsConnector
 });
-module.exports = __toCommonJS(fs_connector_exports);
+module.exports = __toCommonJS(index_exports);
 var import_fs = require("fs");
 var import_promises = require("fs/promises");
 var import_path = require("path");

package/dist/index.mjs

@@ -1,4 +1,4 @@
-// index.ts
+// src/index.ts
 import { existsSync } from "fs";
 import { mkdir, readFile, readdir, writeFile } from "fs/promises";
 import { join, resolve } from "path";

package/package.json

@@ -1,39 +1,26 @@
 {
   "name": "@infrascan/fs-connector",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "Connector for the Infrascan SDK to read and write state to the local filesystem",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
+  "source": "src/index.ts",
   "exports": {
     ".": {
       "require": "./dist/index.js",
-      "import": "./dist/index.mjs",
-      "types": "./dist/index.d.ts"
+      "import": "./dist/index.mjs"
     }
   },
   "files": [
     "dist"
   ],
   "scripts": {
-    "build": "rm -rf dist ; tsup",
-    "prepublish": "rm -rf dist ; tsup",
+    "build": "rm -rf dist ; tsup --config internal/tsconfig/tsup.json",
+    "prepublish": "rm -rf dist ; tsup --config internal/tsconfig/tsup.json",
     "lint": "tsc --noEmit ; eslint .",
     "clean": "rm -rf dist node_modules"
   },
-  "tsup": {
-    "clean": true,
-    "cjsInterop": true,
-    "splitting": false,
-    "entry": [
-      "index.ts"
-    ],
-    "format": [
-      "esm",
-      "cjs"
-    ],
-    "target": "node18"
-  },
   "keywords": [
     "AWS",
     "Infrastructure Diagram",
@@ -44,7 +31,7 @@
   "author": "Liam Farrelly <liam@l3f7.dev> (https://whoisli.am/)",
   "license": "MPL-2.0",
   "devDependencies": {
-    "@infrascan/shared-types": "^0.2.2",
+    "@infrascan/shared-types": "^0.6.0",
     "eslint-config-custom": "*",
     "tsconfig": "*",
     "typescript": "^5.1.6"