@openfn/language-mysql 1.1.2 → 1.3.0

package/node_modules/@openfn/language-common/ast.json

@@ -1,1001 +0,0 @@
-{
-  "operations": [
-    {
-      "name": "execute",
-      "params": [
-        "operations"
-      ],
-      "docs": {
-        "description": "Execute a sequence of operations.\nMain outer API for executing expressions.",
-        "tags": [
-          {
-            "title": "public",
-            "description": null,
-            "type": null
-          },
-          {
-            "title": "example",
-            "description": "execute(\n   create('foo'),\n   delete('bar')\n )"
-          },
-          {
-            "title": "function",
-            "description": null,
-            "name": null
-          },
-          {
-            "title": "param",
-            "description": "Operations to be performed.",
-            "type": {
-              "type": "NameExpression",
-              "name": "Operations"
-            },
-            "name": "operations"
-          },
-          {
-            "title": "returns",
-            "description": null,
-            "type": {
-              "type": "NameExpression",
-              "name": "Promise"
-            }
-          }
-        ]
-      },
-      "valid": true
-    },
-    {
-      "name": "fn",
-      "params": [
-        "func"
-      ],
-      "docs": {
-        "description": "Creates a custom step (or operation) for more flexible job writing.",
-        "tags": [
-          {
-            "title": "public",
-            "description": null,
-            "type": null
-          },
-          {
-            "title": "example",
-            "description": "fn(state => {\n  // do some things to state\n  return state;\n});"
-          },
-          {
-            "title": "function",
-            "description": null,
-            "name": null
-          },
-          {
-            "title": "param",
-            "description": "is the function",
-            "type": {
-              "type": "NameExpression",
-              "name": "Function"
-            },
-            "name": "func"
-          }
-        ]
-      },
-      "valid": true
-    },
-    {
-      "name": "sourceValue",
-      "params": [
-        "path"
-      ],
-      "docs": {
-        "description": "Picks out a single value from source data.\nIf a JSONPath returns more than one value for the reference, the first\nitem will be returned.",
-        "tags": [
-          {
-            "title": "public",
-            "description": null,
-            "type": null
-          },
-          {
-            "title": "example",
-            "description": "sourceValue('$.key')"
-          },
-          {
-            "title": "function",
-            "description": null,
-            "name": null
-          },
-          {
-            "title": "param",
-            "description": "JSONPath referencing a point in `state`.",
-            "type": {
-              "type": "NameExpression",
-              "name": "String"
-            },
-            "name": "path"
-          }
-        ]
-      },
-      "valid": true
-    },
-    {
-      "name": "source",
-      "params": [
-        "path"
-      ],
-      "docs": {
-        "description": "Picks out a value from source data.\nWill return whatever JSONPath returns, which will always be an array.\nIf you need a single value use `sourceValue` instead.",
-        "tags": [
-          {
-            "title": "public",
-            "description": null,
-            "type": null
-          },
-          {
-            "title": "example",
-            "description": "source('$.key')"
-          },
-          {
-            "title": "function",
-            "description": null,
-            "name": null
-          },
-          {
-            "title": "param",
-            "description": "JSONPath referencing a point in `state`.",
-            "type": {
-              "type": "NameExpression",
-              "name": "String"
-            },
-            "name": "path"
-          },
-          {
-            "title": "returns",
-            "description": null,
-            "type": {
-              "type": "TypeApplication",
-              "expression": {
-                "type": "NameExpression",
-                "name": "Array"
-              },
-              "applications": [
-                {
-                  "type": "UnionType",
-                  "elements": [
-                    {
-                      "type": "NameExpression",
-                      "name": "String"
-                    },
-                    {
-                      "type": "NameExpression",
-                      "name": "Object"
-                    }
-                  ]
-                }
-              ]
-            }
-          }
-        ]
-      },
-      "valid": true
-    },
-    {
-      "name": "dataPath",
-      "params": [
-        "path"
-      ],
-      "docs": {
-        "description": "Ensures a path points at the data.",
-        "tags": [
-          {
-            "title": "public",
-            "description": null,
-            "type": null
-          },
-          {
-            "title": "example",
-            "description": "dataPath('key')"
-          },
-          {
-            "title": "function",
-            "description": null,
-            "name": null
-          },
-          {
-            "title": "param",
-            "description": "JSONPath referencing a point in `data`.",
-            "type": {
-              "type": "NameExpression",
-              "name": "string"
-            },
-            "name": "path"
-          },
-          {
-            "title": "returns",
-            "description": null,
-            "type": {
-              "type": "NameExpression",
-              "name": "string"
-            }
-          }
-        ]
-      },
-      "valid": true
-    },
-    {
-      "name": "dataValue",
-      "params": [
-        "path"
-      ],
-      "docs": {
-        "description": "Picks out a single value from the source data object—usually `state.data`.\nIf a JSONPath returns more than one value for the reference, the first\nitem will be returned.",
-        "tags": [
-          {
-            "title": "public",
-            "description": null,
-            "type": null
-          },
-          {
-            "title": "example",
-            "description": "dataValue('key')"
-          },
-          {
-            "title": "function",
-            "description": null,
-            "name": null
-          },
-          {
-            "title": "param",
-            "description": "JSONPath referencing a point in `data`.",
-            "type": {
-              "type": "NameExpression",
-              "name": "String"
-            },
-            "name": "path"
-          }
-        ]
-      },
-      "valid": true
-    },
-    {
-      "name": "referencePath",
-      "params": [
-        "path"
-      ],
-      "docs": {
-        "description": "Ensures a path points at references.",
-        "tags": [
-          {
-            "title": "public",
-            "description": null,
-            "type": null
-          },
-          {
-            "title": "example",
-            "description": "referencePath('key')"
-          },
-          {
-            "title": "function",
-            "description": null,
-            "name": null
-          },
-          {
-            "title": "param",
-            "description": "JSONPath referencing a point in `references`.",
-            "type": {
-              "type": "NameExpression",
-              "name": "string"
-            },
-            "name": "path"
-          },
-          {
-            "title": "returns",
-            "description": null,
-            "type": {
-              "type": "NameExpression",
-              "name": "string"
-            }
-          }
-        ]
-      },
-      "valid": true
-    },
-    {
-      "name": "lastReferenceValue",
-      "params": [
-        "path"
-      ],
-      "docs": {
-        "description": "Picks out the last reference value from source data.",
-        "tags": [
-          {
-            "title": "public",
-            "description": null,
-            "type": null
-          },
-          {
-            "title": "example",
-            "description": "lastReferenceValue('key')"
-          },
-          {
-            "title": "function",
-            "description": null,
-            "name": null
-          },
-          {
-            "title": "param",
-            "description": "JSONPath referencing a point in `references`.",
-            "type": {
-              "type": "NameExpression",
-              "name": "String"
-            },
-            "name": "path"
-          }
-        ]
-      },
-      "valid": true
-    },
-    {
-      "name": "asData",
-      "params": [
-        "data",
-        "state"
-      ],
-      "docs": {
-        "description": "Simple switcher allowing other expressions to use either a JSONPath or\nobject literals as a data source.\n- JSONPath referencing a point in `state`\n- Object Literal of the data itself.\n- Function to be called with state.",
-        "tags": [
-          {
-            "title": "public",
-            "description": null,
-            "type": null
-          },
-          {
-            "title": "example",
-            "description": "asData('$.key'| key | callback)"
-          },
-          {
-            "title": "function",
-            "description": null,
-            "name": null
-          },
-          {
-            "title": "param",
-            "description": null,
-            "type": {
-              "type": "UnionType",
-              "elements": [
-                {
-                  "type": "NameExpression",
-                  "name": "String"
-                },
-                {
-                  "type": "NameExpression",
-                  "name": "object"
-                },
-                {
-                  "type": "NameExpression",
-                  "name": "function"
-                }
-              ]
-            },
-            "name": "data"
-          },
-          {
-            "title": "param",
-            "description": "The current state.",
-            "type": {
-              "type": "NameExpression",
-              "name": "object"
-            },
-            "name": "state"
-          },
-          {
-            "title": "returns",
-            "description": null,
-            "type": {
-              "type": "NameExpression",
-              "name": "array"
-            }
-          }
-        ]
-      },
-      "valid": true
-    },
-    {
-      "name": "each",
-      "params": [
-        "dataSource",
-        "operation"
-      ],
-      "docs": {
-        "description": "Scopes an array of data based on a JSONPath.\nUseful when the source data has `n` items you would like to map to\nan operation.\nThe operation will receive a slice of the data based of each item\nof the JSONPath provided.\n\nIt also ensures the results of an operation make their way back into\nthe state's references.",
-        "tags": [
-          {
-            "title": "public",
-            "description": null,
-            "type": null
-          },
-          {
-            "title": "example",
-            "description": "each(\"$.[*]\",\n  create(\"SObject\",\n    field(\"FirstName\", sourceValue(\"$.firstName\"))\n  )\n)"
-          },
-          {
-            "title": "function",
-            "description": null,
-            "name": null
-          },
-          {
-            "title": "param",
-            "description": "JSONPath referencing a point in `state`.",
-            "type": {
-              "type": "NameExpression",
-              "name": "DataSource"
-            },
-            "name": "dataSource"
-          },
-          {
-            "title": "param",
-            "description": "The operation needed to be repeated.",
-            "type": {
-              "type": "NameExpression",
-              "name": "Operation"
-            },
-            "name": "operation"
-          }
-        ]
-      },
-      "valid": true
-    },
-    {
-      "name": "combine",
-      "params": [
-        "operations"
-      ],
-      "docs": {
-        "description": "Combines two operations into one",
-        "tags": [
-          {
-            "title": "public",
-            "description": null,
-            "type": null
-          },
-          {
-            "title": "example",
-            "description": "combine(\n  create('foo'),\n  delete('bar')\n)"
-          },
-          {
-            "title": "function",
-            "description": null,
-            "name": null
-          },
-          {
-            "title": "param",
-            "description": "Operations to be performed.",
-            "type": {
-              "type": "NameExpression",
-              "name": "Operations"
-            },
-            "name": "operations"
-          },
-          {
-            "title": "returns",
-            "description": null,
-            "type": {
-              "type": "NameExpression",
-              "name": "Operation"
-            }
-          }
-        ]
-      },
-      "valid": true
-    },
-    {
-      "name": "join",
-      "params": [
-        "targetPath",
-        "sourcePath",
-        "targetKey"
-      ],
-      "docs": {
-        "description": "Adds data from a target object",
-        "tags": [
-          {
-            "title": "public",
-            "description": null,
-            "type": null
-          },
-          {
-            "title": "example",
-            "description": "join('$.key','$.data','newKey')"
-          },
-          {
-            "title": "function",
-            "description": null,
-            "name": null
-          },
-          {
-            "title": "param",
-            "description": "Target path",
-            "type": {
-              "type": "NameExpression",
-              "name": "String"
-            },
-            "name": "targetPath"
-          },
-          {
-            "title": "param",
-            "description": "Source path",
-            "type": {
-              "type": "NameExpression",
-              "name": "String"
-            },
-            "name": "sourcePath"
-          },
-          {
-            "title": "param",
-            "description": "Target Key",
-            "type": {
-              "type": "NameExpression",
-              "name": "String"
-            },
-            "name": "targetKey"
-          }
-        ]
-      },
-      "valid": true
-    },
-    {
-      "name": "expandReferences",
-      "params": [
-        "value",
-        "skipFilter"
-      ],
-      "docs": {
-        "description": "Recursively resolves objects that have resolvable values (functions).",
-        "tags": [
-          {
-            "title": "public",
-            "description": null,
-            "type": null
-          },
-          {
-            "title": "function",
-            "description": null,
-            "name": null
-          },
-          {
-            "title": "param",
-            "description": "data",
-            "type": {
-              "type": "NameExpression",
-              "name": "object"
-            },
-            "name": "value"
-          },
-          {
-            "title": "param",
-            "description": "a function which returns true if a value should be skipped",
-            "type": {
-              "type": "OptionalType",
-              "expression": {
-                "type": "NameExpression",
-                "name": "Function"
-              }
-            },
-            "name": "skipFilter"
-          }
-        ]
-      },
-      "valid": true
-    },
-    {
-      "name": "field",
-      "params": [
-        "key",
-        "value"
-      ],
-      "docs": {
-        "description": "Returns a key, value pair in an array.",
-        "tags": [
-          {
-            "title": "public",
-            "description": null,
-            "type": null
-          },
-          {
-            "title": "example",
-            "description": "field('destination_field_name__c', 'value')"
-          },
-          {
-            "title": "function",
-            "description": null,
-            "name": null
-          },
-          {
-            "title": "param",
-            "description": "Name of the field",
-            "type": {
-              "type": "NameExpression",
-              "name": "string"
-            },
-            "name": "key"
-          },
-          {
-            "title": "param",
-            "description": "The value itself or a sourceable operation.",
-            "type": {
-              "type": "NameExpression",
-              "name": "Value"
-            },
-            "name": "value"
-          }
-        ]
-      },
-      "valid": true
-    },
-    {
-      "name": "fields",
-      "params": [
-        "fields"
-      ],
-      "docs": {
-        "description": "Zips key value pairs into an object.",
-        "tags": [
-          {
-            "title": "public",
-            "description": null,
-            "type": null
-          },
-          {
-            "title": "example",
-            "description": "fields(list_of_fields)"
-          },
-          {
-            "title": "function",
-            "description": null,
-            "name": null
-          },
-          {
-            "title": "param",
-            "description": "a list of fields",
-            "type": {
-              "type": "NameExpression",
-              "name": "Fields"
-            },
-            "name": "fields"
-          },
-          {
-            "title": "returns",
-            "description": null,
-            "type": {
-              "type": "NameExpression",
-              "name": "Object"
-            }
-          }
-        ]
-      },
-      "valid": true
-    },
-    {
-      "name": "merge",
-      "params": [
-        "dataSource",
-        "fields"
-      ],
-      "docs": {
-        "description": "Merges fields into each item in an array.",
-        "tags": [
-          {
-            "title": "public",
-            "description": null,
-            "type": null
-          },
-          {
-            "title": "example",
-            "description": "merge(\n  \"$.books[*]\",\n  fields(\n    field( \"publisher\", sourceValue(\"$.publisher\") )\n  )\n)"
-          },
-          {
-            "title": "function",
-            "description": null,
-            "name": null
-          },
-          {
-            "title": "param",
-            "description": null,
-            "type": {
-              "type": "NameExpression",
-              "name": "DataSource"
-            },
-            "name": "dataSource"
-          },
-          {
-            "title": "param",
-            "description": "Group of fields to merge in.",
-            "type": {
-              "type": "NameExpression",
-              "name": "Object"
-            },
-            "name": "fields"
-          },
-          {
-            "title": "returns",
-            "description": null,
-            "type": {
-              "type": "NameExpression",
-              "name": "DataSource"
-            }
-          }
-        ]
-      },
-      "valid": true
-    },
-    {
-      "name": "index",
-      "params": [],
-      "docs": {
-        "description": "Returns the index of the current array being iterated.\nTo be used with `each` as a data source.",
-        "tags": [
-          {
-            "title": "public",
-            "description": null,
-            "type": null
-          },
-          {
-            "title": "example",
-            "description": "index()"
-          },
-          {
-            "title": "function",
-            "description": null,
-            "name": null
-          }
-        ]
-      },
-      "valid": true
-    },
-    {
-      "name": "arrayToString",
-      "params": [
-        "arr",
-        "separator"
-      ],
-      "docs": {
-        "description": "Turns an array into a string, separated by X.",
-        "tags": [
-          {
-            "title": "public",
-            "description": null,
-            "type": null
-          },
-          {
-            "title": "example",
-            "description": "field(\"destination_string__c\", function(state) {\n  return arrayToString(dataValue(\"path_of_array\")(state), ', ')\n})"
-          },
-          {
-            "title": "function",
-            "description": null,
-            "name": null
-          },
-          {
-            "title": "param",
-            "description": "Array of toString'able primatives.",
-            "type": {
-              "type": "NameExpression",
-              "name": "array"
-            },
-            "name": "arr"
-          },
-          {
-            "title": "param",
-            "description": "Separator string.",
-            "type": {
-              "type": "NameExpression",
-              "name": "string"
-            },
-            "name": "separator"
-          },
-          {
-            "title": "returns",
-            "description": null,
-            "type": {
-              "type": "NameExpression",
-              "name": "string"
-            }
-          }
-        ]
-      },
-      "valid": true
-    },
-    {
-      "name": "toArray",
-      "params": [
-        "arg"
-      ],
-      "docs": {
-        "description": "Ensures primitive data types are wrapped in an array.\nDoes not affect array objects.",
-        "tags": [
-          {
-            "title": "public",
-            "description": null,
-            "type": null
-          },
-          {
-            "title": "example",
-            "description": "each(function(state) {\n  return toArray( dataValue(\"path_of_array\")(state) )\n}, ...)"
-          },
-          {
-            "title": "function",
-            "description": null,
-            "name": null
-          },
-          {
-            "title": "param",
-            "description": "Data required to be in an array",
-            "type": {
-              "type": "NameExpression",
-              "name": "any"
-            },
-            "name": "arg"
-          },
-          {
-            "title": "returns",
-            "description": null,
-            "type": {
-              "type": "NameExpression",
-              "name": "array"
-            }
-          }
-        ]
-      },
-      "valid": true
-    },
-    {
-      "name": "composeNextState",
-      "params": [
-        "state",
-        "response"
-      ],
-      "docs": {
-        "description": "Prepares next state",
-        "tags": [
-          {
-            "title": "public",
-            "description": null,
-            "type": null
-          },
-          {
-            "title": "example",
-            "description": "composeNextState(state, response)"
-          },
-          {
-            "title": "function",
-            "description": null,
-            "name": null
-          },
-          {
-            "title": "param",
-            "description": "state",
-            "type": {
-              "type": "NameExpression",
-              "name": "State"
-            },
-            "name": "state"
-          },
-          {
-            "title": "param",
-            "description": "Response to be added",
-            "type": {
-              "type": "NameExpression",
-              "name": "Object"
-            },
-            "name": "response"
-          },
-          {
-            "title": "returns",
-            "description": null,
-            "type": {
-              "type": "NameExpression",
-              "name": "State"
-            }
-          }
-        ]
-      },
-      "valid": true
-    },
-    {
-      "name": "humanProper",
-      "params": [
-        "str"
-      ],
-      "docs": {
-        "description": "Subsitutes underscores for spaces and proper-cases a string",
-        "tags": [
-          {
-            "title": "public",
-            "description": null,
-            "type": null
-          },
-          {
-            "title": "example",
-            "description": "field(\"destination_string__c\", humanProper(state.data.path_to_string))"
-          },
-          {
-            "title": "function",
-            "description": null,
-            "name": null
-          },
-          {
-            "title": "param",
-            "description": "String that needs converting",
-            "type": {
-              "type": "NameExpression",
-              "name": "string"
-            },
-            "name": "str"
-          },
-          {
-            "title": "returns",
-            "description": null,
-            "type": {
-              "type": "NameExpression",
-              "name": "string"
-            }
-          }
-        ]
-      },
-      "valid": true
-    },
-    {
-      "name": "map",
-      "params": [
-        "path",
-        "operation",
-        "state"
-      ],
-      "docs": {
-        "description": "Scopes an array of data based on a JSONPath.\nUseful when the source data has `n` items you would like to map to\nan operation.\nThe operation will receive a slice of the data based of each item\nof the JSONPath provided.",
-        "tags": [
-          {
-            "title": "public",
-            "description": null,
-            "type": null
-          },
-          {
-            "title": "example",
-            "description": "map(\"$.[*]\",\n  create(\"SObject\",\n    field(\"FirstName\", sourceValue(\"$.firstName\"))\n  )\n)"
-          },
-          {
-            "title": "function",
-            "description": null,
-            "name": null
-          },
-          {
-            "title": "param",
-            "description": "JSONPath referencing a point in `state.data`.",
-            "type": {
-              "type": "NameExpression",
-              "name": "string"
-            },
-            "name": "path"
-          },
-          {
-            "title": "param",
-            "description": "The operation needed to be repeated.",
-            "type": {
-              "type": "NameExpression",
-              "name": "function"
-            },
-            "name": "operation"
-          },
-          {
-            "title": "param",
-            "description": "Runtime state.",
-            "type": {
-              "type": "NameExpression",
-              "name": "State"
-            },
-            "name": "state"
-          }
-        ]
-      },
-      "valid": true
-    }
-  ],
-  "exports": [],
-  "common": []
-}