@spectric/ui 0.0.4

package/src/components/query_bar/querylanguage/kuery/functions/utils/get_full_field_name_node.ts

@@ -0,0 +1,87 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Any modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
+
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you 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.
+ */
+
+import { getFields } from './get_fields';
+import { IIndexPattern, KueryNode } from '../../../../types';
+
+export function getFullFieldNameNode(
+  rootNameNode: any,
+  indexPattern?: IIndexPattern,
+  nestedPath?: string
+): KueryNode {
+  const fullFieldNameNode = {
+    ...rootNameNode,
+    value: nestedPath ? `${nestedPath}.${rootNameNode.value}` : rootNameNode.value,
+  };
+
+  // Wildcards can easily include nested and non-nested fields. There isn't a good way to let
+  // users handle this themselves so we automatically add nested queries in this scenario and skip the
+  // error checking below.
+  if (!indexPattern || (fullFieldNameNode.type === 'wildcard' && !nestedPath)) {
+    return fullFieldNameNode;
+  }
+  const fields = getFields(fullFieldNameNode, indexPattern);
+
+  const errors = fields!.reduce((acc: any, field: any) => {
+    const nestedPathFromField =
+      field.subType && field.subType.nested ? field.subType.nested.path : undefined;
+
+    if (nestedPath && !nestedPathFromField) {
+      return [
+        ...acc,
+        `${field.name} is not a nested field but is in nested group "${nestedPath}" in the DQL expression.`,
+      ];
+    }
+
+    if (nestedPathFromField && !nestedPath) {
+      return [
+        ...acc,
+        `${field.name} is a nested field, but is not in a nested group in the DQL expression.`,
+      ];
+    }
+
+    if (nestedPathFromField !== nestedPath) {
+      return [
+        ...acc,
+        `Nested field ${field.name
+        } is being queried with the incorrect nested path. The correct path is ${field.subType!.nested!.path
+        }.`,
+      ];
+    }
+
+    return acc;
+  }, []);
+
+  if (errors.length > 0) {
+    throw new Error(errors.join('\n'));
+  }
+
+  return fullFieldNameNode;
+}

package/src/components/query_bar/querylanguage/kuery/index.ts

@@ -0,0 +1,38 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Any modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
+
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you 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 { DQLSyntaxError } from './kuery_syntax_error';
+export { nodeTypes } from './node_types';
+export * from './ast';
+export { fromKueryExpression as parse, toOpenSearchQuery as toDSL } from './ast';
+export { toCql } from "../outputTypes/toCQL"
+export { toMongo } from "../outputTypes/toMongo"
+
+export * from './types';

package/src/components/query_bar/querylanguage/kuery/kuery_syntax_error.ts

@@ -0,0 +1,76 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Any modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
+
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you 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.
+ */
+
+
+
+
+const endOfInputText = 'end of input';
+
+const grammarRuleTranslations: Record<string, string> = {
+  fieldName: 'field name',
+  value: 'value',
+  literal: 'literal',
+  whitespace: 'whitespace',
+};
+
+interface DQLSyntaxErrorData extends Error {
+  found: string;
+  expected: DQLSyntaxErrorExpected[] | null;
+  location: any;
+}
+
+interface DQLSyntaxErrorExpected {
+  description: string;
+}
+
+export class DQLSyntaxError extends Error {
+  shortMessage: string;
+
+  constructor(error: DQLSyntaxErrorData, expression: any) {
+    let message = error.message;
+    if (error.expected) {
+      const translatedExpectations = error.expected.map((expected) => {
+        return grammarRuleTranslations[expected.description] || expected.description;
+      });
+
+      const translatedExpectationText = translatedExpectations.join(', ');
+      let foundInput = error.found ? `"${error.found}"` : endOfInputText;
+      message = `Expected ${translatedExpectationText} but ${foundInput} found.`
+    }
+
+    const fullMessage = [message, expression, '-'.repeat(error.location.start.offset) + '^'].join(
+      '\n'
+    );
+
+    super(fullMessage);
+    this.name = 'DQLSyntaxError';
+    this.shortMessage = message;
+  }
+}

package/src/components/query_bar/querylanguage/kuery/node_types/function.ts

@@ -0,0 +1,75 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Any modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
+
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you 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.
+ */
+
+
+import { functions } from '../functions';
+import { IIndexPattern, KueryNode } from '../../..';
+import { FunctionName, FunctionTypeBuildNode } from './types';
+
+export function buildNode(functionName: FunctionName, ...args: any[]) {
+  const kueryFunction = functions[functionName];
+  if (kueryFunction === undefined) {
+    throw new Error(`Unknown function "${functionName}"`);
+  }
+
+  return {
+    type: 'function' as 'function',
+    function: functionName,
+    // This requires better typing of the different typings and their return types.
+    // @ts-ignore
+    ...kueryFunction.buildNodeParams(...args),
+  };
+}
+
+// Mainly only useful in the grammar where we'll already have real argument nodes in hand
+export function buildNodeWithArgumentNodes(
+  functionName: FunctionName,
+  args: any[]
+): FunctionTypeBuildNode {
+  if (functions[functionName] === undefined) {
+    throw new Error(`Unknown function "${functionName}"`);
+  }
+
+  return {
+    type: 'function',
+    function: functionName,
+    arguments: args,
+  };
+}
+
+export function toOpenSearchQuery(
+  node: KueryNode,
+  indexPattern?: IIndexPattern,
+  config?: Record<string, any>,
+  context?: Record<string, any>
+) {
+  const kueryFunction = functions[node.function as FunctionName];
+  return kueryFunction.toOpenSearchQuery(node, indexPattern, config, context);
+}

package/src/components/query_bar/querylanguage/kuery/node_types/index.ts

@@ -0,0 +1,46 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Any modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
+
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you 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.
+ */
+
+import * as functionType from './function';
+import * as literal from './literal';
+import * as namedArg from './named_arg';
+import * as wildcard from './wildcard';
+import { NodeTypes } from './types';
+
+export * from "./types"
+
+export const nodeTypes: NodeTypes = {
+  // This requires better typing of the different typings and their return types.
+  // @ts-ignore
+  function: functionType,
+  literal,
+  namedArg,
+  wildcard,
+};

package/src/components/query_bar/querylanguage/kuery/node_types/literal.ts

@@ -0,0 +1,42 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Any modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
+
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you 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.
+ */
+
+import { LiteralTypeBuildNode } from './types';
+
+export function buildNode(value: LiteralTypeBuildNode['value']): LiteralTypeBuildNode {
+  return {
+    type: 'literal',
+    value,
+  };
+}
+
+export function toOpenSearchQuery(node: LiteralTypeBuildNode): LiteralTypeBuildNode['value'] {
+  return node.value;
+}

package/src/components/query_bar/querylanguage/kuery/node_types/named_arg.ts

@@ -0,0 +1,47 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Any modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
+
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you 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.
+ */
+
+import * as ast from '../ast';
+import { nodeTypes } from '.';
+import { NamedArgTypeBuildNode } from './types';
+import { JsonObject } from '../../../types';
+
+export function buildNode(name: string, value: any): NamedArgTypeBuildNode {
+  const argumentNode = value.type === 'literal' ? value : nodeTypes.literal.buildNode(value);
+  return {
+    type: 'namedArg',
+    name,
+    value: argumentNode,
+  };
+}
+
+export function toOpenSearchQuery(node: any): JsonObject {
+  return ast.toOpenSearchQuery(node.value);
+}

package/src/components/query_bar/querylanguage/kuery/node_types/types.ts

@@ -0,0 +1,108 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Any modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
+
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you 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.
+ */
+
+/**
+ * WARNING: these typings are incomplete
+ */
+
+import { JsonValue, IIndexPattern } from '../../../types';
+
+import { KueryNode } from '..';
+
+export type FunctionName =
+  | 'is'
+  | 'and'
+  | 'or'
+  | 'not'
+  | 'range'
+  | 'exists'
+  | 'geoBoundingBox'
+  | 'geoPolygon'
+  | 'nested';
+
+interface FunctionType {
+  buildNode: (functionName: FunctionName, ...args: any[]) => FunctionTypeBuildNode;
+  buildNodeWithArgumentNodes: (functionName: FunctionName, args: any[]) => FunctionTypeBuildNode;
+  toOpenSearchQuery: (
+    node: any,
+    indexPattern?: IIndexPattern,
+    config?: Record<string, any>,
+    context?: Record<string, any>
+  ) => JsonValue;
+}
+
+export interface FunctionTypeBuildNode {
+  type: 'function';
+  function: FunctionName;
+  // TODO -> Need to define a better type for DSL query
+  arguments: any[];
+}
+
+interface LiteralType {
+  buildNode: (value: null | boolean | number | string) => LiteralTypeBuildNode;
+  toOpenSearchQuery: (node: any) => null | boolean | number | string;
+}
+
+export interface LiteralTypeBuildNode {
+  type: 'literal';
+  value: null | boolean | number | string;
+}
+
+interface NamedArgType {
+  buildNode: (name: string, value: any) => NamedArgTypeBuildNode;
+  toOpenSearchQuery: (node: any) => JsonValue;
+}
+
+export interface NamedArgTypeBuildNode {
+  type: 'namedArg';
+  name: string;
+  value: any;
+}
+
+interface WildcardType {
+  wildcardSymbol: string;
+  buildNode: (value: string) => WildcardTypeBuildNode | KueryNode;
+  test: (node: any, string: string) => boolean;
+  toOpenSearchQuery: (node: any) => string;
+  toQueryStringQuery: (node: any) => string;
+  hasLeadingWildcard: (node: any) => boolean;
+}
+
+export interface WildcardTypeBuildNode {
+  type: 'wildcard';
+  value: string;
+}
+
+export interface NodeTypes {
+  function: FunctionType;
+  literal: LiteralType;
+  namedArg: NamedArgType;
+  wildcard: WildcardType;
+}

package/src/components/query_bar/querylanguage/kuery/node_types/wildcard.ts

@@ -0,0 +1,80 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Any modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
+
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you 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.
+ */
+
+import { fromLiteralExpression } from '../ast/ast';
+import { WildcardTypeBuildNode } from './types';
+import { KueryNode } from '..';
+
+export const wildcardSymbol = '@kuery-wildcard@';
+
+// Copied from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
+function escapeRegExp(str: string) {
+  return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
+}
+
+// See https://opensearch.org/docs/latest/opensearch/query-dsl/term/#regex
+function escapeQueryString(str: string) {
+  return str.replace(/[+-=&|><!(){}[\]^"~*?:\\/]/g, '\\$&'); // $& means the whole matched string
+}
+
+export function buildNode(value: string): WildcardTypeBuildNode | KueryNode {
+  if (!value.includes(wildcardSymbol)) {
+    return fromLiteralExpression(value);
+  }
+
+  return {
+    type: 'wildcard',
+    value,
+  };
+}
+
+export function test(node: any, str: string): boolean {
+  const { value } = node;
+  const regex = value.split(wildcardSymbol).map(escapeRegExp).join('[\\s\\S]*');
+  const regexp = new RegExp(`^${regex}$`);
+  return regexp.test(str);
+}
+
+export function toOpenSearchQuery(node: any): string {
+  const { value } = node;
+  return value.split(wildcardSymbol).join('*');
+}
+
+export function toQueryStringQuery(node: any): string {
+  const { value } = node;
+  return value.split(wildcardSymbol).map(escapeQueryString).join('*');
+}
+
+export function hasLeadingWildcard(node: any): boolean {
+  const { value } = node;
+  // A lone wildcard turns into an `exists` query, so we're only concerned with
+  // leading wildcards followed by additional characters.
+  return value.startsWith(wildcardSymbol) && value.replace(wildcardSymbol, '').length > 0;
+}

package/src/components/query_bar/querylanguage/kuery/types.ts

@@ -0,0 +1,52 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ *
+ * Any modifications Copyright OpenSearch Contributors. See
+ * GitHub history for details.
+ */
+
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you 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.
+ */
+
+import { NodeTypes } from './node_types';
+export * from "./node_types"
+export interface KueryNode {
+  type: keyof NodeTypes;
+  [key: string]: any;
+}
+
+export type DslQuery = any;
+
+export interface KueryParseOptions {
+  helpers: {
+    [key: string]: any;
+  };
+  startRule: string;
+  allowLeadingWildcards: boolean;
+  errorOnLuceneSyntax: boolean;
+  cursorSymbol?: string;
+  parseCursor?: boolean;
+}
+
+export { nodeTypes } from './node_types';
+