@gravitee/ui-policy-studio-angular 15.13.0 → 16.0.0

package/index.d.ts

@@ -1,5 +1,406 @@
+import { Observable } from 'rxjs';
+import * as i0 from '@angular/core';
+import { OnChanges, OnDestroy, EventEmitter, SimpleChanges } from '@angular/core';
+
+declare const HttpMethods: readonly ["CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT", "TRACE", "OTHER"];
+type HttpMethod = (typeof HttpMethods)[number];
+declare const toHttpMethod: (value: string) => HttpMethod | undefined;
+
+type Operation = 'PUBLISH' | 'SUBSCRIBE';
+type Operator = 'EQUALS' | 'STARTS_WITH';
+type BaseSelectorTypeEnum = 'HTTP' | 'CHANNEL' | 'CONDITION';
+interface BaseSelector {
+    /**
+     * Selector type.
+     */
+    type?: BaseSelectorTypeEnum;
+}
+interface HttpSelector extends BaseSelector {
+    /**
+     * The path of the selector
+     */
+    path: string;
+    pathOperator: Operator;
+    methods?: HttpMethod[];
+}
+interface ChannelSelector extends BaseSelector {
+    /**
+     * The list of operations associated with this channel selector.
+     */
+    operations?: Operation[];
+    /**
+     * The channel of the selector
+     */
+    channel: string;
+    channelOperator: Operator;
+    entrypoints?: string[];
+}
+interface ConditionSelector extends BaseSelector {
+    /**
+     * The condition of the selector
+     */
+    condition: string;
+}
+type Selector = HttpSelector | ChannelSelector | ConditionSelector;
+
+interface Step {
+    /**
+     * The name of the step
+     */
+    name?: string;
+    /**
+     * The description of the step
+     */
+    description?: string;
+    /**
+     * Is the step enabled or not.
+     */
+    enabled?: boolean;
+    /**
+     * The policy of the step
+     */
+    policy?: string;
+    /**
+     * The configuration of the step
+     */
+    configuration?: unknown;
+    /**
+     * The condition of the step
+     */
+    condition?: string;
+    /**
+     * The message condition of the step
+     */
+    messageCondition?: string;
+    /**
+     * Is the policy deployed or not.
+     */
+    deployed?: boolean;
+}
+
+interface Flow {
+    id?: string;
+    /**
+     * Flow's name.
+     */
+    name?: string;
+    /**
+     * Is the flow enabled.
+     */
+    enabled?: boolean;
+    selectors?: Selector[];
+    connect?: Step[];
+    interact?: Step[];
+    request?: Step[];
+    response?: Step[];
+    subscribe?: Step[];
+    publish?: Step[];
+    /**
+     * Flow's tags.
+     */
+    tags?: string[];
+}
+
 /**
- * Generated bundle index. Do not edit.
+ * API's flow mode.
  */
-/// <amd-module name="@gravitee/ui-policy-studio-angular" />
-export * from './public-api';
+type FlowMode = 'BEST_MATCH' | 'DEFAULT';
+interface FlowExecution {
+    mode?: FlowMode;
+    /**
+     * Is the flow execution match required.
+     */
+    matchRequired?: boolean;
+}
+
+interface Plan {
+    id: string;
+    name: string;
+    flows: Flow[];
+}
+
+type ApiProtocolType = 'HTTP_MESSAGE' | 'HTTP_PROXY' | 'NATIVE_KAFKA';
+
+type FlowPhase = 'REQUEST' | 'RESPONSE' | 'INTERACT' | 'CONNECT' | 'PUBLISH' | 'SUBSCRIBE';
+interface Policy {
+    id: string;
+    name: string;
+    icon?: string;
+    description?: string;
+    category?: string;
+    version?: string;
+    flowPhaseCompatibility?: Partial<Record<ApiProtocolType, FlowPhase[]>>;
+    deployed?: boolean;
+}
+/**
+ * @Deprecated to keep as long as we support APIM < 4.6
+ */
+type ExecutionPhase = 'REQUEST' | 'RESPONSE' | 'MESSAGE_REQUEST' | 'MESSAGE_RESPONSE';
+type PolicyInput = Omit<Policy, 'proxy' | 'message'> & {
+    proxy?: ExecutionPhase[];
+    message?: ExecutionPhase[];
+};
+/**
+ * @Deprecated to keep as long as we support APIM < 4.6
+ */
+declare const fromPolicyInput: (policy: PolicyInput | Policy) => Policy;
+/**
+ * @Deprecated to keep as long as we support APIM < 4.6
+ */
+declare const fromExecutionPhase: (phase: ExecutionPhase | FlowPhase) => FlowPhase;
+
+type ApiType = 'MESSAGE' | 'LLM_PROXY' | 'MCP_PROXY' | 'PROXY' | 'NATIVE';
+
+type SharedPolicyGroupPolicy = {
+    id: string;
+    policyId: string;
+    name: string;
+    description?: string;
+    prerequisiteMessage?: string;
+    apiType: ApiType;
+    phase: FlowPhase;
+};
+
+type CommonGenericPolicy = {
+    _id: string;
+    policyId: string;
+    icon?: string;
+    category?: string;
+    type: 'POLICY' | 'SHARED_POLICY_GROUP';
+};
+type GenericPolicyPolicy = CommonGenericPolicy & {
+    type: 'POLICY';
+} & Omit<Policy, 'id'>;
+type GenericPolicySharedPolicyGroupPolicy = CommonGenericPolicy & {
+    type: 'SHARED_POLICY_GROUP';
+    sharedPolicyGroupId: string;
+} & Omit<SharedPolicyGroupPolicy, 'id'>;
+type GenericPolicy = GenericPolicyPolicy | GenericPolicySharedPolicyGroupPolicy;
+declare const isSharedPolicyGroupPolicy: (policy: GenericPolicy) => policy is GenericPolicySharedPolicyGroupPolicy;
+declare const isPolicy: (policy: GenericPolicy) => policy is GenericPolicyPolicy;
+declare const toGenericPolicies: (policies: Policy[], sharedPolicyGroupPolicies?: SharedPolicyGroupPolicy[]) => GenericPolicy[];
+declare const toPolicy: (genericPolicy: GenericPolicy) => Policy;
+
+interface ConnectorInfo {
+    name: string;
+    type: string;
+    icon: string;
+    supportedModes: ConnectorMode[];
+}
+type ConnectorMode = 'CONNECT' | 'INTERACT' | 'SUBSCRIBE' | 'PUBLISH' | 'REQUEST_RESPONSE';
+
+type SaveOutput = {
+    commonFlows?: Flow[];
+    plansToUpdate?: Plan[];
+    flowExecution?: FlowExecution;
+};
+
+interface FlowVM extends Flow {
+    _id: string;
+    _hasChanged: boolean;
+    _parentFlowGroupName?: string;
+}
+interface FlowGroupVM {
+    _id: string;
+    _planId?: string;
+    _isPlan: boolean;
+    name: string;
+    flows: FlowVM[];
+}
+interface PolicyDocumentation {
+    content: string;
+    language: 'MARKDOWN' | 'ASCIIDOC';
+}
+
+type PolicySchemaFetcher = (policy: Policy) => Observable<unknown>;
+type PolicyDocumentationFetcher = (policy: Policy) => Observable<PolicyDocumentation | string>;
+
+declare class GioPolicyStudioService {
+    private schemasCache;
+    private documentationsCache;
+    private policySchemaFetcher?;
+    private policyDocumentationFetcher?;
+    setPolicySchemaFetcher(policySchemaFetcher: PolicySchemaFetcher): void;
+    setPolicyDocumentationFetcher(policyDocumentationFetcher: PolicyDocumentationFetcher): void;
+    /**
+     * Call the policy schema fetcher to get the schema for the given policy. If the
+     * schema has already been fetched, it will be returned from the cache.
+     *
+     * @param policy to get the schema for
+     * @returns the schema for the policy
+     */
+    getPolicySchema(policy: Policy): Observable<unknown>;
+    /**
+     * Call the policy documentation fetcher to get the documentation for the given policy. If the
+     * documentation has already been fetched, it will be returned from the cache.
+     *
+     * @param policy to get the documentation for
+     * @returns the documentation for the policy
+     */
+    getPolicyDocumentation(policy: Policy): Observable<PolicyDocumentation | string>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<GioPolicyStudioService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<GioPolicyStudioService>;
+}
+
+type FlowSelection = {
+    planIndex: number;
+    flowIndex: number;
+};
+declare class GioPolicyStudioComponent implements OnChanges, OnDestroy {
+    private readonly policyStudioService;
+    /**
+     * May be set to `true` if the API is not manageable from the UI (e.g. kubernetes operator APIs)
+     */
+    readOnly: boolean;
+    /**
+     * API type (required)
+     */
+    apiType: ApiType;
+    /**
+     * Flow execution config (required)
+     */
+    flowExecution: FlowExecution;
+    /**
+     * List of entrypoints to display
+     */
+    entrypointsInfo: ConnectorInfo[];
+    /**
+     * List of endpoints to display
+     */
+    endpointsInfo: ConnectorInfo[];
+    /**
+     * List of common flows to add to common flows group
+     */
+    commonFlows: Flow[];
+    /**
+     * List of plans with their flows
+     */
+    plans: Plan[];
+    /**
+     * List of policies usable in the policy studio
+     */
+    set policies(value: (PolicyInput | Policy)[]);
+    get policies(): Policy[];
+    private _policies;
+    /**
+     * List of SharedPolicyGroups usable in the studio
+     */
+    sharedPolicyGroupPolicies: SharedPolicyGroupPolicy[];
+    /**
+     * When a policy is not available with the current license,
+     * this URL is used to redirect the user to the trial page.
+     */
+    trialUrl?: string;
+    /**
+     * Loading state
+     */
+    loading: boolean;
+    /**
+     * Called when Policy Studio needs to fetch the policy schema
+     * @returns Observable of the policy schema
+     */
+    policySchemaFetcher: PolicySchemaFetcher;
+    /**
+     * Called when Policy Studio needs to fetch the policy documentation
+     * @returns Observable of the policy documentation
+     */
+    policyDocumentationFetcher: PolicyDocumentationFetcher;
+    selectedFlowIndexes: FlowSelection;
+    selectedFlowChanged: EventEmitter<FlowSelection>;
+    /**
+     * Return what is needed to save.
+     **/
+    save: EventEmitter<SaveOutput>;
+    connectorsTooltip: string;
+    selectedFlow?: FlowVM;
+    flowsGroups: FlowGroupVM[];
+    disableSaveButton: boolean;
+    saving: boolean;
+    private initialFlowsGroups;
+    private hasFlowExecutionChanged;
+    private unSavingButtonSubscription?;
+    enableSavingTimer: boolean;
+    protected genericPolicies: GenericPolicy[];
+    constructor(policyStudioService: GioPolicyStudioService);
+    ngOnChanges(changes: SimpleChanges): void;
+    ngOnDestroy(): void;
+    onFlowExecutionChange(flowExecution: FlowExecution): void;
+    onFlowsGroupsChange(flowsGroups: FlowGroupVM[]): void;
+    onSelectedFlowChange(flow: FlowVM): void;
+    onSelectFlow(flowId: string): void;
+    onDeleteSelectedFlow(flow: FlowVM): void;
+    onSave(): void;
+    private initGenericPolicies;
+    static ɵfac: i0.ɵɵFactoryDeclaration<GioPolicyStudioComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<GioPolicyStudioComponent, "gio-policy-studio", never, { "readOnly": { "alias": "readOnly"; "required": false; }; "apiType": { "alias": "apiType"; "required": false; }; "flowExecution": { "alias": "flowExecution"; "required": false; }; "entrypointsInfo": { "alias": "entrypointsInfo"; "required": false; }; "endpointsInfo": { "alias": "endpointsInfo"; "required": false; }; "commonFlows": { "alias": "commonFlows"; "required": false; }; "plans": { "alias": "plans"; "required": false; }; "policies": { "alias": "policies"; "required": false; }; "sharedPolicyGroupPolicies": { "alias": "sharedPolicyGroupPolicies"; "required": false; }; "trialUrl": { "alias": "trialUrl"; "required": false; }; "loading": { "alias": "loading"; "required": false; }; "policySchemaFetcher": { "alias": "policySchemaFetcher"; "required": false; }; "policyDocumentationFetcher": { "alias": "policyDocumentationFetcher"; "required": false; }; "selectedFlowIndexes": { "alias": "selectedFlowIndexes"; "required": false; }; }, { "selectedFlowChanged": "selectedFlowChanged"; "save": "save"; }, never, never, true, never>;
+    static ngAcceptInputType_policies: unknown;
+}
+
+type PolicyGroupOutput = Step[];
+type PolicyGroupInput = Step[];
+type PolicyGroupVM = {
+    name: string;
+    description: string;
+    startConnectorName: string;
+    endConnectorName: string;
+};
+declare class GioPolicyGroupStudioComponent implements OnChanges {
+    private readonly policyStudioService;
+    /**
+     * List of policies usable in the studio
+     */
+    set policies(value: (PolicyInput | Policy)[]);
+    get policies(): Policy[];
+    private _policies;
+    /**
+     * Whether the Policy Group Studio is in read-only mode
+     */
+    readOnly: boolean;
+    /**
+     * Type of the API targeted by the Policy Group Studio
+     */
+    apiType: ApiType;
+    /**
+     * Execution phase targeted by the Policy Group Studio
+     * @deprecated Use `flowPhase` instead. To keep as long as we support APIM < 4.6
+     */
+    set executionPhase(value: ExecutionPhase);
+    /**
+     * Execution phase targeted by the Policy Group Studio
+     */
+    flowPhase: FlowPhase;
+    /**
+     * Called when Policy Group Studio needs to fetch the policy schema
+     * @returns Observable of the policy schema
+     */
+    policySchemaFetcher: PolicySchemaFetcher;
+    /**
+     * Called when Policy Group Studio needs to fetch the policy documentation
+     * @returns Observable of the policy documentation
+     */
+    policyDocumentationFetcher: PolicyDocumentationFetcher;
+    policyGroup: PolicyGroupInput;
+    /**
+     * Output event when the Policy Group Studio changes
+     */
+    policyGroupChange: EventEmitter<PolicyGroupOutput>;
+    protected isLoading: boolean;
+    protected createStartConnector: (name: string) => ConnectorInfo[];
+    protected createEndConnector: (name: string) => ConnectorInfo[];
+    protected policyGroupVM?: PolicyGroupVM;
+    protected steps: Step[];
+    protected trialUrl: string | undefined;
+    protected genericPolicies: GenericPolicy[];
+    protected startConnector: ConnectorInfo[];
+    protected endConnector: ConnectorInfo[];
+    private phases;
+    constructor(policyStudioService: GioPolicyStudioService);
+    ngOnChanges(changes: SimpleChanges): void;
+    protected onStepsChange(steps: Step[]): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<GioPolicyGroupStudioComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<GioPolicyGroupStudioComponent, "gio-policy-group-studio", never, { "policies": { "alias": "policies"; "required": false; }; "readOnly": { "alias": "readOnly"; "required": false; }; "apiType": { "alias": "apiType"; "required": true; }; "executionPhase": { "alias": "executionPhase"; "required": false; }; "flowPhase": { "alias": "flowPhase"; "required": false; }; "policySchemaFetcher": { "alias": "policySchemaFetcher"; "required": true; }; "policyDocumentationFetcher": { "alias": "policyDocumentationFetcher"; "required": true; }; "policyGroup": { "alias": "policyGroup"; "required": false; }; }, { "policyGroupChange": "policyGroupChange"; }, never, never, true, never>;
+    static ngAcceptInputType_policies: unknown;
+}
+
+export { GioPolicyGroupStudioComponent, GioPolicyStudioComponent, HttpMethods, fromExecutionPhase, fromPolicyInput, isPolicy, isSharedPolicyGroupPolicy, toGenericPolicies, toHttpMethod, toPolicy };
+export type { ApiProtocolType, ApiType, BaseSelector, BaseSelectorTypeEnum, ChannelSelector, ConditionSelector, ConnectorInfo, ConnectorMode, ExecutionPhase, Flow, FlowExecution, FlowMode, FlowPhase, GenericPolicy, GenericPolicyPolicy, GenericPolicySharedPolicyGroupPolicy, HttpMethod, HttpSelector, Operation, Operator, Plan, Policy, PolicyDocumentationFetcher, PolicyGroupInput, PolicyGroupOutput, PolicyInput, PolicySchemaFetcher, SaveOutput, Selector, SharedPolicyGroupPolicy, Step };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravitee/ui-policy-studio-angular",
-  "version": "15.13.0",
+  "version": "16.0.0",
   "description": "Gravitee.io - UI Policy Studio Angular",
   "repository": {
     "type": "git",
@@ -11,12 +11,12 @@
     "tslib": "^2.6.2"
   },
   "peerDependencies": {
-    "@angular/animations": "^19.0.0",
-    "@angular/cdk": "^19.0.0",
-    "@angular/common": "^19.0.0",
-    "@angular/core": "^19.0.0",
-    "@angular/forms": "^19.0.0",
-    "@angular/material": "^19.0.0",
+    "@angular/animations": "^20.3.4",
+    "@angular/cdk": "^20.2.8",
+    "@angular/common": "^20.3.4",
+    "@angular/core": "^20.3.4",
+    "@angular/forms": "^20.3.4",
+    "@angular/material": "^20.2.8",
     "@gravitee/ui-particles-angular": "*",
     "lodash": "^4.17.21",
     "ngx-markdown": "^19.1.1"
@@ -32,14 +32,10 @@
     },
     ".": {
       "types": "./index.d.ts",
-      "esm2022": "./esm2022/gravitee-ui-policy-studio-angular.mjs",
-      "esm": "./esm2022/gravitee-ui-policy-studio-angular.mjs",
       "default": "./fesm2022/gravitee-ui-policy-studio-angular.mjs"
     },
     "./testing": {
       "types": "./testing/index.d.ts",
-      "esm2022": "./esm2022/testing/gravitee-ui-policy-studio-angular-testing.mjs",
-      "esm": "./esm2022/testing/gravitee-ui-policy-studio-angular-testing.mjs",
       "default": "./fesm2022/gravitee-ui-policy-studio-angular-testing.mjs"
     }
   },