@lowdefy/connection-elasticsearch 4.0.0-alpha.1 → 4.0.0-alpha.10

package/dist/connections/Elasticsearch/Elasticsearch.js

@@ -1,5 +1,5 @@
 /*
-  Copyright 2020-2021 Lowdefy, Inc
+  Copyright 2020-2022 Lowdefy, Inc
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -18,10 +18,9 @@ import ElasticsearchIndex from './ElasticsearchIndex/ElasticsearchIndex.js';
 import ElasticsearchSearch from './ElasticsearchSearch/ElasticsearchSearch.js';
 import ElasticsearchUpdate from './ElasticsearchUpdate/ElasticsearchUpdate.js';
 import ElasticsearchUpdateByQuery from './ElasticsearchUpdateByQuery/ElasticsearchUpdateByQuery.js';
+import schema from './schema.js';
 export default {
-    import: {
-        schema: 'connections/Elasticsearch/ElasticsearchSchema.json'
-    },
+    schema,
     requests: {
         ElasticsearchDelete,
         ElasticsearchDeleteByQuery,

package/dist/connections/Elasticsearch/ElasticsearchDelete/ElasticsearchDelete.js

@@ -1,5 +1,5 @@
 /*
-  Copyright 2020-2021 Lowdefy, Inc
+  Copyright 2020-2022 Lowdefy, Inc
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -13,7 +13,8 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 */ import { Client } from '@elastic/elasticsearch';
-async function elasticsearchDelete({ request , connection  }) {
+import schema from './schema.js';
+async function ElasticsearchDelete({ request , connection  }) {
     const client = new Client(connection);
     const { body: response  } = await client.delete({
         ...request,
@@ -24,4 +25,9 @@ async function elasticsearchDelete({ request , connection  }) {
         response
     };
 }
-export default elasticsearchDelete;
+ElasticsearchDelete.schema = schema;
+ElasticsearchDelete.meta = {
+    checkRead: false,
+    checkWrite: true
+};
+export default ElasticsearchDelete;

package/dist/connections/Elasticsearch/ElasticsearchDelete/schema.js

@@ -0,0 +1,101 @@
+/*
+  Copyright 2020-2022 Lowdefy, Inc
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/ export default {
+    $schema: 'http://json-schema.org/draft-07/schema#',
+    title: 'Lowdefy Request Schema - ElasticsearchDelete',
+    type: 'object',
+    description: 'Removes a JSON document from the specified index.',
+    required: [
+        'id'
+    ],
+    properties: {
+        id: {
+            anyOf: [
+                {
+                    type: 'string'
+                },
+                {
+                    type: 'number'
+                }, 
+            ],
+            description: 'Unique identifier for the document.'
+        },
+        index: {
+            type: 'string',
+            description: 'The name of the index.'
+        },
+        if_seq_no: {
+            type: 'integer',
+            description: 'Only perform the delete operation if the last operation that has changed the document has the specified sequence number.'
+        },
+        if_primary_term: {
+            type: 'integer',
+            description: 'Only perform the delete operation if the last operation that has changed the document has the specified primary term.'
+        },
+        refresh: {
+            anyOf: [
+                {
+                    type: 'string'
+                },
+                {
+                    type: 'boolean'
+                }, 
+            ],
+            description: 'If true, Elasticsearch refreshes the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false do nothing with refreshes. Valid values: true, false, wait_for. Default: false.',
+            enum: [
+                'true',
+                'false',
+                true,
+                false,
+                'wait_for'
+            ],
+            default: false
+        },
+        routing: {
+            description: 'Custom value used to route operations to a specific shard.',
+            type: 'string'
+        },
+        timeout: {
+            type: 'string',
+            description: 'Period to wait for active shards. Defaults to 1m (one minute).',
+            default: '1m'
+        },
+        version: {
+            description: 'Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.',
+            type: 'integer'
+        },
+        version_type: {
+            type: 'string',
+            description: 'Specific version type.',
+            enum: [
+                'internal',
+                'external',
+                'external_gte',
+                'force'
+            ]
+        },
+        wait_for_active_shards: {
+            type: 'string',
+            description: 'The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). Default: 1, the primary shard.',
+            default: '1'
+        }
+    },
+    errorMessage: {
+        type: 'ElasticsearchDelete request properties should be an object.',
+        required: {
+            id: 'ElasticsearchDelete request should have required property "id".'
+        }
+    }
+};

package/dist/connections/Elasticsearch/ElasticsearchDeleteByQuery/ElasticsearchDeleteByQuery.js

@@ -1,5 +1,5 @@
 /*
-  Copyright 2020-2021 Lowdefy, Inc
+  Copyright 2020-2022 Lowdefy, Inc
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -13,7 +13,8 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 */ import { Client } from '@elastic/elasticsearch';
-async function elasticsearchDeleteByQuery({ request , connection  }) {
+import schema from './schema.js';
+async function ElasticsearchDeleteByQuery({ request , connection  }) {
     const client = new Client(connection);
     const { body: response  } = await client.deleteByQuery({
         ...request,
@@ -23,4 +24,9 @@ async function elasticsearchDeleteByQuery({ request , connection  }) {
         response
     };
 }
-export default elasticsearchDeleteByQuery;
+ElasticsearchDeleteByQuery.schema = schema;
+ElasticsearchDeleteByQuery.meta = {
+    checkRead: false,
+    checkWrite: true
+};
+export default ElasticsearchDeleteByQuery;

package/dist/connections/Elasticsearch/ElasticsearchDeleteByQuery/schema.js

@@ -0,0 +1,245 @@
+/*
+  Copyright 2020-2022 Lowdefy, Inc
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/ export default {
+    $schema: 'http://json-schema.org/draft-07/schema#',
+    title: 'Lowdefy Request Schema - ElasticsearchDeleteByQuery',
+    type: 'object',
+    description: 'Deletes documents that match the specified query.',
+    properties: {
+        index: {
+            type: 'string',
+            description: 'The name of the index.'
+        },
+        allow_no_indices: {
+            type: 'boolean',
+            description: 'If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.',
+            default: true
+        },
+        analyzer: {
+            description: 'The analyzer to use for the query string.',
+            type: 'string'
+        },
+        analyze_wildcard: {
+            description: 'Specify whether wildcard and prefix queries should be analyzed.',
+            type: 'boolean',
+            default: false
+        },
+        conflicts: {
+            type: 'string',
+            enum: [
+                'abort',
+                'proceed'
+            ],
+            description: 'What to do if delete by query hits version conflicts: abort or proceed. Defaults to abort.',
+            default: 'abort'
+        },
+        default_operator: {
+            description: 'The default operator for query string query (AND or OR).',
+            enum: [
+                'AND',
+                'OR'
+            ],
+            type: 'string',
+            default: 'OR'
+        },
+        df: {
+            description: 'The field to use as default where no field prefix is given in the query string.',
+            type: 'string'
+        },
+        expand_wildcards: {
+            description: 'Whether to expand wildcard expression to concrete indices that are open, closed or both.',
+            enum: [
+                'all',
+                'closed',
+                'hidden',
+                'none',
+                'open'
+            ],
+            type: 'string',
+            default: 'open'
+        },
+        from: {
+            description: 'Starting offset.',
+            type: 'number',
+            default: 0
+        },
+        ignore_unavailable: {
+            description: 'Whether specified concrete indices should be ignored when unavailable (missing or closed)',
+            type: 'boolean'
+        },
+        lenient: {
+            description: 'Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.',
+            type: 'boolean'
+        },
+        max_docs: {
+            type: 'integer',
+            description: 'Maximum number of documents to process. Defaults to all documents.'
+        },
+        preference: {
+            description: 'Specify the node or shard the operation should be performed on.',
+            type: 'string',
+            default: 'random'
+        },
+        pretty: {
+            description: 'Pretty format the returned JSON response.',
+            type: 'boolean'
+        },
+        q: {
+            description: 'Query in the Lucene query string syntax.',
+            type: 'string'
+        },
+        request_cache: {
+            description: 'Specify if request cache should be used for this request or not, defaults to index level setting.',
+            type: 'boolean'
+        },
+        refresh: {
+            anyOf: [
+                {
+                    type: 'string'
+                },
+                {
+                    type: 'boolean'
+                }, 
+            ],
+            description: 'If true, Elasticsearch refreshes all shards involved in the delete by query after the request completes. Defaults to false.',
+            enum: [
+                'true',
+                'false',
+                true,
+                false,
+                'wait_for'
+            ],
+            default: false
+        },
+        requests_per_second: {
+            type: 'integer',
+            description: 'The throttle for this request in sub-requests per second. Defaults to -1 (no throttle).',
+            default: -1
+        },
+        routing: {
+            type: 'string',
+            description: 'Custom value used to route operations to a specific shard.'
+        },
+        scroll: {
+            type: 'string',
+            description: 'Period to retain the search context for scrolling. See Scroll search results.'
+        },
+        scroll_size: {
+            type: 'integer',
+            description: 'Size of the scroll request that powers the operation. Defaults to 1000.',
+            default: 1000
+        },
+        search_type: {
+            description: 'Search operation type.',
+            enum: [
+                'dfs_query_then_fetch',
+                'query_then_fetch'
+            ],
+            type: 'string'
+        },
+        search_timeout: {
+            type: 'string',
+            description: 'Explicit timeout for each search request. Defaults to no timeout.'
+        },
+        slices: {
+            type: 'integer',
+            description: "The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks."
+        },
+        sort: {
+            description: 'A comma-separated list of <field>:<direction> pairs.',
+            examples: [
+                'name:asc',
+                [
+                    'rating:asc',
+                    'created_at:desc'
+                ]
+            ],
+            anyOf: [
+                {
+                    items: {
+                        type: 'string'
+                    },
+                    type: 'array'
+                },
+                {
+                    type: 'string'
+                }, 
+            ]
+        },
+        _source: {
+            anyOf: [
+                {
+                    type: 'boolean'
+                },
+                {
+                    type: 'array'
+                }, 
+            ],
+            items: {
+                type: 'string'
+            },
+            description: 'True or false to return the _source field or not, or a list of fields to return.'
+        },
+        _source_excludes: {
+            type: 'array',
+            items: {
+                type: 'string'
+            },
+            description: 'A comma-separated list of source fields to exclude from the response.\n\nYou can also use this parameter to exclude fields from the subset specified in _source_includes query parameter.\n\nIf the _source parameter is false, this parameter is ignored.'
+        },
+        _source_includes: {
+            type: 'array',
+            items: {
+                type: 'string'
+            },
+            description: 'A comma-separated list of source fields to include in the response.\n\nIf this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the _source_excludes query parameter.\n\nIf the _source parameter is false, this parameter is ignored.'
+        },
+        stats: {
+            description: 'Specific tag of the request for logging and statistical purposes',
+            anyOf: [
+                {
+                    items: {
+                        type: 'string'
+                    },
+                    type: 'array'
+                },
+                {
+                    type: 'string'
+                }, 
+            ]
+        },
+        terminate_after: {
+            description: 'The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early. Elasticsearch collects documents before sorting.\nUse with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.',
+            type: 'number'
+        },
+        timeout: {
+            type: 'string',
+            description: 'Period each deletion request waits for active shards. Defaults to 1m (one minute).',
+            default: '1m'
+        },
+        version: {
+            description: 'Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.',
+            type: 'integer'
+        },
+        wait_for_active_shards: {
+            type: 'string',
+            description: 'The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). Default: 1, the primary shard.',
+            default: '1'
+        }
+    },
+    errorMessage: {
+        type: 'ElasticsearchDelete request properties should be an object.'
+    }
+};

package/dist/connections/Elasticsearch/ElasticsearchIndex/ElasticsearchIndex.js

@@ -1,5 +1,5 @@
 /*
-  Copyright 2020-2021 Lowdefy, Inc
+  Copyright 2020-2022 Lowdefy, Inc
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -13,7 +13,8 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 */ import { Client } from '@elastic/elasticsearch';
-async function elasticsearchIndex({ request , connection  }) {
+import schema from './schema.js';
+async function ElasticsearchIndex({ request , connection  }) {
     const client = new Client(connection);
     const body = {
         ...request,
@@ -25,4 +26,9 @@ async function elasticsearchIndex({ request , connection  }) {
         id: response._id
     };
 }
-export default elasticsearchIndex;
+ElasticsearchIndex.schema = schema;
+ElasticsearchIndex.meta = {
+    checkRead: false,
+    checkWrite: true
+};
+export default ElasticsearchIndex;

package/dist/connections/Elasticsearch/ElasticsearchIndex/schema.js

@@ -0,0 +1,114 @@
+/*
+  Copyright 2020-2022 Lowdefy, Inc
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/ export default {
+    $schema: 'http://json-schema.org/draft-07/schema#',
+    title: 'Lowdefy Request Schema - ElasticsearchIndex',
+    type: 'object',
+    description: 'Adds a JSON document to the specified data stream or index and makes it searchable. If the target is an index and the document already exists, the request updates the document and increments its version.',
+    required: [
+        'body'
+    ],
+    properties: {
+        id: {
+            anyOf: [
+                {
+                    type: 'string'
+                },
+                {
+                    type: 'number'
+                }, 
+            ],
+            description: 'Unique identifier for the document.'
+        },
+        index: {
+            type: 'string',
+            description: 'The name of the index.'
+        },
+        if_seq_no: {
+            type: 'integer',
+            description: 'Only perform the operation if the document has this sequence number. See Optimistic concurrency control.'
+        },
+        if_primary_term: {
+            type: 'integer',
+            description: 'Only perform the operation if the document has this primary term. See Optimistic concurrency control.'
+        },
+        op_type: {
+            type: 'string',
+            description: 'Set to create to only index the document if it does not already exist (put if absent). If a document with the specified _id already exists, the indexing operation will fail. Same as using the <index>/_create endpoint. Valid values: index, create. If document id is specified, it defaults to index. Otherwise, it defaults to create. If the request targets a data stream, an op_type of create is required. See Add documents to a data stream.',
+            enum: [
+                'index',
+                'create'
+            ],
+            default: 'create'
+        },
+        pipeline: {
+            type: 'string',
+            description: 'ID of the pipeline to use to preprocess incoming documents.'
+        },
+        refresh: {
+            type: 'string',
+            description: 'If true, Elasticsearch refreshes the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false do nothing with refreshes. Valid values: true, false, wait_for. Default: false.',
+            enum: [
+                'true',
+                'false',
+                'wait_for'
+            ],
+            default: false
+        },
+        routing: {
+            description: 'Custom value used to route operations to a specific shard.',
+            type: 'string'
+        },
+        timeout: {
+            type: 'string',
+            description: 'Period the request waits for the following operations:\n\nAutomatic index creation\nDynamic mapping updates\nWaiting for active shards\nDefaults to 1m (one minute). This guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur.',
+            default: '1m'
+        },
+        version: {
+            description: 'Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.',
+            type: 'integer'
+        },
+        version_type: {
+            type: 'string',
+            description: 'Specific version type: external, external_gte.',
+            enum: [
+                'internal',
+                'external',
+                'external_gte'
+            ]
+        },
+        wait_for_active_shard: {
+            type: 'string',
+            description: 'The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). Default: 1, the primary shard.',
+            default: '1'
+        },
+        require_alias: {
+            type: 'boolean',
+            description: 'If true, the destination must be an index alias. Defaults to false.',
+            default: false
+        },
+        body: {
+            type: 'object',
+            description: 'Request body contains the JSON source for the document data.',
+            additionalProperties: true
+        }
+    },
+    errorMessage: {
+        type: 'ElasticsearchIndex request properties should be an object.',
+        required: {
+            body: 'ElasticsearchIndex request should have required property "body".'
+        }
+    }
+};

package/dist/connections/Elasticsearch/ElasticsearchSearch/ElasticsearchSearch.js

@@ -1,5 +1,5 @@
 /*
-  Copyright 2020-2021 Lowdefy, Inc
+  Copyright 2020-2022 Lowdefy, Inc
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -14,8 +14,8 @@
   limitations under the License.
 */ import { Client } from '@elastic/elasticsearch';
 import { get } from '@lowdefy/helpers';
-import schema from './ElasticsearchSearch.json';
-async function elasticsearchSearch({ request , connection  }) {
+import schema from './schema.js';
+async function ElasticsearchSearch({ request , connection  }) {
     const client = new Client(connection);
     const { body: response  } = await client.search({
         ...request,
@@ -39,16 +39,19 @@ async function elasticsearchSearch({ request , connection  }) {
         response,
         hits,
         total: get(response, 'hits.total', {
-            default: {
-            }
+            default: {}
         }),
         maxScore: get(response, 'hits.max_score', {
             default: 0
         }),
         aggregations: get(response, 'aggregations', {
-            default: {
-            }
+            default: {}
         })
     };
 }
-export default elasticsearchSearch;
+ElasticsearchSearch.schema = schema;
+ElasticsearchSearch.meta = {
+    checkRead: true,
+    checkWrite: false
+};
+export default ElasticsearchSearch;