export declarations

tesler-platform · Jan 28, 2021 · 572a650 · 572a650
1 parent 87434b7
commit 572a650
Show file tree

Hide file tree

Showing 15 changed files with 44 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,19 @@
+# Version 0.2.0 (January 28, 2021)
+
+## Features
+
+* Source types for JSON schemas are now exported and can be extended in your application to customize generated schemas.
+0.3.0 is scheduled to export a function that will take customized types as arguments and will generate schemas based on provided customization.
+```ts
+import { ScreenMetaJson } from '@tesler-ui/schema'
+
+export interface CustomScreenMetaJson extends ScreenMeta {
+    customField: number // add or modify fields if your *.screen.json file format is different
+}
+```
+
+* Some types that previously were declared in [Tesler-UI](https://github.com/tesler-platform/tesler-ui) are moved here as they in fact affect both backend and frontend applications; Tesler UI will reexport those types so nothing should break if you referenced them from your application directly.
+
 # Version 0.1.3 (January 26, 2021)
 
 ## Fixes

diff --git a/README.md b/README.md
@@ -16,6 +16,13 @@ yarn add @tesler-ui/schema
 },
 ```
 
+### Disable `@tesler-ui/schema` in the `browser` section of your `package.json` file:
+```json
+"browser": {
+    "@tesler-ui/schema": false
+}
+```
+
 ### Launch command to generate schemas
 ```sh
 yarn gen:schema

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@tesler-ui/schema",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "author": {
     "name": "Constantine Dergachev",
     "email": "dergachev@hotmail.com",
@@ -11,13 +11,14 @@
     "url": "git://github.com/tesler-platform/tesler-schema.git"
   },
   "homepage": "https://github.com/tesler-platform/tesler-schema",
-  "main": "dist/generator.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "license": "Apache-2.0",
   "bin": "./bin/build-schema",
   "scripts": {
     "lint": "prettier ./src --write",
-    "build": "tsc ./src/generator.ts --outDir dist --importsNotUsedAsValues remove",
-    "gen:schema": "yarn build && node ./dist/generator.js"
+    "build": "tsc",
+    "gen:schema": "yarn build && node ./dist/index.js"
   },
   "devDependencies": {
     "@types/node": "^14.14.22",

diff --git a/src/files/ScreenMeta.d.ts → src/files/ScreenMeta.ts b/src/files/ScreenMeta.d.ts → src/files/ScreenMeta.ts
diff --git a/src/files/SqlBc.d.ts → src/files/SqlBc.ts b/src/files/SqlBc.d.ts → src/files/SqlBc.ts
diff --git a/src/files/ViewMeta.d.ts → src/files/ViewMeta.ts b/src/files/ViewMeta.d.ts → src/files/ViewMeta.ts
diff --git a/src/files/WidgetMeta.d.ts → src/files/WidgetMeta.ts b/src/files/WidgetMeta.d.ts → src/files/WidgetMeta.ts
diff --git a/src/generator.ts b/src/generator.ts
@@ -35,7 +35,7 @@ export function run() {
         mkdirSync('schemas')
     }
     const program = TJS.getProgramFromFiles(
-        schemas.map(item => join(__dirname, '../', `src/files/${item}.d.ts`)),
+        schemas.map(item => join(__dirname, '../', `src/files/${item}.ts`)),
         compilerOptions
     )
     const generator = TJS.buildGenerator(program, settings)

diff --git a/src/index.ts b/src/index.ts
@@ -20,3 +20,8 @@ export { ScreenMetaJson } from './files/ScreenMeta'
 export { ViewMetaJson } from './files/ViewMeta'
 export { WidgetMetaJson } from './files/WidgetMeta'
 export { SqlBcJson } from './files/SqlBc'
+export * from './interfaces/data'
+export * from './interfaces/navigation'
+export * from './interfaces/operations'
+export * from './interfaces/router'
+export * from './interfaces/widget'
diff --git a/src/interfaces/data.d.ts → src/interfaces/data.ts b/src/interfaces/data.d.ts → src/interfaces/data.ts
diff --git a/src/interfaces/navigation.d.ts → src/interfaces/navigation.ts b/src/interfaces/navigation.d.ts → src/interfaces/navigation.ts
diff --git a/src/interfaces/operations.d.ts → src/interfaces/operations.ts b/src/interfaces/operations.d.ts → src/interfaces/operations.ts
diff --git a/src/interfaces/router.d.ts → src/interfaces/router.ts b/src/interfaces/router.d.ts → src/interfaces/router.ts
diff --git a/src/interfaces/widget.d.ts → src/interfaces/widget.ts b/src/interfaces/widget.d.ts → src/interfaces/widget.ts
diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,10 @@
+{
+    "compilerOptions": {
+      "outDir": "./dist/",
+      "baseUrl": "./src",
+      "declaration": true
+    },
+    "include": [
+        "src/index.ts"
+    ]
+}