@openfn/language-mysql 1.3.0 → 1.3.2

package/ast.json

@@ -19,9 +19,8 @@
             "description": "upsertMany(\n  'users', // the DB table\n  [\n    { name: 'one', email: 'one@openfn.org' },\n    { name: 'two', email: 'two@openfn.org' },\n  ]\n)"
           },
           {
-            "title": "constructor",
+            "title": "function",
             "description": null,
-            "type": null,
             "name": null
           },
           {

package/configuration-schema.json

@@ -6,33 +6,48 @@
         "type": "string",
         "description": "The database instance host URL",
         "format": "uri",
-        "minLength": 1
+        "minLength": 1,
+        "examples": [
+          "some-host-url.compute-1.amazonaws.com"
+        ]
       },
       "port": {
         "title": "Port",
         "type": "integer",
         "default": 3306,
         "description": "Database instance port",
-        "minLength": 1
+        "minLength": 1,
+        "examples": [
+          3306
+        ]
       },
       "database": {
         "title": "Database",
         "type": "string",
         "description": "The database name",
-        "minLength": 1
+        "minLength": 1,
+        "examples": [
+          "demo-db"
+        ]
       },
       "user": {
         "title": "Username",
         "type": "string",
         "description": "The username to log in the database",
-        "minLength": 1
+        "minLength": 1,
+        "examples": [
+          "admin-demo"
+        ]
       },
       "password": {
         "title": "Password",
         "type": "string",
         "description": "The password to log in the database",
         "writeOnly": true,
-        "minLength": 1
+        "minLength": 1,
+        "examples": [
+          "@super(!)Secretpass"
+        ]
       }
     },
     "type": "object",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/language-mysql",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "description": "A MySQL Language Pack for OpenFn",
   "homepage": "https://docs.openfn.org",
   "main": "dist/index.cjs",

package/types/Adaptor.d.ts

@@ -1,4 +1,3 @@
-/** @module Adaptor */
 /**
  * Execute a sequence of operations.
  * Wraps `language-common/execute`, and prepends initial state for mysql.
@@ -7,27 +6,11 @@
  *   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 {
-    /** @module Adaptor */
-    /**
-     * Execute a sequence of operations.
-     * Wraps `language-common/execute`, and prepends initial state for mysql.
-     * @example
-     * execute(
-     *   create('foo'),
-     *   delete('bar')
-     * )(state)
-     * @constructor
-     * @param {Operations} operations - Operations to be performed.
-     * @returns {Operation}
-     */
-    constructor(...operations: Operations);
-}
 /**
  * Insert a record
  * @example
@@ -36,28 +19,12 @@ export class execute {
  *      field('name', dataValue('name'))
  *   ))
  * )(state)
- * @constructor
+ * @function
  * @param {string} table - The target table
  * @param {object} fields - A fields object
  * @returns {Operation}
  */
 export function insert(table: string, fields: object): Operation;
-export class insert {
-    /**
-     * Insert a record
-     * @example
-     * execute(
-     *   insert('table', fields(
-     *      field('name', dataValue('name'))
-     *   ))
-     * )(state)
-     * @constructor
-     * @param {string} table - The target table
-     * @param {object} fields - A fields object
-     * @returns {Operation}
-     */
-    constructor(table: string, fields: object);
-}
 /**
  * Insert or Update a record if matched
  * @example
@@ -66,28 +33,12 @@ export class insert {
  *      field('name', dataValue('name'))
  *   ))
  * )(state)
- * @constructor
+ * @function
  * @param {string} table - The target table
  * @param {object} fields - A fields object
  * @returns {Operation}
  */
 export function upsert(table: string, fields: object): Operation;
-export class upsert {
-    /**
-     * Insert or Update a record if matched
-     * @example
-     * execute(
-     *   upsert('table', fields(
-     *      field('name', dataValue('name'))
-     *   ))
-     * )(state)
-     * @constructor
-     * @param {string} table - The target table
-     * @param {object} fields - A fields object
-     * @returns {Operation}
-     */
-    constructor(table: string, fields: object);
-}
 /**
  * Insert or update multiple records using ON DUPLICATE KEY
  * @public
@@ -99,76 +50,31 @@ export class upsert {
  *     { name: 'two', email: 'two@openfn.org' },
  *   ]
  * )
- * @constructor
+ * @function
  * @param {string} table - The target table
  * @param {array} data - An array of objects or a function that returns an array
  * @returns {Operation}
  */
 export function upsertMany(table: string, data: any[]): Operation;
-export class upsertMany {
-    /**
-     * Insert or update multiple records using ON DUPLICATE KEY
-     * @public
-     * @example
-     * upsertMany(
-     *   'users', // the DB table
-     *   [
-     *     { name: 'one', email: 'one@openfn.org' },
-     *     { name: 'two', email: 'two@openfn.org' },
-     *   ]
-     * )
-     * @constructor
-     * @param {string} table - The target table
-     * @param {array} data - An array of objects or a function that returns an array
-     * @returns {Operation}
-     */
-    constructor(table: string, data: any[]);
-}
 /**
  * Execute a SQL statement
  * @example
  * execute(
  *   query({ sql: 'select * from users;' })
  * )(state)
- * @constructor
+ * @function
  * @param {object} options - Payload data for the message
  * @returns {Operation}
  */
 export function query(options: object): Operation;
-export class query {
-    /**
-     * Execute a SQL statement
-     * @example
-     * execute(
-     *   query({ sql: 'select * from users;' })
-     * )(state)
-     * @constructor
-     * @param {object} options - Payload data for the message
-     * @returns {Operation}
-     */
-    constructor(options: object);
-}
 /**
  * Execute a SQL statement
  * @example
  * execute(
  *   sqlString(state => "select * from items;")
  * )(state)
- * @constructor
+ * @function
  * @param {String} queryString - A query string (or function which takes state and returns a string)
  * @returns {Operation}
  */
 export function sqlString(queryString: string): Operation;
-export class sqlString {
-    /**
-     * Execute a SQL statement
-     * @example
-     * execute(
-     *   sqlString(state => "select * from items;")
-     * )(state)
-     * @constructor
-     * @param {String} queryString - A query string (or function which takes state and returns a string)
-     * @returns {Operation}
-     */
-    constructor(queryString: string);
-}