@lowdefy/connection-axios-http 0.0.0-experimental-20250926130521 → 0.0.0-experimental-20251010122007

package/dist/connections/AxiosHttp/AxiosHttp/documentation.md

@@ -0,0 +1,305 @@
+<TITLE>
+AxiosHttp
+</TITLE>
+
+<DESCRIPTION>
+
+### Properties
+
+- `url: string`: The server URL that will be used for the request.
+- `method: enum`: Default: `'get'` - The request method to be used when making the request. Options are:
+  - `'get'`
+  - `'delete'`
+  - `'head'`
+  - `'options'`
+  - `'post'`
+  - `'put'`
+  - `'patch'`
+- `baseURL: string`: `baseURL` will be prepended to `url` unless `url` is absolute. It can be convenient to set `baseURL` for an axios connection to pass relative URLs to requests or mutations using that connection.
+- `headers: object`: An object with custom headers to be sent sent with the request. The object keys should be header names, and the values should be the string header values.
+- `params: object`: An object with URL parameters to be sent with the request.
+- `data: string | object | array`: The data to be sent as the request body. Only applicable for request methods `'put'`, `'post'`, and `'patch'`. Can be an object, array or a string in the format `'Country=Brasil&City=Belo Horizonte'`.
+- `auth: object`: Indicates that HTTP Basic authorization should be used, and supplies credentials. This will set an `Authorization` header, overwriting any existing `Authorization` custom headers you have set using `headers`. Only HTTP Basic auth is configurable through this parameter, for Bearer tokens and such, use `Authorization` custom headers instead. The `auth` object should have the following fields:
+  - `username: string`
+  - `password: string`
+- `httpAgentOptions: object`: Options to pass to the Node.js [`http.Agent`](https://nodejs.org/api/http.html#http_class_http_agent) class.
+- `httpsAgentOptions: object`: Options to pass to the Node.js [`https.Agent`](https://nodejs.org/api/http.html#http_class_http_agent) class.
+- `maxContentLength: number`: Defines the max size of the http response content allowed in bytes.
+- `maxRedirects: number`: Defines the maximum number of redirects to follow. If set to 0, no redirects will be followed.
+- `proxy: object`: Defines the hostname and port of the proxy server. The `proxy` object should have the following fields:
+  - `host: string`: Host IP address (eg. `'127.0.0.1'`).
+  - `port: number`: Port number.
+  - `auth: object`: Object with username and password.
+- `responseType: enum`: Default: `'json'` - The type of data that the server will respond with. Options are:
+  - `'document'`
+  - `'json'`
+  - `'text'`
+- `responseEncoding: string`: Default: `'utf8'` - Indicates encoding to use for decoding responses.
+- `timeout: number`: Default: `0` (no timeout) - The number of milliseconds before the request times out. If the request takes longer than `timeout`, the request will be aborted. Set to `0` for no timeout.
+- `transformRequest: function`: A function to transform the request data before it is sent. Receives `data` and `headers` as arguments and should return the data to be sent.
+- `transformResponse: function`: A function to transform the received data. Receives `data` as an argument and should return the transformed data.
+- `validateStatus: function`: A function to validate whether the response should complete successfully given a status code. Receives `status` as an argument and should `true` if the status code is valid.
+
+</DESCRIPTION>
+
+<CONNECTION>
+AxiosHttp
+</CONNECTION>
+
+<SCHEMA>
+
+```js
+export default {
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  title: 'Lowdefy Connection Schema - AxiosHttp',
+  type: 'object',
+  properties: {
+    url: {
+      type: 'string',
+      description: 'The server URL that will be used for the request.',
+      errorMessage: {
+        type: 'AxiosHttp property "url" should be a string.',
+      },
+    },
+    method: {
+      type: 'string',
+      enum: ['get', 'delete', 'head', 'options', 'post', 'put', 'patch'],
+      description: 'The request method to be used when making the request',
+      errorMessage: {
+        type: 'AxiosHttp property "method" should be a string.',
+        enum: 'AxiosHttp property "method" is not a valid value.',
+      },
+    },
+    baseURL: {
+      type: 'string',
+      description:
+        'baseURL will be prepended to url unless url is absolute. It can be convenient to set baseURL for an axios connection so that requests can use relative urls.',
+      errorMessage: {
+        type: 'AxiosHttp property "baseURL" should be a string.',
+      },
+    },
+    headers: {
+      type: 'object',
+      description:
+        'An object with custom headers to be sent with the request. The object keys should be header names, and the values should be the string header values.',
+      errorMessage: {
+        type: 'AxiosHttp property "headers" should be an object.',
+      },
+    },
+    params: {
+      type: 'object',
+      description: 'An object with URL parameters to be sent with the request.',
+      errorMessage: {
+        type: 'AxiosHttp property "params" should be an object.',
+      },
+    },
+    data: {
+      description:
+        "The data to be sent as the request body. Only applicable for request methods 'put', 'post', and 'patch'. Can be an object, array or a string in the format 'Country=USA&City=New York'.",
+    },
+    timeout: {
+      type: 'number',
+      description:
+        'The number of milliseconds before the request times out. If the request takes longer than timeout, the request will be aborted. Set to 0 for no timeout.',
+      default: 0,
+      errorMessage: {
+        type: 'AxiosHttp property "timeout" should be a number.',
+      },
+    },
+    auth: {
+      type: 'object',
+      description:
+        'Indicates that HTTP Basic authorization should be used, and supplies credentials. This will set an Authorization header, overwriting any existing Authorization custom headers you have set using headers. Only HTTP Basic auth is configurable through this parameter, for Bearer tokens and such, use Authorization custom headers instead.',
+      properties: {
+        username: {
+          type: 'string',
+          description: 'HTTP Basic authorization username.',
+          errorMessage: {
+            type: 'AxiosHttp property "auth.username" should be a string.',
+          },
+        },
+        password: {
+          type: 'string',
+          description: 'HTTP Basic authorization password.',
+          errorMessage: {
+            type: 'AxiosHttp property "auth.password" should be a string.',
+          },
+        },
+      },
+      errorMessage: {
+        type: 'AxiosHttp property "auth" should be an object.',
+      },
+    },
+    responseType: {
+      type: 'string',
+      enum: ['json', 'document', 'text'],
+      description: 'The type of data that the server should respond with.',
+      default: 'json',
+      errorMessage: {
+        type: 'AxiosHttp property "responseType" should be a string.',
+        enum: 'AxiosHttp property "responseType" is not a valid value.',
+      },
+    },
+    responseEncoding: {
+      type: 'string',
+      description: 'Indicates encoding to use for decoding responses.',
+      default: 'utf8',
+      errorMessage: {
+        type: 'AxiosHttp property "responseEncoding" should be a string.',
+      },
+    },
+    maxContentLength: {
+      type: 'number',
+      description: 'Defines the max size of the http response content allowed in bytes.',
+      errorMessage: {
+        type: 'AxiosHttp property "maxContentLength" should be a number.',
+      },
+    },
+    maxRedirects: {
+      type: 'number',
+      description:
+        'Defines the maximum number of redirects to follow. If set to 0, no redirects will be followed.',
+      default: 5,
+      errorMessage: {
+        type: 'AxiosHttp property "maxRedirects" should be a number.',
+      },
+    },
+    proxy: {
+      type: 'object',
+      description: 'Defines the hostname and port of the proxy server.',
+      errorMessage: {
+        type: 'AxiosHttp property "proxy" should be an object.',
+      },
+    },
+  },
+};
+```
+
+</SCHEMA>
+
+<EXAMPLES>
+
+Properties for a AxiosHttp can be set on either the connection, the request, or both. However, both a connection and request need to be defined.
+
+### A basic full example requesting data from https://jsonplaceholder.typicode.com
+
+```yaml
+lowdefy: {{ version }}
+name: Lowdefy starter
+connections:
+  - id: my_api
+    type: AxiosHttp
+    properties:
+      baseURL: https://jsonplaceholder.typicode.com
+pages:
+  - id: welcome
+    type: PageHeaderMenu
+    requests:
+      - id: get_posts
+        type: AxiosHttp
+        connectionId: my_api
+        properties:
+          url: /posts
+    events:
+      onInit:
+        - id: fetch_get_posts
+          type: Request
+          params: get_posts
+    blocks:
+      - id: rest_data
+        type: Markdown
+        properties:
+          content:
+            _string.concat:
+              - |
+                ```yaml
+              - _yaml.stringify:
+                  - _request: get_posts
+              - |
+                ```
+```
+
+### Using the connection to set baseURL and authorization, and handle specific requests as requests
+
+```yaml
+connections:
+  - id: app_api
+    type: AxiosHttp
+    properties:
+      baseURL: app.com/api
+      auth:
+        username: api_user
+        password:
+          _secret: API_PASSWORD
+# ...
+requests:
+  - id: get_orders
+    type: AxiosHttp
+    connectionId: app_api
+    properties:
+      url: /orders
+  - id: update_order
+    type: AxiosHttp
+    connectionId: app_api
+    payload:
+      order_id:
+        _state: order_id
+      data:
+        _state: true
+    properties:
+      url:
+        _nunjucks:
+          template: /orders/{{ order_id }}
+          on:
+            order_id:
+              _payload: order_id
+      method: post
+      data:
+        _payload: data
+```
+
+### Setting properties on only the connection
+
+```yaml
+connections:
+  - id: get_count
+    type: AxiosHttp
+    properties:
+      url: myapp.com/api/count
+      headers:
+        X-Api-Key:
+          _secret: API_KEY
+# ...
+requests:
+  - id: get_count
+    type: AxiosHttp
+    connectionId: get_count
+```
+
+### Setting properties on only the request, and using a generic connection
+
+```yaml
+connections:
+  - id: axios
+    type: AxiosHttp
+# ...
+requests:
+  - id: get_api_1
+    type: AxiosHttp
+    connectionId: axios
+    properties:
+      url: app1.com/api/things
+  - id: post_to_api_2
+    type: AxiosHttp
+    connectionId: axios
+    payload:
+      data:
+        _state: true
+    properties:
+      url: api.otherapp.org/other/thing
+      method: post
+      data:
+        _payload: data
+```
+
+</EXAMPLES>

package/dist/connections/AxiosHttp/documentation.md

@@ -0,0 +1,279 @@
+<TITLE>
+AxiosHttp
+</TITLE>
+
+<DESCRIPTION>
+
+The `AxiosHttp` connection is used to connect to APIs and web servers using HTTP or HTTPS.
+
+It uses the [axios](https://github.com/axios/axios) library.
+
+The same properties can be set on both connections and requests. The properties will be merged, with the request properties overwriting connection properties. This allows properties like authentication headers and the baseURL to be set on the connection, with request specific properties like the request.
+
+>Secrets like authentication headers and API keys should be stored using the [`_secret`](_secret) operator.
+
+</DESCRIPTION>
+
+<REQUESTS>
+
+- AxiosHttp
+
+</REQUESTS>
+
+<SCHEMA>
+
+```js
+export default {
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  title: 'Lowdefy Connection Schema - AxiosHttp',
+  type: 'object',
+  properties: {
+    url: {
+      type: 'string',
+      description: 'The server URL that will be used for the request.',
+      errorMessage: {
+        type: 'AxiosHttp property "url" should be a string.',
+      },
+    },
+    method: {
+      type: 'string',
+      enum: ['get', 'delete', 'head', 'options', 'post', 'put', 'patch'],
+      description: 'The request method to be used when making the request',
+      errorMessage: {
+        type: 'AxiosHttp property "method" should be a string.',
+        enum: 'AxiosHttp property "method" is not a valid value.',
+      },
+    },
+    baseURL: {
+      type: 'string',
+      description:
+        'baseURL will be prepended to url unless url is absolute. It can be convenient to set baseURL for an axios connection so that requests can use relative urls.',
+      errorMessage: {
+        type: 'AxiosHttp property "baseURL" should be a string.',
+      },
+    },
+    headers: {
+      type: 'object',
+      description:
+        'An object with custom headers to be sent with the request. The object keys should be header names, and the values should be the string header values.',
+      errorMessage: {
+        type: 'AxiosHttp property "headers" should be an object.',
+      },
+    },
+    params: {
+      type: 'object',
+      description: 'An object with URL parameters to be sent with the request.',
+      errorMessage: {
+        type: 'AxiosHttp property "params" should be an object.',
+      },
+    },
+    data: {
+      description:
+        "The data to be sent as the request body. Only applicable for request methods 'put', 'post', and 'patch'. Can be an object, array or a string in the format 'Country=USA&City=New York'.",
+    },
+    timeout: {
+      type: 'number',
+      description:
+        'The number of milliseconds before the request times out. If the request takes longer than timeout, the request will be aborted. Set to 0 for no timeout.',
+      default: 0,
+      errorMessage: {
+        type: 'AxiosHttp property "timeout" should be a number.',
+      },
+    },
+    auth: {
+      type: 'object',
+      description:
+        'Indicates that HTTP Basic authorization should be used, and supplies credentials. This will set an Authorization header, overwriting any existing Authorization custom headers you have set using headers. Only HTTP Basic auth is configurable through this parameter, for Bearer tokens and such, use Authorization custom headers instead.',
+      properties: {
+        username: {
+          type: 'string',
+          description: 'HTTP Basic authorization username.',
+          errorMessage: {
+            type: 'AxiosHttp property "auth.username" should be a string.',
+          },
+        },
+        password: {
+          type: 'string',
+          description: 'HTTP Basic authorization password.',
+          errorMessage: {
+            type: 'AxiosHttp property "auth.password" should be a string.',
+          },
+        },
+      },
+      errorMessage: {
+        type: 'AxiosHttp property "auth" should be an object.',
+      },
+    },
+    responseType: {
+      type: 'string',
+      enum: ['json', 'document', 'text'],
+      description: 'The type of data that the server should respond with.',
+      default: 'json',
+      errorMessage: {
+        type: 'AxiosHttp property "responseType" should be a string.',
+        enum: 'AxiosHttp property "responseType" is not a valid value.',
+      },
+    },
+    responseEncoding: {
+      type: 'string',
+      description: 'Indicates encoding to use for decoding responses.',
+      default: 'utf8',
+      errorMessage: {
+        type: 'AxiosHttp property "responseEncoding" should be a string.',
+      },
+    },
+    maxContentLength: {
+      type: 'number',
+      description: 'Defines the max size of the http response content allowed in bytes.',
+      errorMessage: {
+        type: 'AxiosHttp property "maxContentLength" should be a number.',
+      },
+    },
+    maxRedirects: {
+      type: 'number',
+      description:
+        'Defines the maximum number of redirects to follow. If set to 0, no redirects will be followed.',
+      default: 5,
+      errorMessage: {
+        type: 'AxiosHttp property "maxRedirects" should be a number.',
+      },
+    },
+    proxy: {
+      type: 'object',
+      description: 'Defines the hostname and port of the proxy server.',
+      errorMessage: {
+        type: 'AxiosHttp property "proxy" should be an object.',
+      },
+    },
+  },
+};
+```
+
+</SCHEMA>
+
+<EXAMPLES>
+
+Properties for a AxiosHttp can be set on either the connection, the request, or both. However, both a connection and request need to be defined.
+
+### A basic full example requesting data from https://jsonplaceholder.typicode.com
+
+```yaml
+lowdefy: {{ version }}
+name: Lowdefy starter
+connections:
+  - id: my_api
+    type: AxiosHttp
+    properties:
+      baseURL: https://jsonplaceholder.typicode.com
+pages:
+  - id: welcome
+    type: PageHeaderMenu
+    requests:
+      - id: get_posts
+        type: AxiosHttp
+        connectionId: my_api
+        properties:
+          url: /posts
+    events:
+      onInit:
+        - id: fetch_get_posts
+          type: Request
+          params: get_posts
+    blocks:
+      - id: rest_data
+        type: Markdown
+        properties:
+          content:
+            _string.concat:
+              - |
+                ```yaml
+              - _yaml.stringify:
+                  - _request: get_posts
+              - |
+                ```
+```
+
+### Using the connection to set baseURL and authorization, and handle specific requests as requests
+
+```yaml
+connections:
+  - id: app_api
+    type: AxiosHttp
+    properties:
+      baseURL: app.com/api
+      auth:
+        username: api_user
+        password:
+          _secret: API_PASSWORD
+# ...
+requests:
+  - id: get_orders
+    type: AxiosHttp
+    connectionId: app_api
+    properties:
+      url: /orders
+  - id: update_order
+    type: AxiosHttp
+    connectionId: app_api
+    payload:
+      order_id:
+        _state: order_id
+      data:
+        _state: true
+    properties:
+      url:
+        _nunjucks:
+          template: /orders/{{ order_id }}
+          on:
+            order_id:
+              _payload: order_id
+      method: post
+      data:
+        _payload: data
+```
+
+### Setting properties on only the connection
+
+```yaml
+connections:
+  - id: get_count
+    type: AxiosHttp
+    properties:
+      url: myapp.com/api/count
+      headers:
+        X-Api-Key:
+          _secret: API_KEY
+# ...
+requests:
+  - id: get_count
+    type: AxiosHttp
+    connectionId: get_count
+```
+
+### Setting properties on only the request, and using a generic connection
+
+```yaml
+connections:
+  - id: axios
+    type: AxiosHttp
+# ...
+requests:
+  - id: get_api_1
+    type: AxiosHttp
+    connectionId: axios
+    properties:
+      url: app1.com/api/things
+  - id: post_to_api_2
+    type: AxiosHttp
+    connectionId: axios
+    payload:
+      data:
+        _state: true
+    properties:
+      url: api.otherapp.org/other/thing
+      method: post
+      data:
+        _payload: data
+```
+
+</EXAMPLES>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lowdefy/connection-axios-http",
-  "version": "0.0.0-experimental-20250926130521",
+  "version": "0.0.0-experimental-20251010122007",
   "license": "Apache-2.0",
   "description": "",
   "homepage": "https://lowdefy.com",
@@ -35,11 +35,11 @@
     "dist/*"
   ],
   "dependencies": {
-    "@lowdefy/helpers": "0.0.0-experimental-20250926130521",
+    "@lowdefy/helpers": "0.0.0-experimental-20251010122007",
     "axios": "1.8.2"
   },
   "devDependencies": {
-    "@lowdefy/ajv": "0.0.0-experimental-20250926130521",
+    "@lowdefy/ajv": "0.0.0-experimental-20251010122007",
     "@swc/cli": "0.1.63",
     "@swc/core": "1.3.99",
     "@swc/jest": "0.2.29",