forge-sql-orm 1.0.22 → 1.0.24

package/src/core/ForgeSQLQueryBuilder.ts

@@ -19,6 +19,16 @@ export interface ForgeSqlOperation extends QueryBuilderForgeSql {
   fetch(): SchemaSqlForgeSql;
 }
 
+/**
+ * Options for configuring ForgeSQL ORM behavior.
+ */
+export interface ForgeSqlOrmOptions {
+  /**
+   * Enables logging of raw SQL queries in the Atlassian Forge Developer Console.
+   */
+  logRawSqlQuery?: boolean;
+}
+
 /**
  * Interface for schema-level SQL operations.
  */
@@ -96,5 +106,10 @@ export interface QueryBuilderForgeSql {
     loggerContext?: LoggingOptions,
   ): QueryBuilder<Entity, RootAlias>;
 
+  /**
+   * Provides access to the underlying Knex instance for building complex query parts.
+   * enabling advanced query customization and performance tuning.
+   * @returns The Knex instance, which can be used for query building.
+   */
   getKnex(): Knex<any, any[]>;
 }

package/src/core/ForgeSQLSelectOperations.ts

@@ -1,9 +1,15 @@
 import { sql, UpdateQueryResponse } from "@forge/sql";
 import type { EntitySchema } from "@mikro-orm/core/metadata/EntitySchema";
 import { parseDateTime } from "../utils/sqlUtils";
-import { SchemaSqlForgeSql } from "./ForgeSQLQueryBuilder";
+import { ForgeSqlOrmOptions, SchemaSqlForgeSql } from "./ForgeSQLQueryBuilder";
 
 export class ForgeSQLSelectOperations implements SchemaSqlForgeSql {
+  private readonly options: ForgeSqlOrmOptions;
+
+  constructor(options: ForgeSqlOrmOptions) {
+    this.options = options;
+  }
+
   /**
    * Executes a schema-based SQL query and maps the result to the entity schema.
    * @param query - The SQL query to execute.
@@ -23,7 +29,7 @@ export class ForgeSQLSelectOperations implements SchemaSqlForgeSql {
         .forEach((p) => {
           const fieldName = p.name;
           const fieldNames = p.fieldNames;
-          const rawFieldName = fieldNames && Array.isArray(fieldNames)? fieldNames[0]: p.name;
+          const rawFieldName = fieldNames && Array.isArray(fieldNames) ? fieldNames[0] : p.name;
 
           switch (p.type) {
             case "datetime":
@@ -52,9 +58,10 @@ export class ForgeSQLSelectOperations implements SchemaSqlForgeSql {
    * @returns A list of results as objects.
    */
   async executeRawSQL<T extends object | unknown>(query: string): Promise<T[]> {
-    console.debug("Executing raw SQL: " + query);
+    if (this.options.logRawSqlQuery) {
+      console.debug("Executing raw SQL: " + query);
+    }
     const sqlStatement = await sql.prepare<T>(query).execute();
-    console.debug("Query result: " + JSON.stringify(sqlStatement));
     return sqlStatement.rows as T[];
   }
 
@@ -64,7 +71,9 @@ export class ForgeSQLSelectOperations implements SchemaSqlForgeSql {
    * @returns The update response containing affected rows.
    */
   async executeRawUpdateSQL(query: string): Promise<UpdateQueryResponse> {
-    console.debug("Executing update SQL: " + query);
+    if (this.options.logRawSqlQuery) {
+      console.debug("Executing update SQL: " + query);
+    }
     const sqlStatement = sql.prepare<UpdateQueryResponse>(query);
     const updateQueryResponseResults = await sqlStatement.execute();
     return updateQueryResponseResults.rows;

package/dist-cli/tsm/bin.js

@@ -1,18 +0,0 @@
-#!/usr/bin/env node
-"use strict";let argv=process.argv.slice(2);if(argv.includes("-h")||argv.includes("--help")){let e="";e+=`
-  Usage
-    $ tsm [options] -- <command>
-`,e+=`
-  Options`,e+=`
-    --tsmconfig    Configuration file path (default: tsm.js)`,e+=`
-    --quiet        Silence all terminal messages`,e+=`
-    --version      Displays current version`,e+=`
-    --help         Displays this message
-`,e+=`
-  Examples`,e+=`
-    $ tsm server.ts`,e+=`
-    $ node -r tsm input.jsx`,e+=`
-    $ node --loader tsm input.jsx`,e+=`
-    $ NO_COLOR=1 tsm input.jsx --trace-warnings`,e+=`
-    $ tsm server.tsx --tsmconfig tsm.mjs
-`,console.log(e),process.exit(0)}(argv.includes("-v")||argv.includes("--version"))&&(console.log("tsm, v2.3.0"),process.exit(0));let{URL,pathToFileURL}=require("url");argv=["--enable-source-maps","--loader",new URL("loader.mjs",pathToFileURL(__filename)).href,...argv],require("child_process").spawn("node",argv,{stdio:"inherit"}).on("exit",process.exit);

package/dist-cli/tsm/config/index.d.ts

@@ -1,22 +0,0 @@
-import type { Loader, TransformOptions } from 'esbuild';
-
-export type Extension = `.${string}`;
-export type Options = TransformOptions;
-
-export type Config = {
-	[extn: Extension]: Options;
-}
-
-export type ConfigFile =
-	| { common?: Options; config?: Config; loaders?: never; [extn: Extension]: never }
-	| { common?: Options; loaders?: Loaders; config?: never; [extn: Extension]: never }
-	| { common?: Options; config?: never; loaders?: never; [extn: Extension]: Options }
-
-export type Loaders = {
-	[extn: Extension]: Loader;
-}
-
-/**
- * TypeScript helper for writing `tsm.js` contents.
- */
-export function define(contents: ConfigFile): ConfigFile;

package/dist-cli/tsm/config/index.js

@@ -1 +0,0 @@
-exports.define=c=>c;

package/dist-cli/tsm/license

@@ -1,9 +0,0 @@
-MIT License
-
-Copyright (c) Luke Edwards <luke.edwards05@gmail.com> (lukeed.com)
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist-cli/tsm/loader.mjs

@@ -1 +0,0 @@
-"use strict";import{existsSync as j,promises as S}from"fs";import{fileURLToPath as d,URL as h}from"url";import*as y from"./utils.js";let u,m,c=y.$defaults("esm"),T=c.file&&import("file:///"+c.file);async function x(){let t=await T;return t=t&&t.default||t,y.$finalize(c,t)}const w=/\.\w+(?=\?|$)/,b=/\.[mc]?tsx?(?=\?|$)/;async function p(t){u=u||await x();let[r]=w.exec(t)||[];return u[r]}function g(t){let r=d(t);if(j(r))return t}const C={".js":[".ts",".tsx",".jsx"],".jsx":[".tsx"],".mjs":[".mts"],".cjs":[".cts"]},R=new h("file:///"+process.cwd()+"/");export const resolve=async function(t,r,o){if(/^\w+\:?/.test(t))return o(t,r,o);let e=new h(t,r.parentURL||R),s,n,l,i,a=0,f;if(i=w.exec(e.href)){if(s=i[0],!r.parentURL||b.test(s))return{url:e.href,shortCircuit:!0};if(n=g(e.href))return{url:n,shortCircuit:!0};if(l=C[s]){for(f=e.href.substring(0,i.index);a<l.length;a++)if(n=g(f+l[a]))return a=i.index+s.length,{shortCircuit:!0,url:a>e.href.length?f+e.href.substring(a):n}}return o(t,r,o)}u=u||await x();for(s in u)if(n=g(e.href+s),n)return{url:n,shortCircuit:!0};return o(t,r,o)},load=async function(t,r,o){let e=await p(t);if(e==null)return o(t,r,o);let s=e.format==="cjs"?"commonjs":"module",n=d(t),l=await S.readFile(n);m=m||await import("esbuild");let i=await m.transform(l.toString(),{...e,sourcefile:n,format:s==="module"?"esm":"cjs"});return{format:s,source:i.code,shortCircuit:!0}},getFormat=async function(t,r,o){let e=await p(t);return e==null?o(t,r,o):{format:e.format==="cjs"?"commonjs":"module"}},transformSource=async function(t,r,o){let e=await p(r.url);return e==null?o(t,r,o):(m=m||await import("esbuild"),{source:(await m.transform(t.toString(),{...e,sourcefile:r.url,format:r.format==="module"?"esm":"cjs"})).code})};

package/dist-cli/tsm/package.json

@@ -1,51 +0,0 @@
-{
-  "name": "tsm",
-  "version": "2.3.0",
-  "repository": "lukeed/tsm",
-  "description": "TypeScript Module Loader",
-  "license": "MIT",
-  "bin": "bin.js",
-  "author": {
-    "name": "Luke Edwards",
-    "email": "luke.edwards05@gmail.com",
-    "url": "https://lukeed.com"
-  },
-  "exports": {
-    ".": {
-      "import": "./loader.mjs",
-      "require": "./require.js"
-    },
-    "./config": "./config/index.js",
-    "./package.json": "./package.json"
-  },
-  "files": [
-    "bin.js",
-    "utils.js",
-    "require.js",
-    "loader.mjs",
-    "config"
-  ],
-  "engines": {
-    "node": ">=12"
-  },
-  "scripts": {
-    "build": "node build",
-    "types": "tsc --skipLibCheck"
-  },
-  "dependencies": {
-    "esbuild": "^0.15.16"
-  },
-  "devDependencies": {
-    "@types/node": "16.11.6",
-    "@types/react": "17.0.33",
-    "typescript": "4.9.3"
-  },
-  "keywords": [
-    "esm",
-    "loader",
-    "typescript",
-    "loader hook",
-    "require hook",
-    "experimental-loader"
-  ]
-}

package/dist-cli/tsm/readme.md

@@ -1,62 +0,0 @@
-<div align="center">
-  <img src="logo.png" alt="tsm" width="200" />
-</div>
-
-<div align="center">
-  <a href="https://npmjs.org/package/tsm">
-    <img src="https://badgen.net/npm/v/tsm" alt="version" />
-  </a>
-  <a href="https://github.com/lukeed/tsm/actions">
-    <img src="https://github.com/lukeed/tsm/workflows/CI/badge.svg" alt="CI" />
-  </a>
-  <a href="https://npmjs.org/package/tsm">
-    <img src="https://badgen.net/npm/dm/tsm" alt="downloads" />
-  </a>
-  <a href="https://packagephobia.now.sh/result?p=tsm">
-    <img src="https://badgen.net/packagephobia/publish/tsm" alt="publish size" />
-  </a>
-</div>
-
-<div align="center">TypeScript Module Loader</div>
-
-## Features
-
-* Supports `node <file>` usage
-* Supports [ESM `--loader`](https://nodejs.org/api/esm.html#esm_loaders) usage<sup>†</sup>
-* Supports [`--require` hook](https://nodejs.org/api/cli.html#cli_r_require_module) usage
-* Optional [configuration](/docs/configuration.md) file for per-extension customization
-
-> <sup>†</sup> The ESM Loader API is still **experimental** and will change in the future.
-
-## Install
-
-```sh
-# install as project dependency
-$ npm install --save-dev tsm
-
-# or install globally
-$ npm install --global tsm
-```
-
-## Usage
-
-> **Note:** Refer to [`/docs/usage.md`](/docs/usage.md) for more information.
-
-```sh
-# use as `node` replacement
-$ tsm server.ts
-
-# forwards any `node` ENV or flags
-$ NO_COLOR=1 tsm server.ts --trace-warnings
-
-# use as `--require` hook
-$ node --require tsm server.tsx
-$ node -r tsm server.tsx
-
-# use as `--loader` hook
-$ node --loader tsm main.jsx
-```
-
-## License
-
-MIT © [Luke Edwards](https://lukeed.com)

package/dist-cli/tsm/require.js

@@ -1 +0,0 @@
-"use strict";const{readFileSync}=require("fs"),{extname}=require("path"),tsm=require("./utils"),loadJS=require.extensions[".js"];let esbuild,env=tsm.$defaults("cjs"),uconf=env.file&&require(env.file),config=tsm.$finalize(env,uconf);const tsrequire='var $$req=require("module").createRequire(__filename);require=('+function(){let{existsSync:t}=$$req("fs"),r=$$req("url");return new Proxy(require,{apply(l,n,o){let[e]=o;if(!e)return l.apply(n||$$req,o);if(/^\w+\:?/.test(e))return $$req(e);let u=/\.([mc])?[tj]sx?(?=\?|$)/.exec(e);if(u==null)return $$req(e);let f=r.pathToFileURL(__filename),s=r.fileURLToPath(new r.URL(e,f));if(t(s))return $$req(e);let p=u[0],a=new RegExp(p+"$"),i=s.replace(a,p.replace("js","ts"));return t(i)||p===".js"&&(i=s.replace(a,".tsx"),t(i)||(i=s.replace(a,".jsx"),t(i)))?$$req(i):$$req(e)}})}+")();";function transform(t,r){return esbuild=esbuild||require("esbuild"),esbuild.transformSync(t,r).code}function loader(t,r){let l=extname(r),n=config[l]||{},o=t._compile.bind(t);n.sourcefile=r,/\.[mc]?[tj]sx?$/.test(l)&&(n.banner=tsrequire+(n.banner||""),n.supported=n.supported||{},n.supported["dynamic-import"]=!1),config[l]!=null&&(t._compile=e=>{let u=transform(e,n);return o(u,r)});try{return loadJS(t,r)}catch(e){if((e&&e.code)!=="ERR_REQUIRE_ESM")throw e;let f=readFileSync(r,"utf8"),s=transform(f,{...n,format:"cjs"});return o(s,r)}}for(let t in config)require.extensions[t]=loader;config[".js"]==null&&(require.extensions[".js"]=loader);

package/dist-cli/tsm/utils.js

@@ -1 +0,0 @@
-"use strict";const{resolve}=require("path"),{existsSync}=require("fs");exports.$defaults=function(l){let{FORCE_COLOR:e,NO_COLOR:s,NODE_DISABLE_COLORS:o,TERM:t}=process.env,i=process.argv.slice(2),n=new Set(i),f=n.has("-q")||n.has("--quiet"),d=!o&&s==null&&t!=="dumb"&&(e!=null&&e!=="0"||process.stdout.isTTY),r=n.has("--tsmconfig")?i.indexOf("--tsmconfig"):-1,a=resolve(".",!!~r&&i[++r]||"tsm.js");return{file:existsSync(a)&&a,isESM:l==="esm",options:{format:l,charset:"utf8",sourcemap:"inline",target:"node"+process.versions.node,logLevel:f?"silent":"warning",color:d}}},exports.$finalize=function(l,e){let s=l.options;e&&e.common&&(Object.assign(s,e.common),delete e.common);let o={".mts":{...s,loader:"ts"},".jsx":{...s,loader:"jsx"},".tsx":{...s,loader:"tsx"},".cts":{...s,loader:"ts"},".ts":{...s,loader:"ts"}};l.isESM?o[".json"]={...s,loader:"json"}:o[".mjs"]={...s,loader:"js"};let t;if(e&&e.loaders)for(t in e.loaders)o[t]={...s,loader:e.loaders[t]};else if(e){let i=e.config||e;for(t in i)o[t]={...s,...i[t]}}return o};