@nora-soderlund/google-maps-solar-api - npm Package Compare versions

Comparing version 1.0.5 to 1.0.6

dist/index.d.ts

 export * from "./constants";
 export * from "./requests/getDataLayers";
-export * from "./requests/getTiff";
+export * from "./requests/getGeoTiff";
 export * from "./requests/findClosestBuildingInsights";
+export * from "./helpers/getDataLayersForBounds";
 export * from "./types/BuildingInsights";
@@ -6,0 +7,0 @@ export * from "./types/CashPurchaseSavings";

dist/index.js

@@ -19,4 +19,5 @@ "use strict";
 __exportStar(require("./requests/getDataLayers"), exports);
-__exportStar(require("./requests/getTiff"), exports);
+__exportStar(require("./requests/getGeoTiff"), exports);
 __exportStar(require("./requests/findClosestBuildingInsights"), exports);
+__exportStar(require("./helpers/getDataLayersForBounds"), exports);
 __exportStar(require("./types/BuildingInsights"), exports);
@@ -23,0 +24,0 @@ __exportStar(require("./types/CashPurchaseSavings"), exports);

package.json

 {
   "name": "@nora-soderlund/google-maps-solar-api",
   "description": "A TypeScript implementation of Google Maps Solar API endpoints.",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "main": "dist/index.js",
   "scripts": {
-    "build": "npx tsc"
+    "build": "npx tsc",
+    "test": "npx jest tests"
   },
   "devDependencies": {
+    "@jest/globals": "^29.7.0",
+    "@types/jest": "^29.5.5",
+    "ts-jest": "^29.1.1",
     "typescript": "^5.2.2"
@@ -15,3 +19,7 @@ },
     "url": "https://github.com/nora-soderlund/google-maps-solar-api"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "geolib": "^3.3.4"
   }
 }

README.md

@@ -54,7 +54,7 @@ # google-maps-solar-api
 
-https://nora-soderlund.se/articles/integrating-the-new-solar-api-in-google-maps
+https://nora-soderlund.com/articles/integrating-the-new-solar-api-in-google-maps
 
 Another example of visualizing potential solar panel placements in dynamic maps:
 
-https://nora-soderlund.se/articles/visualizing-potential-solar-panel-placements-in-google-maps
+https://nora-soderlund.com/articles/visualizing-potential-solar-panel-placements-in-google-maps
 
@@ -75,5 +75,26 @@ ## References
 
-#### `getTiff(apiKeyOrProxyUrl: string | URL, url: string): Promise<ArrayBuffer>`
+#### `getGeoTiff(apiKeyOrProxyUrl: string | URL, url: string): Promise<ArrayBuffer>`
 Returns a raw [ArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) object of the GeoTIFF file or throws a generic Error if the request failed.
 
 See [geoTiff.get](https://developers.google.com/maps/documentation/solar/reference/rest/v1/geoTiff/get) on the Solar API reference.
+
+### Helpers
+#### `getDataLayersForBounds(bounds: LatLngBox, pixelSizeMeters: number, paddingMeters: number = 0): DataLayerBounds`
+Used for getting a connected area coverage. Does not perform any asynchronous requests. Returns a [DataLayerBounds](#datalayerbounds) object. 
+
+#### `DataLayerBounds`
+##### `dataLayerView: DataLayerView;`
+The highest supported data layer view, for radius meters over 175m, the DataLayerView in the request must not include monthly flux or hourly shade.
+
+##### `tiles: LatLng[];`
+The tiles that make up the generated bounds, use with `radiusMetersPerTile`
+
+##### `radiusMetersPerTile: number;`
+The radius in meters for each tile.
+
+##### `bounds: LatLngBox;`
+The generated bounds for the new tiles.
+
+##### `horizontalTiles: number;`
+##### `verticalTiles: number;`
+The horizontal and vertical tiles count. 

src/constants.ts

 export const GOOGLE_MAPS_SOLAR_API_BASE = "https://solar.googleapis.com/";

src/index.ts

 export * from "./constants";
 
 export * from "./requests/getDataLayers";
-export * from "./requests/getTiff";
+export * from "./requests/getGeoTiff";
 export * from "./requests/findClosestBuildingInsights"
 
+export * from "./helpers/getDataLayersForBounds";
+
 export * from "./types/BuildingInsights";
@@ -8,0 +10,0 @@ export * from "./types/CashPurchaseSavings";

src/requests/findClosestBuildingInsights.ts

@@ -0,0 +0,0 @@ import { GOOGLE_MAPS_SOLAR_API_BASE } from "../constants";

src/requests/getDataLayers.ts

@@ -0,0 +0,0 @@ import { GOOGLE_MAPS_SOLAR_API_BASE } from "../constants";

src/types/BuildingInsights.ts

@@ -0,0 +0,0 @@ import { Date } from "./Date";

src/types/CashPurchaseSavings.ts

@@ -0,0 +0,0 @@ import { Money } from "./Money";

src/types/DataLayers.ts

@@ -0,0 +0,0 @@ import { Date } from "./Date";

src/types/DataLayerView.ts

@@ -0,0 +0,0 @@ export type DataLayerView =

src/types/Date.ts

@@ -0,0 +0,0 @@ export type Date = {

src/types/FinancedPurchaseSavings.ts

@@ -0,0 +0,0 @@ import { Money } from "./Money";

src/types/FinancialAnalysis.ts

@@ -0,0 +0,0 @@ import { CashPurchaseSavings } from "./CashPurchaseSavings";

src/types/FinancialDetails.ts

@@ -0,0 +0,0 @@ import { Money } from "./Money";

src/types/ImageryQuality.ts

@@ -0,0 +0,0 @@ export type ImageryQuality =

src/types/LatLng.ts

@@ -0,0 +0,0 @@ /**

src/types/LatLngBox.ts

@@ -0,0 +0,0 @@ import { LatLng } from "./LatLng";

src/types/LeasingSavings.ts

@@ -0,0 +0,0 @@ import { Money } from "./Money";

src/types/Money.ts

@@ -0,0 +0,0 @@ /**

src/types/RoofSegmentSizeAndSunshineStats.ts

@@ -0,0 +0,0 @@ import { LatLng } from "./LatLng";

src/types/RoofSegmentSummary.ts

@@ -0,0 +0,0 @@ /**

src/types/SavingsOverTime.ts

@@ -0,0 +0,0 @@ import { Money } from "./Money";

src/types/SizeAndSunshineStats.ts

@@ -0,0 +0,0 @@ /**

src/types/SolarPanel.ts

@@ -0,0 +0,0 @@ import { LatLng } from "./LatLng";

src/types/SolarPanelConfig.ts

@@ -0,0 +0,0 @@ import { RoofSegmentSummary } from "./RoofSegmentSummary";

src/types/SolarPanelOrientation.ts

@@ -0,0 +0,0 @@ /**

src/types/SolarPotential.ts

@@ -0,0 +0,0 @@ import { FinancialAnalysis } from "./FinancialAnalysis";

tsconfig.json

@@ -108,3 +108,4 @@ {
     "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
-  }
+  },
+  "exclude": [ "node_modules", "tests" ]
 }

Fixed alerts

No License Found

License

(Experimental) License information could not be found.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

106704

increased by6.53%

Number of package files

145

increased by5.84%

Number of low license alerts

0

decreased by-100%

Lines of code

1746

increased by6.66%

Number of lines in readme file

99

increased by26.92%

Worsened metrics

Dependency count

1

increased byInfinity%

Dev dependency count

4

increased by300%

Dependency changes

• + Addedgeolib@^3.3.4

• + Addedgeolib@3.3.4(transitive)