vscode-apollo 2.5.6 → 2.6.0

package/sampleWorkspace/connectors-community/connectors/aws/README

@@ -0,0 +1,125 @@
+# AWS REST Connector
+
+This connector currently enables the following features using AWS REST APIs:
+
+- Lambda
+  - [Invoke Function](# https://docs.aws.amazon.com/lambda/latest/api/API_Invoke.html) - requires [lambda:InvokeFunction](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awslambda.html) permission
+- DynamoDB
+  - [GetItem](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html) - requires dynamodb:GetItem or AmazonDynamoDBReadOnlyAccess for your instance
+
+## Prerequisites
+
+To use the `.graphql` files in this folder without modifying them, you must have AWS resources that mirror how the connectors are designed.
+You can also modify the schema files to work with your existing resources. For example, you change the Lambda URL to have one of your function names in it and modify the selection to match what your Lambda returns.
+
+### DynamoDB prerequisites
+
+These prerequisites apply if you want to use the `dynamodb.graphql` schema file as-is.
+
+1. Create a table called `product-catalog`.
+2. Create items in that table that contain an `id`_(string)_, `name`_(string)_, `description`_(string)_ and `image` _(string)_.
+
+### Lambda prerequisites
+
+These prerequisites apply if you want to use the `lambda.graphql` schema file as-is.
+
+1. Create a Lambda named "products" and have it return a body of products like this:
+
+    ```
+    return {
+      statusCode: 200,
+      body: [{
+        "id": "RANQi6AZkUXCbZ",
+        "name": "OG Olive Putter - Blade",
+        "description": "The traditional Block in a blade shape is made from a solid block of Olive wood. The head weight is approximately 360 grams with the addition of pure tungsten weights. Paired with a walnut center-line and white accents colors.",
+        "image": "https://keynote-strapi-production.up.railway.app/uploads/thumbnail_IMG_9102_3119483fac.png"
+      }],
+    };
+    ```
+
+1. Create a Lambda named `product-price` and have it return a price object based on the incoming `product_id`:
+
+    ```
+    const id = event.product_id;
+    const prices = [{
+      id: "RANQi6AZkUXCbZ",
+      price: {
+        default_price: 49900,
+        is_active: true,
+        currency: "usd",
+        billing_schema: "per_unit",
+        recurring: {
+          interval: 0,
+          interval_count: 3,
+        },
+      },
+    }]
+    return prices.find((p) => p.id == id);
+    ```
+
+## 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` and `router.yaml` files 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 you want to use for this connector—`dynamodb.graphql` and/or `lambda.graphql`
+      - *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. Set up a user in your IAM AWS Console and give them the appropriate permissions. You'll need to then set the proper environment variables for [Sigv4 authentication](https://www.apollographql.com/docs/graphos/routing/security/subgraph-authentication#default-chain-authentication) - _see docs for `AWS_ROLE_ARN` configuration_:
+
+    ```
+    # AWS Lambda - requires [InvokeFunction](https://docs.aws.amazon.com/lambda/latest/api/API_Invoke.html) permission
+    # DynamoDB - requires [GetItem](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html) permission
+
+    export AWS_ACCESS_KEY_ID=....
+    export AWS_SECRET_ACCESS_KEY=....
+    ```
+
+    _Note: You can look at the `router.yaml` file to see config options for Sigv4 in the comments._
+
+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 --router-config router.yaml
+    ```
+
+You’re all set! Open up http://localhost:4000 to query your graph using Apollo Sandbox.
+
+### Adding to an existing graph in GraphOS
+
+1. Ensure you set up Sigv4 for your hosted router and configure the `router.yaml` as outlined in the [docs](https://www.apollographql.com/docs/graphos/routing/security/subgraph-authentication#default-chain-authentication).
+
+1. Then, to add these connectors to an existing graph, publish the schema files to your graph ref using `rover subgraph publish`:
+
+  ```
+  APOLLO_KEY=service:My-Graph-s1ff1u:•••••••••••••••••••••• \
+    rover subgraph publish My-Graph-s1ff1u@main --name Lambda --schema lambda.graphql --routing-url http://lambda
+  ```
+
+## Additional Setup for VS Code Task runner
+
+Edit your `.vscode/settings.json` to include the following keys:
+
+```
+{
+  "terminal.integrated.profiles.osx": {
+    "graphos": {
+      "path": "zsh",
+      "args": ["-l"],
+      "env": {
+        "API_KEY": "",
+        "APOLLO_KEY": "",
+        ...
+      }
+    }
+  },
+  "terminal.integrated.defaultProfile.osx": "graphos"
+}
+```
+
+Once you've set this up, you can execute the `Tasks: Run Task` command in VS Code to run the `rover dev` task.
+Alternatively, you can open a new terminal window in VS Code with the `graphos` profile, then run `rover dev --supergraph-config supergraph.yaml --router-config router.yaml`.
+
+## Contributing
+
+You can contribute any AWS resources to this project. The functionality should be isolated to a `.graphql` file that represents the AWS resource. You can use the current modules in this folder as examples to work with. 

package/sampleWorkspace/connectors-community/connectors/aws/dynamodb.graphql

@@ -0,0 +1,130 @@
+extend schema
+  @link(
+    url: "https://specs.apollo.dev/federation/v2.11"
+    import: ["@key", "@requires", "@override", "@external", "@shareable"]
+  )
+  @link(
+    url: "https://specs.apollo.dev/connect/v0.2"
+    import: ["@source", "@connect"]
+  )
+  # https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html
+  # See router.yaml for Sigv4 configuration
+  @source(
+    name: "dynamodb"
+    http: { 
+      # If you want to use multiple regions, see router.yaml for configuration based on environment variables
+      baseURL: "https://dynamodb.us-east-1.amazonaws.com"
+    }
+  )
+
+type DynamoTable {
+  id: ID
+  name: String
+  itemCount: Int
+  tableSizeBytes: Float
+  creationDateTime: Float
+  itemConnection(cursor: String = "", limit: Int = 5): ItemConnection
+    @connect(
+      source: "dynamodb"
+      http: {
+        POST: "/"
+        body: """
+        $args.cursor->match(
+          [null, $({
+            TableName: $this.name,
+            Limit: $args.limit,
+          })],
+          ["", $({
+            TableName: $this.name,
+            Limit: $args.limit,
+          })],
+          [@, $({
+            TableName: $this.name,
+            Limit: $args.limit,
+            ExclusiveStartKey: { id: { S: @ } }
+          })]
+        )
+        """
+        headers: [{ name: "X-Amz-Target", value: "DynamoDB_20120810.Scan" }]
+      }
+      selection: """
+      pageInfo: {
+        count: Count
+        total: ScannedCount
+        next: LastEvaluatedKey.id.S
+      }
+      items: $.Items {
+        id: id.S
+      }
+      """
+    )
+}
+
+type ItemConnection {
+  items: [Item]
+  pageInfo: PageInfo
+}
+type Item {
+  id: ID!
+}
+type Mutation {
+  deleteTable(name: ID!): Boolean
+    @connect(
+      source: "dynamodb"
+      http: {
+        POST: "/"
+        body: """
+        TableName: $args.name
+        """
+        headers: [{ name: "X-Amz-Target", value: "DynamoDB_20120810.DeleteTable" }]
+      }
+      selection: """
+      $(true)
+      """
+    )
+}
+type PageInfo {
+  count: Int
+  total: Int
+  next: String
+}
+
+type Query {
+  tables(limit: Int = 10): [DynamoTable]
+  @connect(
+    source: "dynamodb"
+    http: {
+      POST: "/"
+      body: """
+      Limit: $args.limit
+      """
+      headers: [{ name: "X-Amz-Target", value: "DynamoDB_20120810.ListTables" }]
+    }
+    selection: """
+    $.TableNames->map({name: @}) { name }
+    """
+  )
+  table(
+    name: String!
+  ): DynamoTable
+  @connect(
+    source: "dynamodb"
+    http: {
+      POST: "/"
+      body: """
+      TableName: $args.name
+      """
+      headers: [{ name: "X-Amz-Target", value: "DynamoDB_20120810.DescribeTable" }]
+    }
+    selection: """
+    $.Table {
+      id: TableId
+      name: TableName
+      itemCount: ItemCount
+      tableSizeBytes: TableSizeBytes
+      creationDateTime: CreationDateTime
+    }
+    """
+    entity: true
+  )
+}

package/sampleWorkspace/connectors-community/connectors/aws/json-responses/product-price.json

@@ -0,0 +1,10 @@
+{
+  "default_price": 35000,
+  "is_active": true,
+  "currency": "usd",
+  "billing_schema": "per_unit",
+  "recurring": {
+    "interval": 0,
+    "interval_count": 3
+  }
+}

package/sampleWorkspace/connectors-community/connectors/aws/json-responses/products.json

@@ -0,0 +1,53 @@
+{
+  "statusCode": 200,
+  "body": [
+    {
+      "id": "RANQi6AZkUXCbZ",
+      "name": "OG Olive Putter - Blade",
+      "description": "The traditional Block in a blade shape is made from a solid block of Olive wood. The head weight is approximately 360 grams with the addition of pure tungsten weights. Paired with a walnut center-line and white accents colors.",
+      "image": "https://keynote-strapi-production.up.railway.app/uploads/thumbnail_IMG_9102_3119483fac.png"
+    },
+    {
+      "id": "RANYrWRy876AA5",
+      "name": "Butter Knife Olive Putter- Blade",
+      "description": "The traditional Block in a extremely thin blade shape (~1\") is made from a solid block of Olive wood. The head weight is approximately 330 grams with the addition of pure tungsten weights.",
+      "image": "https://keynote-strapi-production.up.railway.app/uploads/thumbnail_IMG_9104_97c221e79c.png"
+    },
+    {
+      "id": "RANb0l4hEX1P5h",
+      "name": "Purple Heart Putter - Mallet",
+      "description": "The traditional Block in a mallet shape is made from a solid block of Purple Heart wood. The head weight is approximately 350 grams with the addition of pure tungsten weights. Paired with a cherrywood center-line.",
+      "image": "https://keynote-strapi-production.up.railway.app/uploads/thumbnail_IMG_9107_a64354f144.png"
+    },
+    {
+      "id": "R8Thrlp7oTghTr",
+      "name": "Purple Heart Putter - Blade",
+      "description": "The traditional Block in a blade shape is made from a solid block of Purple Heart wood. The head weight is approximately 350 grams with the addition of pure tungsten weights. Paired with a cherrywood center-line and white accents colors.",
+      "image": "https://keynote-strapi-production.up.railway.app/uploads/thumbnail_IMG_8808_028b0dc74f.png"
+    },
+    {
+      "id": "RANfaXNYj1y69D",
+      "name": "Purple Heart Putter - Mallet - Hardwood Hosel",
+      "description": "The traditional Block in a mallet shape is made from a solid block of Purple Heart wood. It also features an offset hardwood hosel lathed for a perfect fit. The head weight is approximately 350 grams with the addition of pure tungsten weights. Paired with a accents of your choice.",
+      "image": "https://keynote-strapi-production.up.railway.app/uploads/thumbnail_IMG_9108_cb1db8a258.png"
+    },
+    {
+      "id": "RANhWQ2gr4Nddk",
+      "name": "Bubinga Single-Step Putter - Blade",
+      "description": "The traditional Block in a blade shape that is made from a solid block of Bubinga wood. The head weight is approximately 350 grams with the addition of pure tungsten weights. Paired with a olivewood center-line and white accents colors.",
+      "image": "https://keynote-strapi-production.up.railway.app/uploads/thumbnail_IMG_9113_fdd623c915.png"
+    },
+    {
+      "id": "RANj7kJZbpaST9",
+      "name": "Creamy Purple Heart Putter - Mallet",
+      "description": "The traditional Block in a mallet shape that is made from a solid block of Purple Heart wood. The head weight is approximately 350 grams with the addition of pure tungsten weights. Paired with a cherrywood center-line and cream accents colors paired with drip for the weights.",
+      "image": "https://keynote-strapi-production.up.railway.app/uploads/thumbnail_IMG_9114_b81c1a597c.png"
+    },
+    {
+      "id": "RANlyfWstQOkdx",
+      "name": "Adjustable Walnut Putter - Mallet",
+      "description": "The prototype Block in a mallet shape that is made from a solid block of Walnut wood. The head weight is approximately 350 grams with the addition of pure tungsten weights. Paired with a cherrywood center-line and teal accents colors. It includes two adjustable weights to dial in the swingweight for your personal preference",
+      "image": "https://keynote-strapi-production.up.railway.app/uploads/thumbnail_IMG_9115_75fddf436a.png"
+    }
+  ]
+}

package/sampleWorkspace/connectors-community/connectors/aws/lambda.graphql

@@ -0,0 +1,179 @@
+extend schema
+  @link(
+    url: "https://specs.apollo.dev/federation/v2.10"
+    import: ["@key", "@requires", "@override", "@external", "@shareable"]
+  )
+  @link(
+    url: "https://specs.apollo.dev/connect/v0.2"
+    import: ["@source", "@connect"]
+  )
+  # https://docs.aws.amazon.com/lambda/latest/api
+  # See router.yaml for Sigv4 configuration
+  @source(
+    name: "lambda"
+    # If you want to use multiple regions, see router.yaml for configuration based on environment variables
+    http: { baseURL: "https://lambda.us-east-1.amazonaws.com" }
+  )
+
+type LambdaFunction {
+  name: String
+  configuration: LambdaFunctionConfiguration
+  concurrency: Int
+  code: LambdaFunctionCode
+}
+type LambdaFunctionCode {
+  sourceKMSKeyArn: String
+  resolvedImageUri: String
+  repositoryType: String
+  error: String
+  imageUri: String
+  location: String
+}
+input LambdaFunctionCodeInput {
+  imageUri: String
+  zipFile: String
+  s3Bucket: String
+  s3Key: String
+  s3ObjectVersion: String
+  publish: Boolean
+}
+type LambdaFunctionConfiguration {
+  description: String
+  tracingConfigMode: String
+  revisionId: String
+  lastModified: String
+  runtime: String
+  version: String
+  packageType: String
+  lastUpdateSuccess: Boolean
+  arn: String
+  kmsKeyArn: String
+  memorySize: Int
+  timeout: Int
+  handler: String
+  codeSha256: String
+  role: String
+  state: String
+  stateReason: String
+  architectures: [String]
+}
+type Mutation {
+  createFunction(
+    name: String!
+    roleArn: String!
+    code: LambdaFunctionCodeInput!
+  ): LambdaFunction
+    @connect(
+      source: "lambda"
+      http: { 
+        POST: "/2015-03-31/functions" 
+        body: """
+        FunctionName: $args.name
+        Role: $args.roleArn
+        Code: $args.code
+        """
+      }
+      selection: """
+      name: FunctionName
+      configuration: {
+        description: Description
+        tracingConfigMode: TracingConfig.Mode
+        revisionId: RevisionId
+        lastModified: LastModified
+        runtime: Runtime
+        version: Version
+        packageType: PackageType
+        arn: FunctionArn
+        kmsKeyArn: KMSKeyArn
+        memorySize: MemorySize
+        timeout: Timeout
+        handler: Handler
+        codeSha256: CodeSha256
+        role: Role
+        state: State
+        stateReason: StateReasonCode
+        architectures: Architectures
+      }
+      """
+    )
+  deleteFunction(name: String!): Boolean
+    @connect(
+      source: "lambda"
+      http: { DELETE: "/2015-03-31/functions/{$args.name}" }
+      selection: """
+      $(true)
+      """
+    )
+}
+type Query {
+  getFunction(name: String!): LambdaFunction
+    @connect(
+      source: "lambda"
+      http: { GET: "/2015-03-31/functions/{$args.name}" }
+      selection: """
+      name: $.Configuration.FunctionName
+      configuration: $.Configuration {
+        description: Description
+        tracingConfigMode: TracingConfig.Mode
+        revisionId: RevisionId
+        lastModified: LastModified
+        runtime: Runtime
+        version: Version
+        packageType: PackageType
+        lastUpdateSuccess: LastUpdateStatus->match(
+          ["Successful", true],
+          ["Unsuccessful", false]
+        )
+        arn: FunctionArn
+        kmsKeyArn: KMSKeyArn
+        memorySize: MemorySize
+        timeout: Timeout
+        handler: Handler
+        codeSha256: CodeSha256
+        role: Role
+        state: State
+        stateReason: StateReasonCode
+        architectures: Architectures
+      }
+      concurrency: Concurrency.ReservedConcurrentExecutions
+      code: $.Code {
+        sourceKMSKeyArn: SourceKMSKeyArn
+        resolvedImageUri: ResolvedImageUri
+        repositoryType: RepositoryType
+        error: Error
+        imageUri: ImageUri
+        location: Location
+      }
+      """
+      entity: true
+    )
+  listFunctions(limit: Int = 10, next: String = ""): [LambdaFunction]
+    @connect(
+      source: "lambda"
+      http: { GET: "/2015-03-31/functions" }
+      selection: """
+      $.Functions {
+        name: FunctionName
+        configuration: {
+          description: Description
+          tracingConfigMode: TracingConfig.Mode
+          revisionId: RevisionId
+          lastModified: LastModified
+          runtime: Runtime
+          version: Version
+          packageType: PackageType
+          arn: FunctionArn
+          kmsKeyArn: KMSKeyArn
+          memorySize: MemorySize
+          timeout: Timeout
+          handler: Handler
+          codeSha256: CodeSha256
+          role: Role
+          state: State
+          stateReason: StateReasonCode
+          architectures: Architectures
+        }
+      }
+      """
+    )
+}

package/sampleWorkspace/connectors-community/connectors/aws/router.yaml

@@ -0,0 +1,54 @@
+supergraph:
+  listen: 0.0.0.0:${env.PORT:-4000}
+
+headers:
+  all:
+    request:
+      - propagate:
+          matching: .*
+telemetry:
+  instrumentation:
+    spans: 
+      mode: spec_compliant
+connectors:
+    preview_connect_v0_2: true
+authentication:
+  connector:
+    sources:
+      aws-lambda.lambda:
+        aws_sig_v4:
+          default_chain:
+            # You can also set AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY as environment variables
+            # Docs: https://www.apollographql.com/docs/graphos/routing/security/subgraph-authentication#default-chain-authentication
+            profile_name: "default" #name of profile in .aws/configuration file
+            region: "us-east-1"
+            service_name: "lambda"
+            # assume_role:
+            #   role_arn: "arn:aws:iam::{accountId}:role/{roleName}"
+            #   session_name: "connector"
+      aws-dynamodb.dynamodb:
+        aws_sig_v4:
+          default_chain:
+            # You can also set AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY as environment variables
+            # Docs: https://www.apollographql.com/docs/graphos/routing/security/subgraph-authentication#default-chain-authentication
+            profile_name: "default" #name of profile in .aws/configuration file
+            region: "us-east-1"
+            service_name: "dynamodb"
+            # assume_role:
+            #   role_arn: "arn:aws:iam::{accountId}:role/{roleName}"
+            #   session_name: "connector"
+
+## If you want to override the url to use dynamic urls based on environment variables
+# connectors:
+#   subgraphs:
+#     dynamodb: # The name of the subgraph
+#       sources:
+#         address: # Refers to @source(name: "v1")
+#           override_url: ${env.DYNAMODB_URL:-https://dynamodb.us-east-1.amazonaws.com}
+#       # $config: #<- if you wanted to have environment variables used in schema file (i.e. {$config.apiKey})
+#       #   apiKey: ${env.API_KEY}
+#     lambda:
+#       sources:
+#         lambda:
+#           override_url: ${env.LAMBDA_URL:-https://lambda.us-east-1.amazonaws.com}
+

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

@@ -0,0 +1,10 @@
+federation_version: =2.11.0
+subgraphs:
+  aws-lambda:
+    routing_url: http://lambda
+    schema:
+      file: lambda.graphql
+  aws-dynamodb:
+    routing_url: http://dynamodb
+    schema:
+      file: dynamodb.graphql

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

@@ -0,0 +1,35 @@
+# Bored API REST Connector
+
+This connector covers the full [Bored API](https://bored-api.appbrewery.com/).  This is an API that retrieves random activites. 
+
+This API is considered a teaching tool and is best used for practice with Connectors. It has no business or production value, but sometimes that's nice.
+
+API Requests are rate limited to 100 requests every 15 minutes.
+
+## Additional Setup for VS Code Task runner
+
+Edit your `.vscode/settings.json` to include the following keys:
+
+```
+{
+  "terminal.integrated.profiles.osx": {
+    "graphos": {
+      "path": "zsh",
+      "args": ["-l"],
+      "env": {
+        "API_KEY": "",
+        "APOLLO_KEY": "",
+        ...
+      }
+    }
+  },
+  "terminal.integrated.defaultProfile.osx": "graphos"
+}
+```
+
+Once you've set this up, you can execute the `Tasks: Run Task` command in VS Code to run the `rover dev` task.
+Alternatively, you can open a new terminal window in VS Code with the `graphos` profile, then run `rover dev --supergraph-config supergraph.yaml --router-config router.yaml`.
+
+## Contributing
+
+This conector will not evolve, however, contributions of other REST API connectors are welcome. Please see the [Contribution Guide](https://github.com/apollographql/connectors-community/tree/main?tab=readme-ov-file#contributing-a-connector-to-the-community)

package/sampleWorkspace/connectors-community/connectors/bored/bored.graphql

@@ -0,0 +1,87 @@
+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: "bored", http: { baseURL: "https://bored-api.appbrewery.com" })
+type Query {
+  getRandomActivity: Activity
+    @connect(
+      source: "bored"
+      http: { GET: "/random" }
+      selection: """
+      activity
+      availability
+      type
+      participants
+      price
+      accessibility
+      duration
+      kidFriendly
+      link
+      key
+      """
+    )
+
+  getActivityByType(type: ActivityType!): [Activity]
+    @connect(
+      source: "bored"
+      http: {
+        GET: "/filter"
+        queryParams: """
+            type: $args.type->match(
+          ["EDUCATION", "education"],
+          ["RECREATIONAL", "recreational"],
+          ["SOCIAL", "social"],
+          ["DIY", "diy"],
+          ["CHARITY", "charity"],
+          ["COOKING", "cooking"],
+          ["RELAXATION", "relaxation"],
+          ["MUSIC", "music"],
+          ["BUSYWORK", "busywork"]
+        )
+        """
+      }
+      selection: """
+      activity
+      availability
+      type
+      participants
+      price
+      accessibility
+      duration
+      kidFriendly
+      link
+      key
+      """
+    )
+}
+
+type Activity {
+  activity: String
+  availability: Float
+  type: String
+  participants: Int
+  price: Float
+  accessibility: String
+  duration: String
+  kidFriendly: Boolean
+  link: String
+  key: String
+}
+
+enum ActivityType {
+  EDUCATION
+  RECREATIONAL
+  SOCIAL
+  DIY
+  CHARITY
+  COOKING
+  RELAXATION
+  MUSIC
+  BUSYWORK
+}