knex 2.5.0 → 3.0.0

package/lib/migrations/seed/stub/js.stub

@@ -1,13 +1,13 @@
-/**
- * @param { import("knex").Knex } knex
- * @returns { Promise<void> } 
- */
-exports.seed = async function(knex) {
-  // Deletes ALL existing entries
-  await knex('table_name').del()
-  await knex('table_name').insert([
-    {id: 1, colName: 'rowValue1'},
-    {id: 2, colName: 'rowValue2'},
-    {id: 3, colName: 'rowValue3'}
-  ]);
-};
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> } 
+ */
+exports.seed = async function(knex) {
+  // Deletes ALL existing entries
+  await knex('table_name').del()
+  await knex('table_name').insert([
+    {id: 1, colName: 'rowValue1'},
+    {id: 2, colName: 'rowValue2'},
+    {id: 3, colName: 'rowValue3'}
+  ]);
+};

package/lib/migrations/seed/stub/ls.stub

@@ -1,11 +1,11 @@
-exports.seed = (knex) ->
-  # Deletes ALL existing entries
-  knex('table_name').del()
-  .then(() ->
-    # Inserts seed entries
-    knex('table_name').insert([
-      {id: 1, colName: 'rowValue1'},
-      {id: 2, colName: 'rowValue2'},
-      {id: 3, colName: 'rowValue3'}
-    ])
-  )
+exports.seed = (knex) ->
+  # Deletes ALL existing entries
+  knex('table_name').del()
+  .then(() ->
+    # Inserts seed entries
+    knex('table_name').insert([
+      {id: 1, colName: 'rowValue1'},
+      {id: 2, colName: 'rowValue2'},
+      {id: 3, colName: 'rowValue3'}
+    ])
+  )

package/lib/migrations/seed/stub/mjs.stub

@@ -1,12 +1,12 @@
-
-export const seed = async (knex) => {
-  // Deletes ALL existing entries
-  await knex('table_name').del();
-  
-  // Inserts seed entries
-  await knex('table_name').insert([
-    {id: 1, colName: 'rowValue1'},
-    {id: 2, colName: 'rowValue2'},
-    {id: 3, colName: 'rowValue3'}
-  ]);
-};
+
+export const seed = async (knex) => {
+  // Deletes ALL existing entries
+  await knex('table_name').del();
+  
+  // Inserts seed entries
+  await knex('table_name').insert([
+    {id: 1, colName: 'rowValue1'},
+    {id: 2, colName: 'rowValue2'},
+    {id: 3, colName: 'rowValue3'}
+  ]);
+};

package/lib/migrations/seed/stub/ts.stub

@@ -1,13 +1,13 @@
-import { Knex } from "knex";
-
-export async function seed(knex: Knex): Promise<void> {
-    // Deletes ALL existing entries
-    await knex("table_name").del();
-
-    // Inserts seed entries
-    await knex("table_name").insert([
-        { id: 1, colName: "rowValue1" },
-        { id: 2, colName: "rowValue2" },
-        { id: 3, colName: "rowValue3" }
-    ]);
-};
+import { Knex } from "knex";
+
+export async function seed(knex: Knex): Promise<void> {
+    // Deletes ALL existing entries
+    await knex("table_name").del();
+
+    // Inserts seed entries
+    await knex("table_name").insert([
+        { id: 1, colName: "rowValue1" },
+        { id: 2, colName: "rowValue2" },
+        { id: 3, colName: "rowValue3" }
+    ]);
+};

package/lib/migrations/util/fs.js

@@ -1,86 +1,86 @@
-const fs = require('fs');
-const flatten = require('lodash/flatten');
-const os = require('os');
-const path = require('path');
-const { promisify } = require('util');
-
-// Promisify common fs functions.
-const stat = promisify(fs.stat);
-const readFile = promisify(fs.readFile);
-const writeFile = promisify(fs.writeFile);
-const readdir = promisify(fs.readdir);
-const mkdir = promisify(fs.mkdir);
-
-function existsSync(path) {
-  try {
-    fs.accessSync(path);
-    return true;
-  } catch (e) {
-    return false;
-  }
-}
-
-/**
- * Creates a temporary directory and returns it path.
- *
- * @returns {Promise<string>}
- */
-function createTemp() {
-  return promisify(fs.mkdtemp)(`${os.tmpdir()}${path.sep}`);
-}
-
-/**
- * Ensures the given path exists.
- *  - If the path already exist, it's fine - it does nothing.
- *  - If the path doesn't exist, it will create it.
- *
- * @param {string} path
- * @returns {Promise}
- */
-function ensureDirectoryExists(dir) {
-  return stat(dir).catch(() => mkdir(dir, { recursive: true }));
-}
-
-/**
- * Read a directory,
- * sorting folders and files by alphabetically order.
- * Can be browsed recursively.
- *
- * @param {string} dir
- * The directory to analyse
- *
- * @param {boolean} recursive
- * Browse directory recursively
- *
- * @returns {Promise<[string]>}
- * All found files, concatenated to the current dir
- */
-async function getFilepathsInFolder(dir, recursive = false) {
-  const pathsList = await readdir(dir);
-  return flatten(
-    await Promise.all(
-      pathsList.sort().map(async (currentPath) => {
-        const currentFile = path.resolve(dir, currentPath);
-        const statFile = await stat(currentFile);
-        if (statFile && statFile.isDirectory()) {
-          if (recursive) {
-            return await getFilepathsInFolder(currentFile, true);
-          }
-          return [];
-        }
-        return [currentFile];
-      })
-    )
-  );
-}
-
-module.exports = {
-  existsSync,
-  stat,
-  readdir,
-  readFile,
-  writeFile,
-  createTemp,
-  ensureDirectoryExists,
-  getFilepathsInFolder,
-};
+const fs = require('fs');
+const flatten = require('lodash/flatten');
+const os = require('os');
+const path = require('path');
+const { promisify } = require('util');
+
+// Promisify common fs functions.
+const stat = promisify(fs.stat);
+const readFile = promisify(fs.readFile);
+const writeFile = promisify(fs.writeFile);
+const readdir = promisify(fs.readdir);
+const mkdir = promisify(fs.mkdir);
+
+function existsSync(path) {
+  try {
+    fs.accessSync(path);
+    return true;
+  } catch (e) {
+    return false;
+  }
+}
+
+/**
+ * Creates a temporary directory and returns it path.
+ *
+ * @returns {Promise<string>}
+ */
+function createTemp() {
+  return promisify(fs.mkdtemp)(`${os.tmpdir()}${path.sep}`);
+}
+
+/**
+ * Ensures the given path exists.
+ *  - If the path already exist, it's fine - it does nothing.
+ *  - If the path doesn't exist, it will create it.
+ *
+ * @param {string} path
+ * @returns {Promise}
+ */
+function ensureDirectoryExists(dir) {
+  return stat(dir).catch(() => mkdir(dir, { recursive: true }));
+}
+
+/**
+ * Read a directory,
+ * sorting folders and files by alphabetically order.
+ * Can be browsed recursively.
+ *
+ * @param {string} dir
+ * The directory to analyse
+ *
+ * @param {boolean} recursive
+ * Browse directory recursively
+ *
+ * @returns {Promise<[string]>}
+ * All found files, concatenated to the current dir
+ */
+async function getFilepathsInFolder(dir, recursive = false) {
+  const pathsList = await readdir(dir);
+  return flatten(
+    await Promise.all(
+      pathsList.sort().map(async (currentPath) => {
+        const currentFile = path.resolve(dir, currentPath);
+        const statFile = await stat(currentFile);
+        if (statFile && statFile.isDirectory()) {
+          if (recursive) {
+            return await getFilepathsInFolder(currentFile, true);
+          }
+          return [];
+        }
+        return [currentFile];
+      })
+    )
+  );
+}
+
+module.exports = {
+  existsSync,
+  stat,
+  readdir,
+  readFile,
+  writeFile,
+  createTemp,
+  ensureDirectoryExists,
+  getFilepathsInFolder,
+};

package/lib/migrations/util/import-file.js

@@ -1,12 +1,12 @@
-const isModuleType = require('./is-module-type');
-
-/**
- * imports 'mjs', else requires.
- * NOTE: require me late!
- * @param {string} filepath
- */
-module.exports = async function importFile(filepath) {
-  return (await isModuleType(filepath))
-    ? import(require('url').pathToFileURL(filepath))
-    : require(filepath);
-};
+const isModuleType = require('./is-module-type');
+
+/**
+ * imports 'mjs', else requires.
+ * NOTE: require me late!
+ * @param {string} filepath
+ */
+module.exports = async function importFile(filepath) {
+  return (await isModuleType(filepath))
+    ? import(require('url').pathToFileURL(filepath))
+    : require(filepath);
+};

package/lib/migrations/util/is-module-type.js

@@ -1,9 +1,9 @@
-const getPackageType = require('get-package-type');
-
-module.exports = async function isModuleType(filepath) {
-  return (
-    filepath.endsWith('.mjs') ||
-    (!filepath.endsWith('.cjs') &&
-      (await getPackageType(filepath)) === 'module')
-  );
-};
+const getPackageType = require('get-package-type');
+
+module.exports = async function isModuleType(filepath) {
+  return (
+    filepath.endsWith('.mjs') ||
+    (!filepath.endsWith('.cjs') &&
+      (await getPackageType(filepath)) === 'module')
+  );
+};

package/lib/migrations/util/template.js

@@ -1,52 +1,52 @@
-const template = require('lodash/template');
-
-const { readFile, writeFile } = require('./fs');
-
-/**
- * Light wrapper over lodash templates making it safer to be used with javascript source code.
- *
- * In particular, doesn't interfere with use of interpolated strings in javascript.
- *
- * @param {string} content Template source
- * @param {_.TemplateOptions} options Template options
- */
-const jsSourceTemplate = (content, options) =>
-  template(content, {
-    interpolate: /<%=([\s\S]+?)%>/g,
-    ...options,
-  });
-
-/**
- * Compile the contents of specified (javascript) file as a lodash template
- *
- * @param {string} filePath Path of file to be used as template
- * @param {_.TemplateOptions} options Lodash template options
- */
-const jsFileTemplate = async (filePath, options) => {
-  const contentBuffer = await readFile(filePath);
-  return jsSourceTemplate(contentBuffer.toString(), options);
-};
-
-/**
- * Write a javascript file using another file as a (lodash) template
- *
- * @param {string} targetFilePath
- * @param {string} sourceFilePath
- * @param {_.TemplateOptions} options options passed to lodash templates
- */
-const writeJsFileUsingTemplate = async (
-  targetFilePath,
-  sourceFilePath,
-  options,
-  variables
-) =>
-  writeFile(
-    targetFilePath,
-    (await jsFileTemplate(sourceFilePath, options))(variables)
-  );
-
-module.exports = {
-  jsSourceTemplate,
-  jsFileTemplate,
-  writeJsFileUsingTemplate,
-};
+const template = require('lodash/template');
+
+const { readFile, writeFile } = require('./fs');
+
+/**
+ * Light wrapper over lodash templates making it safer to be used with javascript source code.
+ *
+ * In particular, doesn't interfere with use of interpolated strings in javascript.
+ *
+ * @param {string} content Template source
+ * @param {_.TemplateOptions} options Template options
+ */
+const jsSourceTemplate = (content, options) =>
+  template(content, {
+    interpolate: /<%=([\s\S]+?)%>/g,
+    ...options,
+  });
+
+/**
+ * Compile the contents of specified (javascript) file as a lodash template
+ *
+ * @param {string} filePath Path of file to be used as template
+ * @param {_.TemplateOptions} options Lodash template options
+ */
+const jsFileTemplate = async (filePath, options) => {
+  const contentBuffer = await readFile(filePath);
+  return jsSourceTemplate(contentBuffer.toString(), options);
+};
+
+/**
+ * Write a javascript file using another file as a (lodash) template
+ *
+ * @param {string} targetFilePath
+ * @param {string} sourceFilePath
+ * @param {_.TemplateOptions} options options passed to lodash templates
+ */
+const writeJsFileUsingTemplate = async (
+  targetFilePath,
+  sourceFilePath,
+  options,
+  variables
+) =>
+  writeFile(
+    targetFilePath,
+    (await jsFileTemplate(sourceFilePath, options))(variables)
+  );
+
+module.exports = {
+  jsSourceTemplate,
+  jsFileTemplate,
+  writeJsFileUsingTemplate,
+};

package/lib/migrations/util/timestamp.js

@@ -1,14 +1,14 @@
-function yyyymmddhhmmss() {
-  const now = new Date();
-
-  return (
-    now.getUTCFullYear().toString() +
-    (now.getUTCMonth() + 1).toString().padStart(2, '0') +
-    now.getUTCDate().toString().padStart(2, '0') +
-    now.getUTCHours().toString().padStart(2, '0') +
-    now.getUTCMinutes().toString().padStart(2, '0') +
-    now.getUTCSeconds().toString().padStart(2, '0')
-  );
-}
-
-module.exports = { yyyymmddhhmmss };
+function yyyymmddhhmmss() {
+  const now = new Date();
+
+  return (
+    now.getUTCFullYear().toString() +
+    (now.getUTCMonth() + 1).toString().padStart(2, '0') +
+    now.getUTCDate().toString().padStart(2, '0') +
+    now.getUTCHours().toString().padStart(2, '0') +
+    now.getUTCMinutes().toString().padStart(2, '0') +
+    now.getUTCSeconds().toString().padStart(2, '0')
+  );
+}
+
+module.exports = { yyyymmddhhmmss };

package/lib/query/analytic.js

@@ -1,52 +1,52 @@
-const assert = require('assert');
-
-// Analytic
-// -------
-
-// The "Analytic" is an object holding any necessary info about a analytic function
-// e.g row_number, rank, dense_rank,
-class Analytic {
-  constructor(method, schema, alias, orderBy, partitions) {
-    this.schema = schema;
-    this.type = 'analytic';
-    this.method = method;
-    this.order = orderBy || [];
-    this.partitions = partitions || [];
-    this.alias = alias;
-    this.and = this;
-
-    this.grouping = 'columns';
-  }
-
-  partitionBy(column, direction) {
-    assert(
-      Array.isArray(column) || typeof column === 'string',
-      `The argument to an analytic partitionBy function must be either a string
-            or an array of string.`
-    );
-
-    if (Array.isArray(column)) {
-      this.partitions = this.partitions.concat(column);
-    } else {
-      this.partitions.push({ column: column, order: direction });
-    }
-    return this;
-  }
-
-  orderBy(column, direction) {
-    assert(
-      Array.isArray(column) || typeof column === 'string',
-      `The argument to an analytic orderBy function must be either a string
-            or an array of string.`
-    );
-
-    if (Array.isArray(column)) {
-      this.order = this.order.concat(column);
-    } else {
-      this.order.push({ column: column, order: direction });
-    }
-    return this;
-  }
-}
-
-module.exports = Analytic;
+const assert = require('assert');
+
+// Analytic
+// -------
+
+// The "Analytic" is an object holding any necessary info about a analytic function
+// e.g row_number, rank, dense_rank,
+class Analytic {
+  constructor(method, schema, alias, orderBy, partitions) {
+    this.schema = schema;
+    this.type = 'analytic';
+    this.method = method;
+    this.order = orderBy || [];
+    this.partitions = partitions || [];
+    this.alias = alias;
+    this.and = this;
+
+    this.grouping = 'columns';
+  }
+
+  partitionBy(column, direction) {
+    assert(
+      Array.isArray(column) || typeof column === 'string',
+      `The argument to an analytic partitionBy function must be either a string
+            or an array of string.`
+    );
+
+    if (Array.isArray(column)) {
+      this.partitions = this.partitions.concat(column);
+    } else {
+      this.partitions.push({ column: column, order: direction });
+    }
+    return this;
+  }
+
+  orderBy(column, direction) {
+    assert(
+      Array.isArray(column) || typeof column === 'string',
+      `The argument to an analytic orderBy function must be either a string
+            or an array of string.`
+    );
+
+    if (Array.isArray(column)) {
+      this.order = this.order.concat(column);
+    } else {
+      this.order.push({ column: column, order: direction });
+    }
+    return this;
+  }
+}
+
+module.exports = Analytic;

package/lib/query/constants.js

@@ -1,15 +1,15 @@
-/**
- * internal constants, do not use in application code
- */
-module.exports = {
-  lockMode: {
-    forShare: 'forShare',
-    forUpdate: 'forUpdate',
-    forNoKeyUpdate: 'forNoKeyUpdate',
-    forKeyShare: 'forKeyShare',
-  },
-  waitMode: {
-    skipLocked: 'skipLocked',
-    noWait: 'noWait',
-  },
-};
+/**
+ * internal constants, do not use in application code
+ */
+module.exports = {
+  lockMode: {
+    forShare: 'forShare',
+    forUpdate: 'forUpdate',
+    forNoKeyUpdate: 'forNoKeyUpdate',
+    forKeyShare: 'forKeyShare',
+  },
+  waitMode: {
+    skipLocked: 'skipLocked',
+    noWait: 'noWait',
+  },
+};