Skip to content

Commit

Permalink
feat: migrate to TypeScript (#150)
Browse files Browse the repository at this point in the history
* feat: setup typescript

* chore: make typescript files out of declaration files

* chore: please linter by ordering right

* chore: remove unused type

* chore: migrate builder to typescript

* chore: migrate consts to typescript

* chore: migrate main to typescript

* chore: extend eslint to typescript

* chore: extend prettier to typescript files

* chore: fix tests

* Update package.json

Co-authored-by: Eduardo Bouças <mail@eduardoboucas.com>

* chore: add missing npm-run-all dependency

Co-authored-by: Netlify Team Account 1 <netlify-team-account-1@users.noreply.github.com>
Co-authored-by: Eduardo Bouças <mail@eduardoboucas.com>
  • Loading branch information
3 people authored Oct 26, 2021
1 parent 3686a7e commit d79ed42
Show file tree
Hide file tree
Showing 17 changed files with 188 additions and 91 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ node_modules
/coverage
/build
.vscode
dist
4 changes: 3 additions & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 13 additions & 10 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
{
"name": "@netlify/functions",
"main": "./src/main.js",
"types": "./src/main.d.ts",
"main": "./dist/main.js",
"types": "./dist/main.d.ts",
"version": "0.7.2",
"description": "JavaScript utilities for Netlify Functions",
"files": [
"src/**/*.js",
"src/**/*.ts",
"!src/**/*.test.js"
"dist/**/*.js",
"dist/**/*.d.ts"
],
"scripts": {
"build": "tsc",
"prepack": "npm run build",
"prepublishOnly": "npm ci && npm test",
"test": "run-s format test:dev",
"format": "run-s format:check-fix:*",
Expand All @@ -20,14 +21,14 @@
"format:check-fix:prettier": "run-e format:check:prettier format:fix:prettier",
"format:check:prettier": "cross-env-shell prettier --check $npm_package_config_prettier",
"format:fix:prettier": "cross-env-shell prettier --write $npm_package_config_prettier",
"test:dev": "run-s test:dev:*",
"test:ci": "run-s test:ci:*",
"test:dev": "run-s build test:dev:*",
"test:ci": "run-s build test:ci:*",
"test:dev:ava": "ava",
"test:ci:ava": "nyc -r lcovonly -r text -r json ava"
},
"config": {
"eslint": "--ignore-pattern README.md --ignore-path .gitignore --cache --format=codeframe --max-warnings=0 \"{src,scripts,.github}/**/*.{js,md,html}\" \"*.{js,md,html}\" \".*.{js,md,html}\"",
"prettier": "--ignore-path .gitignore --loglevel=warn \"{src,scripts,.github}/**/*.{js,md,yml,json,html}\" \"*.{js,yml,json,html}\" \".*.{js,yml,json,html}\" \"!**/package-lock.json\" \"!package-lock.json\""
"eslint": "--ignore-pattern README.md --ignore-path .gitignore --cache --format=codeframe --max-warnings=0 \"{src,scripts,.github}/**/*.{ts,js,md,html}\" \"*.{ts,js,md,html}\" \".*.{ts,js,md,html}\"",
"prettier": "--ignore-path .gitignore --loglevel=warn \"{src,scripts,.github}/**/*.{ts,js,md,yml,json,html}\" \"*.{ts,js,yml,json,html}\" \".*.{ts,js,yml,json,html}\" \"!**/package-lock.json\" \"!package-lock.json\""
},
"ava": {
"files": [
Expand Down Expand Up @@ -60,7 +61,9 @@
"@netlify/eslint-config-node": "^3.3.4",
"ava": "^2.4.0",
"husky": "^4.3.8",
"nyc": "^15.0.0"
"npm-run-all": "^4.1.5",
"nyc": "^15.0.0",
"typescript": "^4.4.4"
},
"engines": {
"node": ">=8.3.0"
Expand Down
3 changes: 3 additions & 0 deletions src/function/context.d.ts → src/function/context.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// eslint-disable-next-line eslint-comments/disable-enable-pair
/* eslint-disable @typescript-eslint/no-explicit-any */

// From https://docs.aws.amazon.com/lambda/latest/dg/nodejs-prog-model-context.html.
export interface Context {
callbackWaitsForEmptyEventLoop: boolean
Expand Down
30 changes: 13 additions & 17 deletions src/function/event.d.ts → src/function/event.ts
Original file line number Diff line number Diff line change
@@ -1,16 +1,3 @@
export interface Event {
rawUrl: string
rawQuery: string
path: string
httpMethod: string
headers: EventHeaders
multiValueHeaders: EventMultiValueHeaders
queryStringParameters: EventQueryStringParameters | null
multiValueQueryStringParameters: EventMultiValueQueryStringParameters | null
body: string | null
isBase64Encoded: boolean
}

interface EventHeaders {
[name: string]: string | undefined
}
Expand All @@ -19,14 +6,23 @@ interface EventMultiValueHeaders {
[name: string]: string[] | undefined
}

interface EventPathParameters {
[name: string]: string | undefined
}

interface EventQueryStringParameters {
[name: string]: string | undefined
}

interface EventMultiValueQueryStringParameters {
[name: string]: string[] | undefined
}

export interface Event {
rawUrl: string
rawQuery: string
path: string
httpMethod: string
headers: EventHeaders
multiValueHeaders: EventMultiValueHeaders
queryStringParameters: EventQueryStringParameters | null
multiValueQueryStringParameters: EventMultiValueQueryStringParameters | null
body: string | null
isBase64Encoded: boolean
}
1 change: 1 addition & 0 deletions src/function/handler.d.ts → src/function/handler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import type { Event } from './event'
import type { Response } from './response'

export interface HandlerCallback {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(error: any, response: Response): void
}

Expand Down
File renamed without changes.
File renamed without changes.
7 changes: 0 additions & 7 deletions src/lib/builder.d.ts

This file was deleted.

44 changes: 0 additions & 44 deletions src/lib/builder.js

This file was deleted.

49 changes: 49 additions & 0 deletions src/lib/builder.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
import isPromise from 'is-promise'

import { Handler } from '../function/handler'
import { Response } from '../function/response'

import { BUILDER_FUNCTIONS_FLAG, HTTP_STATUS_METHOD_NOT_ALLOWED, HTTP_STATUS_OK, METADATA_VERSION } from './consts'

const augmentResponse = (response: Response) => {
if (!response || response.statusCode !== HTTP_STATUS_OK) {
return response
}

return {
...response,
metadata: { version: METADATA_VERSION, builder_function: BUILDER_FUNCTIONS_FLAG },
}
}

const wrapHandler =
(handler: Handler): Handler =>
// eslint-disable-next-line promise/prefer-await-to-callbacks
(event, context, callback) => {
if (event.httpMethod !== 'GET' && event.httpMethod !== 'HEAD') {
return Promise.resolve({
body: 'Method Not Allowed',
statusCode: HTTP_STATUS_METHOD_NOT_ALLOWED,
})
}

// Removing query string parameters from the builder function.
const modifiedEvent = {
...event,
multiValueQueryStringParameters: {},
queryStringParameters: {},
}

// eslint-disable-next-line promise/prefer-await-to-callbacks
const wrappedCallback = (error: unknown, response: Response) => callback(error, augmentResponse(response))
const execution = handler(modifiedEvent, context, wrappedCallback)

if (isPromise(execution)) {
// eslint-disable-next-line promise/prefer-await-to-then
return execution.then(augmentResponse)
}

return execution
}

export { wrapHandler as builder }
7 changes: 1 addition & 6 deletions src/lib/consts.js → src/lib/consts.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,4 @@ const HTTP_STATUS_METHOD_NOT_ALLOWED = 405
const HTTP_STATUS_OK = 200
const METADATA_VERSION = 1

module.exports = {
BUILDER_FUNCTIONS_FLAG,
HTTP_STATUS_METHOD_NOT_ALLOWED,
HTTP_STATUS_OK,
METADATA_VERSION,
}
export { BUILDER_FUNCTIONS_FLAG, HTTP_STATUS_METHOD_NOT_ALLOWED, HTTP_STATUS_OK, METADATA_VERSION }
2 changes: 0 additions & 2 deletions src/main.d.ts

This file was deleted.

3 changes: 0 additions & 3 deletions src/main.js

This file was deleted.

2 changes: 2 additions & 0 deletions src/main.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export { builder } from './lib/builder'
export * from './function'
2 changes: 1 addition & 1 deletion test/builder.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
const test = require('ava')

const { builder } = require('../src/lib/builder')
const { builder } = require('../dist/lib/builder')

const { invokeLambda } = require('./helpers/main')

Expand Down
101 changes: 101 additions & 0 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig.json to read more about this file */

/* Projects */
// "incremental": true, /* Enable incremental compilation */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./", /* Specify the folder for .tsbuildinfo incremental compilation files. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */

/* Language and Environment */
"target": "es5" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
// "reactNamespace": "", /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */

/* Modules */
"module": "commonjs" /* Specify what module code is generated. */,
"rootDir": "./src" /* Specify the root folder within your source files. */,
// "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like `./node_modules/@types`. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "resolveJsonModule": true, /* Enable importing .json files */
// "noResolve": true, /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */

/* JavaScript Support */
"allowJs": true /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */,
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */

/* Emit */
"declaration": true /* Generate .d.ts files from TypeScript and JavaScript files in your project. */,
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
"outDir": "./dist" /* Specify an output folder for all emitted files. */,
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like `__extends` in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing `const enum` declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */

/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */,
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,

/* Type Checking */
"strict": true /* Enable all strict type-checking options. */,
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied `any` type.. */
// "strictNullChecks": true, /* When type checking, take into account `null` and `undefined`. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when `this` is given the type `any`. */
// "useUnknownInCatchVariables": true, /* Type catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when a local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */

/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
},
"include": ["src"]
}

0 comments on commit d79ed42

Please sign in to comment.