@googlemaps/extended-component-library - npm Package Compare versions

Comparing version 0.1.3 to 0.1.4

package.json

 {
   "name": "@googlemaps/extended-component-library",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "Web Components for building rich experiences with the Google Maps JavaScript API.",
@@ -15,2 +15,4 @@ "license": "Apache-2.0",
   "scripts": {
+    "cem": "wireit",
+    "docs": "wireit",
     "build": "wireit",
@@ -20,36 +22,30 @@ "build:ts": "wireit",
     "build:bundle": "wireit",
-    "test": "wireit",
-    "docs": "wireit"
+    "test": "wireit"
   },
   "type": "module",
   "files": [
-    "**/*.js",
-    "**/*.js.map",
-    "**/*.d.ts",
-    "!web-test-runner.config.js",
-    "!custom-elements-manifest.config.js",
-    "!build/*",
-    "!testing/*",
-    "!**/*_test.*",
-    "!.wireit/**",
-    "!**/doc_src/*"
+    "dist",
+    "lib",
+    "!lib/cdn_index.*",
+    "!lib/testing/*",
+    "!lib/**/*_test.*"
   ],
   "exports": {
-    "./api_loader.js": "./api_loader/api_loader.js",
-    "./icon_button.js": "./icon_button/icon_button.js",
-    "./overlay_layout.js": "./overlay_layout/overlay_layout.js",
-    "./place_building_blocks/place_attribution.js": "./place_building_blocks/place_attribution/place_attribution.js",
-    "./place_building_blocks/place_data_provider.js": "./place_building_blocks/place_data_provider/place_data_provider.js",
-    "./place_building_blocks/place_directions_button.js": "./place_building_blocks/place_directions_button/place_directions_button.js",
-    "./place_building_blocks/place_field_boolean.js": "./place_building_blocks/place_field_boolean/place_field_boolean.js",
-    "./place_building_blocks/place_field_link.js": "./place_building_blocks/place_field_link/place_field_link.js",
-    "./place_building_blocks/place_field_text.js": "./place_building_blocks/place_field_text/place_field_text.js",
-    "./place_building_blocks/place_opening_hours.js": "./place_building_blocks/place_opening_hours/place_opening_hours.js",
-    "./place_building_blocks/place_photo_gallery.js": "./place_building_blocks/place_photo_gallery/place_photo_gallery.js",
-    "./place_building_blocks/place_price_level.js": "./place_building_blocks/place_price_level/place_price_level.js",
-    "./place_building_blocks/place_rating.js": "./place_building_blocks/place_rating/place_rating.js",
-    "./place_building_blocks/place_reviews.js": "./place_building_blocks/place_reviews/place_reviews.js",
-    "./place_overview.js": "./place_overview/place_overview.js",
-    "./place_picker.js": "./place_picker/place_picker.js",
-    "./split_layout.js": "./split_layout/split_layout.js"
+    "./api_loader.js": "./lib/api_loader/api_loader.js",
+    "./icon_button.js": "./lib/icon_button/icon_button.js",
+    "./overlay_layout.js": "./lib/overlay_layout/overlay_layout.js",
+    "./place_building_blocks/place_attribution.js": "./lib/place_building_blocks/place_attribution/place_attribution.js",
+    "./place_building_blocks/place_data_provider.js": "./lib/place_building_blocks/place_data_provider/place_data_provider.js",
+    "./place_building_blocks/place_directions_button.js": "./lib/place_building_blocks/place_directions_button/place_directions_button.js",
+    "./place_building_blocks/place_field_boolean.js": "./lib/place_building_blocks/place_field_boolean/place_field_boolean.js",
+    "./place_building_blocks/place_field_link.js": "./lib/place_building_blocks/place_field_link/place_field_link.js",
+    "./place_building_blocks/place_field_text.js": "./lib/place_building_blocks/place_field_text/place_field_text.js",
+    "./place_building_blocks/place_opening_hours.js": "./lib/place_building_blocks/place_opening_hours/place_opening_hours.js",
+    "./place_building_blocks/place_photo_gallery.js": "./lib/place_building_blocks/place_photo_gallery/place_photo_gallery.js",
+    "./place_building_blocks/place_price_level.js": "./lib/place_building_blocks/place_price_level/place_price_level.js",
+    "./place_building_blocks/place_rating.js": "./lib/place_building_blocks/place_rating/place_rating.js",
+    "./place_building_blocks/place_reviews.js": "./lib/place_building_blocks/place_reviews/place_reviews.js",
+    "./place_overview.js": "./lib/place_overview/place_overview.js",
+    "./place_picker.js": "./lib/place_picker/place_picker.js",
+    "./split_layout.js": "./lib/split_layout/split_layout.js"
   },
@@ -83,2 +79,29 @@ "unpkg": "dist/index.min.js",
   "wireit": {
+    "cem": {
+      "command": "cem analyze --litelement --globs \"src/**/*.ts\" --exclude \"**/*_test.ts\" --exclude \"src/testing/*.ts\"",
+      "files": [
+        "src/**/*.ts",
+        "custom-elements-manifest.config.js",
+        "!**/*.d.ts",
+        "!**/*_test.ts",
+        "!src/testing/*.ts"
+      ],
+      "output": [
+        "custom-elements.json"
+      ]
+    },
+    "docs": {
+      "command": "node build/make_docs.js",
+      "dependencies": [
+        "cem"
+      ],
+      "files": [
+        "**/doc_src/*",
+        "build/make_docs.js",
+        "custom-elements.json"
+      ],
+      "output": [
+        "**/README.md"
+      ]
+    },
     "build": {
@@ -90,16 +113,10 @@ "dependencies": [
     "build:ts": {
-      "command": "tsc --pretty",
+      "command": "tsc --pretty --rootDir \"src\" --outDir \"lib\"",
       "files": [
         "tsconfig.json",
-        "**/*.ts",
-        "!**/*.d.ts"
+        "src/**/*.ts"
       ],
       "output": [
         ".tsbuildinfo",
-        "**/*.js",
-        "**/*.js.map",
-        "**/*.d.ts",
-        "!*.js",
-        "!types/",
-        "!build/rollup.config.js"
+        "lib/**/*"
       ],
@@ -115,7 +132,7 @@ "clean": "if-file-deleted"
         "build/finalize_package.sh",
-        "base/constants.js"
+        "lib/base/constants.js"
       ],
       "output": [
-        "**/*.js",
-        "**/*.md"
+        "lib/**/*.js",
+        "lib/**/*.md"
       ],
@@ -131,6 +148,6 @@ "clean": false
         "build/rollup.config.js",
-        "**/*.js"
+        "lib/**/*.js"
       ],
       "output": [
-        "dist/**/*"
+        "dist/index.min.js"
       ]
@@ -147,18 +164,4 @@ },
       "output": []
-    },
-    "docs": {
-      "command": "cem analyze --litelement --globs \"**/*.ts\" --exclude \"**/*_test.ts\"",
-      "files": [
-        "**/*.ts",
-        "**/doc_src/*",
-        "custom-elements-manifest.config.js",
-        "!**/*.d.ts",
-        "!**/*_test.ts"
-      ],
-      "output": [
-        "**/README.md",
-        "custom-elements.json"
-      ]
     }
   }
 }

README.md

@@ -40,3 +40,3 @@ # Extended Component Library
 
-The components in this library make use of Google Maps Platform APIs. To start, you'll need to [sign up for Google Maps Platform and create an API key](https://console.cloud.google.com/google/maps-apis/start?utm_source=npm&utm_medium=documentation&utm_campaign=&utm_content=web_components). Then, place an API Loader element somewhere in the root of your app's HTML, specifying your API key:
+The components in this library make use of Google Maps Platform APIs. To start, you'll need to [sign up for Google Maps Platform and create an API key](https://console.cloud.google.com/google/maps-apis/start?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components). Then, place an API Loader element somewhere in the root of your app's HTML, specifying your API key:
 
@@ -103,20 +103,20 @@ ```html
 
-Map and marker components can be used with the Extended Component Library, or on their own. See the [guide](https://developers.google.com/maps/documentation/web-components/overview?utm_source=npm&utm_medium=documentation&utm_campaign=&utm_content=web_components) for more information on Web Components in the Maps JS SDK.
+Map and marker components can be used with the Extended Component Library, or on their own. See the [guide](https://developers.google.com/maps/documentation/web-components/overview?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components) for more information on Web Components in the Maps JS SDK.
 
 | Component               | Description                                    |
 | ----------------------- | ---------------------------------------------- |
-| [`<gmp-map>`](https://developers.google.com/maps/documentation/javascript/reference/map?utm_source=npm&utm_medium=documentation&utm_campaign=&utm_content=web_components#MapElement)             | The map component displays a map on a webpage, and can wrap other map-related components such as markers inside the map component in HTML. |
-| [`<gmp-advanced-marker>`](https://developers.google.com/maps/documentation/javascript/reference/advanced-markers?utm_source=npm&utm_medium=documentation&utm_campaign=&utm_content=web_components#AdvancedMarkerElement) | The marker component displays a pin on the map at specified coordinates. |
+| [`<gmp-map>`](https://developers.google.com/maps/documentation/javascript/reference/map?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components#MapElement)             | The map component displays a map on a webpage, and can wrap other map-related components such as markers inside the map component in HTML. |
+| [`<gmp-advanced-marker>`](https://developers.google.com/maps/documentation/javascript/reference/advanced-markers?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components#AdvancedMarkerElement) | The marker component displays a pin on the map at specified coordinates. |
 
 ## Inventory of components
 
-| Component                                                | Description                                                                                                                                                                                                                           |
-| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [`<gmpx-api-loader>`](api_loader/README.md)              | The API loader component loads the Google Maps Platform libraries necessary for Extended Components.                                                                                                                                  |
-| [`<gmpx-icon-button>`](icon_button/README.md)            | The icon button component is used for actions in the UI that help users get things done with a single tap. It contains an icon and a text label.                                                                                      |
-| [`<gmpx-overlay-layout>`](overlay_layout/README.md)      | The overlay layout component allows you to display information in a responsive panel view that sits on top of main content, like a map or a list. You might use this to show a modal dialog, more details about a place, or settings. |
-| [`<gmpx-place-overview>`](place_overview/README.md)      | The place overview component displays detailed information about millions of businesses, including opening hours, star reviews, and photos, plus directions and other actions in a premade UI in 5 sizes and formats.                 |
-| [`<gmpx-place-picker>`](place_picker/README.md)          | The place picker component is a text input that allows end users to search Google Maps’ global database for a specific address or place using autocomplete.                                                                           |
-| [`<gmpx-split-layout>`](split_layout/README.md)          | The split layout component allows you to display custom HTML information in a responsive panel view alongside main content. In a narrow container, such as a mobile viewport, the panel will be shown below the main content.         |
-| [Place building blocks](place_building_blocks/README.md) | The place data provider component, along with individual place details components, lets you choose how to display Google Maps place information like opening hours, star reviews, and photos in a new, custom view.                   |
+| Component                                                    | Description                                                                                                                                                                                                                           |
+| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [`<gmpx-api-loader>`](src/api_loader/README.md)              | The API loader component loads the Google Maps Platform libraries necessary for Extended Components.                                                                                                                                  |
+| [`<gmpx-icon-button>`](src/icon_button/README.md)            | The icon button component is used for actions in the UI that help users get things done with a single tap. It contains an icon and a text label.                                                                                      |
+| [`<gmpx-overlay-layout>`](src/overlay_layout/README.md)      | The overlay layout component allows you to display information in a responsive panel view that sits on top of main content, like a map or a list. You might use this to show a modal dialog, more details about a place, or settings. |
+| [`<gmpx-place-overview>`](src/place_overview/README.md)      | The place overview component displays detailed information about millions of businesses, including opening hours, star reviews, and photos, plus directions and other actions in a premade UI in 5 sizes and formats.                 |
+| [`<gmpx-place-picker>`](src/place_picker/README.md)          | The place picker component is a text input that allows end users to search Google Maps’ global database for a specific address or place using autocomplete.                                                                           |
+| [`<gmpx-split-layout>`](src/split_layout/README.md)          | The split layout component allows you to display custom HTML information in a responsive panel view alongside main content. In a narrow container, such as a mobile viewport, the panel will be shown below the main content.         |
+| [Place building blocks](src/place_building_blocks/README.md) | The place data provider component, along with individual place details components, lets you choose how to display Google Maps place information like opening hours, star reviews, and photos in a new, custom view.                   |
 
@@ -150,5 +150,5 @@ ## Styling and theming
 
-The Extended Component Library uses Google Maps Platform services, and any use of Google Maps Platform is subject to the [Terms of Service](https://cloud.google.com/maps-platform/terms?utm_source=npm&utm_medium=documentation&utm_campaign=&utm_content=web_components).
+This library uses Google Maps Platform services, and any use of Google Maps Platform is subject to the [Terms of Service](https://cloud.google.com/maps-platform/terms?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components).
 
-For clarity, the Extended Component Library, and each underlying component, is not a Google Maps Platform Core Service. 
+For clarity, this library, and each underlying component, is not a Google Maps Platform Core Service. 
 
@@ -161,6 +161,8 @@ ## Attribution
 
-This library is community supported, with sponsorship from Google to maintain and ensure a base level of quality. It is not governed by the Google Maps Platform [Technical Support Services Guidelines](https://cloud.google.com/maps-platform/terms/tssg?utm_source=npm&utm_medium=documentation&utm_campaign=&utm_content=web_components).
+This library is offered via an open source license. It is not governed by the Google Maps Platform [Technical Support Services Guidelines](https://cloud.google.com/maps-platform/terms/tssg?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components), the [SLA](https://cloud.google.com/maps-platform/terms/sla?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components), or the [Deprecation Policy](https://cloud.google.com/maps-platform/terms?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components) (however, any Google Maps Platform services used by the library remain subject to the Google Maps Platform Terms of Service).
 
-Google will make efforts to support the public and protected surface of the library and maintain backwards compatibility in the future; however, while the library is in version 0.x, Google reserves the right to make backwards-incompatible changes. If Google does remove some functionality (typically because better functionality exists or if the feature proved infeasible), the intention is to deprecate the functionality and give developers adequate time to update their code.
+This library adheres to [semantic versioning](https://semver.org/) to indicate when backwards-incompatible changes are introduced. Accordingly, while the library is in version 0.x, backwards-incompatible changes may be introduced at any time. 
 
+If you find a bug, or have a feature request, please file an issue on GitHub. If you would like to get answers to technical questions from other Google Maps Platform developers, ask through one of our [developer community channels](https://developers.google.com/maps/developer-community?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=web_components). If you'd like to contribute, please check the [Contributing guide](https://github.com/googlemaps/extended-component-library/blob/main/CONTRIBUTING.md) in the GitHub repository.
 
+

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

Found 14 instances in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

Found 15 instances in 1 package

Improved metrics

Total package byte prevSize

952079

increased by0.66%

Number of low license alerts

15

decreased by-6.25%

Lines of code

10624

increased by0.42%

Number of lines in readme file

165

increased by1.23%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes