@google-cloud/navconnect 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,115 @@
+[//]: # "This README.md file is auto-generated, all changes to this file will be lost."
+[//]: # "The comments you see below are used to generate those parts of the template in later states."
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# [Navigation Connect API: Nodejs Client][homepage]
+
+This library is considered to be in **preview**. This means it is still a
+work-in-progress and under active development. Any release is subject to
+backwards-incompatible changes at any time.
+
+[![npm version](https://img.shields.io/npm/v/@google-cloud/navconnect.svg)](https://www.npmjs.org/package/@google-cloud/navconnect)
+
+Navigation Connect API client for Node.js
+
+[//]: # "partials.introduction"
+
+A comprehensive list of changes in each version may be found in
+[the CHANGELOG][homepage_changelog].
+
+* [Navigation Connect API Nodejs Client API Reference](https://cloud.google.com/nodejs/docs/reference/navconnect/latest)
+* [Navigation Connect API Documentation](https://developers.google.com/maps/documentation/mobility/navigationconnect)
+
+Read more about the client libraries for Cloud APIs, including the older
+Google APIs Client Libraries, in [Client Libraries Explained][explained].
+
+[explained]: https://cloud.google.com/apis/docs/client-libraries-explained
+
+**Table of contents:**
+
+* [Quickstart](#quickstart)
+  * [Before you begin](#before-you-begin)
+  * [Installing the client library](#installing-the-client-library)
+
+* [Versioning](#versioning)
+* [Contributing](#contributing)
+* [License](#license)
+
+## Quickstart
+### Before you begin
+
+1.  [Select or create a Cloud Platform project][projects].
+1.  [Enable billing for your project][billing].
+1.  [Enable the Navigation Connect API API][enable_api].
+1.  [Set up authentication][auth] so you can access the
+    API from your local workstation.
+### Installing the client library
+
+```bash
+npm install @google-cloud/navconnect
+```
+
+[//]: # "partials.body"
+
+## Samples
+
+Samples are in the [`samples/`][homepage_samples] directory. Each sample's `README.md` has instructions for running its sample.
+
+| Sample                      | Source Code                       |
+| --------------------------- | --------------------------------- |
+| create trip | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-navconnect/samples/generated/v1/nav_connect_service.create_trip.js) |
+| get trip | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-navconnect/samples/generated/v1/nav_connect_service.get_trip.js) |
+| maps | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-navconnect/samples/generated/v1/snippet_metadata_google.maps.navconnect.v1.json) |
+
+
+## Supported Node.js Versions
+
+Our client libraries follow the [Node.js release schedule](https://github.com/nodejs/release#release-schedule).
+Libraries are compatible with all current _active_ and _maintenance_ versions of
+Node.js.
+If you are using an end-of-life version of Node.js, we recommend that you update
+as soon as possible to an actively supported LTS version.
+
+Google's client libraries support legacy versions of Node.js runtimes on a
+best-efforts basis with the following warnings:
+
+* Legacy versions are not tested in continuous integration.
+* Some security patches and features cannot be backported.
+* Dependencies cannot be kept up-to-date.
+
+Client libraries targeting some end-of-life versions of Node.js are available, and
+can be installed through npm [dist-tags](https://docs.npmjs.com/cli/dist-tag).
+The dist-tags follow the naming convention `legacy-(version)`.
+For example, `npm install @google-cloud/navconnect@legacy-8` installs client libraries
+for versions compatible with Node.js 8.
+
+## Versioning
+
+This library follows [Semantic Versioning](http://semver.org/).
+
+More Information: [Google Cloud Platform Launch Stages][launch_stages]
+
+[launch_stages]: https://cloud.google.com/terms/launch-stages
+
+## Contributing
+
+Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-navconnect/CONTRIBUTING.md).
+
+Please note that this `README.md`
+and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`)
+are generated from a central template.
+
+## License
+
+Apache Version 2.0
+
+See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-navconnect/LICENSE)
+
+[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
+[projects]: https://console.cloud.google.com/project
+[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
+[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=navigationconnect.googleapis.com
+[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local
+[homepage_samples]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-navconnect/samples
+[homepage_changelog]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-navconnect/CHANGELOG.md
+[homepage]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-navconnect

package/build/protos/google/maps/navconnect/v1/navconnect_service.proto

@@ -0,0 +1,263 @@
+// Copyright 2026 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.maps.navconnect.v1;
+
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/field_info.proto";
+import "google/api/resource.proto";
+import "google/protobuf/duration.proto";
+import "google/protobuf/field_mask.proto";
+import "google/protobuf/timestamp.proto";
+import "google/type/latlng.proto";
+
+option go_package = "cloud.google.com/go/maps/navconnect/apiv1/navconnectpb;navconnectpb";
+option java_multiple_files = true;
+option java_outer_classname = "NavConnectServiceProto";
+option java_package = "com.google.maps.navconnect.v1";
+
+// Service for NavConnect clients to create and get trips.
+service NavConnectService {
+  option (google.api.default_host) = "navigationconnect.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/cloud-platform";
+
+  // Creates a trip. This must be called before the mobile application can start
+  // the trip. The returned trip will have the `auth_token` field set.
+  rpc CreateTrip(CreateTripRequest) returns (Trip) {
+    option (google.api.http) = {
+      post: "/v1/{parent=projects/*}/trips"
+      body: "trip"
+    };
+    option (google.api.method_signature) = "parent,trip,trip_id";
+  }
+
+  // Gets a trip.
+  rpc GetTrip(GetTripRequest) returns (Trip) {
+    option (google.api.http) = {
+      get: "/v1/{name=projects/*/trips/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+}
+
+// A trip.
+message Trip {
+  option (google.api.resource) = {
+    type: "navconnect.googleapis.com/Trip"
+    pattern: "projects/{project}/trips/{trip}"
+    plural: "trips"
+    singular: "trip"
+  };
+
+  // All possible trip states.
+  enum State {
+    // The trip state is unspecified.
+    STATE_UNSPECIFIED = 0;
+
+    // The trip was created but has not yet started.
+    NEW = 1;
+
+    // The transporter is enroute to the destination.
+    ENROUTE = 2;
+
+    // The transporter arrived at the destination.
+    ARRIVED = 3;
+
+    // The trip was suspended.
+    SUSPENDED = 4;
+
+    // The trip failed to complete successfully.
+    FAILED = 5;
+
+    // The trip failed due to a client error.
+    CLIENT_ERROR = 6;
+  }
+
+  // Output only. Identifier. The resource name of the trip.
+  // Format: projects/{project_number}/trips/{trip_id}.
+  string name = 1 [
+    (google.api.field_behavior) = OUTPUT_ONLY,
+    (google.api.field_behavior) = IDENTIFIER
+  ];
+
+  // Immutable. The configuration for the trip.
+  TripConfig config = 7 [(google.api.field_behavior) = IMMUTABLE];
+
+  // Input only. Immutable. The Android application ID of the mobile application
+  // that will use the trip. At least one of `android_app_id` or `ios_app_id`
+  // must be set.
+  string android_app_id = 8 [
+    (google.api.field_behavior) = INPUT_ONLY,
+    (google.api.field_behavior) = IMMUTABLE
+  ];
+
+  // Input only. Immutable. The iOS bundle ID of the mobile application that
+  // will use the trip. At least one of `android_app_id` or `ios_app_id` must be
+  // set.
+  string ios_app_id = 9 [
+    (google.api.field_behavior) = INPUT_ONLY,
+    (google.api.field_behavior) = IMMUTABLE
+  ];
+
+  // Output only. An opaque token that authorizes access to begin a NavConnect
+  // trip in Google Maps or Waze and grants these applications access to update
+  // the trip. Only returned by `CreateTrip`.
+  AuthToken auth_token = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The Trip state.
+  State state = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The latest data about the execution of the trip. This may not
+  // be set if the trip is in an error state.
+  TripExecution execution = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Time according to the server when the trip was created.
+  google.protobuf.Timestamp create_time = 5
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Time at which the server received the latest trip update.
+  google.protobuf.Timestamp update_time = 6
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Configuration for the trip.
+message TripConfig {
+  // Optional. Whether to enable high frequency trip updates.
+  //
+  // NOTE: Enabling this feature logs the trip under Enterprise Tier usage, and
+  // is subject to Enterprise Tier rates.
+  bool enable_high_frequency_updates = 1
+      [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Whether to enable pubsub notifications for the trip.
+  bool enable_pubsub = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. If set, only the specified subset of the Trip fields will be
+  // included in the pubsub notifications.
+  //
+  // If not set, all Trip fields will be included in the pubsub notifications
+  // (default behavior).
+  //
+  // The following fields are not supported:
+  //
+  // * `android_app_id`
+  // * `ios_app_id`
+  // * `auth_token`
+  // * `config`
+  //
+  // NOTE: This field is ignored if `enable_pubsub` is false.
+  google.protobuf.FieldMask pubsub_field_mask = 3
+      [(google.api.field_behavior) = OPTIONAL];
+}
+
+// An authentication token.
+message AuthToken {
+  // Output only. The authentication token that should be passed to the mobile
+  // application.
+  string token = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Time at which the authentication token will expire.
+  google.protobuf.Timestamp expire_time = 2
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Data about the execution of the trip.
+message TripExecution {
+  // Output only. Origin of the trip which is generally the transporter's
+  // location at start of the NavConnect trip.
+  Location origin = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The destination of the trip as reported by the mobile
+  // application.
+  Stop destination = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The location signal representing the last known location of
+  // the transporter. This will be the road snapped location if available.
+  Location location = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Time traveled thus far.
+  google.protobuf.Duration traveled_duration = 4
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Time left on this trip as estimated by Google.
+  google.protobuf.Duration remaining_duration = 5
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Distance traveled from the origin in meters.
+  optional int32 traveled_distance_meters = 6
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Distance remaining to the destination in meters.
+  optional int32 remaining_distance_meters = 7
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Indicates whether a stop was added along the route.
+  optional bool stop_added_in_route = 8
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// A stop in the trip where some task is to be performed.
+message Stop {
+  // Required. The location of the stop as a lat/lng.
+  google.type.LatLng point = 1 [(google.api.field_behavior) = REQUIRED];
+}
+
+// A location as reported by the mobile application.
+message Location {
+  // Output only. The location lat/lng.
+  google.type.LatLng point = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The time when the location was sourced as denoted by the
+  // client.
+  google.protobuf.Timestamp source_time = 2
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The time at which the server received this location update.
+  google.protobuf.Timestamp server_time = 3
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Request message for NavConnectService.CreateTrip.
+message CreateTripRequest {
+  // Required. The parent resource under which this trip will be created.
+  // Format: projects/{project_number}
+  string parent = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The ID to use for the trip, which will become the final component
+  // of the trip's resource name.
+  //
+  // This value must be a valid RFC-4122 UUID.
+  string trip_id = 2 [
+    (google.api.field_info).format = UUID4,
+    (google.api.field_behavior) = REQUIRED
+  ];
+
+  // Required. The trip to create.
+  Trip trip = 3 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request message for NavConnectService.GetTrip.
+message GetTripRequest {
+  // Required. The resource name of the trip to get.
+  // Format: projects/{project}/trips/{trip_id}
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = { type: "navconnect.googleapis.com/Trip" }
+  ];
+}