+++

Author: vadim-tropashko

.github/workflows/CHANGELOG.md

@@ -18,7 +18,7 @@ The former calls `toDDL` and `toERD`
 are encouraged to be replaced with
 
 ```
-   let parsed = new ddl(input,opt);
+   let parsed = new parsed(input,opt);
    let output = parsed.getDDL();
    let errors = parsed.getErrors();
 ```

README.md

@@ -51,12 +51,12 @@ See below for examples of how to use this library.
 ### DDL NodeJS ECMA Script Module (ESM) Example
 
 ```js
-import { ddl } from "@oracle/quicksql";
+import { parsed } from "@oracle/quicksql";
 import fs from "fs";
 
 try {
     const text = fs.readFileSync( './test/department_employees.quicksql' );
-    console.log( new ddl( text.toString() ).getDDL() );
+    console.log( new parsed( text.toString() ).getDDL() );
 } catch( e ) {
     console.error( e );
 };
@@ -65,12 +65,12 @@ try {
 ### DDL NodeJS Common JS (CJS) Example
 
 ```js
-const { ddl } = require( "@oracle/quicksql" );
+const { parsed } = require( "@oracle/quicksql" );
 const fs = require( "fs" );
 
 try {
     const text = fs.readFileSync( './test/department_employees.quicksql' );
-    console.log( new ddl( text.toString() ).getDDL() );
+    console.log( new parsed( text.toString() ).getDDL() );
 } catch( e ) {
     console.error( e );
 };
@@ -80,8 +80,8 @@ try {
 
 ```html
 <script type="module">
-    import { ddl } from './dist/quick-sql.js';
-    document.body.innerText = new ddl(
+    import { parsed } from './dist/quick-sql.js';
+    document.body.innerText = new parsed(
 `departments /insert 2
     name /nn
     location
@@ -107,7 +107,7 @@ view emp_v departments employees
 ```html
 <script src="./dist/quick-sql.umd.cjs"></script>
 <script>
-    document.body.innerText = new quickSQL.ddl(
+    document.body.innerText = new quickSQL.parsed(
 `departments /insert 2
     name /nn
     location

dist/quick-sql.js

@@ -16,9 +16,9 @@
 Error diagnostics procedure is called like this
 
 ```js
-let output = ddl.errorMsgs(`dept
+let output = new parsed.(`dept
    col1
- "is this table or misaligned column?"`);
+ "is this table or misaligned column?"`).getErrors();
 ```
 
 It returns an array of the Error objects

dist/quick-sql.umd.cjs

@@ -11,7 +11,7 @@ export const guid = 'guid';
 export const tswtz = 'Timestamp with time zone';
 export const tswltz = 'Timestamp with local time zone';
 
-export const ddl = (function () {
+export const parsed = (function () {
 
     const defaultOptions = { 
         apex: {label: 'APEX', value:'no',check:['yes','no']},
@@ -471,8 +471,7 @@ export function toQSQL( input ) {
  * @returns JSON object listing tables and links
  */
 export function toERD( input, options ) {
-    const parsed = new ddl(input, options);
-    return parsed.getERD();
+    return new parsed(input, options).getERD();
 };
 
 /**
@@ -482,8 +481,7 @@ export function toERD( input, options ) {
  * @returns translated DDL 
  */
 export function toDDL( input, options ) {
-    const parsed = new ddl(input, options);
-    return parsed.getDDL();
+    return new parsed(input, options).getDDL();
 }; 
 /**
  * @deprecated since version 1.2.0. 
@@ -492,17 +490,16 @@ export function toDDL( input, options ) {
  * @returns list of SyntaxError objects 
  */
 export function errors( input, options ) {
-    const parsed = new ddl(input, options);
-    return parsed.getErrors();
+    return new parsed(input, options).getErrors();
 }; 
 
 export const version = {
     writable: false,
     value: typeof __PACKAGE_VERSION__ === 'undefined' ? 'development' : __PACKAGE_VERSION__
 };
 
-ddl.version = version;
-ddl.toDDL = toDDL;  // legacy, deprecated
-ddl.toERD = toERD;  // legacy, deprecated
+parsed.version = version;
+parsed.toDDL = toDDL;  // legacy, deprecated
+parsed.toERD = toERD;  // legacy, deprecated
 
-export default ddl;
+export default parsed;

doc/user/error-diagnostics.md

@@ -1,6 +1,5 @@
 import {singular} from './naming.js';
-import  {ddl} from "../src/ddl.js";
-
+import {version} from './ddl.js';
 
 var json2qsql = (function () {
     function JSON2QSQL() {
@@ -102,7 +101,7 @@ var json2qsql = (function () {
                 output += "\n\ndv "+key+"_dv "+key +"";
                 output += '\n\n#settings = { genpk: false, drop: true }';
 
-                output += '\n\n-- Generated by json2qsql.js ' + `${ ddl.version } ` + new Date().toLocaleString() +'\n\n';
+                output += '\n\n-- Generated by json2qsql.js ' + `${ version.value } ` + new Date().toLocaleString() +'\n\n';
 
                 output += '#document = \n';
                 output += JSON.stringify(value, null, 3);    

src/ddl.js

@@ -1,5 +1,4 @@
 export function singular( name ) {
-    // ddl.options["Duality View"].value != 'yes'
     // identity columns in JSON document are singular
     if( name == null )
         return name;

src/json2qsql.js

@@ -1,4 +1,4 @@
-import  {ddl, toERD} from "../src/ddl.js";
+import  {parsed, toERD} from "../src/ddl.js";
 
 import fs from "fs";
 
@@ -44,10 +44,8 @@ export default function diagram_tests() {
 `Bug35827754
     data file
     `
-    output = new ddl(input).getERD();
+    output = new parsed(input).getERD();
 
-    //console.log(ddl.toDDL(input));    
-    //console.log(JSON.stringify(output, null, 4));    
     assert( "output.items[0].columns[2].name == 'data_filename'" );
     assert( "output.items[0].columns[2].datatype == 'varchar2(255 char)'" );
     assert( "output.items[0].columns[5].name == 'data_lastupd'" );

src/naming.js

@@ -1,4 +1,4 @@
-import  {errors, ddl} from "../src/ddl.js";
+import  {errors, parsed} from "../src/ddl.js";
 import errorMsgs from '../src/errorMsgs.js'
 
 
@@ -27,36 +27,36 @@ export default function error_msg_tests() {
     `);
     checkError(output, 1, 4, errorMsgs.messages.duplicateId);
 
-    output = new ddl(`dept
+    output = new parsed(`dept
     name vc-200
     name vc0
     `).getErrors();
     checkError(output, 1, 4+4+2+1, errorMsgs.messages.invalidDatatype);
     checkError(output, 2, 4+4+1, errorMsgs.messages.invalidDatatype);
     checkNoError(output, errorMsgs.messages.misalignedAttribute);
 
-    output = new ddl(`dept
+    output = new parsed(`dept
     name
 customer
     dept /fk department    
     `).getErrors();
     checkError(output, 3, 4+4+1+3+1, errorMsgs.messages.undefinedObject+'department');
     checkNoError(output, errorMsgs.messages.misalignedAttribute);
 
-    output = new ddl(`dept
+    output = new parsed(`dept
     name
 view customer_view customer
     `).getErrors();
     checkError(output, 2, 4+1+13+1, errorMsgs.messages.undefinedObject+'customer');
     checkNoError(output, errorMsgs.messages.misalignedAttribute);
 
-    output = new ddl(`dept
+    output = new parsed(`dept
    col1
     "is this table or misaligned column?"
     `).getErrors();
     checkError(output, 2, 4, errorMsgs.messages.misalignedAttribute+"3");
 
-    output = new ddl(`dept
+    output = new parsed(`dept
    col1
    col2
     "is this table or misaligned column?"