vscode-apollo 2.5.6 → 2.6.0

package/sampleWorkspace/connectors-community/connectors/bored/supergraph.yaml

@@ -0,0 +1,6 @@
+subgraphs:
+  bored:
+    routing_url: http://localhost:4000
+    schema:
+      file: bored.graphql
+federation_version: =2.11.0

package/sampleWorkspace/connectors-community/connectors/common-room/README.md

@@ -0,0 +1,23 @@
+# Common Room REST Connector
+
+This connector currently covers the Contact object in Common Room](https://api.commonroom.io/docs/) REST API. To use this, you'll need to add a `COMMON_ROOM_API_KEY` in your environment variables then running `rover` or the `router` binary with the config files in this folder (`router.yaml` and `supergraph.yaml`). 
+
+## Contributing
+
+A partial implementation of the `Contacts` API has been implemented including: 
+
+- GET contact by email
+- POST add note to contact
+
+The following schema modules still need to be implemented:
+
+- Activities
+- Segments
+- Tags
+- Right to be Forgotten
+
+To contribute any of these modules, you'll need to:
+
+1. A schema designed for that portion of the rest API as a new `.graphql` file
+2. Add the new `.graphql` file to the `supergraph.yaml` 
+3. Add the connector config to the `router.yaml` and be sure to use the subgraph name you populated in the previous step (referenced in `supergraph.yaml`)

package/sampleWorkspace/connectors-community/connectors/common-room/contacts.graphql

@@ -0,0 +1,141 @@
+extend schema
+  @link(
+    url: "https://specs.apollo.dev/federation/v2.10"
+    import: ["@key", "@requires"]
+  )
+  @link(
+    url: "https://specs.apollo.dev/connect/v0.2"
+    import: ["@source", "@connect"]
+  )
+  @source(
+    name: "common-room"
+    http: {
+      # https://api.commonroom.io/docs
+      baseURL: "https://api.commonroom.io/community/v1"
+      headers: [{ name: "Authorization", value: "Bearer {$config.apiKey}" }]
+    }
+  )
+
+type Contact {
+  email: String!
+  fullName: String
+  activities: Int
+  avatar: String
+  bio: String
+  organization: Organization
+  title: String
+  firstSeen: String
+  lastActive: String
+  location: Location
+  tags: [MemberTag]
+  segments: [Segment]
+  emails: [Email]
+}
+
+type Email {
+  email: String
+  sources: [String]
+}
+
+type Segment {
+  id: ID
+  name: String
+}
+
+type MemberTag {
+  id: ID
+  name: String
+}
+
+type Location {
+  full: String
+  city: String
+  region: String
+  country: String
+}
+
+type Organization {
+  name: String
+  url: String
+}
+
+type Query {
+  contact(email: String!): Contact
+    @connect(
+      source: "common-room"
+      http: { GET: "/members?email={$args.email}" }
+      selection: """
+      # JSON Example Response 👇
+      # https://github.com/apollographql/connectors-community/tree/main/connectors/common-room/json-responses/members%3Femail%3D.json
+      $->first {
+        email: $args.email
+        fullName
+        activities: activities_count
+        avatar
+        bio
+        organization: {
+          name: organization
+          url: organization_domain
+        }
+        title
+        firstSeen: first_seen
+        lastActive: last_active
+        location {
+          full: raw
+          city
+          region
+          country
+        }
+        tags: member_tags {
+          id
+          name
+        }
+        segments {
+          id
+          name
+        }
+        emails: email {
+          email
+          sources
+        }
+      }
+      """
+      entity: true
+    )
+}
+
+type Mutation {
+  addNoteToContact(social: SocialType!, id: ID!, note: String!): Boolean
+    @connect(
+      source: "common-room"
+      http: {
+        POST: "/members/note"
+        body: """
+        socialType: $args.social->match(
+          ["EMAIL","email"],
+          ["TWITTER","twitter"],
+          ["GITHUB","github"],
+          ["LINKEDIN","linkedin"],
+        )
+        value: $args.id
+        note: $args.note
+        """
+      }
+      selection: """
+      # JSON Example Response 👇 - It's the Common Room user id
+      # {
+      #   "id": [
+      #     123456789
+      #   ]
+      # }
+      $(true)
+      """
+    )
+}
+
+enum SocialType {
+  EMAIL
+  TWITTER
+  GITHUB
+  LINKEDIN
+}

package/sampleWorkspace/connectors-community/connectors/common-room/json-responses/members_email_.json

@@ -0,0 +1,61 @@
+[
+    {
+      "fullName": "Michael Watson",
+      "activities_count": 3334,
+      "avatar": "https://avatars.githubusercontent.com/u/8645958?u=2d97981f1bbdf44e76a47e67fdaa3d26354ddb74&v=4",
+      "bio": "Developer Advocate for Apollo Federation - Previous Solutions Architect - 5+ yrs",
+      "organization": "Apollo GraphQL",
+      "organization_domain": "http://www.apollographql.com",
+      "title": "Head of DevRel",
+      "first_seen": "2018-10-03T14:37:25.000Z",
+      "last_active": "2025-02-14T22:23:57.000Z",
+      "location": {
+        "raw": "San Francisco, California, United States",
+        "city": "San Francisco",
+        "region": "California",
+        "country": "United States"
+      },
+      "member_tags": [
+        {
+          "id": 731426,
+          "name": "team_member"
+        },
+        {
+          "id": 731431,
+          "name": "contributor"
+        }
+      ],
+      "segments": [
+        {
+          "id": 123456,
+          "name": "Segment Name"
+        }
+      ],
+      "email": [
+        {
+          "email": "watson+connectors+live@apollographql.com",
+          "sources": [
+            "ConnectorsLiveUsers"
+          ]
+        }
+      ],
+      "url": [],
+      "twitter": [],
+      "github": [
+        "michael-watson"
+      ],
+      "linkedin": [
+        "in/michael-watson-85844442"
+      ],
+      "discord": [],
+      "youtube": [],
+      "common_room_member_url": "https://app.commonroom.io/community/1337/member/1337",
+      "custom_fields": [
+        {
+          "name": "Custom Field Name",
+          "type": "string",
+          "value": ""
+        }
+      ]
+    }
+  ]

package/sampleWorkspace/connectors-community/connectors/common-room/router.yaml

@@ -0,0 +1,18 @@
+supergraph:
+  listen: 127.0.0.1:4000
+
+headers:
+  all:
+    request:
+      - propagate:
+          matching: .*
+telemetry:
+  instrumentation:
+    spans: 
+      mode: spec_compliant
+
+connectors:
+  subgraphs:
+    contacts:
+      $config:
+        apiKey: ${env.COMMON_ROOM_API_KEY}

package/sampleWorkspace/connectors-community/connectors/common-room/supergraph.yaml

@@ -0,0 +1,6 @@
+federation_version: =2.11.0
+subgraphs:
+  contacts:
+    routing_url: http://contacts
+    schema:
+      file: contacts.graphql

package/sampleWorkspace/connectors-community/connectors/googlemaps/README.md

@@ -0,0 +1,58 @@
+# Google Maps REST Connector
+
+This connector currently covers a portion of the [Google Maps Legacy API](https://developers.google.com/maps/documentation/places/web-service/legacy/details).
+
+Including:
+[Place Search](https://developers.google.com/maps/documentation/places/web-service/legacy/search)
+[Distance Matrix](https://developers.google.com/maps/documentation/distance-matrix/distance-matrix)
+[Timezone](https://developers.google.com/maps/documentation/timezone/requests-timezone)
+
+Google Maps has two types of REST APIs, legacy requires an [API KEY passed via the URL](https://developers.google.com/maps/documentation/places/web-service/get-api-key#creating-api-keys). 
+
+It is important to restrict the use of these keys and to not expose these calls to the client.
+
+If you require any features from the new API's, they use [OAUTH2](https://developers.google.com/maps/documentation/places/web-service/oauth-token) and will require updates to this schema to use.
+
+At the time of this writing legacy maps API's are stable for use but will not recieve new features.
+
+You can read more in Google Maps Documenation.
+
+## Prerequisites
+
+To use the connector, you need a [Google Maps API key](https://developers.google.com/maps/documentation/places/web-service/get-api-key#creating-api-keys).
+
+## Getting started 
+
+1. If you haven't already, [create a new graph in GraphOS](https://www.apollographql.com/docs/graphos/get-started/guides/rest#step-1-set-up-your-graphql-api). Once you get to the **Set up your local development environment** modal in the [Create a graph](https://www.apollographql.com/docs/graphos/get-started/guides/rest#create-a-graph) section:
+    - Copy the `supergraph.yaml` file from this folder instead of the `supergraph.yaml` provided by the modal.
+    - Instead of downloading the example schema provided by the modal, copy the schema files from this folder
+      - *Note: If you only want to one of the schema files, you need to modify the `supergraph.yaml` file to only contain the respective schema file .*
+
+1. Run `rover dev` to start the local development session:
+
+    ```
+    APOLLO_KEY=service:My-Graph-s1ff1u:•••••••••••••••••••••• \
+      APOLLO_GRAPH_REF=My-Graph-s1ff1u@main \
+      rover dev --supergraph-config supergraph.yaml
+    ```
+
+You’re all set! Open up http://localhost:4000 to query your graph using Apollo Sandbox.
+
+### Adding to an existing graph in GraphOS
+
+To add these connectors to an existing graph, publish the schema files to your graph ref using `rover subgraph publish` example below:
+
+```
+APOLLO_KEY=service:My-Graph-s1ff1u:•••••••••••••••••••••• \
+  rover subgraph publish My-Graph-s1ff1u@main --name places --schema places.graphql --routing-url http://places
+
+```
+
+## Contributing
+
+To add other modules to this schema, see the [Google Maps API list](https://console.cloud.google.com/google/maps-apis/api-list) - only legacy API KEY endpoints should be added to this schema
+
+To contribute them, make sure to:
+
+1. Add a schema designed for the module as a new `.graphql` file.
+2. Update the `supergraph.yaml` file accordingly.

package/sampleWorkspace/connectors-community/connectors/googlemaps/distancematrix.graphql

@@ -0,0 +1,155 @@
+extend schema
+  @link(
+    url: "https://specs.apollo.dev/federation/v2.11"
+    import: ["@key", "@shareable", "@external", "@requires"]
+  ) # Enable this schema to use Apollo Federation features
+  @link( # Enable this schema to use Apollo Connectors
+    url: "https://specs.apollo.dev/connect/v0.2"
+    import: ["@connect", "@source"]
+  )
+  #this connector uses the legacy ditance API.  To enable this in Google, you must create an API key and give permissions to this API
+  @source(
+    name: "distance"
+    http: { baseURL: "https://maps.googleapis.com/maps/api/" }
+  )
+
+type Query {
+  # Direct distance calculation between two named locations
+  getDistanceByLocation(from: String!, to: String!): TravelEstimate
+    @connect(
+      source: "distance"
+      http: {
+        GET: "/distancematrix/json?origins={$args.from}&destinations={$args.to}&key=YOUR_API_KEY"
+      }
+      selection: """
+      destinationAddresses: destination_addresses
+      originAddresses: origin_addresses
+      rows {
+        elements {
+          distance {
+            text
+            value
+          }
+          duration {
+            text
+            value
+          }
+          status
+        }
+      }
+      status
+      """
+    )
+    
+  # Direct distance calculation between two place IDs
+  getDistanceByPlaceId(fromPlaceId: String!, toPlaceId: String!): TravelEstimate
+    @connect(
+      source: "distance"
+      http: {
+        GET: "/distancematrix/json?origins=place_id:{$args.fromPlaceId}&destinations=place_id:{$args.toPlaceId}&key=YOUR_API_KEY"
+      }
+      selection: """
+      destinationAddresses: destination_addresses
+      originAddresses: origin_addresses
+      rows {
+        elements {
+          distance {
+            text
+            value
+          }
+          duration {
+            text
+            value
+          }
+          status
+        }
+      }
+      status
+      """
+    )
+}
+
+type TravelEstimate {
+  destinationAddresses: [String]
+  originAddresses: [String]
+  rows: [TravelEstimateRow]
+  status: String
+}
+
+type TravelEstimateRow {
+  elements: [TravelEstimateElement]
+}
+
+type TravelEstimateElement {
+  distance: TravelEstimateDistance
+  duration: TravelEstimateDuration
+  status: String
+}
+
+type TravelEstimateDistance {
+  text: String
+  value: Int
+}
+
+type TravelEstimateDuration {
+  text: String
+  value: Int
+}
+
+type Place @key(fields: "id", resolvable: false) {
+  id: String @external
+  
+  # Get travel distance and duration to another place by id
+  travelTo(destinationPlaceId: String!): TravelEstimate
+    @connect(
+      source: "distance"
+      http: {
+        GET: "/distancematrix/json?origins=place_id:{$this.id}&destinations=place_id:{$args.destinationPlaceId}&key=YOUR_API_KEY"
+      }
+      selection: """
+      destinationAddresses: destination_addresses
+      originAddresses: origin_addresses
+      rows {
+        elements {
+          distance {
+            text
+            value
+          }
+          duration {
+            text
+            value
+          }
+          status
+        }
+      }
+      status
+      """
+    )
+    
+  # Get travel distance and duration to a named location 
+  travelToLocation(destination: String!): TravelEstimate
+    @connect(
+      source: "distance"
+      http: {
+        GET: "/distancematrix/json?origins=place_id:{$this.id}&destinations={$args.destination}&key=YOUR_API_KEY"
+      }
+      selection: """
+      destinationAddresses: destination_addresses
+      originAddresses: origin_addresses
+      rows {
+        elements {
+          distance {
+            text
+            value
+          }
+          duration {
+            text
+            value
+          }
+          status
+        }
+      }
+      status
+      """
+    )
+}

package/sampleWorkspace/connectors-community/connectors/googlemaps/places-legacy.graphql

@@ -0,0 +1,117 @@
+extend schema
+  @link(
+    url: "https://specs.apollo.dev/federation/v2.11"
+    import: ["@key", "@shareable", "@external"]
+  ) # Enable this schema to use Apollo Federation features
+  @link( # Enable this schema to use Apollo Connectors
+    url: "https://specs.apollo.dev/connect/v0.2"
+    import: ["@connect", "@source"]
+  )
+  @source(
+    name: "places"
+    http: { baseURL: "https://maps.googleapis.com/maps/api/place/" }
+  )
+
+type Query {
+  searchForPlace(query: String): [Place]
+    @connect(
+      source: "places"
+      http: {
+        GET: "textsearch/json?query={$args.query}&key=YOUR_API_KEY"
+      }
+      selection: """
+       $.results {
+        businessStatus: business_status
+        formattedAddress: formatted_address
+        location: $.geometry.location {
+          latitude: lat
+          longitude: lng
+        }
+        openingHours: opening_hours {
+          openNow: open_now
+        }
+        photos {
+          photoReference: photo_reference
+          htmlAttributions: html_attributions
+        }
+        id: place_id
+        rating
+        reference
+        types
+        userRatingsTotal: user_ratings_total
+      }
+      """
+    )
+
+  getPlaceDetailsById(id: String!): Place
+    @connect(
+      source: "places"
+      http: {
+        GET: "details/json?place_id={$args.id}&key=YOUR_API_KEY"
+      }
+      entity: true
+      selection: """
+        $.result {
+        businessStatus: business_status
+        formattedAddress: formatted_address
+        location: $.geometry.location {
+          latitude: lat
+          longitude: lng
+        }
+        openingHours: opening_hours {
+          openNow: open_now
+        }
+        photos {
+          photoReference: photo_reference
+          htmlAttributions: html_attributions
+        }
+        id: place_id
+        rating
+        reference
+        types
+        userRatingsTotal: user_ratings_total
+      }
+      """
+    )
+}
+
+type Place @key(fields: "id") {
+  id: String 
+  businessStatus: String
+  formattedAddress: String
+  location: Location 
+  openingHours: OpeningHours
+  photos: [Photo]
+  rating: Float
+  reference: String
+  types: [String]
+  userRatingsTotal: Int
+}
+type Location {
+  latitude: Float
+  longitude: Float
+}
+type OpeningHours {
+  openNow: Boolean
+}
+type Photo {
+  photoReference: String
+  htmlAttributions: [String]
+  url(height: Int = 720, width: Int = 1280): String
+    @connect(
+      source: "places"
+      http: {
+        GET: "/photo"
+        queryParams: """
+        photo_reference: $this.photoReference
+        maxwidth: $args.width
+        maxheight: $args.height
+        key:$(config.key)
+        skipHttpRedirect: $(true)
+        """
+      }
+      selection: """
+      url
+      """
+    )
+}