Merge pull request #1 from speakeasy-api/kevincai/SPE-265-initial-setup

Creating simple typescript repository

Author: kevincai3

.gitignore

@@ -0,0 +1,4 @@
+node_modules
+.DS_Store
+.husky
+dist/*

.nvmrc

@@ -0,0 +1 @@
+v16.16.0

.prettierrc.json

@@ -0,0 +1 @@
+{}

README.md

@@ -1 +1,17 @@
-# speakeasy-typescript-sdk
+# speakeasy-typescript-sdk
+
+## Setting up
+
+Feel free to use any system to manage your Node installing, but a `.nvmrc` is included in the library for `nvm` support.
+
+To setup:
+
+1. Install `nvm` following instructions on (nvm repo)[https://github.com/nvm-sh/nvm]
+2. Install the correct node version with `nvm install`
+3. Make sure the symlinks are correct with `nvm use`
+
+## Formating, Linting & Testing
+
+`prettier` is used with `husky` and `lint-staged` to lint on commit, which should be installed automatically by `npm`.
+
+Use `yarn test` to run the test suite.

jest.config.ts

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+};

package.json

@@ -0,0 +1,38 @@
+{
+  "name": "speakeasy-typescript-sdk",
+  "version": "0.0.1",
+  "main": "index.js",
+  "repository": "git@github.com:speakeasy-api/speakeasy-typescript-sdk.git",
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/express": "^4.17.13",
+    "@types/har-format": "^1.2.8",
+    "@types/jest": "^28.1.6",
+    "@types/node": "^18.6.0",
+    "@types/supertest": "^2.0.12",
+    "husky": "^8.0.1",
+    "jest": "^28.1.3",
+    "lint-staged": "^13.0.3",
+    "prettier": "^2.7.1",
+    "supertest": "^6.2.4",
+    "ts-jest": "^28.0.7",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.7.4"
+  },
+  "peerDepedencies": {
+    "express": "^4.18.1"
+  },
+  "scripts": {
+    "build": "yarn tsc",
+    "test": "yarn jest",
+    "prepare": "yarn husky install"
+  },
+  "dependencies": {},
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "lint-staged": {
+    "**/*": "prettier --write --ignore-unknown"
+  }
+}

src/client.ts

@@ -0,0 +1,26 @@
+const DEFAULT_SPEAKEASY_SERVER_URL = "grpc.speakeasyapi.dev:443";
+
+export type Config = {
+  apiKey: string;
+};
+
+export class SpeakeasySDK {
+  apiKey: string;
+  serverUrl: string;
+
+  public constructor(config: Config) {
+    const { apiKey } = config;
+    if (apiKey == null) {
+      throw new Error("Speakeasy API key is required");
+    }
+
+    this.apiKey = config.apiKey;
+
+    const serverUrl = process.env.SPEAKEASY_SERVER_URL;
+    if (serverUrl) {
+      this.serverUrl = serverUrl;
+    } else {
+      this.serverUrl = DEFAULT_SPEAKEASY_SERVER_URL;
+    }
+  }
+}

src/error.ts

@@ -0,0 +1,3 @@
+export function outputError(errMsg: string): void {
+  console.error(errMsg);
+}

src/index.ts

@@ -0,0 +1 @@
+export { SpeakeasySDK } from "./client";

src/middleware/express/middleware.ts

@@ -0,0 +1,19 @@
+import { Request, Response } from "express";
+import { getInstance } from "../../speakeasy";
+import { sendApiCall } from "../../transport";
+import { outputError } from "../../error";
+
+export function expressMiddleware() {
+  return function (req: Request, res: Response, next: () => void) {
+    const speakeasy = getInstance();
+    if (speakeasy == null) {
+      outputError("Speakeasy has not been initialized");
+      return next();
+    }
+
+    res.on("finish", () => {
+      sendApiCall();
+    });
+    next();
+  };
+}