chore: adding stream_types object and tag to forgetAll api

Author: utkarsha-deriv

src/features/Apiexplorer/Schema/RecursiveContent/RecursiveProperties/index.tsx

@@ -1,18 +1,26 @@
 import React from 'react';
 import SchemaDescription from '../SchemaDescription';
 import SchemaObjectContent from '../SchemaObjectContent';
+import StreamTypesObject from '../StreamTypesObject';
 
 type TRecursiveProperties = {
   is_open: boolean;
   properties: any;
   value: any;
+  jsonSchema?: any;
 };
 
-const RecursiveProperties = ({ is_open, properties, value }: TRecursiveProperties) => {
+const RecursiveProperties = ({ is_open, properties, value, jsonSchema }: TRecursiveProperties) => {
   const keys = properties && Object.keys(properties);
   if (!is_open) {
+    //if object is not open then ret null
     return null;
   }
+
+  if ('oneOf' in value) {
+    return <StreamTypesObject definitions={jsonSchema.definitions} />;
+  }
+  // this will be true when we are not inside properties obj? !!!!!!
   if (!keys) {
     return (
       <React.Fragment>
@@ -28,7 +36,18 @@ const RecursiveProperties = ({ is_open, properties, value }: TRecursivePropertie
             {index === 0 && value?.items?.description && (
               <SchemaDescription description={value.items.description} />
             )}
-            <SchemaObjectContent key={key} key_value={key} properties={properties} />
+            {/* check if its forgetAll Request not response */}
+            {key === 'forget_all' && 'oneOf' in value[key] ? (
+              <SchemaObjectContent
+                key={key}
+                key_value={key}
+                properties={properties}
+                jsonSchema={jsonSchema}
+                is_stream_types={true}
+              />
+            ) : (
+              <SchemaObjectContent key={key} key_value={key} properties={properties} />
+            )}
           </React.Fragment>
         );
       })}

src/features/Apiexplorer/Schema/RecursiveContent/SchemaBodyHeader/index.tsx

@@ -12,6 +12,7 @@ type TSchemaBodyHeader = {
   setIsOpenObject: (boolean) => void;
   examples: string[];
   enum;
+  is_stream_types?: boolean;
 };
 
 const SchemaBodyHeader = ({
@@ -24,6 +25,7 @@ const SchemaBodyHeader = ({
   title,
   is_open_object,
   setIsOpenObject,
+  is_stream_types,
 }: TSchemaBodyHeader) => {
   let typeClassName;
   switch (type) {
@@ -116,6 +118,17 @@ const SchemaBodyHeader = ({
             ) : (
               <></>
             )}
+
+            {is_stream_types && (
+              <React.Fragment>
+                <div className={styles.schemaObjectContent}>
+                  <span className={styles.enumLabel}>{'one of'}</span>
+                  <button onClick={() => setIsOpenObject(!is_open_object)}>{'stream_types'}</button>
+                  <span className={`${styles.enumType} ${styles.array}`}>{'array'}</span>
+                </div>
+              </React.Fragment>
+            )}
+
             {pattern && (
               <div className={styles.schemaRegexContainer}>
                 <div className={styles.schemaBodyPattern}>{pattern}</div>

src/features/Apiexplorer/Schema/RecursiveContent/SchemaObjectContent/index.tsx

@@ -10,9 +10,17 @@ const ReactJson = React.lazy(() => import('react-json-view'));
 type TSchemaObjectContent = {
   key_value: string;
   properties: any;
+  jsonSchema?: any;
+  is_stream_types?: boolean;
 };
 
-export default function SchemaObjectContent({ key_value, properties }: TSchemaObjectContent) {
+//json schema also here full obj
+export default function SchemaObjectContent({
+  key_value,
+  properties,
+  jsonSchema,
+  is_stream_types = false,
+}: TSchemaObjectContent) {
   const [is_open_object, setIsOpenObject] = useState<boolean>(false);
   const [is_code_open, setIsCodeOpen] = useState<boolean>(false);
   const {
@@ -52,6 +60,7 @@ export default function SchemaObjectContent({ key_value, properties }: TSchemaOb
           title={title}
           is_open_object={is_open_object}
           setIsOpenObject={setIsOpenObject}
+          is_stream_types={is_stream_types}
         />
         {/* Description */}
         <SchemaDescription description={description} />
@@ -68,6 +77,7 @@ export default function SchemaObjectContent({ key_value, properties }: TSchemaOb
             is_open={is_open_object}
             properties={value.properties || value?.items?.properties}
             value={value}
+            jsonSchema={jsonSchema}
           />
         )}
       </div>

src/features/Apiexplorer/Schema/RecursiveContent/StreamTypesObject/StreamTypesBody.tsx

@@ -0,0 +1,40 @@
+import React from 'react';
+import styles from '../../Schema.module.scss';
+
+type TStreamTypesBody = {
+  type: string;
+  _enum: Array<
+    | 'balance'
+    | 'candles'
+    | 'cashier_payments'
+    | 'p2p_advert'
+    | 'p2p_advertiser'
+    | 'p2p_order'
+    | 'proposal'
+    | 'proposal_open_contract'
+    | 'ticks'
+    | 'transaction'
+    | 'trading_platform_asset_listing'
+    | 'website_status'
+    | 'p2p_settings'
+    | 'crypto_estimations'
+  >;
+};
+
+const StreamTypesBody = ({ type, _enum }: TStreamTypesBody) => {
+  return (
+    <div className={styles.streamTypesBody}>
+      <div className={styles.streamTypesObject}>
+        <span className={styles.enumLabel}>enum</span>
+        <span className={`${styles.enumType} ${styles.string}`}>{type}</span>
+        {_enum.map((enum_name: string, i: number) => (
+          <div className={`${styles.schemaCode} ${styles.schemaEnums}`} key={i}>
+            {enum_name}
+          </div>
+        ))}
+      </div>
+    </div>
+  );
+};
+
+export default StreamTypesBody;

src/features/Apiexplorer/Schema/RecursiveContent/StreamTypesObject/StreamTypesHeader.tsx

@@ -0,0 +1,20 @@
+import React from 'react';
+import SchemaTitle from '../../SchemaTitle';
+import styles from '../../Schema.module.scss';
+
+type TStreamTypesHeader = {
+  description: string;
+};
+
+const StreamTypesHeader = ({ description }: TStreamTypesHeader) => {
+  return (
+    <div className={styles.streamTypesHeader}>
+      <SchemaTitle className={styles.streamTypesTitle}>{'stream_types'}</SchemaTitle>
+      <div className={styles.streamTypesDescription}>
+        <div>{description}</div>
+      </div>
+    </div>
+  );
+};
+
+export default StreamTypesHeader;

src/features/Apiexplorer/Schema/RecursiveContent/StreamTypesObject/index.tsx

@@ -0,0 +1,40 @@
+import React from 'react';
+import StreamTypesHeader from './StreamTypesHeader';
+import StreamTypesBody from './StreamTypesBody';
+import styles from '../../Schema.module.scss';
+
+type TStreamTypesObject = {
+  definitions: {
+    stream_types: {
+      description: string;
+      type: string;
+      enum: Array<
+        | 'balance'
+        | 'candles'
+        | 'cashier_payments'
+        | 'p2p_advert'
+        | 'p2p_advertiser'
+        | 'p2p_order'
+        | 'proposal'
+        | 'proposal_open_contract'
+        | 'ticks'
+        | 'transaction'
+        | 'trading_platform_asset_listing'
+        | 'website_status'
+        | 'p2p_settings'
+        | 'crypto_estimations'
+      >;
+    };
+  };
+};
+
+const StreamTypesObject = ({ definitions }: TStreamTypesObject) => {
+  return (
+    <div className={styles.streamTypesContainer}>
+      <StreamTypesHeader description={definitions.stream_types.description} />
+      <StreamTypesBody type={definitions.stream_types.type} _enum={definitions.stream_types.enum} />
+    </div>
+  );
+};
+
+export default StreamTypesObject;

src/features/Apiexplorer/Schema/Schema.module.scss

@@ -34,6 +34,7 @@
   display: flex;
   flex-direction: row;
   position: relative;
+  gap: rem(0.8);
 
   p {
     color: var(--ifm-color-white);
@@ -301,3 +302,74 @@
 .reactJsonView {
   margin-bottom: rem(2.4);
 }
+
+.streamTypesContainer {
+  border-radius: 6px;
+  margin-top: rem(1);
+  margin-bottom: rem(2.4);
+
+  .streamTypesBody {
+    background-color: rgba(219, 219, 219, 0.05);
+    display: flex;
+    padding: rem(1);
+
+    .streamTypesObject {
+      display: flex;
+      flex-wrap: wrap;
+      gap: rem(0.8);
+      align-items: center;
+
+      .enumLabel {
+        font-size: rem(1.4);
+        line-height: rem(1.4);
+        color: var(--ifm-color-emphasis-200);
+      }
+
+      .enumType {
+        font-size: rem(1.4);
+        &.string {
+          color: var(--schema-string);
+        }
+      }
+
+      .enumLabel,
+      .enumType {
+        display: flex;
+        justify-content: center;
+        align-items: center;
+      }
+
+      .schemaEnums {
+        width: fit-content;
+        height: fit-content;
+        font-size: rem(1.4);
+        line-height: rem(1.4);
+        color: var(--ifm-color-success-light);
+        border: none;
+        padding: rem(0.6) rem(0.8);
+        border-radius: 4px;
+        background-color: rgba(0, 255, 104, 0.16);
+      }
+    }
+  }
+
+  .streamTypesHeader {
+    padding: rem(1);
+    border: none;
+    background: #151717;
+
+    .streamTypesTitle {
+      font-size: rem(1.6);
+      color: var(--ifm-color-white);
+      font-weight: bold;
+    }
+    .streamTypesDescription {
+      display: flex;
+      padding: rem(0.5) 0;
+      gap: rem(2);
+      justify-content: space-between;
+      color: var(--ifm-color-white);
+      font-size: rem(1.4);
+    }
+  }
+}

src/features/Apiexplorer/Schema/SchemaProperties/index.tsx

@@ -32,6 +32,7 @@ const SchemaProperties = ({ jsonSchema }: TJsonSchemaType) => {
           is_open
           properties={jsonSchema.properties}
           value={jsonSchema.properties}
+          jsonSchema={jsonSchema}
         />
       )}
     </React.Fragment>