@ttoss/aws-appsync-nodejs 1.7.4 → 1.8.1

package/README.md

@@ -5,7 +5,7 @@ This package implements a AWS AppSync client for Node.js. We've followed the [AW
 ## Installation
 
 ```bash
-yarn add @ttoss/aws-appsync-nodejs
+pnpm add @ttoss/aws-appsync-nodejs
 ```
 
 ## Quickstart
@@ -14,7 +14,7 @@ yarn add @ttoss/aws-appsync-nodejs
 import { appSyncClient } from '@ttoss/aws-appsync-nodejs';
 
 appSyncClient.setConfig({
-  apiEndpoint: 'https://xxxxxx.appsync-api.us-east-1.amazonaws.com/graphql',
+  endpoint: 'https://xxxxxx.appsync-api.us-east-1.amazonaws.com/graphql',
   apiKey: 'da2-xxxxxxxxxxxxxxxxxxxxxxxxxx',
 });
 
@@ -34,13 +34,13 @@ appSyncClient.query(query, { id: '1' }).then((result) => {
 
 ## Config
 
-You need to configure the client with `apiEndpoint` (required), `apiKey` (optional) and `awsCredentials` (optional).
+You need to configure the client with `endpoint` (required), `apiKey` (optional) and `credentials` (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.
+1. If you don't provide `apiKey` or `credentials`, 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',
+  endpoint: 'https://xxxxxx.appsync-api.us-east-1.amazonaws.com/graphql',
 });
 ```
 
@@ -48,17 +48,31 @@ appSyncClient.setConfig({
 
 ```typescript
 appSyncClient.setConfig({
-  apiEndpoint: 'https://xxxxxx.appsync-api.us-east-1.amazonaws.com/graphql',
+  endpoint: '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.
+3. If you provide `credentials`, the client will use the credentials to authenticate.
 
 ```typescript
 appSyncClient.setConfig({
-  apiEndpoint,
-  awsCredentials: {
+  endpoint,
+  credentials: {
+    accessKeyId: // access key id,
+    secretAccessKey: // secret access key,
+    sessionToken: // optional session token,
+  },
+});
+```
+
+If you provide the default endpoint (`https://xxxxxx.appsync-api.us-east-1.amazonaws.com/graphql`), the client will retrieve the region from the endpoint. If you provide the endpoint with the custom domain (`https://custom-domain.com`), you need to provide the region as well.
+
+```typescript
+appSyncClient.setConfig({
+  endpoint: 'https://custom-domain.com',
+  region: 'us-east-1',
+  credentials: {
     accessKeyId: // access key id,
     secretAccessKey: // secret access key,
     sessionToken: // optional session token,

package/dist/esm/index.js

@@ -1,9 +1,9 @@
 /** Powered by @ttoss/config. https://ttoss.dev/docs/modules/packages/config/ */
 
 // src/index.ts
-import { HttpRequest } from "@aws-sdk/protocol-http";
+import { HttpRequest } from "@smithy/protocol-http";
 import { Sha256 } from "@aws-crypto/sha256-js";
-import { SignatureV4 } from "@aws-sdk/signature-v4";
+import { SignatureV4 } from "@smithy/signature-v4";
 import { defaultProvider } from "@aws-sdk/credential-provider-node";
 var _config;
 var setConfig = config => {
@@ -11,7 +11,7 @@ var setConfig = config => {
 };
 var queryWithApiKey = async (query2, variables) => {
   const {
-    apiEndpoint,
+    endpoint,
     apiKey
   } = _config;
   if (!apiKey) {
@@ -27,7 +27,7 @@ var queryWithApiKey = async (query2, variables) => {
       variables
     })
   };
-  const request = new Request(apiEndpoint, options);
+  const request = new Request(endpoint, options);
   const response = await fetch(request);
   const body = await response.json();
   return body;
@@ -42,14 +42,10 @@ var getRegionFromEndpoint = endpoint => {
   return region;
 };
 var queryWithCredentials = async (query2, variables) => {
-  const {
-    apiEndpoint,
-    awsCredentials
-  } = _config;
-  const endpoint = new URL(apiEndpoint);
-  const region = getRegionFromEndpoint(apiEndpoint);
+  const endpoint = new URL(_config.endpoint);
+  const region = _config.region || getRegionFromEndpoint(_config.endpoint);
   const signer = new SignatureV4({
-    credentials: awsCredentials || defaultProvider(),
+    credentials: _config.credentials || defaultProvider(),
     region,
     service: "appsync",
     sha256: Sha256
@@ -65,7 +61,8 @@ var queryWithCredentials = async (query2, variables) => {
       query: query2,
       variables
     }),
-    path: endpoint.pathname
+    path: endpoint.pathname,
+    protocol: endpoint.protocol
   });
   const signed = await signer.sign(requestToBeSigned);
   const request = new Request(endpoint, signed);

package/dist/index.d.mts

@@ -6,11 +6,12 @@ import { AwsCredentialIdentity } from '@aws-sdk/types';
  */
 
 type Config = {
-    apiEndpoint: string;
+    endpoint: string;
+    region?: string;
     apiKey?: string;
-    awsCredentials?: AwsCredentialIdentity;
+    credentials?: AwsCredentialIdentity;
 };
-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.d.ts

@@ -6,11 +6,12 @@ import { AwsCredentialIdentity } from '@aws-sdk/types';
  */
 
 type Config = {
-    apiEndpoint: string;
+    endpoint: string;
+    region?: string;
     apiKey?: string;
-    awsCredentials?: AwsCredentialIdentity;
+    credentials?: AwsCredentialIdentity;
 };
-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,9 +30,9 @@ __export(src_exports, {
   appSyncClient: () => appSyncClient
 });
 module.exports = __toCommonJS(src_exports);
-var import_protocol_http = require("@aws-sdk/protocol-http");
+var import_protocol_http = require("@smithy/protocol-http");
 var import_sha256_js = require("@aws-crypto/sha256-js");
-var import_signature_v4 = require("@aws-sdk/signature-v4");
+var import_signature_v4 = require("@smithy/signature-v4");
 var import_credential_provider_node = require("@aws-sdk/credential-provider-node");
 var _config;
 var setConfig = config => {
@@ -40,7 +40,7 @@ var setConfig = config => {
 };
 var queryWithApiKey = async (query2, variables) => {
   const {
-    apiEndpoint,
+    endpoint,
     apiKey
   } = _config;
   if (!apiKey) {
@@ -56,7 +56,7 @@ var queryWithApiKey = async (query2, variables) => {
       variables
     })
   };
-  const request = new Request(apiEndpoint, options);
+  const request = new Request(endpoint, options);
   const response = await fetch(request);
   const body = await response.json();
   return body;
@@ -71,14 +71,10 @@ var getRegionFromEndpoint = endpoint => {
   return region;
 };
 var queryWithCredentials = async (query2, variables) => {
-  const {
-    apiEndpoint,
-    awsCredentials
-  } = _config;
-  const endpoint = new URL(apiEndpoint);
-  const region = getRegionFromEndpoint(apiEndpoint);
+  const endpoint = new URL(_config.endpoint);
+  const region = _config.region || getRegionFromEndpoint(_config.endpoint);
   const signer = new import_signature_v4.SignatureV4({
-    credentials: awsCredentials || (0, import_credential_provider_node.defaultProvider)(),
+    credentials: _config.credentials || (0, import_credential_provider_node.defaultProvider)(),
     region,
     service: "appsync",
     sha256: import_sha256_js.Sha256
@@ -94,7 +90,8 @@ var queryWithCredentials = async (query2, variables) => {
       query: query2,
       variables
     }),
-    path: endpoint.pathname
+    path: endpoint.pathname,
+    protocol: endpoint.protocol
   });
   const signed = await signer.sign(requestToBeSigned);
   const request = new Request(endpoint, signed);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttoss/aws-appsync-nodejs",
-  "version": "1.7.4",
+  "version": "1.8.1",
   "description": "",
   "license": "MIT",
   "author": "ttoss",
@@ -12,22 +12,29 @@
     "url": "https://github.com/ttoss/ttoss.git",
     "directory": "packages/aws-appsync-nodejs"
   },
-  "main": "dist/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
   "files": [
-    "dist/"
+    "dist/",
+    "src/"
   ],
   "dependencies": {
     "@aws-crypto/sha256-js": "^5.2.0",
-    "@aws-sdk/credential-provider-node": "^3.460.0",
-    "@aws-sdk/protocol-http": "^3.370.0",
-    "@aws-sdk/signature-v4": "^3.370.0"
+    "@aws-sdk/credential-provider-node": "^3.503.1",
+    "@smithy/protocol-http": "^3.1.1",
+    "@smithy/signature-v4": "^2.1.1"
   },
   "devDependencies": {
-    "@aws-sdk/types": "^3.460.0",
-    "@types/jest": "^29.5.11",
+    "@aws-sdk/types": "^3.502.0",
+    "@types/jest": "^29.5.12",
     "jest": "^29.7.0",
-    "tsup": "^8.0.1",
-    "@ttoss/config": "^1.31.4"
+    "tsup": "^8.0.2",
+    "@ttoss/config": "^1.31.5"
   },
   "keywords": [],
   "engines": {

package/src/index.ts

@@ -0,0 +1,120 @@
+/**
+ * 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/
+ */
+import { AwsCredentialIdentity } from '@aws-sdk/types';
+import { HttpRequest } from '@smithy/protocol-http';
+import { Sha256 } from '@aws-crypto/sha256-js';
+import { SignatureV4 } from '@smithy/signature-v4';
+import { defaultProvider } from '@aws-sdk/credential-provider-node';
+
+export type Config = {
+  endpoint: string;
+  region?: string;
+  apiKey?: string;
+  credentials?: AwsCredentialIdentity;
+};
+
+let _config: Config;
+
+const setConfig = (config: Config) => {
+  _config = config;
+};
+
+export type Query = (
+  query: string,
+  variables?: Record<string, unknown>
+) => Promise<{
+  data: Record<string, unknown> | null;
+  errors?: {
+    message: string;
+    path: string | null;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    locations: any[];
+  }[];
+}>;
+
+const queryWithApiKey: Query = async (query, variables) => {
+  const { endpoint, apiKey } = _config;
+
+  if (!apiKey) {
+    throw new Error('No API Key set');
+  }
+
+  const options: RequestInit = {
+    method: 'POST',
+    headers: {
+      'x-api-key': apiKey,
+    },
+    body: JSON.stringify({ query, variables }),
+  };
+
+  const request = new Request(endpoint, options);
+
+  const response = await fetch(request);
+
+  const body = await response.json();
+
+  return body;
+};
+
+const getRegionFromEndpoint = (endpoint: string): string => {
+  const matcher = /\.[a-z]+-[a-z]+-[0-9]\./;
+  const regexResponse = endpoint.match(matcher);
+  let region = '';
+  if (regexResponse) {
+    region = regexResponse[0].replace(/\./g, '');
+  }
+  return region;
+};
+
+const queryWithCredentials: Query = async (query, variables) => {
+  const endpoint = new URL(_config.endpoint);
+
+  const region = _config.region || getRegionFromEndpoint(_config.endpoint);
+
+  const signer = new SignatureV4({
+    credentials: _config.credentials || 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, variables }),
+    path: endpoint.pathname,
+    protocol: endpoint.protocol,
+  });
+
+  const signed = await signer.sign(requestToBeSigned);
+
+  const request = new Request(endpoint, signed);
+
+  const response = await fetch(request);
+
+  const body = await response.json();
+
+  return body;
+};
+
+const query: Query = async (query, variables) => {
+  if (_config.apiKey) {
+    return queryWithApiKey(query, variables);
+  }
+
+  return queryWithCredentials(query, variables);
+};
+
+export const appSyncClient = {
+  query,
+  setConfig,
+  get config() {
+    return _config;
+  },
+};