@crowdstrike/logscale-parser-edit 1.158.0--devbuild-2000--sha-b89e22d51ea2f682d93c635f83918f8efe458ac4 → 1.160.0--build-2079--sha-2384efb063d1d91906e4e8176066cecf88812518

package/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * @crowdstrike/logscale-parser-edit
  *
- * Allows you to embed an editor for LogScale parsers as a WebComponent.
+ * Allows you to embed an editor for LogScale parsers as a web component.
  *
  * ```ts
  * // Importing the module defines the "logscale-parser-edit" custom element as a side-effect.
@@ -23,7 +23,7 @@ export declare interface CommonOptions {
     currentTime?: number;
     /** Allows you to open the webcomponent's internal shadow DOM.
      *
-     * This is useful for writing E2E tests where you want to inspect the internal DOM of the WebComponent.
+     * This is useful for writing E2E tests where you want to inspect the internal DOM of the web component.
      * Do this sparingly, since the internal DOM elements can change between releases of
      * the webcomponents.
      */
@@ -102,10 +102,33 @@ export declare interface Options extends CommonOptions {
     readOnly?: boolean;
 }
 
+/** LogScale Parser matching the schema https://schemas.humio.com/parser/v0.3.0
+ * @public @sealed
+ */
+export declare type Parser = {
+    $schema: "https://schemas.humio.com/parser/v0.3.0";
+    name: string;
+    description?: string | null;
+    script: string;
+    fieldsToBeRemovedBeforeParsing?: string[];
+    tagFields?: string[];
+    testCases?: {
+        event: {
+            rawString: string;
+        };
+        assertions: {
+            outputEventIndex: number;
+            fieldsNotPresent: string[];
+            fieldsHaveValues: Record<string, string>;
+        }[];
+    }[];
+};
+
 /** Custom element that embeds the LogScale parser editor.
  * @public @sealed
  */
 export declare class ParserEdit extends WebcomponentBase<Options> {
+    private _app;
     /** Requests the parser to be saved. Will trigger the callback provided by `#onSave` once completed (on success or failure).
      * @public
      */
@@ -114,6 +137,10 @@ export declare class ParserEdit extends WebcomponentBase<Options> {
      * @public
      */
     onSave(callback: (error: Error) => void): void;
+    /** Extract the current parser from the component.
+     * @public
+     */
+    exportParserData(): Promise<Parser>;
     /** Changes the parser editor to be in read-only mode (when given `true`) or in editable mode (when given `false`).
      * @public
      */