@openfn/language-mssql 3.1.2 → 4.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/language-mssql",
-  "version": "3.1.2",
+  "version": "4.0.1",
   "description": "A Microsoft SQL language pack for OpenFn",
   "exports": {
     ".": {

package/types/Adaptor.d.ts

@@ -6,48 +6,21 @@
  *   create('foo'),
  *   delete('bar')
  * )(state)
- * @constructor
+ * @function
  * @param {Operations} operations - Operations to be performed.
  * @returns {Operation}
  */
 export function execute(...operations: Operations): Operation;
-export class execute {
-    /**
-     * Execute a sequence of operations.
-     * Wraps `language-common/execute`, and prepends initial state for mssql.
-     * @example
-     * execute(
-     *   create('foo'),
-     *   delete('bar')
-     * )(state)
-     * @constructor
-     * @param {Operations} operations - Operations to be performed.
-     * @returns {Operation}
-     */
-    constructor(...operations: Operations);
-}
 /**
  * Execute an SQL statement
  * @public
  * @example
  * sql({ query, options })
- * @constructor
+ * @function
  * @param {object} params - Payload data for the message
  * @returns {Operation}
  */
 export function sql(params: object): Operation;
-export class sql {
-    /**
-     * Execute an SQL statement
-     * @public
-     * @example
-     * sql({ query, options })
-     * @constructor
-     * @param {object} params - Payload data for the message
-     * @returns {Operation}
-     */
-    constructor(params: object);
-}
 /**
  * Fetch a uuid key given a condition
  * @public
@@ -58,87 +31,42 @@ export class sql {
  *    where: { first_name: 'Mama%', last_name: 'Cisse'},
  *    operator: { first_name: 'like', last_name: '='}
  *  })
- * @constructor
+ * @function
  * @param {object} filter - A filter object with the lookup table, a uuid and the condition
  * @returns {Operation}
  */
 export function findValue(filter: object): Operation;
-export class findValue {
-    /**
-     * Fetch a uuid key given a condition
-     * @public
-     * @example
-     * findValue({
-     *    uuid: 'id',
-     *    relation: 'users',
-     *    where: { first_name: 'Mama%', last_name: 'Cisse'},
-     *    operator: { first_name: 'like', last_name: '='}
-     *  })
-     * @constructor
-     * @param {object} filter - A filter object with the lookup table, a uuid and the condition
-     * @returns {Operation}
-     */
-    constructor(filter: object);
-}
 /**
  * Insert a record
  * @public
  * @example
  * insert(table, record, {setNull: ["'undefined'", "''"], logValues: false})
- * @constructor
+ * @function
  * @param {string} table - The target table
  * @param {object} record - Payload data for the record as a JS object
  * @param {object} options - Optional options argument
  * @returns {Operation}
  */
 export function insert(table: string, record: object, options: object): Operation;
-export class insert {
-    /**
-     * Insert a record
-     * @public
-     * @example
-     * insert(table, record, {setNull: ["'undefined'", "''"], logValues: false})
-     * @constructor
-     * @param {string} table - The target table
-     * @param {object} record - Payload data for the record as a JS object
-     * @param {object} options - Optional options argument
-     * @returns {Operation}
-     */
-    constructor(table: string, record: object, options: object);
-}
 /**
  * Insert many records, using the keys of the first as the column template
  * @public
  * @example
  * insertMany(table, records, { setNull: false, writeSql: true, logValues: false })
- * @constructor
+ * @function
  * @param {string} table - The target table
  * @param {function} records - A function that takes state and returns an array of records
  * @param {object} options - Optional options argument
  * @returns {Operation}
  */
 export function insertMany(table: string, records: Function, options: object): Operation;
-export class insertMany {
-    /**
-     * Insert many records, using the keys of the first as the column template
-     * @public
-     * @example
-     * insertMany(table, records, { setNull: false, writeSql: true, logValues: false })
-     * @constructor
-     * @param {string} table - The target table
-     * @param {function} records - A function that takes state and returns an array of records
-     * @param {object} options - Optional options argument
-     * @returns {Operation}
-     */
-    constructor(table: string, records: Function, options: object);
-}
 /**
  * Insert or update a record using SQL MERGE
  * @public
  * @example
  * upsert(table, uuid, record, { setNull: "'undefined'", logValues: false})
  * upsert(table, [uuid1, uuid2], record, { setNull: "'undefined'", logValues: false})
- * @constructor
+ * @function
  * @param {string} table - The target table
  * @param {string} uuid - The uuid column to determine a matching/existing record
  * @param {object} record - Payload data for the record as a JS object
@@ -146,22 +74,6 @@ export class insertMany {
  * @returns {Operation}
  */
 export function upsert(table: string, uuid: string, record: object, options: object): Operation;
-export class upsert {
-    /**
-     * Insert or update a record using SQL MERGE
-     * @public
-     * @example
-     * upsert(table, uuid, record, { setNull: "'undefined'", logValues: false})
-     * upsert(table, [uuid1, uuid2], record, { setNull: "'undefined'", logValues: false})
-     * @constructor
-     * @param {string} table - The target table
-     * @param {string} uuid - The uuid column to determine a matching/existing record
-     * @param {object} record - Payload data for the record as a JS object
-     * @param {object} options - Optional options argument
-     * @returns {Operation}
-     */
-    constructor(table: string, uuid: string, record: object, options: object);
-}
 /**
  * Insert or update a record based on a logical condition using ON CONFLICT UPDATE
  * @public
@@ -173,7 +85,7 @@ export class upsert {
  *   { name: 'Elodie', id: 7 },
  *   { writeSql:true, execute: true, logValues: false }
  * )
- * @constructor
+ * @function
  * @param {string} logical - a data to check existing value for.
  * @param {string} table - The target table
  * @param {string} uuid - The uuid column to determine a matching/existing record
@@ -182,28 +94,6 @@ export class upsert {
  * @returns {Operation}
  */
 export function upsertIf(logical: string, table: string, uuid: string, record: object, options: object): Operation;
-export class upsertIf {
-    /**
-     * Insert or update a record based on a logical condition using ON CONFLICT UPDATE
-     * @public
-     * @example
-     * upsertIf(
-     *   dataValue('name'),
-     *   'users', // the DB table
-     *   'uuid', // a DB column with a unique constraint
-     *   { name: 'Elodie', id: 7 },
-     *   { writeSql:true, execute: true, logValues: false }
-     * )
-     * @constructor
-     * @param {string} logical - a data to check existing value for.
-     * @param {string} table - The target table
-     * @param {string} uuid - The uuid column to determine a matching/existing record
-     * @param {object} record - Payload data for the record as a JS object or function
-     * @param {object} options - Optional options argument
-     * @returns {Operation}
-     */
-    constructor(logical: string, table: string, uuid: string, record: object, options: object);
-}
 /**
  * Insert or update multiple records using ON CONFLICT UPDATE and excluded
  * @public
@@ -214,7 +104,7 @@ export class upsertIf {
  * upsertMany(
  *  'users', ['email', 'phone'], records, { logValues: false }
  * )
- * @constructor
+ * @function
  * @param {string} table - The target table
  * @param {string} uuid - The uuid column to determine a matching/existing record
  * @param {function} records - A function that takes state and returns an array of records
@@ -222,50 +112,17 @@ export class upsertIf {
  * @returns {Operation}
  */
 export function upsertMany(table: string, uuid: string, records: Function, options: object): Operation;
-export class upsertMany {
-    /**
-     * Insert or update multiple records using ON CONFLICT UPDATE and excluded
-     * @public
-     * @example
-     * upsertMany(
-     *  'users', 'email', records, { logValues: false }
-     * )
-     * upsertMany(
-     *  'users', ['email', 'phone'], records, { logValues: false }
-     * )
-     * @constructor
-     * @param {string} table - The target table
-     * @param {string} uuid - The uuid column to determine a matching/existing record
-     * @param {function} records - A function that takes state and returns an array of records
-     * @param {object} options - Optional options argument
-     * @returns {Operation}
-     */
-    constructor(table: string, uuid: string, records: Function, options: object);
-}
 /**
  * List the columns of a table in a database.
  * @public
  * @example
  * describeTable('clinic_visits')
- * @constructor
+ * @function
  * @param {string} tableName - The name of the table to describe
  * @param {object} options - Optional options argument
  * @returns {Operation}
  */
 export function describeTable(tableName: string, options: object): Operation;
-export class describeTable {
-    /**
-     * List the columns of a table in a database.
-     * @public
-     * @example
-     * describeTable('clinic_visits')
-     * @constructor
-     * @param {string} tableName - The name of the table to describe
-     * @param {object} options - Optional options argument
-     * @returns {Operation}
-     */
-    constructor(tableName: string, options: object);
-}
 /**
  * Create a table in database when given an array of columns and a table_name.
  * @public
@@ -278,34 +135,13 @@ export class describeTable {
  *     unique: false, // optional - to be set to true for unique constraint
  *   })
  * ));
- * @constructor
+ * @function
  * @param {string} tableName - The name of the table to create
  * @param {array} columns - An array of form columns
  * @param {object} options - Optional options argument
  * @returns {Operation}
  */
 export function insertTable(tableName: string, columns: any[], options: object): Operation;
-export class insertTable {
-    /**
-     * Create a table in database when given an array of columns and a table_name.
-     * @public
-     * @example
-     * insertTable('table_name', state => state.data.map(
-     *   column => ({
-     *     name: column.name,
-     *     type: column.type,
-     *     required: true, // optional
-     *     unique: false, // optional - to be set to true for unique constraint
-     *   })
-     * ));
-     * @constructor
-     * @param {string} tableName - The name of the table to create
-     * @param {array} columns - An array of form columns
-     * @param {object} options - Optional options argument
-     * @returns {Operation}
-     */
-    constructor(tableName: string, columns: any[], options: object);
-}
 /**
  * Alter an existing table in the database.
  * @public
@@ -318,32 +154,11 @@ export class insertTable {
  *     unique: false, // optional - to be set to true for unique constraint
  *   })
  * ));
- * @constructor
+ * @function
  * @param {string} tableName - The name of the table to alter
  * @param {array} columns - An array of form columns
  * @param {object} options - Optional options argument
  * @returns {Operation}
  */
 export function modifyTable(tableName: string, columns: any[], options: object): Operation;
-export class modifyTable {
-    /**
-     * Alter an existing table in the database.
-     * @public
-     * @example
-     * modifyTable('table_name', state => state.data.map(
-     *   newColumn => ({
-     *     name: newColumn.name,
-     *     type: newColumn.type,
-     *     required: true, // optional
-     *     unique: false, // optional - to be set to true for unique constraint
-     *   })
-     * ));
-     * @constructor
-     * @param {string} tableName - The name of the table to alter
-     * @param {array} columns - An array of form columns
-     * @param {object} options - Optional options argument
-     * @returns {Operation}
-     */
-    constructor(tableName: string, columns: any[], options: object);
-}
 export { alterState, combine, dataPath, dataValue, dateFns, each, field, fields, fn, http, lastReferenceValue, merge, sourceValue } from "@openfn/language-common";