@gravitee/ui-components 3.25.3-typescript-8a53edf → 3.25.3-typescript-e7256ca

package/src/policy-studio/gv-policy-studio.d.ts

@@ -0,0 +1,464 @@
+declare const GvPolicyStudio_base: {
+    new (): {
+        [x: string]: any;
+        _controller: {};
+        _handleKeyDown: (e: any) => void;
+        _handleKeyUp: (e: any) => void;
+        connectedCallback(): void;
+        disconnectedCallback(): void;
+        _onKeyDown(e: any): void;
+        _onKeyUp(e: any): void;
+        isPressed(...keys: any[]): boolean;
+        onKeyboard(controller: any): void;
+    };
+    [x: string]: any;
+};
+/**
+ *  Studio Policy component
+ *
+ * ⚠️ This component is based on `asciidoctor`, `highlight.js` and `asciidoctor-highlight.js`.
+ * To use this component in your project be sure the dependencies are installed or
+ * install them with: `npm install asciidoctor highlight.js asciidoctor-highlight.js --save`
+ *
+ * @fires gv-policy-studio:select-policy - Select policy event
+ * @fires gv-policy-studio:save - Event sent when "Save" button is clicked, it contains the whole definition of the API
+ * @fires gv-policy-studio:debug - Event sent when validation button of the 'Try it' tab is clicked, it contains the whole definition of the API and the information about the try it request.
+ *
+ * @attr {Array} policies - Policies available
+ * @attr {Array} services - Services available
+ * @attr {Array} resourceTypes - Resources types available
+ * @attr {Array} propertyProviders - Providers of properties
+ * @attr {Array} dynamicPropertySchema - Schema for the dynamic property form
+ * @attr {String} tabId - Current tabId to display (design, settings, properties or resources)
+ * @attr {Object} definition - The definition of flows
+ * @attr {Object} documentation - The documentation to display
+ * @attr {Object} flowSchema - The flow form configuration to display in gv-schema-form component
+ * @attr {Object} configurationSchema - The form configuration to display in gv-schema-form component
+ * @attr {Object} configurationInformation - The information related to api configuration tab
+ * @attr {Boolean} isDirty - true if component is dirty
+ * @attr {Array} selectedFlowsId - The selected flows id
+ * @attr {Boolean} sortable - true if flows are sortable
+ * @attr {Boolean} readonly - true if readonly
+ * @attr {Boolean} readonly-plans - true if plans' flows can't be modified
+ * @attr {Boolean} can-add - true if user can add flow
+ * @attr {String} flowsTitle - flows menu title
+ * @attr {Boolean} has-policy-filter - true if policies have onRequest/onResponse properties
+ * @attr {Boolean} can-debug - true if debug tab should be displayed
+ * @attr {Object} debugResponse - true if debug tab should be displayed
+ * @attr {Boolean} has-conditional-steps - true if steps can be conditioned
+ */
+export class GvPolicyStudio extends GvPolicyStudio_base {
+    static get properties(): {
+        policies: {
+            type: ArrayConstructor;
+        };
+        services: {
+            type: ObjectConstructor;
+        };
+        resourceTypes: {
+            type: ArrayConstructor;
+            attribute: string;
+        };
+        propertyProviders: {
+            type: ArrayConstructor;
+            attribute: string;
+        };
+        dynamicPropertySchema: {
+            type: ObjectConstructor;
+            attribute: string;
+        };
+        tabId: {
+            type: StringConstructor;
+            attribute: string;
+        };
+        _tabId: {
+            type: StringConstructor;
+            attribute: boolean;
+        };
+        definition: {
+            type: ObjectConstructor;
+        };
+        _definition: {
+            type: ObjectConstructor;
+            attribute: boolean;
+        };
+        documentation: {
+            type: ObjectConstructor;
+        };
+        flowSchema: {
+            type: ObjectConstructor;
+            attribute: string;
+        };
+        configurationSchema: {
+            type: ObjectConstructor;
+            attribute: string;
+        };
+        _configurationSchema: {
+            type: ObjectConstructor;
+            attribute: boolean;
+        };
+        configurationInformation: {
+            type: StringConstructor;
+            attribute: string;
+        };
+        isDirty: {
+            type: BooleanConstructor;
+            attribute: string;
+            reflect: boolean;
+        };
+        _dragPolicy: {
+            type: ObjectConstructor;
+            attribute: boolean;
+        };
+        _dropPolicy: {
+            type: ObjectConstructor;
+            attribute: boolean;
+        };
+        selectedFlowsId: {
+            type: ArrayConstructor;
+            attribute: string;
+        };
+        _selectedFlowsId: {
+            type: ArrayConstructor;
+            attribute: boolean;
+        };
+        _currentPolicyId: {
+            type: StringConstructor;
+            attribute: boolean;
+        };
+        _searchPolicyQuery: {
+            type: StringConstructor;
+            attribute: boolean;
+        };
+        _searchFlowQuery: {
+            type: StringConstructor;
+            attribute: boolean;
+        };
+        _flowStepSchema: {
+            type: ObjectConstructor;
+            attribute: boolean;
+        };
+        _currentFlowStep: {
+            type: ObjectConstructor;
+            attribute: boolean;
+        };
+        _policyFilter: {
+            type: ArrayConstructor;
+            attribute: boolean;
+        };
+        _flowFilter: {
+            type: ArrayConstructor;
+            attribute: boolean;
+        };
+        _currentAskConfirmation: {
+            type: BooleanConstructor;
+            attribute: boolean;
+        };
+        hasProperties: {
+            type: BooleanConstructor;
+            attribute: string;
+        };
+        _hasProperties: {
+            type: BooleanConstructor;
+            attribute: boolean;
+        };
+        hasResources: {
+            type: BooleanConstructor;
+            attribute: string;
+        };
+        hasPolicyFilter: {
+            type: BooleanConstructor;
+            attribute: string;
+        };
+        flowsTitle: {
+            type: StringConstructor;
+            attribute: string;
+        };
+        sortable: {
+            type: BooleanConstructor;
+        };
+        canAdd: {
+            type: BooleanConstructor;
+            attribute: string;
+        };
+        readonly: {
+            type: BooleanConstructor;
+        };
+        readonlyPlans: {
+            type: BooleanConstructor;
+            attribute: string;
+        };
+        canDebug: {
+            type: BooleanConstructor;
+            attribute: string;
+        };
+        _canDebug: {
+            type: BooleanConstructor;
+            attribute: boolean;
+        };
+        debugResponse: {
+            type: ObjectConstructor;
+            attribute: string;
+        };
+        hasConditionalSteps: {
+            type: BooleanConstructor;
+            attribute: string;
+        };
+    };
+    static get styles(): import("lit").CSSResult[];
+    isDirty: boolean;
+    policies: any[];
+    resourceTypes: any[];
+    set tabId(arg: any);
+    get tabId(): any;
+    set selectedFlowsId(arg: any);
+    get selectedFlowsId(): any;
+    flowsTitle: string;
+    sortable: boolean;
+    services: {};
+    _definition: {
+        flows: never[];
+    };
+    _tabs: {
+        id: string;
+        title: string;
+        icon: string;
+    }[];
+    _policyFilter: any[];
+    _flowFilter: any[];
+    set hasProperties(arg: any);
+    get hasProperties(): any;
+    _hasProperties: any;
+    set hasResources(arg: any);
+    set canDebug(arg: any);
+    get _flowFilterOptions(): {
+        id: string;
+        title: string;
+        icon: string;
+    }[] | undefined;
+    set hasPolicyFilter(arg: any);
+    _policyFilterOptions: {
+        id: string;
+        title: string;
+        icon: string;
+    }[] | undefined;
+    set configurationSchema(arg: any);
+    get configurationSchema(): any;
+    _configurationSchema: any;
+    _tabId: any;
+    set definition(arg: {
+        flows: never[];
+    });
+    get definition(): {
+        flows: never[];
+    };
+    _initialDefinition: any;
+    _selectedFlowsId: any;
+    _updateSelectedFlows(selectedFlowsId: any): void;
+    _selectFirstFlow(dispatch?: boolean): void;
+    _getFlowElement(flowId: any): any;
+    _onDragEndPolicy(): void;
+    _onDropPolicy({ detail }: {
+        detail: any;
+    }): Promise<void>;
+    _dragPolicy: any;
+    _dropPolicy: any;
+    _currentAskConfirmation: boolean | null | undefined;
+    _onDeletePolicy({ detail }: {
+        detail: any;
+    }): void;
+    _onDesign(): void;
+    buildSchema({ schema }: {
+        schema: any;
+    }): any;
+    _editFlowStep({ step, flow, policy, group }: {
+        step: any;
+        flow: any;
+        policy: any;
+        group: any;
+    }): Promise<void>;
+    _currentPolicyId: any;
+    _onEditFlowStep({ detail: { step, flow, policy, group } }: {
+        detail: {
+            step: any;
+            flow: any;
+            policy: any;
+            group: any;
+        };
+    }): Promise<void>;
+    _getResizableViews(): any;
+    _maximizeTopView(): void;
+    _maximizeBottomView(): void;
+    _splitMainViews(): void;
+    _onChangeFlowStepState({ detail }: {
+        detail: any;
+    }): void;
+    _onCloseFlowStepForm(): Promise<void>;
+    _closeFlowStepForm(force?: boolean): Promise<void>;
+    _askToValidateForms(): Promise<any>;
+    _setCurrentFlowStep(currentFlowStep: any, flowStepSchema: any, force?: boolean): Promise<void>;
+    _currentFlowStep: any;
+    _flowStepSchema: any;
+    _refresh(closeStepForm?: boolean): void;
+    _onSelectFlows({ detail }: {
+        detail: any;
+    }): Promise<void>;
+    _onOpenDocumentationFromMenu({ detail: { policy } }: {
+        detail: {
+            policy: any;
+        };
+    }): Promise<void>;
+    _fetchDocumentation(policy: any): void;
+    _onOpenDocumentation(): void;
+    _onOpenDocumentationFromForm(): void;
+    _findFlowCollection(flowId: any): {
+        plan: any;
+        flows: any;
+    };
+    _findFlowById(flowId: any): undefined;
+    getSelectedFlow(index?: number): undefined;
+    _onTargetPolicy({ detail }: {
+        detail: any;
+    }): void;
+    _onChangeFlowStep({ detail }: {
+        detail: any;
+    }): void;
+    _writeFlowStep(values: any): void;
+    _onSubmitFlowStep({ detail }: {
+        detail: any;
+    }): Promise<void>;
+    _onCancelFlow(): void;
+    _onSubmitFlow({ detail: { values } }: {
+        detail: {
+            values: any;
+        };
+    }): void;
+    _onCancelFlowMode(): void;
+    _onSubmitFlowMode({ detail: { values } }: {
+        detail: {
+            values: any;
+        };
+    }): void;
+    _onChangeTab({ detail }: {
+        detail: any;
+    }): void;
+    _changeTabValidator({ from, to }: {
+        from: any;
+        to: any;
+    }): Promise<any>;
+    _changeTab(tabId: any): void;
+    _onDragStartFlowStep(flow: any, { detail }: {
+        detail: any;
+    }): void;
+    _renderFlowEmptyState(readonlyMode: any): import("lit-html").TemplateResult<1>;
+    _renderFlow(index: number | undefined, hasEmptyState: boolean | undefined, readonlyMode: any): import("lit-html").TemplateResult<1>;
+    _onFetchResources(event: any): void;
+    _renderPolicy(readonlyMode: any): import("lit-html").TemplateResult<1>;
+    _getFlowStepForm(): any;
+    _onResetFlowStep(): void;
+    _generateFlowsId(list: any, force?: boolean): any;
+    _generatePlanFlowsId(plan: any, force?: boolean): any;
+    _generateFlowStepId(flowId: any, flowKey: any, position: any): string;
+    _generateId(prefix: any, list: any, force?: boolean, isFlow?: boolean): any;
+    getChildren(): any[];
+    getUpdateComplete(): Promise<void>;
+    shouldUpdate(changedProperties: any): any;
+    updated(props: any): void;
+    _renderFlowStepForm(readonlyMode: any): import("lit-html").TemplateResult<1>;
+    _onCloseDocumentation(): void;
+    documentation: any;
+    _onDeleteFlow({ detail }: {
+        detail: any;
+    }): void;
+    get definedFlows(): never[];
+    get definedPlans(): any;
+    get definedResources(): any;
+    get definedProperties(): any;
+    _onDuplicateFlow({ detail }: {
+        detail: any;
+    }): Promise<void>;
+    _onChangeFlowState({ detail }: {
+        detail: any;
+    }): void;
+    _onAddFlowPlan({ detail }: {
+        detail: any;
+    }): Promise<void>;
+    _onAddFlow(): Promise<void>;
+    _addFlow(collection: any, duplicate?: null): any;
+    _createFlowFromSchema(): {};
+    _instantiate(propertiesDefinition: any, initiator?: {}): {};
+    _deleteFlow(collection: any, flow: any): void;
+    _findFlowIndex(list: any, id: any): null;
+    _onReorderFlows({ detail: { plan } }: {
+        detail: {
+            plan: any;
+        };
+    }): Promise<void>;
+    _onSearchPolicy({ detail }: {
+        detail: any;
+    }): void;
+    _searchPolicyQuery: any;
+    _onClearPolicy(): void;
+    _onSearchFlows({ detail }: {
+        detail: any;
+    }): void;
+    _searchFlowQuery: any;
+    _onClearFlows(): void;
+    _onResetAll(): Promise<void>;
+    _filterNotValidStep(step: any): boolean;
+    _removePrivateProperties(o: any): any;
+    _submitOrConfirmForms(): any[];
+    getPropertiesElement(): any;
+    _checkCurrentFlowStep(): Promise<void | any[]>;
+    saved(): void;
+    _definitionSaved: {
+        flows: any[];
+    } | null | undefined;
+    _buildDefinitionToSave(): {
+        flows: any[];
+    };
+    _buildDefinitionToSend(definitionToSave: any): {
+        flows: any;
+    };
+    _onSaveAll(): void;
+    _onDebug(requestEvent: any): void;
+    get filteredFlows(): never[] | null;
+    get filteredPlans(): any;
+    _onFilterFlows({ detail }: {
+        detail: any;
+    }): void;
+    _getFilteredPolicies(): any[];
+    _onFilterPolicies({ detail }: {
+        detail: any;
+    }): void;
+    _renderDesign(readonlyMode: any): import("lit-html").TemplateResult<1>;
+    _renderDebug(): import("lit-html").TemplateResult<1>;
+    _renderConfigurationForm(readonlyMode: any): import("lit-html").TemplateResult<1>;
+    _renderFlowForm(readonlyMode: any): import("lit-html").TemplateResult<1> | undefined;
+    _onResourcesChange({ detail }: {
+        detail: any;
+    }): void;
+    _onPropertiesChange({ detail }: {
+        detail: any;
+    }): void;
+    _onSaveProvider({ detail }: {
+        detail: any;
+    }): void;
+    _onSwitchEncryptedProperty({ detail }: {
+        detail: any;
+    }): void;
+    render(): import("lit-html").TemplateResult<1>;
+    /**
+     * Determine if the design view should be in readonly mode or not
+     * It is in readonly mode if:
+     *  the readonly attribute is set to true
+     *  OR
+     *  the main selected flow belongs to a plan and the readonly-plans attribute is set to true
+     *  OR
+     *  the second flow for comparison belongs to a plan and the readonly-plans attribute is set to true
+     * @returns {boolean|*|{type: BooleanConstructor}|{attribute: string, type: BooleanConstructor}|{type: *}|{attribute: string, type: *}}
+     * @private
+     */
+    private _getReadonlyModeForDesign;
+}
+export {};