Merge pull request #441 from trivir/feature/update-export-formats

Update Export Formats and Bug Fixes

.gitignore

@@ -119,6 +119,9 @@ out
 # Stores VSCode versions used for testing VSCode extensions
 .vscode-test
 
+# Stores JetBrain IDE's configuration
+.idea
+
 # yarn v2
 .yarn/cache
 .yarn/unplugged
@@ -127,4 +130,4 @@ out
 .pnp.*
 
 test/fs_tmp/*
-!test/fs_tmp/.gitkeep
+!test/fs_tmp/.gitkeep

jest.config.js

@@ -5,9 +5,9 @@ module.exports = {
   testEnvironment: 'node',
   snapshotResolver: '<rootDir>/snapshotResolve.js',
   testMatch: ['**/?(*.)(test).ts'],
-  testTimeout: 30000,
+  testTimeout: 90000,
   extensionsToTreatAsEsm: ['.ts'],
   transform: {
     '^.+\\.tsx?$': ['ts-jest', { useESM: true }]
   },
-};
+};

package.json

@@ -20,6 +20,7 @@
     "test:record_noauth": "NODE_OPTIONS=--experimental-vm-modules FRODO_POLLY_MODE=record_noauth npx jest --verbose=true --silent=false --updateSnapshot --testPathIgnorePatterns cjs --testPathPattern",
     "test:update": "NODE_OPTIONS=--experimental-vm-modules npx jest --verbose=true --silent=false --updateSnapshot --testPathPattern",
     "lint": "eslint --ext .ts --ignore-path .gitignore .",
+    "lint:fix": "eslint --fix --ext .ts --ignore-path .gitignore .",
     "clean-types": "rimraf types",
     "generate-types": "tsc",
     "build": "npx tsup && npm run clean-types && npm run generate-types",

src/api/AgentApi.test.ts

@@ -32,7 +32,8 @@
 import * as AgentApi from './AgentApi';
 import { state } from '../index';
 import { getAgent } from '../test/mocks/ForgeRockApiMockEngine';
-import { autoSetupPolly, filterRecording } from '../utils/AutoSetupPolly';
+import { autoSetupPolly } from '../utils/AutoSetupPolly';
+import { filterRecording } from '../utils/PollyUtils';
 
 const ctx = autoSetupPolly();
 

src/api/AgentApi.ts

@@ -4,9 +4,8 @@ import { State } from '../shared/State';
 import { debugMessage } from '../utils/Console';
 import { getCurrentRealmPath } from '../utils/ForgeRockUtils';
 import { deleteDeepByKey } from '../utils/JsonUtils';
-import { type IdObjectSkeletonInterface } from './ApiTypes';
+import { type AmConfigEntityInterface, EntityType } from './ApiTypes';
 import { generateAmApi } from './BaseApi';
-import { type AmServiceType } from './ServiceApi';
 
 const getAgentTypesURLTemplate =
   '%s/json%s/realm-config/agents?_action=getAllTypes';
@@ -29,11 +28,13 @@ const getApiConfig = () => {
 export type GatewayAgentType = 'IdentityGatewayAgent';
 export type JavaAgentType = 'J2EEAgent';
 export type WebAgentType = 'WebAgent';
-export type AgentType = GatewayAgentType | JavaAgentType | WebAgentType;
+export type AgentType =
+  | GatewayAgentType
+  | JavaAgentType
+  | WebAgentType
+  | EntityType;
 
-export type AgentSkeleton = IdObjectSkeletonInterface & {
-  _type: AmServiceType;
-};
+export type AgentSkeleton = AmConfigEntityInterface;
 
 /**
  * Get agent types

src/api/ApiTypes.ts

@@ -14,6 +14,10 @@ export interface IdObjectSkeletonInterface extends NoIdObjectSkeletonInterface {
   _id?: string;
 }
 
+export interface AmConfigEntityInterface extends IdObjectSkeletonInterface {
+  _type?: EntityType;
+}
+
 export type Readable<Type> = Type;
 
 export type Writable<Type> = {
@@ -33,3 +37,8 @@ export type PagedResult<Type> = {
   totalPagedResults: number;
   remainingPagedResults: number;
 };
+
+export type EntityType = IdObjectSkeletonInterface & {
+  name: string;
+  collection: boolean;
+};

src/api/AuthenticateApi.test.ts

@@ -34,11 +34,8 @@
  */
 import * as AuthenticateApi from './AuthenticateApi';
 import { state } from '../index';
-import {
-  autoSetupPolly,
-  defaultMatchRequestsBy,
-  filterRecording,
-} from '../utils/AutoSetupPolly';
+import { autoSetupPolly } from '../utils/AutoSetupPolly';
+import { defaultMatchRequestsBy, filterRecording } from '../utils/PollyUtils';
 
 // need to modify the default matching rules to allow the mocking to work for an authentication flow.
 const matchConfig = defaultMatchRequestsBy();

src/api/AuthenticationSettingsApi.ts

@@ -56,8 +56,8 @@ export async function getAuthenticationSettings({
 }
 
 /**
- * Put authentiction settings
- * @param {AuthenticationSettingsSkeleton} settings authentiction settings object
+ * Put authentication settings
+ * @param {AuthenticationSettingsSkeleton} settings authentication settings object
  * @returns {Promise<AuthenticationSettingsSkeleton>} a promise that resolves to an authentiction settings object
  */
 export async function putAuthenticationSettings({

src/api/CirclesOfTrustApi.ts

@@ -3,9 +3,8 @@ import util from 'util';
 import { State } from '../shared/State';
 import { getCurrentRealmPath } from '../utils/ForgeRockUtils';
 import { cloneDeep } from '../utils/JsonUtils';
-import { type IdObjectSkeletonInterface, type PagedResult } from './ApiTypes';
+import { type AmConfigEntityInterface, type PagedResult } from './ApiTypes';
 import { generateAmApi } from './BaseApi';
-import { type AmServiceType } from './ServiceApi';
 
 const circleOfTrustByIdURLTemplate =
   '%s/json%s/realm-config/federation/circlesoftrust/%s';
@@ -20,10 +19,9 @@ const getApiConfig = () => {
   };
 };
 
-export type CircleOfTrustSkeleton = IdObjectSkeletonInterface & {
+export type CircleOfTrustSkeleton = AmConfigEntityInterface & {
   status?: string;
   trustedProviders?: string[];
-  _type?: AmServiceType;
 };
 
 /**

src/api/NodeApi.test.ts

@@ -31,7 +31,8 @@
  */
 import * as NodeApi from './NodeApi';
 import { state } from '../index';
-import { autoSetupPolly, filterRecording } from '../utils/AutoSetupPolly';
+import { autoSetupPolly } from '../utils/AutoSetupPolly';
+import { filterRecording } from '../utils/PollyUtils';
 
 const ctx = autoSetupPolly();
 

src/api/NodeApi.ts

@@ -4,13 +4,13 @@ import { State } from '../shared/State';
 import { getCurrentRealmPath } from '../utils/ForgeRockUtils';
 import { deleteDeepByKey } from '../utils/JsonUtils';
 import {
+  AmConfigEntityInterface,
   type IdObjectSkeletonInterface,
   type NoIdObjectSkeletonInterface,
   type PagedResult,
   type QueryResult,
 } from './ApiTypes';
 import { generateAmApi } from './BaseApi';
-import { type AmServiceType } from './ServiceApi';
 
 const queryAllNodeTypesURLTemplate =
   '%s/json%s/realm-config/authentication/authenticationtrees/nodes?_action=getAllTypes';
@@ -49,8 +49,7 @@ export interface InnerNodeRefSkeletonInterface {
   nodeType: string;
 }
 
-export type NodeSkeleton = IdObjectSkeletonInterface & {
-  _type: AmServiceType;
+export type NodeSkeleton = AmConfigEntityInterface & {
   nodes?: InnerNodeRefSkeletonInterface[];
   tree?: string;
   identityResource?: string;

src/api/OAuth2ClientApi.ts

@@ -4,14 +4,13 @@ import { State } from '../shared/State';
 import { getCurrentRealmPath } from '../utils/ForgeRockUtils';
 import { deleteDeepByKey } from '../utils/JsonUtils';
 import {
-  type IdObjectSkeletonInterface,
+  type AmConfigEntityInterface,
   type NoIdObjectSkeletonInterface,
   type PagedResult,
   type Readable,
   type Writable,
 } from './ApiTypes';
 import { generateAmApi } from './BaseApi';
-import { AmServiceType } from './ServiceApi';
 
 const oauth2ClientURLTemplate = '%s/json%s/realm-config/agents/OAuth2Client/%s';
 const oauth2ClientListURLTemplate =
@@ -23,7 +22,7 @@ const getApiConfig = () => {
   };
 };
 
-export type OAuth2ClientSkeleton = IdObjectSkeletonInterface & {
+export type OAuth2ClientSkeleton = AmConfigEntityInterface & {
   overrideOAuth2ClientConfig?: {
     [k: string]: string | number | boolean | string[] | object | undefined;
   };
@@ -61,7 +60,6 @@ export type OAuth2ClientSkeleton = IdObjectSkeletonInterface & {
   coreUmaClientConfig?: {
     [k: string]: string | number | boolean | string[] | object | undefined;
   };
-  _type: AmServiceType;
 };
 
 /**

src/api/OAuth2ProviderApi.ts

@@ -3,9 +3,8 @@ import util from 'util';
 import { State } from '../shared/State';
 import { getCurrentRealmPath } from '../utils/ForgeRockUtils';
 import { cloneDeep } from '../utils/JsonUtils';
-import { type IdObjectSkeletonInterface } from './ApiTypes';
+import { type AmConfigEntityInterface } from './ApiTypes';
 import { generateAmApi } from './BaseApi';
-import { type AmServiceType } from './ServiceApi';
 
 const oAuth2ProviderServiceURLTemplate =
   '%s/json%s/realm-config/services/oauth-oidc';
@@ -20,7 +19,7 @@ const getApiConfig = () => {
   };
 };
 
-export type OAuth2ProviderSkeleton = IdObjectSkeletonInterface & {
+export type OAuth2ProviderSkeleton = AmConfigEntityInterface & {
   advancedOIDCConfig: {
     supportedRequestParameterEncryptionEnc?: string[];
     authorisedOpenIdConnectSSOClients?: string[];
@@ -159,7 +158,6 @@ export type OAuth2ProviderSkeleton = IdObjectSkeletonInterface & {
     cibaAuthReqIdLifetime: number;
     [k: string]: string | number | boolean | string[] | object | undefined;
   };
-  _type?: AmServiceType;
   [k: string]: string | number | boolean | string[] | object | undefined;
 };
 

src/api/PoliciesApi.test.ts

@@ -31,7 +31,8 @@
  */
 import * as PolicySetApi from './PolicySetApi';
 import * as PoliciesApi from './PoliciesApi';
-import { autoSetupPolly, filterRecording } from '../utils/AutoSetupPolly';
+import { autoSetupPolly } from '../utils/AutoSetupPolly';
+import { filterRecording } from '../utils/PollyUtils';
 import { type PolicySetSkeleton } from './PolicySetApi';
 import { type PolicySkeleton } from './PoliciesApi';
 import { cloneDeep } from '../utils/JsonUtils';

src/api/PolicySetApi.test.ts

@@ -31,7 +31,8 @@
  */
 import * as PolicySetApi from './PolicySetApi';
 import { state } from '../index';
-import { autoSetupPolly, filterRecording } from '../utils/AutoSetupPolly';
+import { autoSetupPolly } from '../utils/AutoSetupPolly';
+import { filterRecording } from '../utils/PollyUtils';
 import { type PolicySetSkeleton } from './PolicySetApi';
 import { cloneDeep } from '../utils/JsonUtils';
 

src/api/ResourceTypesApi.test.ts

@@ -31,7 +31,8 @@
  */
 import * as ResourceTypesApi from './ResourceTypesApi';
 import { state } from '../index';
-import { autoSetupPolly, filterRecording } from '../utils/AutoSetupPolly';
+import { autoSetupPolly } from '../utils/AutoSetupPolly';
+import { filterRecording } from '../utils/PollyUtils';
 import { type ResourceTypeSkeleton } from './ResourceTypesApi';
 
 const ctx = autoSetupPolly();