add file schema renderer (#20)

* add file schema renderer

* 2.14.1

Author: kbarbounakis

README.md

@@ -653,4 +653,24 @@ or use query expressions for applying nested query options:
             }))
         ).getItems();
 
-> `/People?$expand=address($select=id,streetAddress,addressLocalilty;$expand=addressCountry)`
+> `/People?$expand=address($select=id,streetAddress,addressLocalilty;$expand=addressCountry)`
+
+## Using CLI
+
+`@themost/client` provides a command line interface for generating client-side type declarations from an OData metadata service.
+
+Connect to an OData service and generate client-side type declarations:
+
+```bash
+$ npx @themost/client http://localhost:3000/api/
+```
+or extract metadata from an OData metadata document:
+
+```bash
+$ npx @themost/client ./metadata.xml
+```
+Use `--out-file` option for specifying the output file:
+
+```bash
+$ npx @themost/client http://localhost:3000/api/ --out-file ./client.d.ts
+```

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@themost/client",
-  "version": "2.14.0",
+  "version": "2.14.1",
   "description": "MOST Web Framework Codename Blueshift - Client Common",
   "module": "dist/index.esm.js",
   "main": "dist/index.js",

package.json

@@ -1,5 +1,6 @@
+#!/usr/bin/env node
 const minimist = require('minimist');
-const { TypeRenderer } = require('../dist');
+const { TypeRenderer, FileSchemaRenderer } = require('../dist');
 const { writeFileSync } = require('fs');
 
 async function main() {
@@ -9,17 +10,18 @@ async function main() {
         },
     });
     if (args.help) {
-        console.log('Usage: client-cli [options]');
+        console.log('Usage: client-cli <source> [options]');
         console.log('Options:');
-        console.log('  --host <host>  The HTTP address of the host api server to connect to');
-        console.log('  --out-file <file>  The output file to write the rendered types to');
+        console.log('  --out-file <output>  The output file to write the rendered types to');
         return;
     }
-    if (!args.host) {
-        console.error('Error: Missing required argument --host');
+    const source = args._[0];
+    if (!source) {
+        console.error('Missing argument: A source metadata file or a valid URL must be provided');
         return process.exit(-1);
     }
-    const typeRenderer = new TypeRenderer(args.host);
+    const isURL = source.startsWith('http://') || source.startsWith('https://');
+    const typeRenderer = isURL ? new TypeRenderer(source) : new FileSchemaRenderer(source);
     const result = await typeRenderer.renderAny();
     if (args.outFile) {
         writeFileSync(args.outFile, result);

util/bin/cli.js

@@ -0,0 +1,22 @@
+import {FileSchemaRenderer, TypeRenderer} from '@themost/client/util';
+import { resolve } from 'path';
+
+describe("FileSchemaRenderer(", () => {
+
+    it("should render type", async () => {
+        const renderer = new FileSchemaRenderer(resolve(__dirname, 'metadata.xml'));
+        let typeDeclaration = await renderer.render('Thing');
+        expect(typeDeclaration).toBeInstanceOf(String);
+        typeDeclaration = await renderer.render('Workspace');
+        expect(typeDeclaration).toBeInstanceOf(String);
+    });
+
+    it("should render any type", async () => {
+        const renderer = new FileSchemaRenderer(resolve(__dirname, 'metadata.xml'));
+        const typeDeclarations = await renderer.renderAny();
+        expect(typeDeclarations).toBeInstanceOf(String);
+    });
+
+
+
+});

util/spec/FileSchemaRenderer.spec.ts

@@ -1,7 +1,7 @@
 import {TypeRenderer} from '@themost/client/util';
 import { serveApplication, getApplication } from '@themost/test';
 
-describe("BasicClientDataContext", () => {
+describe("TypeRenderer", () => {
 
     beforeAll(async () => {
         const app = await getApplication();

util/spec/TypeRenderer.spec.ts

@@ -1,5 +1,6 @@
 import {EdmEntityType, EdmNavigationProperty, EdmProperty, EdmSchema} from '@themost/client';
 import {BasicDataContext} from '@themost/client/common';
+import { readFile } from 'fs';
 
 const EdmTypeMap = new Map([
     [
@@ -48,7 +49,7 @@ class TypeRenderer {
     /**
      * @param {string} host 
      */
-    constructor(host: string) {
+    constructor(host?: string) {
         this.context = new BasicDataContext(host);
     }
 
@@ -116,13 +117,21 @@ ${properties.sort(
     }
 
     async render(type: string) {
-        this.schema = await this.context.getMetadata();
+        if (this.schema == null) {
+            this.schema = await this.getSchema();
+        }
         const entityType = this.schema.EntityType.find((t) => t.Name === type);
         return this.renderType(entityType)
     }
 
+    protected getSchema(): Promise<EdmSchema> {
+        return this.context.getMetadata();
+    }
+
     async renderAny() {
-        this.schema = await this.context.getMetadata();
+        if (this.schema == null) {
+            this.schema = await this.getSchema();
+        }
         const typeDeclarations = this.schema.EntityType.sort(
             (a, b) => {
                 if (a.Name < b.Name) return -1;
@@ -132,7 +141,32 @@ ${properties.sort(
         ).map((entityType) => this.renderType(entityType));
         return typeDeclarations.join('\n');
     }
+}
+
+class FileSchemaRenderer extends TypeRenderer {
+    constructor(private file: string) {
+        super();
+    }
+
+    protected getSchema(): Promise<EdmSchema> {
+        return new Promise((resolve, reject) => {
+            void readFile(this.file, 'utf8', (err, data) => {
+               if (err) {
+                   return reject(err);
+               }
+               try {
+                   const schema = EdmSchema.loadXML(data);
+                   return resolve(schema);
+               } catch (e) {
+                   return reject(e);
+               }
+            });
+        });
+    }
 
 }
 
-export { TypeRenderer }
+export {
+    TypeRenderer,
+    FileSchemaRenderer
+}