introspeql 1.0.0 → 1.2.0

package/dist/schemas/schema-definition-factory.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SchemaDefinitionFactory = void 0;
 var schema_definition_1 = require("./schema-definition");
 var enums_1 = require("../enums");
-var tables_1 = require("../tables");
+var relations_1 = require("../relations");
 var functions_1 = require("../functions");
 var types_1 = require("../types");
 var comments_1 = require("../comments");
@@ -15,10 +15,14 @@ var SchemaDefinitionFactory = /** @class */ (function () {
         this.validateDBObjectNames(data.enums);
         this.validateDBObjectNames(data.tables);
         this.validateDBObjectNames(data.functions);
+        this.validateDBObjectNames(data.views);
+        this.validateDBObjectNames(data.materializedViews);
         var enumDefinitions = this.createSortedEnumDefinitions(data, config);
-        var tableDefinitions = this.createSortedTableDefinitions(data, config);
+        var tableDefinitions = this.createSortedRelationDefinitions('table', data, config);
+        var viewDefinitions = this.createSortedRelationDefinitions('view', data, config);
+        var materializedViewDefinitions = this.createSortedRelationDefinitions('materializedView', data, config);
         var functionDefinitions = this.createSortedFunctionDefinitions(data, config);
-        return new schema_definition_1.SchemaDefinition(data.name, enumDefinitions, tableDefinitions, functionDefinitions);
+        return new schema_definition_1.SchemaDefinition(data.name, enumDefinitions, tableDefinitions, viewDefinitions, materializedViewDefinitions, functionDefinitions);
     };
     SchemaDefinitionFactory.validateDBObjectNames = function (dbObjects) {
         var seen = new Set();
@@ -70,18 +74,20 @@ var SchemaDefinitionFactory = /** @class */ (function () {
             (!config.copyComments &&
                 commentTokens.includes(shared_1.Directives.EnableTSDocComments)));
     };
-    SchemaDefinitionFactory.createSortedTableDefinitions = function (data, config) {
-        var sortedTables = this.sortDBObjectData(data.tables);
-        return this.createTableDefinitions(sortedTables, config);
+    SchemaDefinitionFactory.createSortedRelationDefinitions = function (relationType, data, config) {
+        var sortedRelations = this.sortDBObjectData(relationType === 'table' ? data.tables
+            : relationType === 'view' ? data.views
+                : data.materializedViews);
+        return this.createRelationDefinitions(relationType, sortedRelations, config);
     };
-    SchemaDefinitionFactory.createTableDefinitions = function (tables, config) {
+    SchemaDefinitionFactory.createRelationDefinitions = function (relationType, relations, config) {
         var _this = this;
-        var tableDefinitions = tables.map(function (tableData) {
-            var shouldCopyTableComment = _this.shouldCopyDBObjectComment(tableData, config);
+        var relationDefinitions = relations.map(function (relationData) {
+            var shouldCopyRelationComment = _this.shouldCopyDBObjectComment(relationData, config);
             var comment = '';
-            if (shouldCopyTableComment) {
+            if (shouldCopyRelationComment) {
                 try {
-                    comment = comments_1.CommentConverter.convertComment(tableData.comment);
+                    comment = comments_1.CommentConverter.convertComment(relationData.comment);
                 }
                 catch (e) {
                     if (e instanceof shared_1.ParsingError) {
@@ -93,7 +99,7 @@ var SchemaDefinitionFactory = /** @class */ (function () {
                 }
             }
             /*
-              By default, comments on a column are copied if the parent table's
+              By default, comments on a column are copied if the parent relation's
               comments should be copied. This can be overridden with directives
               applied to the column-level comment directly.
             */
@@ -101,14 +107,14 @@ var SchemaDefinitionFactory = /** @class */ (function () {
                 if (!comment)
                     return false;
                 var tokens = (0, shared_1.getTokens)(comment);
-                return ((shouldCopyTableComment &&
+                return ((shouldCopyRelationComment &&
                     !tokens.includes(shared_1.Directives.DisableTSDocComments)) ||
-                    (!shouldCopyTableComment &&
+                    (!shouldCopyRelationComment &&
                         tokens.includes(shared_1.Directives.EnableTSDocComments)));
             };
-            var columnDefinitions = tableData.columns.map(function (columnData) {
-                var tsType = (0, types_1.lookupType)(columnData.type, tableData.schema, config);
-                var typeDefinition = new tables_1.ColumnTypeDefinition(tsType, columnData.type.numDimensions, columnData.type.isNullable);
+            var columnDefinitions = relationData.columns.map(function (columnData) {
+                var tsType = (0, types_1.lookupType)(columnData.type, relationData.schema, config);
+                var typeDefinition = new relations_1.ColumnTypeDefinition(tsType, columnData.type.numDimensions, columnData.type.isNullable);
                 var comment = '';
                 if (shouldCopyColumnComment(columnData.comment)) {
                     try {
@@ -123,11 +129,15 @@ var SchemaDefinitionFactory = /** @class */ (function () {
                         }
                     }
                 }
-                return new tables_1.ColumnDefinition(columnData.name, typeDefinition, comment);
+                return new relations_1.ColumnDefinition(columnData.name, typeDefinition, comment);
             });
-            return new tables_1.TableDefinition(tableData.name, columnDefinitions, comment);
+            return (relationType === 'table' ?
+                new relations_1.TableDefinition(relationData.name, columnDefinitions, comment)
+                : relationType === 'view' ?
+                    new relations_1.ViewDefinition(relationData.name, columnDefinitions, comment)
+                    : new relations_1.MaterializedViewDefinition(relationData.name, columnDefinitions, comment));
         });
-        return tableDefinitions;
+        return relationDefinitions;
     };
     SchemaDefinitionFactory.createSortedFunctionDefinitions = function (data, config) {
         var sortedFunctionData = this.sortDBObjectData(data.functions);

package/dist/schemas/schema-definition.d.ts

@@ -1,11 +1,13 @@
 import { EnumDefinition } from '../enums';
 import { FunctionDefinition } from '../functions';
-import { TableDefinition } from '../tables';
+import { TableDefinition, ViewDefinition, MaterializedViewDefinition } from '../relations';
 export declare class SchemaDefinition {
     protected pgSchemaName: string;
     protected enumDefinitions: EnumDefinition[];
     protected tableDefinitions: TableDefinition[];
+    protected viewDefinitions: ViewDefinition[];
+    protected materializedViewDefinitions: MaterializedViewDefinition[];
     protected functionDefinitions: FunctionDefinition[];
-    constructor(pgSchemaName: string, enumDefinitions: EnumDefinition[], tableDefinitions: TableDefinition[], functionDefinitions: FunctionDefinition[]);
+    constructor(pgSchemaName: string, enumDefinitions: EnumDefinition[], tableDefinitions: TableDefinition[], viewDefinitions: ViewDefinition[], materializedViewDefinitions: MaterializedViewDefinition[], functionDefinitions: FunctionDefinition[]);
     toString(): string;
 }

package/dist/schemas/schema-definition.js

@@ -3,10 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SchemaDefinition = void 0;
 var shared_1 = require("../shared");
 var SchemaDefinition = /** @class */ (function () {
-    function SchemaDefinition(pgSchemaName, enumDefinitions, tableDefinitions, functionDefinitions) {
+    function SchemaDefinition(pgSchemaName, enumDefinitions, tableDefinitions, viewDefinitions, materializedViewDefinitions, functionDefinitions) {
         this.pgSchemaName = pgSchemaName;
         this.enumDefinitions = enumDefinitions;
         this.tableDefinitions = tableDefinitions;
+        this.viewDefinitions = viewDefinitions;
+        this.materializedViewDefinitions = materializedViewDefinitions;
         this.functionDefinitions = functionDefinitions;
     }
     SchemaDefinition.prototype.toString = function () {
@@ -17,6 +19,12 @@ var SchemaDefinition = /** @class */ (function () {
         var tables = this.tableDefinitions
             .map(function (tableDef) { return tableDef.toString(); })
             .join('\n\n');
+        var views = this.viewDefinitions
+            .map(function (viewDef) { return viewDef.toString(); })
+            .join('\n\n');
+        var materializedViews = this.materializedViewDefinitions
+            .map(function (matViewDef) { return matViewDef.toString(); })
+            .join('\n\n');
         var functions = this.functionDefinitions
             .map(function (funcDef) { return funcDef.toString(); })
             .join('\n\n');
@@ -27,6 +35,12 @@ var SchemaDefinition = /** @class */ (function () {
         if (tables.length) {
             result += "\n\n  export namespace Tables {\n".concat((0, shared_1.indent)(tables, 4), "\n  }");
         }
+        if (views.length) {
+            result += "\n\n  export namespace Views {\n".concat((0, shared_1.indent)(views, 4), "\n  }");
+        }
+        if (materializedViews.length) {
+            result += "\n\n  export namespace MaterializedViews {\n".concat((0, shared_1.indent)(materializedViews, 4), "\n  }");
+        }
         if (functions.length) {
             result += "\n\n  export namespace Functions {\n".concat((0, shared_1.indent)(functions, 4), "\n  }");
         }

package/dist/shared/capitalize.d.ts

@@ -0,0 +1 @@
+export declare function capitalize<T extends string>(str: T): Capitalize<T>;

package/dist/shared/capitalize.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.capitalize = capitalize;
+function capitalize(str) {
+    return (str[0].toUpperCase() + str.slice(1));
+}

package/dist/shared/convert-pg-identifier-to-ts-identifier.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.convertPGIdentifierToTSIdentifier = convertPGIdentifierToTSIdentifier;
+var capitalize_1 = require("./capitalize");
 /**
  * Converts a PostgreSQL identifier to a valid TypeScript identifier.
  *
@@ -47,11 +48,8 @@ function convertPGIdentifierToTSIdentifier(identifier) {
     if (word.length) {
         words.push(word);
     }
-    var result = prefix + words.map(function (word) { return capitalize(word); }).join('');
+    var result = prefix + words.map(function (word) { return (0, capitalize_1.capitalize)(word); }).join('');
     if (/^\d/.test(result))
         result = '_' + result;
     return result;
 }
-function capitalize(str) {
-    return str[0].toUpperCase() + str.slice(1);
-}

package/dist/shared/index.d.ts

@@ -1,3 +1,4 @@
+export * from './capitalize';
 export * from './directives';
 export * from './get-tokens';
 export * from './indent';

package/dist/shared/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./capitalize"), exports);
 __exportStar(require("./directives"), exports);
 __exportStar(require("./get-tokens"), exports);
 __exportStar(require("./indent"), exports);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "introspeql",
-  "version": "1.0.0",
-  "description": "IntrospeQL reads information about the schemas, tables, columns, functions, and enums in your PostgreSQL database and produces a TypeScript file detailing type information for each database object.",
+  "version": "1.2.0",
+  "description": "IntrospeQL reads information about the schemas, tables, views, materialized views, functions and enums in your PostgreSQL database and produces a TypeScript file detailing type information for each object in the database.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [

package/dist/tables/index.d.ts

@@ -1,8 +0,0 @@
-export * from './column-data';
-export * from './column-definition';
-export * from './column-type-definition';
-export * from './read-column-data';
-export * from './read-table-data';
-export * from './should-include-table';
-export * from './table-data';
-export * from './table-definition';

package/dist/tables/read-table-data.d.ts

@@ -1,4 +0,0 @@
-import { type TableData } from './table-data';
-import type { Client } from 'pg';
-import type { ParsedConfig } from '../config';
-export declare function readTableData(client: Client, config: ParsedConfig): Promise<TableData[]>;

package/dist/tables/table-definition.d.ts

@@ -1,10 +0,0 @@
-import { ColumnDefinition } from './column-definition';
-export declare class TableDefinition {
-    protected pgTableName: string;
-    protected columns: ColumnDefinition[];
-    private comment?;
-    constructor(pgTableName: string, columns: ColumnDefinition[], comment?: string);
-    toString(): string;
-    protected createColumnNamesUnion(): string;
-    protected createRowTypeDefinition(): string;
-}