Merge pull request #102 from miroapp/chore/types-in-package

Added types for module

.changeset/tasty-spies-fetch.md

@@ -0,0 +1,5 @@
+---
+"@mirohq/cloud-data-import": patch
+---
+
+Added types for module

package.json

@@ -2,13 +2,20 @@
 	"name": "@mirohq/cloud-data-import",
 	"version": "0.4.0",
 	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"module": "dist/esm/index.js",
+	"files": [
+		"dist",
+		"dist/esm"
+	],
 	"bin": {
 		"cloud-data-import": "./dist/cli.js"
 	},
 	"exports": {
 		".": {
 			"require": "./dist/index.js",
-			"import": "./dist/esm/index.js"
+			"import": "./dist/esm/index.js",
+			"types": "./dist/index.d.ts"
 		}
 	},
 	"publishConfig": {
@@ -25,8 +32,8 @@
 		"lint:fix": "eslint . --fix",
 		"format": "prettier --write \"**/*.{js,ts,json,md}\"",
 		"prepare": "husky",
-		"build:cjs": "tsc -p tsconfig.build.json && tsc-alias",
-		"build:esm": "tsc -p tsconfig.esm.json && tsc-alias",
+		"build:cjs": "tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json",
+		"build:esm": "tsc -p tsconfig.esm.json && tsc-alias -p tsconfig.esm.json",
 		"build": "npm run build:cjs && npm run build:esm",
 		"release": "npm run build && changeset publish",
 		"dev:setup": "npm install && npm run build && npm link",

src/lib/index.ts

@@ -1,5 +1,7 @@
 import {createRateLimiter, getAwsScanners} from '@/scanners'
 
+export type {GetAwsScannersArguments} from '@/scanners'
+
 /**
  * @public
  * @experimental This export is experimental and may change or be removed in future versions.

src/scanners/getAwsScanners.ts

@@ -38,10 +38,10 @@ import {getEC2VpnGateways} from './scan-functions/aws/ec2-vpn-gateways'
 import {getEC2NetworkInterfaces} from './scan-functions/aws/ec2-network-interfaces'
 import {getAthenaNamedQueries} from './scan-functions/aws/athena-named-queries'
 
-interface GetAwsScannersArguments {
-	credentials: Credentials
+export interface GetAwsScannersArguments {
+	credentials?: Credentials
 	getRateLimiter: GetRateLimiterFunction
-	hooks: ScannerLifecycleHook[]
+	hooks?: ScannerLifecycleHook[]
 	regions: string[]
 	shouldIncludeGlobalServices: boolean
 }
@@ -56,7 +56,7 @@ export const getAwsScanners = ({
 	const options = {
 		credentials,
 		getRateLimiter,
-		hooks,
+		hooks: hooks || [],
 	}
 
 	/**

src/scanners/index.ts

@@ -2,3 +2,4 @@ export {RateLimiter, createRateLimiter} from './common/RateLimiter'
 export {createGlobalScanner} from './common/createGlobalScanner'
 export {createRegionalScanner} from './common/createRegionalScanner'
 export {getAwsScanners} from './getAwsScanners'
+export type {GetAwsScannersArguments} from './getAwsScanners'

tsconfig.build.json

@@ -4,7 +4,9 @@
 		"rootDir": "./src",
 		"outDir": "./dist",
 		"module": "commonjs",
-		"target": "es2016"
+		"target": "es2016",
+		"declaration": true,
+		"declarationMap": true
 	},
 	"exclude": ["tests"]
 }

tsconfig.esm.json

@@ -5,7 +5,9 @@
 		"outDir": "./dist/esm",
 		"moduleResolution": "node",
 		"module": "esnext",
-		"target": "esnext"
+		"target": "esnext",
+		"declaration": true,
+		"declarationMap": true
 	},
 	"exclude": ["tests"]
 }