Export spot core functionality (#1040)

README.md

@@ -113,6 +113,31 @@ You can then run a generator with:
 npx @airtasker/spot generate --contract api.ts
 ```
 
+## In Memory Usage
+
+```ts
+import { Spot } from "@airtasker/spot";
+
+const contract = Spot.parseContract("./api.ts")
+const openApi = Spot.OpenApi3.generateOpenAPI3(contract);
+
+console.log(openApi);
+
+/*
+{
+  openapi: '3.0.2',
+  info: { title: 'my-api', description: undefined, version: '0.0.0' },
+  paths: { '/users': { post: [Object] } },
+  components: {
+    schemas: { CreateUserRequest: [Object], CreateUserResponse: [Object] },
+    securitySchemes: undefined
+  },
+  security: undefined
+}
+*/
+
+```
+
 # Commands
 
 <!-- commands -->
@@ -203,7 +228,7 @@ OPTIONS
   --all  see all commands in CLI
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.1.0/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.0/src/commands/help.ts)_
 
 ## `spot init`
 

index.ts

@@ -0,0 +1 @@
+export * from "./lib/src/lib";

lib/src/core.ts

@@ -0,0 +1,6 @@
+import * as JsonSchema from "./generators/json-schema";
+import * as OpenApi2 from "./generators/openapi2";
+import * as OpenApi3 from "./generators/openapi3";
+import { parse } from "./parser";
+
+export { parse as parseContract, OpenApi2, OpenApi3, JsonSchema };

lib/src/generators/json-schema/index.ts

@@ -0,0 +1,2 @@
+export { generateJsonSchema } from "./json-schema";
+export * as Specification from "./json-schema-specification";

lib/src/generators/openapi2/index.ts

@@ -0,0 +1,2 @@
+export { generateOpenAPI2 } from "./openapi2";
+export * as Specification from "./openapi2-specification";

lib/src/generators/openapi3/index.ts

@@ -0,0 +1,2 @@
+export { generateOpenAPI3 } from "./openapi3";
+export * as Specification from "./openapi3-specification";

lib/src/lib.ts

@@ -1 +1,2 @@
+export * as Spot from "./core";
 export * from "./syntax";

lib/src/parsers/headers-parser.ts

@@ -1,4 +1,4 @@
-import { ParameterDeclaration, PropertySignature, TypeGuards } from "ts-morph";
+import { ParameterDeclaration, PropertySignature } from "ts-morph";
 import { Header } from "../definitions";
 import { OptionalNotAllowedError, ParserError } from "../errors";
 import { isHeaderTypeSafe } from "../http";

lib/src/parsers/parser-helpers.ts

@@ -2,7 +2,6 @@ import {
   ArrayLiteralExpression,
   ClassDeclaration,
   Decorator,
-  InterfaceDeclaration,
   JSDoc,
   JSDocableNode,
   MethodDeclaration,
@@ -16,14 +15,10 @@ import {
   StringLiteral,
   ts,
   TypeGuards,
-  TypeLiteralNode,
-  TypeNode,
-  TypeReferenceNode
+  TypeNode
 } from "ts-morph";
 import { HttpMethod, QueryParamArrayStrategy } from "../definitions";
 import { getTargetDeclarationFromTypeReference } from "./type-parser";
-import { Result } from "../util";
-import { ParserError } from "../errors";
 
 // FILE HELPERS
 

package.json

@@ -73,8 +73,8 @@
     "npm-shrinkwrap.json",
     "oclif.manifest.json"
   ],
-  "main": "index.js",
-  "types": "index.d.ts",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
   "homepage": "https://github.com/airtasker/spot",
   "license": "MIT",
   "oclif": {

tsconfig.json

@@ -1,52 +1,58 @@
 {
   "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
     /* Basic Options */
-    "target": "es2019" /* Optional chaining was introduced in es2020. This project supports node >= 12. Only node >= 14 supports optional chaining. */,
-    "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
+    // "incremental": true,                   /* Enable incremental compilation */
+    // Optional chaining was introduced in es2020. This project supports node >= 12. Only node >= 14 supports optional chaining.
+    "target": "es2019",                       /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
+    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
     // "lib": [],                             /* Specify library files to be included in the compilation. */
     // "allowJs": true,                       /* Allow javascript files to be compiled. */
     // "checkJs": true,                       /* Report errors in .js files. */
     // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
-    "declaration": true /* Generates corresponding '.d.ts' file. */,
+    "declaration": true,                      /* Generates corresponding '.d.ts' file. */
     // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
     // "sourceMap": true,                     /* Generates corresponding '.map' file. */
     // "outFile": "./",                       /* Concatenate and emit output to single file. */
-    "outDir": "build/" /* Redirect output structure to the directory. */,
+    "outDir": "build/",                       /* Redirect output structure to the directory. */
     // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
-    // "composite": true, /* Enable project compilation */,
+    // "composite": true,                     /* Enable project compilation */
     // "removeComments": true,                /* Do not emit comments to output. */
     // "noEmit": true,                        /* Do not emit outputs. */
     // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
     // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
     // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
 
     /* Strict Type-Checking Options */
-    "strict": true /* Enable all strict type-checking options. */,
-    "noImplicitAny": true /* Raise error on expressions and declarations with an implied 'any' type. */,
-    "strictNullChecks": true /* Enable strict null checks. */,
-    "strictFunctionTypes": true /* Enable strict checking of function types. */,
-    "strictPropertyInitialization": true /* Enable strict checking of property initialization in classes. */,
-    "noImplicitThis": true /* Raise error on 'this' expressions with an implied 'any' type. */,
-    "alwaysStrict": true /* Parse in strict mode and emit "use strict" for each source file. */,
+    "strict": true,                           /* Enable all strict type-checking options. */
+    "noImplicitAny": true,                    /* Raise error on expressions and declarations with an implied 'any' type. */
+    "strictNullChecks": true,                 /* Enable strict null checks. */
+    "strictFunctionTypes": true,              /* Enable strict checking of function types. */
+    "strictBindCallApply": true,              /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    "strictPropertyInitialization": true,     /* Enable strict checking of property initialization in classes. */
+    "noImplicitThis": true,                   /* Raise error on 'this' expressions with an implied 'any' type. */
+    "alwaysStrict": true,                     /* Parse in strict mode and emit "use strict" for each source file. */
 
     /* Additional Checks */
     // "noUnusedLocals": true,                /* Report errors on unused locals. */
     // "noUnusedParameters": true,            /* Report errors on unused parameters. */
-    "noImplicitReturns": true /* Report error when not all code paths in function return a value. */,
-    "noFallthroughCasesInSwitch": true /* Report errors for fallthrough cases in switch statement. */,
+    "noImplicitReturns": true,                /* Report error when not all code paths in function return a value. */
+    "noFallthroughCasesInSwitch": true,       /* Report errors for fallthrough cases in switch statement. */
 
     /* Module Resolution Options */
-    "moduleResolution": "node" /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */,
-    "baseUrl": "./" /* Base directory to resolve non-absolute module names. */,
-    "paths": {
+    "moduleResolution": "node",               /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    "baseUrl": "./",                          /* Base directory to resolve non-absolute module names. */
+    "paths": {                                /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
       "@airtasker/spot": ["./lib/src/lib"]
-    } /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */,
+    },
     // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
     // "typeRoots": [],                       /* List of folders to include type definitions from. */
     // "types": [],                           /* Type declaration files to be included in compilation. */
-    "allowSyntheticDefaultImports": true /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */,
-    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
+    "allowSyntheticDefaultImports": true,     /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
     // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
 
     /* Source Map Options */
     // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
@@ -55,9 +61,13 @@
     // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
 
     /* Experimental Options */
-    "experimentalDecorators": true /* Enables experimental support for ES7 decorators. */
+    "experimentalDecorators": true,           /* Enables experimental support for ES7 decorators. */
     // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+
+    /* Advanced Options */
+    "skipLibCheck": true,                     /* Skip type checking of declaration files. */
+    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
   },
-  "include": ["cli/src", "lib/src"],
+  "include": ["cli/src", "lib/src", "index.ts"],
   "exclude": ["**/*.spec.ts", "**/__spec-examples__/*"]
 }