@gravitee/ui-policy-studio-angular 14.2.1 → 15.0.0-handle-md-doc-dedae47

package/lib/components/step-form/gio-ps-step-form.component.d.ts

@@ -4,9 +4,11 @@ import { Observable } from 'rxjs';
 import { GioJsonSchema, GioJsonSchemaContext } from '@gravitee/ui-particles-angular';
 import { FlowPhase, Step, GenericPolicy, ApiType } from '../../models';
 import { GioPolicyStudioService } from '../../policy-studio/gio-policy-studio.service';
+import { PolicyDocumentation } from '../../policy-studio/gio-policy-studio.model';
 import * as i0 from "@angular/core";
 export declare class GioPolicyStudioStepFormComponent implements OnChanges, OnInit, OnDestroy {
     private readonly policyStudioService;
+    private readonly noDocumentationAvailable;
     readOnly: boolean;
     step?: Step;
     flowPhase: FlowPhase;
@@ -15,7 +17,7 @@ export declare class GioPolicyStudioStepFormComponent implements OnChanges, OnIn
     stepChange: EventEmitter<Step>;
     isValid: EventEmitter<boolean>;
     policySchema$?: Observable<GioJsonSchema | null | undefined>;
-    policyDocumentation$?: Observable<string>;
+    policyDocumentation$?: Observable<PolicyDocumentation>;
     infoBanner?: string;
     stepForm?: UntypedFormGroup;
     context?: GioJsonSchemaContext;

package/lib/models/PolicySchemaFetcher.d.ts

@@ -1,4 +1,5 @@
 import { Observable } from 'rxjs';
+import { PolicyDocumentation } from '../policy-studio/gio-policy-studio.model';
 import { Policy } from './policy/Policy';
 export type PolicySchemaFetcher = (policy: Policy) => Observable<unknown>;
-export type PolicyDocumentationFetcher = (policy: Policy) => Observable<string>;
+export type PolicyDocumentationFetcher = (policy: Policy) => Observable<PolicyDocumentation>;

package/lib/policy-studio/gio-policy-studio.model.d.ts

@@ -11,3 +11,7 @@ export interface FlowGroupVM {
     name: string;
     flows: FlowVM[];
 }
+export interface PolicyDocumentation {
+    content: string;
+    language: 'MARKDOWN' | 'ASCIIDOC';
+}

package/lib/policy-studio/gio-policy-studio.service.d.ts

@@ -1,5 +1,6 @@
 import { Observable } from 'rxjs';
 import { Policy, PolicyDocumentationFetcher, PolicySchemaFetcher } from '../models';
+import { PolicyDocumentation } from './gio-policy-studio.model';
 import * as i0 from "@angular/core";
 export declare class GioPolicyStudioService {
     private schemasCache;
@@ -23,7 +24,7 @@ export declare class GioPolicyStudioService {
      * @param policy to get the documentation for
      * @returns the documentation for the policy
      */
-    getPolicyDocumentation(policy: Policy): Observable<string>;
+    getPolicyDocumentation(policy: Policy): Observable<PolicyDocumentation>;
     static ɵfac: i0.ɵɵFactoryDeclaration<GioPolicyStudioService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<GioPolicyStudioService>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravitee/ui-policy-studio-angular",
-  "version": "14.2.1",
+  "version": "15.0.0-handle-md-doc-dedae47",
   "description": "Gravitee.io - UI Policy Studio Angular",
   "repository": {
     "type": "git",
@@ -18,7 +18,8 @@
     "@angular/forms": "^19.0.0",
     "@angular/material": "^19.0.0",
     "@gravitee/ui-particles-angular": "*",
-    "lodash": "^4.17.21"
+    "lodash": "^4.17.21",
+    "ngx-markdown": "^19.1.1"
   },
   "publishConfig": {
     "access": "public"

package/testing/lib/models/PolicySchemaFetcher.d.ts

@@ -1,4 +1,5 @@
 import { Observable } from 'rxjs';
+import { PolicyDocumentation } from '../policy-studio/gio-policy-studio.model';
 import { Policy } from './policy/Policy';
 export type PolicySchemaFetcher = (policy: Policy) => Observable<unknown>;
-export type PolicyDocumentationFetcher = (policy: Policy) => Observable<string>;
+export type PolicyDocumentationFetcher = (policy: Policy) => Observable<PolicyDocumentation>;

package/testing/lib/policy-studio/gio-policy-studio.model.d.ts

@@ -0,0 +1,17 @@
+import { Flow } from '../models';
+export interface FlowVM extends Flow {
+    _id: string;
+    _hasChanged: boolean;
+    _parentFlowGroupName?: string;
+}
+export interface FlowGroupVM {
+    _id: string;
+    _icon?: string;
+    _planId?: string;
+    name: string;
+    flows: FlowVM[];
+}
+export interface PolicyDocumentation {
+    content: string;
+    language: 'MARKDOWN' | 'ASCIIDOC';
+}