Update README

Author: smguggen

.github/README.md

@@ -1 +1 @@
-declare module 'aws-quick-api-config';
+declare module 'aws-dynasync';

README.md

@@ -2,7 +2,7 @@ import { Construct } from 'constructs';
 import { AppSyncSchema } from './schema';
 import { getName, validateTable } from '../util';
 import { DbTable } from '../db/table';
-import { SchemaTable } from '../types';
+import { SchemaTable, GraphQlTypeList } from '../types';
 import { 
     GraphqlApi, 
     ISchema,
@@ -11,12 +11,11 @@ import {
     UserPoolConfig
 } from 'aws-cdk-lib/aws-appsync';
 import { IUserPool } from 'aws-cdk-lib/aws-cognito';
-import { IntermediateParams } from './schema-alpha';
 
 export interface AppSyncStackProps {
     config: UserPoolConfig
     tables: (DbTable | SchemaTable)[]
-    schemaTypes?: IntermediateParams
+    schemaTypes?: GraphQlTypeList
 }
 
 export class AppSyncStack {

assets/images/db.png

@@ -1,53 +1,12 @@
-import { IGraphqlApi, ISchemaConfig, Resolver } from "aws-cdk-lib/aws-appsync";
+import { IGraphqlApi, ISchemaConfig } from "aws-cdk-lib/aws-appsync";
 import { 
     GraphqlApi as GraphqlApiAlpha, 
     Field, 
     IIntermediateType, 
     ObjectType, 
     ResolvableField, 
-    Directive,
-    InterfaceType,
-    IField
 } from "@aws-cdk/aws-appsync-alpha";
 import { Lazy } from "aws-cdk-lib";
-import { SchemaObject } from "../types";
-
-export interface IntermediateTypes {
-    [name:string]: IIntermediateType
-}  
-
-export type IntermediateType = 'type' | 'input' | 'interface' | 'union' | 'enum';
-
-export interface IntermediateParams {
-    types?: IntermediateTypeList
-    interfaces?: IntermediateTypeList
-    inputs?: IntermediateTypeList
-    unions?:  {[name:string]: (string | IIntermediateType)[]}
-    enums?:  {[name:string]: string[]}
-}
-
-export interface SchemaFields {
-    [name:string]: IField
-} 
-
-export interface IntermediateTypeBase {
-    directives?: Directive[]
-    interfaceTypes?: InterfaceType[]
-    intermediateType?: IIntermediateType
-    resolvers?: Resolver[]
-}
-
-export interface IntermediateTypeProps extends IntermediateTypeBase {
-    definition: SchemaObject
-}
-
-export interface IntermediateTypeOptions extends IntermediateTypeBase {
-    definition: SchemaFields
-}
-
-export interface IntermediateTypeList {
-    [name:string]: IntermediateTypeProps | SchemaObject
-}
 
 /**
  * Class based on aws-appsync alpha Schema class,

index.d.ts

@@ -5,14 +5,16 @@ import {
 } from 'aws-cdk-lib/aws-appsync';
 import { DbTable } from '../db/table';
 import { 
-    SchemaAlpha,
-    IntermediateParams, 
+    SchemaAlpha
+} from './schema-alpha';
+import { 
+    SchemaObject,
+    GraphQlTypeList, 
     IntermediateType, 
     IntermediateTypeProps, 
     IntermediateTypes, 
     SchemaFields
-} from './schema-alpha';
-import { SchemaObject } from '../types';
+} from '../types';
 import { 
     GraphqlType, 
     BaseTypeOptions, 
@@ -39,7 +41,7 @@ export class AppSyncSchema implements ISchema {
     protected customTypes:string[] = []
     protected types:IntermediateTypes = {}
 
-    constructor(types?:IntermediateParams) {
+    constructor(types?:GraphQlTypeList) {
         if (types && Object.keys(types).length) this.initTypes(types);
     }
 
@@ -209,7 +211,7 @@ export class AppSyncSchema implements ISchema {
         }
     }
 
-    initTypes(types:IntermediateParams = {}) {
+    initTypes(types:GraphQlTypeList = {}) {
         for (let intermediateType in types) {
             if (types.hasOwnProperty(intermediateType)) {
                 const keys = Object.keys(types[intermediateType]);

src/api/index.ts

@@ -15,6 +15,11 @@ export class Dynasync extends Resource {
         tables:[],
         types: {}
     }
+
+    public static init(scope:Construct, id: string, props?:DynasyncProps): Dynasync {
+        return new Dynasync(scope,id,props);
+    }
+
     constructor(
         protected scope: Construct, 
         protected id: string, 
@@ -28,11 +33,14 @@ export class Dynasync extends Resource {
             if (!existsSync($props.configFile)) throw new Error(`Config file ${$props.configFile} does not exist`);
             if (!/json/.test(extname($props.configFile)))  throw new Error(`File at ${$props.configFile} is not JSON file`);
         }
-        const configFilePath = $props.configFile || join(process.cwd(), 'tables.json');
+        const configFilePath = $props.configFile || join(process.cwd(), 'dynasync.json');
         if (existsSync(configFilePath)) {
             this.$config = JSON.parse(readFileSync(configFilePath).toString());
         }
         const properties = this.props;
+        if (!properties.tables?.length) {
+            throw new Error("No tables provided. Cannot build API and Database without tables. Please configure parameters or provide 'dynasync.json' config file");
+        }
         const userPool =  properties.userPool || new UserPool(scope, `${id}UserPool`);
         this.appsync = new AppSyncStack(scope, `${id}AppSyncStack`, {
             config: {

src/api/schema-alpha.ts

@@ -6,15 +6,15 @@ import { SchemaGlobalIndex } from "./key/global"
 import { SchemaLocalIndex } from "./key/local"
 import { ResourceProps } from "aws-cdk-lib"
 import { IUserPool } from "aws-cdk-lib/aws-cognito"
-import {
-    IntermediateParams
-} from './api/schema-alpha';
 import { DbTable } from "./db/table"
+import { Directive, IField, IIntermediateType, InterfaceType } from "@aws-cdk/aws-appsync-alpha"
+import { Resolver } from "aws-cdk-lib/aws-appsync"
+
 export interface DynasyncProps extends ResourceProps {
     userPool?: IUserPool
     tables?: (DbTable | SchemaTable)[]
     configFile?: string
-    types?: IntermediateParams
+    types?: GraphQlTypeList
     userPoolRegex?: string
     userPoolDeny?: boolean
 }
@@ -63,6 +63,14 @@ export interface SchemaGlobal {
     capacity?: Capacity
 }
 
+export interface GraphQlTypeList {
+    types?: IntermediateTypeList
+    interfaces?: IntermediateTypeList
+    inputs?: IntermediateTypeList
+    unions?:  {[name:string]: (string | IIntermediateType)[]}
+    enums?:  {[name:string]: string[]}
+}
+
 export interface SchemaLocal {
     sortKey: string | KeyInstance
     include?: string[]
@@ -95,3 +103,32 @@ export type SchemaObject = Record<string, string>
 export type GraphType = 'id' | 'string' | 'int' | 'float' | 'boolean' | 
 'awsDate' | 'awsTime' | 'awsDateTime' | 'awsTimestamp' | 'awsEmail' | 
 'awsJson' | 'awsUrl' | 'awsPhone' | 'awsIpAddress' | 'intermediate'
+
+export interface IntermediateTypes {
+    [name:string]: IIntermediateType
+}  
+
+export type IntermediateType = 'type' | 'input' | 'interface' | 'union' | 'enum';
+
+export interface SchemaFields {
+    [name:string]: IField
+} 
+
+export interface IntermediateTypeBase {
+    directives?: Directive[]
+    interfaceTypes?: InterfaceType[]
+    intermediateType?: IIntermediateType
+    resolvers?: Resolver[]
+}
+
+export interface IntermediateTypeProps extends IntermediateTypeBase {
+    definition: SchemaObject
+}
+
+export interface IntermediateTypeOptions extends IntermediateTypeBase {
+    definition: SchemaFields
+}
+
+export interface IntermediateTypeList {
+    [name:string]: IntermediateTypeProps | SchemaObject
+}

src/api/schema.ts

@@ -1,6 +1,6 @@
 import { join } from "path";
 
-export const pathToJson = join(__dirname, 'tables.json');
+export const pathToJson = join(__dirname, 'dynasync.json');
 
 export const  passedTypes =  {               
     types: {

src/index.ts

@@ -3,9 +3,9 @@ import { Dynasync } from '../../src';
 import { App, Stack } from 'aws-cdk-lib';
 import { join } from 'path';
 import { UserPool } from 'aws-cdk-lib/aws-cognito';
-import {tables} from '../tables.json';
+import {tables} from '../dynasync.json';
 import { writeFileSync } from 'fs';
-import { SchemaTable, SchemaTableInstance } from '../../src/types';
+import { SchemaTable } from '../../src/types';
 import { definition } from '../schema';
 import { pathToJson, passedTypes } from '../data';
 import { DbTable } from '../../src/db/table';

src/types.ts

@@ -2,7 +2,7 @@
   "compilerOptions": {
     "target":"ES2018",
     "module": "commonjs",
-    "lib": ["es2016", "es2017.object", "es2017.string"],
+    "lib": ["es2018"],
     "declaration": true,
     "outDir": "lib",
     "declarationDir": "lib/types",