@ttoss/aws-appsync-nodejs 1.2.0 → 1.3.1

package/README.md

@@ -0,0 +1,67 @@
+# @ttoss/aws-appsync-nodejs
+
+This package implements a AWS AppSync client for Node.js. We've followed the [AWS Amplify](https://docs.amplify.aws/lib/graphqlapi/graphql-from-nodejs/q/platform/js/) example to create this package.
+
+## Installation
+
+```bash
+yarn add @ttoss/aws-appsync-nodejs
+```
+
+## Quickstart
+
+```typescript
+import { appSyncClient } from '@ttoss/aws-appsync-nodejs';
+
+appSyncClient.setConfig({
+  apiEndpoint: 'https://xxxxxx.appsync-api.us-east-1.amazonaws.com/graphql',
+  apiKey: 'da2-xxxxxxxxxxxxxxxxxxxxxxxxxx',
+});
+
+const query = /* GraphQL */ `
+  query user($id: ID!) {
+    user(id: $id) {
+      id
+      name
+    }
+  }
+`;
+
+appSyncClient.query(query, { id: '1' }).then((result) => {
+  console.log(result);
+});
+```
+
+## Config
+
+You need to configure the client with `apiEndpoint` (required), `apiKey` (optional) and `awsCredentials` (optional).
+
+1. If you don't provide `apiKey` or `awsCredentials`, the client will try to use the AWS credentials from the environment variables of your system—local computer, AWS Lambda, EC2.
+
+```typescript
+appSyncClient.setConfig({
+  apiEndpoint: 'https://xxxxxx.appsync-api.us-east-1.amazonaws.com/graphql',
+});
+```
+
+2. If you provide `apiKey`, the client will use the API key to authenticate.
+
+```typescript
+appSyncClient.setConfig({
+  apiEndpoint: 'https://xxxxxx.appsync-api.us-east-1.amazonaws.com/graphql',
+  apiKey: 'da2-xxxxxxxxxxxxxxxxxxxxxxxxxx',
+});
+```
+
+3. If you provide `awsCredentials`, the client will use the credentials to authenticate.
+
+```typescript
+appSyncClient.setConfig({
+  apiEndpoint,
+  awsCredentials: {
+    accessKeyId: // access key id,
+    secretAccessKey: // secret access key,
+    sessionToken: // optional session token,
+  },
+});
+```

package/dist/esm/index.js

@@ -1,7 +1,11 @@
 /** Powered by @ttoss/config. https://ttoss.dev/docs/modules/packages/config/ */
 
 // src/index.ts
+import { HttpRequest } from "@aws-sdk/protocol-http";
 import { Request, default as fetch } from "node-fetch";
+import { Sha256 } from "@aws-crypto/sha256-js";
+import { SignatureV4 } from "@aws-sdk/signature-v4";
+import { defaultProvider } from "@aws-sdk/credential-provider-node";
 var _config;
 var setConfig = (config) => {
   _config = config;
@@ -23,14 +27,46 @@ var queryWithApiKey = async (query2, variables) => {
   const body = await response.json();
   return body;
 };
+var getRegionFromEndpoint = (endpoint) => {
+  const matcher = /\.[a-z]+-[a-z]+-[0-9]\./;
+  const regexResponse = endpoint.match(matcher);
+  let region = "";
+  if (regexResponse) {
+    region = regexResponse[0].replace(/\./g, "");
+  }
+  return region;
+};
+var queryWithCredentials = async (query2, variables) => {
+  const { apiEndpoint, awsCredentials } = _config;
+  const endpoint = new URL(apiEndpoint);
+  const region = getRegionFromEndpoint(apiEndpoint);
+  const signer = new SignatureV4({
+    credentials: awsCredentials || defaultProvider(),
+    region,
+    service: "appsync",
+    sha256: Sha256
+  });
+  const requestToBeSigned = new HttpRequest({
+    method: "POST",
+    headers: {
+      "Content-Type": "application/json",
+      host: endpoint.host
+    },
+    hostname: endpoint.host,
+    body: JSON.stringify({ query: query2, variables }),
+    path: endpoint.pathname
+  });
+  const signed = await signer.sign(requestToBeSigned);
+  const request = new Request(endpoint, signed);
+  const response = await fetch(request);
+  const body = await response.json();
+  return body;
+};
 var query = async (query2, variables) => {
   if (_config.apiKey) {
     return queryWithApiKey(query2, variables);
   }
-  if (_config.awsCredentials) {
-    return { data: null };
-  }
-  throw new Error("No API key or credentials set");
+  return queryWithCredentials(query2, variables);
 };
 var appSyncClient = {
   query,

package/dist/index.d.ts

@@ -1,9 +1,16 @@
-declare type Config = {
+import { AwsCredentialIdentity } from '@aws-sdk/types';
+
+/**
+ * Implementation of the AppSync client for NodeJS, based on the AWS Amplify
+ * documentation: https://docs.amplify.aws/lib/graphqlapi/graphql-from-nodejs/q/platform/js/
+ */
+
+type Config = {
     apiEndpoint: string;
     apiKey?: string;
-    awsCredentials?: any;
+    awsCredentials?: AwsCredentialIdentity;
 };
-declare type Query = (query: string, variables: Record<string, unknown>) => Promise<{
+type Query = (query: string, variables: Record<string, unknown>) => Promise<{
     data: Record<string, unknown> | null;
     errors?: {
         message: string;

package/dist/index.js

@@ -30,7 +30,11 @@ __export(src_exports, {
   appSyncClient: () => appSyncClient
 });
 module.exports = __toCommonJS(src_exports);
+var import_protocol_http = require("@aws-sdk/protocol-http");
 var import_node_fetch = __toESM(require("node-fetch"));
+var import_sha256_js = require("@aws-crypto/sha256-js");
+var import_signature_v4 = require("@aws-sdk/signature-v4");
+var import_credential_provider_node = require("@aws-sdk/credential-provider-node");
 var _config;
 var setConfig = (config) => {
   _config = config;
@@ -52,14 +56,46 @@ var queryWithApiKey = async (query2, variables) => {
   const body = await response.json();
   return body;
 };
+var getRegionFromEndpoint = (endpoint) => {
+  const matcher = /\.[a-z]+-[a-z]+-[0-9]\./;
+  const regexResponse = endpoint.match(matcher);
+  let region = "";
+  if (regexResponse) {
+    region = regexResponse[0].replace(/\./g, "");
+  }
+  return region;
+};
+var queryWithCredentials = async (query2, variables) => {
+  const { apiEndpoint, awsCredentials } = _config;
+  const endpoint = new URL(apiEndpoint);
+  const region = getRegionFromEndpoint(apiEndpoint);
+  const signer = new import_signature_v4.SignatureV4({
+    credentials: awsCredentials || (0, import_credential_provider_node.defaultProvider)(),
+    region,
+    service: "appsync",
+    sha256: import_sha256_js.Sha256
+  });
+  const requestToBeSigned = new import_protocol_http.HttpRequest({
+    method: "POST",
+    headers: {
+      "Content-Type": "application/json",
+      host: endpoint.host
+    },
+    hostname: endpoint.host,
+    body: JSON.stringify({ query: query2, variables }),
+    path: endpoint.pathname
+  });
+  const signed = await signer.sign(requestToBeSigned);
+  const request = new import_node_fetch.Request(endpoint, signed);
+  const response = await (0, import_node_fetch.default)(request);
+  const body = await response.json();
+  return body;
+};
 var query = async (query2, variables) => {
   if (_config.apiKey) {
     return queryWithApiKey(query2, variables);
   }
-  if (_config.awsCredentials) {
-    return { data: null };
-  }
-  throw new Error("No API key or credentials set");
+  return queryWithCredentials(query2, variables);
 };
 var appSyncClient = {
   query,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttoss/aws-appsync-nodejs",
-  "version": "1.2.0",
+  "version": "1.3.1",
   "description": "",
   "license": "MIT",
   "author": "ttoss",
@@ -12,14 +12,24 @@
     "dist/"
   ],
   "scripts": {
-    "build": "tsup"
+    "build": "tsup",
+    "test": "jest"
   },
   "dependencies": {
+    "@aws-crypto/sha256-js": "^2.0.2",
+    "@aws-sdk/credential-provider-node": "^3.231.0",
+    "@aws-sdk/protocol-http": "^3.226.0",
+    "@aws-sdk/signature-v4": "^3.226.0",
     "node-fetch": "2"
   },
+  "devDependencies": {
+    "@ttoss/config": "^1.26.0",
+    "@types/jest": "^29.2.4",
+    "jest": "^29.3.1"
+  },
   "keywords": [],
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "88b98945c469cdfdece6b12ce41243403ad2c242"
+  "gitHead": "f7fcb1caa22adf045f0ec7d15a678bfe48a3913d"
 }