@ts-safeql/generate - npm Package Compare versions

Comparing version 0.0.6 to 0.0.7

lib/index.d.ts

@@ -1,1 +0,1 @@
-export { generate, GenerateResult } from "./src/generate";
+export { createGenerator, GenerateError, GenerateParams, GenerateResult } from "./src/generate";

lib/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generate = void 0;
+exports.createGenerator = void 0;
 var generate_1 = require("./src/generate");
-Object.defineProperty(exports, "generate", { enumerable: true, get: function () { return generate_1.generate; } });
+Object.defineProperty(exports, "createGenerator", { enumerable: true, get: function () { return generate_1.createGenerator; } });
 //# sourceMappingURL=index.js.map

lib/src/generate.d.ts

 import { DuplicateColumnsError, IdentiferCase, ParsedQuery, PostgresError } from "@ts-safeql/shared";
-import { Either } from "fp-ts/lib/Either";
+import { either } from "fp-ts";
 import postgres from "postgres";
-import "source-map-support/register";
-import { ColType } from "./utils/colTypes";
-declare type CacheKey = string;
 declare type JSToPostgresTypeMap = Record<string, unknown>;
@@ -15,7 +12,3 @@ declare type Sql = postgres.Sql<JSToPostgresTypeMap>;
 export declare type GenerateError = DuplicateColumnsError | PostgresError;
-export declare function getMetadataFromCacheOrFetch(sql: Sql, cacheKey: CacheKey): Promise<{
-    pgTypes: postgres.RowList<PgTypeRow[]>;
-    pgCols: PgColRow[];
-    pgColsByTableOidCache: Map<number, PgColRow[]>;
-}>;
+declare type CacheKey = string;
 export interface GenerateParams {
@@ -26,3 +19,3 @@ sql: Sql;
     cacheMetadata?: boolean;
-    cacheKey: string;
+    cacheKey: CacheKey;
     fieldTransform: IdentiferCase | undefined;
@@ -33,16 +26,7 @@ overrides?: Partial<{
 }
-export declare function generate(params: GenerateParams): Promise<Either<GenerateError, GenerateResult>>;
-interface PgTypeRow {
-    oid: number;
-    name: ColType;
-}
-interface PgColRow {
-    tableOid: number;
-    tableName: string;
-    colName: string;
-    colType: ColType;
-    colNum: number;
-    colHasDef: boolean;
-    colNotNull: boolean;
-}
+export declare function createGenerator(): {
+    generate: (params: GenerateParams) => Promise<either.Either<GenerateError, GenerateResult>>;
+    dropCacheKey: (cacheKey: CacheKey) => boolean;
+    clearCache: () => void;
+};
 export {};

lib/src/generate.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generate = exports.getMetadataFromCacheOrFetch = void 0;
+exports.createGenerator = void 0;
 const shared_1 = require("@ts-safeql/shared");
 const fp_ts_1 = require("fp-ts");
 const postgres_1 = require("postgres");
-require("source-map-support/register");
 const getLeftJoinTables_1 = require("./utils/getLeftJoinTables");
-const $cacheMap = new Map();
-async function getDatabaseMetadata(sql) {
-    const pgTypes = await getPgTypes(sql);
-    const pgCols = await getPgCols(sql);
-    const pgColsByTableOidCache = (0, shared_1.groupBy)(pgCols, "tableOid");
-    return { pgTypes, pgCols, pgColsByTableOidCache };
+function createGenerator() {
+    const cacheMap = new Map();
+    return {
+        generate: (params) => generate(params, cacheMap),
+        dropCacheKey: (cacheKey) => cacheMap.delete(cacheKey),
+        clearCache: () => cacheMap.clear(),
+    };
 }
-async function getMetadataFromCacheOrFetch(sql, cacheKey) {
-    const cache = $cacheMap.get(cacheKey);
-    if (cache !== undefined) {
-        return cache;
-    }
-    const cacheValue = await getDatabaseMetadata(sql);
-    $cacheMap.set(cacheKey, cacheValue);
-    return cacheValue;
-}
-exports.getMetadataFromCacheOrFetch = getMetadataFromCacheOrFetch;
-async function generate(params) {
+exports.createGenerator = createGenerator;
+async function generate(params, cacheMap) {
     var _a;
     const { sql, query, cacheMetadata = true } = params;
     const { pgCols, pgColsByTableOidCache, pgTypes } = cacheMetadata
-        ? await getMetadataFromCacheOrFetch(sql, params.cacheKey)
+        ? await (0, shared_1.getOrSetFromMap)({
+            map: cacheMap,
+            key: params.cacheKey,
+            value: () => getDatabaseMetadata(sql),
+        })
         : await getDatabaseMetadata(sql);
@@ -80,3 +75,8 @@ try {
 }
-exports.generate = generate;
+async function getDatabaseMetadata(sql) {
+    const pgTypes = await getPgTypes(sql);
+    const pgCols = await getPgCols(sql);
+    const pgColsByTableOidCache = (0, shared_1.groupBy)(pgCols, "tableOid");
+    return { pgTypes, pgCols, pgColsByTableOidCache };
+}
 function mapColumnAnalysisResultsToTypeLiteral(params) {
@@ -83,0 +83,0 @@ const properties = params.columns.map((col) => {

lib/src/generate.test.js

 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
@@ -9,4 +32,5 @@ return (mod && mod.__esModule) ? mod : { "default": mod };
 const assert_1 = __importDefault(require("assert"));
-const fp_ts_1 = require("fp-ts");
-const function_1 = require("fp-ts/lib/function");
+const TE = __importStar(require("fp-ts/TaskEither"));
+const O = __importStar(require("fp-ts/Option"));
+const function_1 = require("fp-ts/function");
 const libpg_query_1 = require("libpg-query");
@@ -45,3 +69,2 @@ const mocha_1 = require("mocha");
     await runMigrations(sql);
-    await (0, generate_1.getMetadataFromCacheOrFetch)(sql, "test");
 });
@@ -52,9 +75,16 @@ after(async () => {
 });
-const generateTE = (0, function_1.flow)(generate_1.generate, fp_ts_1.taskEither.tryCatchK(function_1.identity, shared_1.InternalError.to));
-const parseQueryTE = (0, function_1.flow)(libpg_query_1.parseQuery, fp_ts_1.taskEither.tryCatchK(function_1.identity, shared_1.InternalError.to));
+const { generate } = (0, generate_1.createGenerator)();
+const generateTE = (0, function_1.flow)(generate, TE.tryCatchK(function_1.identity, shared_1.InternalError.to));
+const parseQueryTE = (0, function_1.flow)(libpg_query_1.parseQuery, TE.tryCatchK(function_1.identity, shared_1.InternalError.to));
 const testQuery = async (params) => {
     const { query } = params;
     const cacheKey = "test";
-    return (0, function_1.pipe)(fp_ts_1.taskEither.Do, fp_ts_1.taskEither.bind("pgParsed", () => parseQueryTE(params.query)), fp_ts_1.taskEither.bind("result", ({ pgParsed }) => generateTE({ sql, pgParsed, query, cacheKey, fieldTransform: undefined })), fp_ts_1.taskEither.chainW(({ result }) => fp_ts_1.taskEither.fromEither(result)), fp_ts_1.taskEither.match((error) => (0, function_1.pipe)(params.expectedError, fp_ts_1.option.fromNullable, fp_ts_1.option.fold(() => assert_1.default.fail(error.message), (expectedError) => assert_1.default.strictEqual(error.message, expectedError))), ({ result }) => assert_1.default.equal(result, params.expected)))();
+    return (0, function_1.pipe)(TE.Do, TE.bind("pgParsed", () => parseQueryTE(params.query)), TE.bind("result", ({ pgParsed }) => generateTE({ sql, pgParsed, query, cacheKey, fieldTransform: undefined })), TE.chainW(({ result }) => TE.fromEither(result)), TE.match((error) => (0, function_1.pipe)(params.expectedError, O.fromNullable, O.fold(() => assert_1.default.fail(error.message), (expectedError) => assert_1.default.strictEqual(error.message, expectedError))), ({ result }) => assert_1.default.equal(result, params.expected)))();
 };
+(0, mocha_1.test)("(init generate cache)", async () => {
+    await testQuery({
+        query: `SELECT 1 as x`,
+        expected: `{ x: number; }`,
+    });
+});
 (0, mocha_1.test)("select columns", async () => {
@@ -61,0 +91,0 @@ await testQuery({

lib/src/utils/getLeftJoinTables.test.js

@@ -10,3 +10,3 @@ "use strict";
 const fp_ts_1 = require("fp-ts");
-const function_1 = require("fp-ts/lib/function");
+const function_1 = require("fp-ts/function");
 const libpg_query_1 = __importDefault(require("libpg-query"));
@@ -13,0 +13,0 @@ const mocha_1 = require("mocha");

package.json

 {
   "name": "@ts-safeql/generate",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "",
@@ -25,8 +25,7 @@ "main": "lib/index.js",
   "dependencies": {
-    "@ts-safeql/shared": "0.0.5",
-    "@ts-safeql/test-utils": "0.0.5",
+    "@ts-safeql/shared": "0.0.6",
+    "@ts-safeql/test-utils": "0.0.6",
     "fp-ts": "^2.12.3",
     "pg-connection-string": "^2.5.0",
-    "postgres": "^3.3.0",
-    "source-map-support": "^0.5.21"
+    "postgres": "^3.3.0"
   },
@@ -33,0 +32,0 @@ "scripts": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

34058

increased by2.37%

Dependency count

5

decreased by-16.67%

Lines of code

498

increased by2.68%

Dependency changes

• + Added@ts-safeql/shared@0.0.6(transitive)

• + Added@ts-safeql/test-utils@0.0.6(transitive)

• - Removedsource-map-support@^0.5.21

• - Removed@ts-safeql/shared@0.0.5(transitive)

• - Removed@ts-safeql/test-utils@0.0.5(transitive)

• - Removedbuffer-from@1.1.2(transitive)

• - Removedsource-map@0.6.1(transitive)

• - Removedsource-map-support@0.5.21(transitive)

• Updated@ts-safeql/shared@0.0.6

• Updated@ts-safeql/test-utils@0.0.6