feat: updated schema of config and docs + common bump

.changeset/lovely-elephants-dream.md

@@ -0,0 +1,5 @@
+---
+'@ballerine/common': patch
+---
+
+updated types and functionalities

apps/backoffice-v2/src/domains/workflows/fetchers.ts

@@ -62,7 +62,7 @@ export const BaseWorkflowByIdSchema = z.object({
   workflowDefinition: ObjectWithIdSchema.extend({
     name: z.string(),
     contextSchema: z.record(z.any(), z.any()).nullable(),
-    documentsSchema: z.record(z.string(), z.any()).optional(),
+    documentsSchema: z.array(z.any()).optional(),
     config: z.record(z.any(), z.any()).nullable(),
   }),
   createdAt: z.string().datetime(),

apps/backoffice-v2/src/pages/Entity/hooks/useTasks/useTasks.tsx

@@ -15,8 +15,8 @@ import {
   getDocumentSchemaByDefinition,
   isNullish,
   StateTag,
+  TAvailableDocuments,
   TDocument,
-  TDocumentsWithAvailability,
 } from '@ballerine/common';
 import * as React from 'react';
 import { ComponentProps, useMemo } from 'react';
@@ -45,32 +45,35 @@ const pluginsOutputBlacklist = [
 ];
 
 function getDocumentsSchemas(issuerCountryCode, workflow: TWorkflowById) {
-  return (
+  const data = getDocumentSchemaByDefinition(
+    issuerCountryCode,
+    workflow.workflowDefinition?.documentsSchema as TDocument[],
+  );
+  const filters =
     issuerCountryCode &&
-    getDocumentSchemaByDefinition(
-      issuerCountryCode,
-      workflow.workflowDefinition?.documentsSchema as TDocumentsWithAvailability,
-    )
+    data
       .concat(getDocumentsByCountry(issuerCountryCode))
       .reduce((unique: TDocument[], item: TDocument) => {
         const isDuplicate = unique.some(u => u.type === item.type && u.category === item.category);
         if (!isDuplicate) {
           unique.push(item);
         }
         return unique;
-      }, [] as TDocument[])
-      .filter((documentSchema: TDocument) => {
-        if (!workflow.workflowDefinition.documentsSchema?.availableDocuments) return true;
+      }, [] as TDocument[]);
 
-        const isInside = !!workflow.workflowDefinition.documentsSchema?.availableDocuments.find(
-          (availableDocument: TDocumentsWithAvailability['availableDocuments'][number]) =>
-            availableDocument.type === documentSchema.type &&
-            availableDocument.category === documentSchema.category,
-        );
+  const filteredDocs = filters.filter((documentSchema: TDocument) => {
+    if (!workflow.workflowDefinition.config?.availableDocuments) return true;
 
-        return isInside;
-      })
-  );
+    const isIncludes = !!workflow.workflowDefinition.config?.availableDocuments.find(
+      (availableDocument: TAvailableDocuments[number]) =>
+        availableDocument.type === documentSchema.type &&
+        availableDocument.category === documentSchema.category,
+    );
+
+    return isIncludes;
+  });
+  debugger;
+  return filteredDocs;
 }
 
 export const useTasks = ({
@@ -134,7 +137,7 @@ export const useTasks = ({
   const issuerCountryCode = extractCountryCodeFromWorkflow(workflow);
 
   const documentsSchemas = getDocumentsSchemas(issuerCountryCode, workflow);
-
+  debugger;
   const registryInfoBlock =
     Object.keys(filteredPluginsOutput ?? {}).length === 0
       ? []

packages/common/src/index.ts

@@ -25,7 +25,7 @@ export type {
   DefaultContextSchema,
   TDefaultSchemaDocumentPage,
   TDocument,
-  TDocumentsWithAvailability,
+  TAvailableDocuments,
 } from './schemas';
 
 export {

packages/common/src/schemas/documents/workflow/documents/schemas/index.ts

@@ -1,5 +1,5 @@
 import { getGhanaDocuments } from './GH';
-import { TDocument, TDocumentsWithAvailability } from '../types';
+import { TDocument } from '../types';
 import { countryCodes } from '@/countries';
 import { DefaultContextSchema } from '@/schemas';
 import { getCanadaDocuments } from './CA';
@@ -19,12 +19,10 @@ export const getDocumentsByCountry = (countryCode: (typeof countryCodes)[number]
 
 export const getDocumentSchemaByDefinition = (
   countryCode: (typeof countryCodes)[number],
-  documentsSchema: TDocumentsWithAvailability | undefined,
+  documentsSchema: TDocument[] | undefined,
 ): TDocument[] => {
   return (
-    documentsSchema?.schema?.filter(
-      documentSchema => documentSchema.issuer.country === countryCode,
-    ) || []
+    documentsSchema?.filter(documentSchema => documentSchema.issuer.country === countryCode) || []
   );
 };
 

packages/common/src/schemas/documents/workflow/documents/types.ts

@@ -5,7 +5,4 @@ export type TDocument = Omit<DefaultContextSchema['documents'][number], 'pages'
   propertiesSchema: JSONSchema7;
 };
 
-export type TDocumentsWithAvailability = {
-  availableDocuments: Array<{ category: string; type: string }>;
-  schema: TDocument[];
-};
+export type TAvailableDocuments = Array<{ category: string; type: string }>;

packages/common/src/schemas/index.ts

@@ -4,5 +4,5 @@ export { defaultContextSchema } from './documents/default-context-schema';
 export { getGhanaDocuments } from './documents/workflow/documents/schemas/GH';
 export { getDocumentsByCountry, getDocumentId } from './documents/workflow/documents/schemas/index';
 export { type TDocument } from './documents/workflow/documents/types';
-export { type TDocumentsWithAvailability } from './documents/workflow/documents/types';
+export { type TAvailableDocuments } from './documents/workflow/documents/types';
 export { getDocumentSchemaByDefinition } from './documents/workflow/documents/schemas/index';

services/workflows-service/src/workflow/schemas/zod-schemas.ts

@@ -19,6 +19,7 @@ export const ConfigSchema = z
     isLockedDocumentCategoryAndType: z.boolean().optional(),
     allowMultipleActiveWorkflows: z.boolean().optional(),
     initialEvent: z.string().optional(),
+    availableDocuments: z.array(z.object({ category: z.string(), type: z.string() })).optional(),
     callbackResult: z
       .object({
         transformers: z.array(z.any()),

services/workflows-service/src/workflow/utils/add-properties-schema-to-document.ts

@@ -4,7 +4,6 @@ import {
   getDocumentsByCountry,
   isObject,
   TDocument,
-  type TDocumentsWithAvailability,
 } from '@ballerine/common';
 import { WorkflowDefinition } from '@prisma/client';
 
@@ -17,7 +16,7 @@ export const addPropertiesSchemaToDocument = (
     (documentSchema &&
       getPropertiesFromDefinition(
         document,
-        documentSchema as TDocumentsWithAvailability,
+        documentSchema as TDocument[],
         document?.issuer?.country,
       )) ||
     getPropertiesSchemaForDocument(document);
@@ -37,10 +36,10 @@ function getPropertiesSchemaForDocument(document: DefaultContextSchema['document
 
 const getPropertiesFromDefinition = (
   document: DefaultContextSchema['documents'][number],
-  documentsSchema: TDocumentsWithAvailability,
+  documentsSchema: TDocument[],
   countryCode: string,
 ): ReturnType<typeof getPropertiesSchemaForDocument> | undefined => {
-  const localizedDocumentSchemas = documentsSchema.schema.filter(
+  const localizedDocumentSchemas = documentsSchema.filter(
     documentSchema => documentSchema.issuer.country === countryCode,
   );