@strapi/plugin-documentation 0.0.0-experimental.62ce06180fe9a772eaeb3d43d238b26644f39f7c → 0.0.0-experimental.6340da17068c3bed7fb006e7bcc554c71129e282

package/dist/server/services/helpers/utils/clean-schema-attributes.mjs

@@ -0,0 +1,313 @@
+import getSchemaData from './get-schema-data.mjs';
+import pascalCase from './pascal-case.mjs';
+
+/**
+ * @description - Convert attribute component names to OpenAPI component names
+ *
+ * @returns OpenAPI component name
+ */ const convertComponentName = (component, isRef = false)=>{
+    const cleanComponentName = `${pascalCase(component)}Component`;
+    if (isRef) {
+        return `#/components/schemas/${cleanComponentName}`;
+    }
+    return cleanComponentName;
+};
+/**
+ * @description - Converts types found on attributes to OpenAPI acceptable data types
+ *
+ * @returns Attributes using OpenAPI acceptable data types
+ */ const cleanSchemaAttributes = (attributes, { typeMap = new Map(), isRequest = false, didAddStrapiComponentsToSchemas })=>{
+    const schemaAttributes = {};
+    for (const prop of Object.keys(attributes)){
+        const attribute = attributes[prop];
+        switch(attribute.type){
+            case 'password':
+                {
+                    if (!isRequest) {
+                        break;
+                    }
+                    schemaAttributes[prop] = {
+                        type: 'string',
+                        format: 'password',
+                        example: '*******'
+                    };
+                    break;
+                }
+            case 'email':
+                {
+                    schemaAttributes[prop] = {
+                        type: 'string',
+                        format: 'email'
+                    };
+                    break;
+                }
+            case 'string':
+            case 'text':
+            case 'richtext':
+                {
+                    schemaAttributes[prop] = {
+                        type: 'string'
+                    };
+                    break;
+                }
+            case 'timestamp':
+                {
+                    schemaAttributes[prop] = {
+                        type: 'string',
+                        format: 'timestamp',
+                        example: Date.now()
+                    };
+                    break;
+                }
+            case 'time':
+                {
+                    schemaAttributes[prop] = {
+                        type: 'string',
+                        format: 'time',
+                        example: '12:54.000'
+                    };
+                    break;
+                }
+            case 'date':
+                {
+                    schemaAttributes[prop] = {
+                        type: 'string',
+                        format: 'date'
+                    };
+                    break;
+                }
+            case 'datetime':
+                {
+                    schemaAttributes[prop] = {
+                        type: 'string',
+                        format: 'date-time'
+                    };
+                    break;
+                }
+            case 'boolean':
+                {
+                    schemaAttributes[prop] = {
+                        type: 'boolean'
+                    };
+                    break;
+                }
+            case 'enumeration':
+                {
+                    schemaAttributes[prop] = {
+                        type: 'string',
+                        enum: [
+                            ...attribute.enum
+                        ]
+                    };
+                    break;
+                }
+            case 'decimal':
+            case 'float':
+                {
+                    schemaAttributes[prop] = {
+                        type: 'number',
+                        format: 'float'
+                    };
+                    break;
+                }
+            case 'integer':
+                {
+                    schemaAttributes[prop] = {
+                        type: 'integer'
+                    };
+                    break;
+                }
+            case 'biginteger':
+                {
+                    schemaAttributes[prop] = {
+                        type: 'string',
+                        pattern: '^\\d*$',
+                        example: '123456789'
+                    };
+                    break;
+                }
+            case 'json':
+            case 'blocks':
+                {
+                    schemaAttributes[prop] = {};
+                    break;
+                }
+            case 'uid':
+                {
+                    schemaAttributes[prop] = {
+                        type: 'string'
+                    };
+                    break;
+                }
+            case 'component':
+                {
+                    const componentAttributes = strapi.components[attribute.component].attributes;
+                    const rawComponentSchema = {
+                        type: 'object',
+                        properties: {
+                            ...isRequest ? {} : {
+                                id: {
+                                    oneOf: [
+                                        {
+                                            type: 'string'
+                                        },
+                                        {
+                                            type: 'number'
+                                        }
+                                    ]
+                                }
+                            },
+                            ...cleanSchemaAttributes(componentAttributes, {
+                                typeMap,
+                                isRequest,
+                                didAddStrapiComponentsToSchemas
+                            })
+                        }
+                    };
+                    const refComponentSchema = {
+                        $ref: convertComponentName(attribute.component, true)
+                    };
+                    const componentExists = didAddStrapiComponentsToSchemas(convertComponentName(attribute.component), rawComponentSchema);
+                    const finalComponentSchema = componentExists ? refComponentSchema : rawComponentSchema;
+                    if (attribute.repeatable) {
+                        schemaAttributes[prop] = {
+                            type: 'array',
+                            items: finalComponentSchema
+                        };
+                    } else {
+                        schemaAttributes[prop] = finalComponentSchema;
+                    }
+                    break;
+                }
+            case 'dynamiczone':
+                {
+                    const components = attribute.components.map((component)=>{
+                        const componentAttributes = strapi.components[component].attributes;
+                        const rawComponentSchema = {
+                            type: 'object',
+                            properties: {
+                                ...isRequest ? {} : {
+                                    id: {
+                                        oneOf: [
+                                            {
+                                                type: 'string'
+                                            },
+                                            {
+                                                type: 'number'
+                                            }
+                                        ]
+                                    }
+                                },
+                                __component: {
+                                    type: 'string',
+                                    enum: [
+                                        component
+                                    ]
+                                },
+                                ...cleanSchemaAttributes(componentAttributes, {
+                                    typeMap,
+                                    isRequest,
+                                    didAddStrapiComponentsToSchemas
+                                })
+                            }
+                        };
+                        const refComponentSchema = {
+                            $ref: convertComponentName(component, true)
+                        };
+                        const componentExists = didAddStrapiComponentsToSchemas(convertComponentName(component), rawComponentSchema);
+                        const finalComponentSchema = componentExists ? refComponentSchema : rawComponentSchema;
+                        return finalComponentSchema;
+                    });
+                    let discriminator;
+                    if (components.every((component)=>Object.hasOwn(component, '$ref'))) {
+                        discriminator = {
+                            propertyName: '__component',
+                            mapping: attribute.components.reduce((acc, component)=>{
+                                acc[component] = convertComponentName(component, true);
+                                return acc;
+                            }, {})
+                        };
+                    }
+                    schemaAttributes[prop] = {
+                        type: 'array',
+                        items: {
+                            anyOf: components
+                        },
+                        discriminator
+                    };
+                    break;
+                }
+            case 'media':
+                {
+                    const imageAttributes = strapi.contentType('plugin::upload.file').attributes;
+                    const isListOfEntities = attribute.multiple ?? false;
+                    if (isRequest) {
+                        const oneOfType = {
+                            oneOf: [
+                                {
+                                    type: 'integer'
+                                },
+                                {
+                                    type: 'string'
+                                }
+                            ],
+                            example: 'string or id'
+                        };
+                        schemaAttributes[prop] = isListOfEntities ? {
+                            type: 'array',
+                            items: oneOfType
+                        } : oneOfType;
+                        break;
+                    }
+                    schemaAttributes[prop] = getSchemaData(isListOfEntities, cleanSchemaAttributes(imageAttributes, {
+                        typeMap,
+                        didAddStrapiComponentsToSchemas
+                    }));
+                    break;
+                }
+            case 'relation':
+                {
+                    const isListOfEntities = attribute.relation.includes('ToMany');
+                    if (isRequest) {
+                        const oneOfType = {
+                            oneOf: [
+                                {
+                                    type: 'integer'
+                                },
+                                {
+                                    type: 'string'
+                                }
+                            ],
+                            example: 'string or id'
+                        };
+                        schemaAttributes[prop] = isListOfEntities ? {
+                            type: 'array',
+                            items: oneOfType
+                        } : oneOfType;
+                        break;
+                    }
+                    if (!('target' in attribute) || !attribute.target || typeMap.has(attribute.target)) {
+                        schemaAttributes[prop] = getSchemaData(isListOfEntities, {});
+                        break;
+                    }
+                    typeMap.set(attribute.target, true);
+                    const targetAttributes = strapi.contentType(attribute.target).attributes;
+                    schemaAttributes[prop] = getSchemaData(isListOfEntities, cleanSchemaAttributes(targetAttributes, {
+                        typeMap,
+                        isRequest,
+                        didAddStrapiComponentsToSchemas
+                    }));
+                    break;
+                }
+            default:
+                {
+                    // @ts-expect-error - This is a catch all for any other types
+                    throw new Error(`Invalid type ${attribute.type} while generating open api schema.`);
+                }
+        }
+    }
+    return schemaAttributes;
+};
+
+export { cleanSchemaAttributes as default };
+//# sourceMappingURL=clean-schema-attributes.mjs.map

package/dist/server/services/helpers/utils/clean-schema-attributes.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"clean-schema-attributes.mjs","sources":["../../../../../server/src/services/helpers/utils/clean-schema-attributes.ts"],"sourcesContent":["import type { Struct } from '@strapi/types';\nimport type { OpenAPIV3 } from 'openapi-types';\n\nimport getSchemaData from './get-schema-data';\nimport pascalCase from './pascal-case';\n\ninterface Options {\n  typeMap?: Map<string, boolean>;\n  isRequest?: boolean;\n  didAddStrapiComponentsToSchemas: (name: string, schema: object) => boolean;\n}\n\n/**\n * @description - Convert attribute component names to OpenAPI component names\n *\n * @returns OpenAPI component name\n */\nconst convertComponentName = (component: string, isRef = false): string => {\n  const cleanComponentName = `${pascalCase(component)}Component`;\n\n  if (isRef) {\n    return `#/components/schemas/${cleanComponentName}`;\n  }\n  return cleanComponentName;\n};\n\n/**\n * @description - Converts types found on attributes to OpenAPI acceptable data types\n *\n * @returns Attributes using OpenAPI acceptable data types\n */\nconst cleanSchemaAttributes = (\n  attributes: Struct.SchemaAttributes,\n  { typeMap = new Map(), isRequest = false, didAddStrapiComponentsToSchemas }: Options\n): Record<string, OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject> => {\n  const schemaAttributes: Record<string, OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject> = {};\n\n  for (const prop of Object.keys(attributes)) {\n    const attribute = attributes[prop];\n\n    switch (attribute.type) {\n      case 'password': {\n        if (!isRequest) {\n          break;\n        }\n\n        schemaAttributes[prop] = { type: 'string', format: 'password', example: '*******' };\n        break;\n      }\n      case 'email': {\n        schemaAttributes[prop] = { type: 'string', format: 'email' };\n        break;\n      }\n      case 'string':\n      case 'text':\n      case 'richtext': {\n        schemaAttributes[prop] = { type: 'string' };\n        break;\n      }\n      case 'timestamp': {\n        schemaAttributes[prop] = { type: 'string', format: 'timestamp', example: Date.now() };\n        break;\n      }\n      case 'time': {\n        schemaAttributes[prop] = { type: 'string', format: 'time', example: '12:54.000' };\n        break;\n      }\n      case 'date': {\n        schemaAttributes[prop] = { type: 'string', format: 'date' };\n        break;\n      }\n      case 'datetime': {\n        schemaAttributes[prop] = { type: 'string', format: 'date-time' };\n        break;\n      }\n      case 'boolean': {\n        schemaAttributes[prop] = { type: 'boolean' };\n        break;\n      }\n      case 'enumeration': {\n        schemaAttributes[prop] = { type: 'string', enum: [...attribute.enum] };\n        break;\n      }\n      case 'decimal':\n      case 'float': {\n        schemaAttributes[prop] = { type: 'number', format: 'float' };\n        break;\n      }\n      case 'integer': {\n        schemaAttributes[prop] = { type: 'integer' };\n        break;\n      }\n      case 'biginteger': {\n        schemaAttributes[prop] = { type: 'string', pattern: '^\\\\d*$', example: '123456789' };\n        break;\n      }\n      case 'json':\n      case 'blocks': {\n        schemaAttributes[prop] = {};\n        break;\n      }\n      case 'uid': {\n        schemaAttributes[prop] = { type: 'string' };\n        break;\n      }\n      case 'component': {\n        const componentAttributes = strapi.components[attribute.component].attributes;\n        const rawComponentSchema: OpenAPIV3.SchemaObject = {\n          type: 'object',\n          properties: {\n            ...(isRequest ? {} : { id: { oneOf: [{ type: 'string' }, { type: 'number' }] } }),\n            ...cleanSchemaAttributes(componentAttributes, {\n              typeMap,\n              isRequest,\n              didAddStrapiComponentsToSchemas,\n            }),\n          },\n        };\n\n        const refComponentSchema: OpenAPIV3.ReferenceObject = {\n          $ref: convertComponentName(attribute.component, true),\n        };\n\n        const componentExists = didAddStrapiComponentsToSchemas(\n          convertComponentName(attribute.component),\n          rawComponentSchema\n        );\n\n        const finalComponentSchema = componentExists ? refComponentSchema : rawComponentSchema;\n        if (attribute.repeatable) {\n          schemaAttributes[prop] = {\n            type: 'array',\n            items: finalComponentSchema,\n          };\n        } else {\n          schemaAttributes[prop] = finalComponentSchema;\n        }\n        break;\n      }\n      case 'dynamiczone': {\n        const components = attribute.components.map((component) => {\n          const componentAttributes = strapi.components[component].attributes;\n          const rawComponentSchema: OpenAPIV3.SchemaObject = {\n            type: 'object',\n            properties: {\n              ...(isRequest ? {} : { id: { oneOf: [{ type: 'string' }, { type: 'number' }] } }),\n              __component: { type: 'string', enum: [component] },\n              ...cleanSchemaAttributes(componentAttributes, {\n                typeMap,\n                isRequest,\n                didAddStrapiComponentsToSchemas,\n              }),\n            },\n          };\n\n          const refComponentSchema: OpenAPIV3.ReferenceObject = {\n            $ref: convertComponentName(component, true),\n          };\n\n          const componentExists = didAddStrapiComponentsToSchemas(\n            convertComponentName(component),\n            rawComponentSchema\n          );\n          const finalComponentSchema = componentExists ? refComponentSchema : rawComponentSchema;\n          return finalComponentSchema;\n        });\n        let discriminator: OpenAPIV3.DiscriminatorObject | undefined;\n        if (components.every((component) => Object.hasOwn(component, '$ref'))) {\n          discriminator = {\n            propertyName: '__component',\n            mapping: attribute.components.reduce(\n              (acc, component) => {\n                acc[component] = convertComponentName(component, true);\n                return acc;\n              },\n              {} as {\n                [value: string]: string;\n              }\n            ),\n          };\n        }\n\n        schemaAttributes[prop] = {\n          type: 'array',\n          items: {\n            anyOf: components,\n          },\n          discriminator,\n        };\n        break;\n      }\n      case 'media': {\n        const imageAttributes = strapi.contentType('plugin::upload.file').attributes;\n        const isListOfEntities = attribute.multiple ?? false;\n\n        if (isRequest) {\n          const oneOfType: OpenAPIV3.SchemaObject = {\n            oneOf: [{ type: 'integer' }, { type: 'string' }],\n            example: 'string or id',\n          };\n\n          schemaAttributes[prop] = isListOfEntities\n            ? { type: 'array', items: oneOfType }\n            : oneOfType;\n          break;\n        }\n\n        schemaAttributes[prop] = getSchemaData(\n          isListOfEntities,\n          cleanSchemaAttributes(imageAttributes, { typeMap, didAddStrapiComponentsToSchemas })\n        );\n        break;\n      }\n\n      case 'relation': {\n        const isListOfEntities = attribute.relation.includes('ToMany');\n\n        if (isRequest) {\n          const oneOfType: OpenAPIV3.SchemaObject = {\n            oneOf: [{ type: 'integer' }, { type: 'string' }],\n            example: 'string or id',\n          };\n\n          schemaAttributes[prop] = isListOfEntities\n            ? { type: 'array', items: oneOfType }\n            : oneOfType;\n          break;\n        }\n\n        if (!('target' in attribute) || !attribute.target || typeMap.has(attribute.target)) {\n          schemaAttributes[prop] = getSchemaData(isListOfEntities, {});\n\n          break;\n        }\n\n        typeMap.set(attribute.target, true);\n        const targetAttributes = strapi.contentType(attribute.target).attributes;\n\n        schemaAttributes[prop] = getSchemaData(\n          isListOfEntities,\n          cleanSchemaAttributes(targetAttributes, {\n            typeMap,\n            isRequest,\n            didAddStrapiComponentsToSchemas,\n          })\n        );\n\n        break;\n      }\n      default: {\n        // @ts-expect-error - This is a catch all for any other types\n        throw new Error(`Invalid type ${attribute.type} while generating open api schema.`);\n      }\n    }\n  }\n\n  return schemaAttributes;\n};\n\nexport default cleanSchemaAttributes;\n"],"names":["convertComponentName","component","isRef","cleanComponentName","pascalCase","cleanSchemaAttributes","attributes","typeMap","Map","isRequest","didAddStrapiComponentsToSchemas","schemaAttributes","prop","Object","keys","attribute","type","format","example","Date","now","enum","pattern","componentAttributes","strapi","components","rawComponentSchema","properties","id","oneOf","refComponentSchema","$ref","componentExists","finalComponentSchema","repeatable","items","map","__component","discriminator","every","hasOwn","propertyName","mapping","reduce","acc","anyOf","imageAttributes","contentType","isListOfEntities","multiple","oneOfType","getSchemaData","relation","includes","target","has","set","targetAttributes","Error"],"mappings":";;;AAYA;;;;AAIC,IACD,MAAMA,oBAAAA,GAAuB,CAACC,SAAAA,EAAmBC,QAAQ,KAAK,GAAA;AAC5D,IAAA,MAAMC,kBAAAA,GAAqB,CAAA,EAAGC,UAAAA,CAAWH,SAAAA,CAAAA,CAAW,SAAS,CAAC;AAE9D,IAAA,IAAIC,KAAAA,EAAO;QACT,OAAO,CAAC,qBAAqB,EAAEC,kBAAAA,CAAAA,CAAoB;AACrD,IAAA;IACA,OAAOA,kBAAAA;AACT,CAAA;AAEA;;;;AAIC,IACD,MAAME,qBAAAA,GAAwB,CAC5BC,UAAAA,EACA,EAAEC,OAAAA,GAAU,IAAIC,GAAAA,EAAK,EAAEC,SAAAA,GAAY,KAAK,EAAEC,+BAA+B,EAAW,GAAA;AAEpF,IAAA,MAAMC,mBAAuF,EAAC;AAE9F,IAAA,KAAK,MAAMC,IAAAA,IAAQC,MAAAA,CAAOC,IAAI,CAACR,UAAAA,CAAAA,CAAa;QAC1C,MAAMS,SAAAA,GAAYT,UAAU,CAACM,IAAAA,CAAK;AAElC,QAAA,OAAQG,UAAUC,IAAI;YACpB,KAAK,UAAA;AAAY,gBAAA;AACf,oBAAA,IAAI,CAACP,SAAAA,EAAW;AACd,wBAAA;AACF,oBAAA;oBAEAE,gBAAgB,CAACC,KAAK,GAAG;wBAAEI,IAAAA,EAAM,QAAA;wBAAUC,MAAAA,EAAQ,UAAA;wBAAYC,OAAAA,EAAS;AAAU,qBAAA;AAClF,oBAAA;AACF,gBAAA;YACA,KAAK,OAAA;AAAS,gBAAA;oBACZP,gBAAgB,CAACC,KAAK,GAAG;wBAAEI,IAAAA,EAAM,QAAA;wBAAUC,MAAAA,EAAQ;AAAQ,qBAAA;AAC3D,oBAAA;AACF,gBAAA;YACA,KAAK,QAAA;YACL,KAAK,MAAA;YACL,KAAK,UAAA;AAAY,gBAAA;oBACfN,gBAAgB,CAACC,KAAK,GAAG;wBAAEI,IAAAA,EAAM;AAAS,qBAAA;AAC1C,oBAAA;AACF,gBAAA;YACA,KAAK,WAAA;AAAa,gBAAA;oBAChBL,gBAAgB,CAACC,KAAK,GAAG;wBAAEI,IAAAA,EAAM,QAAA;wBAAUC,MAAAA,EAAQ,WAAA;AAAaC,wBAAAA,OAAAA,EAASC,KAAKC,GAAG;AAAG,qBAAA;AACpF,oBAAA;AACF,gBAAA;YACA,KAAK,MAAA;AAAQ,gBAAA;oBACXT,gBAAgB,CAACC,KAAK,GAAG;wBAAEI,IAAAA,EAAM,QAAA;wBAAUC,MAAAA,EAAQ,MAAA;wBAAQC,OAAAA,EAAS;AAAY,qBAAA;AAChF,oBAAA;AACF,gBAAA;YACA,KAAK,MAAA;AAAQ,gBAAA;oBACXP,gBAAgB,CAACC,KAAK,GAAG;wBAAEI,IAAAA,EAAM,QAAA;wBAAUC,MAAAA,EAAQ;AAAO,qBAAA;AAC1D,oBAAA;AACF,gBAAA;YACA,KAAK,UAAA;AAAY,gBAAA;oBACfN,gBAAgB,CAACC,KAAK,GAAG;wBAAEI,IAAAA,EAAM,QAAA;wBAAUC,MAAAA,EAAQ;AAAY,qBAAA;AAC/D,oBAAA;AACF,gBAAA;YACA,KAAK,SAAA;AAAW,gBAAA;oBACdN,gBAAgB,CAACC,KAAK,GAAG;wBAAEI,IAAAA,EAAM;AAAU,qBAAA;AAC3C,oBAAA;AACF,gBAAA;YACA,KAAK,aAAA;AAAe,gBAAA;oBAClBL,gBAAgB,CAACC,KAAK,GAAG;wBAAEI,IAAAA,EAAM,QAAA;wBAAUK,IAAAA,EAAM;AAAIN,4BAAAA,GAAAA,SAAAA,CAAUM;AAAK;AAAC,qBAAA;AACrE,oBAAA;AACF,gBAAA;YACA,KAAK,SAAA;YACL,KAAK,OAAA;AAAS,gBAAA;oBACZV,gBAAgB,CAACC,KAAK,GAAG;wBAAEI,IAAAA,EAAM,QAAA;wBAAUC,MAAAA,EAAQ;AAAQ,qBAAA;AAC3D,oBAAA;AACF,gBAAA;YACA,KAAK,SAAA;AAAW,gBAAA;oBACdN,gBAAgB,CAACC,KAAK,GAAG;wBAAEI,IAAAA,EAAM;AAAU,qBAAA;AAC3C,oBAAA;AACF,gBAAA;YACA,KAAK,YAAA;AAAc,gBAAA;oBACjBL,gBAAgB,CAACC,KAAK,GAAG;wBAAEI,IAAAA,EAAM,QAAA;wBAAUM,OAAAA,EAAS,QAAA;wBAAUJ,OAAAA,EAAS;AAAY,qBAAA;AACnF,oBAAA;AACF,gBAAA;YACA,KAAK,MAAA;YACL,KAAK,QAAA;AAAU,gBAAA;oBACbP,gBAAgB,CAACC,IAAAA,CAAK,GAAG,EAAC;AAC1B,oBAAA;AACF,gBAAA;YACA,KAAK,KAAA;AAAO,gBAAA;oBACVD,gBAAgB,CAACC,KAAK,GAAG;wBAAEI,IAAAA,EAAM;AAAS,qBAAA;AAC1C,oBAAA;AACF,gBAAA;YACA,KAAK,WAAA;AAAa,gBAAA;oBAChB,MAAMO,mBAAAA,GAAsBC,OAAOC,UAAU,CAACV,UAAUd,SAAS,CAAC,CAACK,UAAU;AAC7E,oBAAA,MAAMoB,kBAAAA,GAA6C;wBACjDV,IAAAA,EAAM,QAAA;wBACNW,UAAAA,EAAY;4BACV,GAAIlB,SAAAA,GAAY,EAAC,GAAI;gCAAEmB,EAAAA,EAAI;oCAAEC,KAAAA,EAAO;AAAC,wCAAA;4CAAEb,IAAAA,EAAM;AAAS,yCAAA;AAAG,wCAAA;4CAAEA,IAAAA,EAAM;AAAS;AAAE;AAAC;6BAAG;AAChF,4BAAA,GAAGX,sBAAsBkB,mBAAAA,EAAqB;AAC5ChB,gCAAAA,OAAAA;AACAE,gCAAAA,SAAAA;AACAC,gCAAAA;6BACF;AACF;AACF,qBAAA;AAEA,oBAAA,MAAMoB,kBAAAA,GAAgD;wBACpDC,IAAAA,EAAM/B,oBAAAA,CAAqBe,SAAAA,CAAUd,SAAS,EAAE,IAAA;AAClD,qBAAA;AAEA,oBAAA,MAAM+B,eAAAA,GAAkBtB,+BAAAA,CACtBV,oBAAAA,CAAqBe,SAAAA,CAAUd,SAAS,CAAA,EACxCyB,kBAAAA,CAAAA;oBAGF,MAAMO,oBAAAA,GAAuBD,kBAAkBF,kBAAAA,GAAqBJ,kBAAAA;oBACpE,IAAIX,SAAAA,CAAUmB,UAAU,EAAE;wBACxBvB,gBAAgB,CAACC,KAAK,GAAG;4BACvBI,IAAAA,EAAM,OAAA;4BACNmB,KAAAA,EAAOF;AACT,yBAAA;oBACF,CAAA,MAAO;wBACLtB,gBAAgB,CAACC,KAAK,GAAGqB,oBAAAA;AAC3B,oBAAA;AACA,oBAAA;AACF,gBAAA;YACA,KAAK,aAAA;AAAe,gBAAA;AAClB,oBAAA,MAAMR,aAAaV,SAAAA,CAAUU,UAAU,CAACW,GAAG,CAAC,CAACnC,SAAAA,GAAAA;AAC3C,wBAAA,MAAMsB,sBAAsBC,MAAAA,CAAOC,UAAU,CAACxB,SAAAA,CAAU,CAACK,UAAU;AACnE,wBAAA,MAAMoB,kBAAAA,GAA6C;4BACjDV,IAAAA,EAAM,QAAA;4BACNW,UAAAA,EAAY;gCACV,GAAIlB,SAAAA,GAAY,EAAC,GAAI;oCAAEmB,EAAAA,EAAI;wCAAEC,KAAAA,EAAO;AAAC,4CAAA;gDAAEb,IAAAA,EAAM;AAAS,6CAAA;AAAG,4CAAA;gDAAEA,IAAAA,EAAM;AAAS;AAAE;AAAC;iCAAG;gCAChFqB,WAAAA,EAAa;oCAAErB,IAAAA,EAAM,QAAA;oCAAUK,IAAAA,EAAM;AAACpB,wCAAAA;AAAU;AAAC,iCAAA;AACjD,gCAAA,GAAGI,sBAAsBkB,mBAAAA,EAAqB;AAC5ChB,oCAAAA,OAAAA;AACAE,oCAAAA,SAAAA;AACAC,oCAAAA;iCACF;AACF;AACF,yBAAA;AAEA,wBAAA,MAAMoB,kBAAAA,GAAgD;AACpDC,4BAAAA,IAAAA,EAAM/B,qBAAqBC,SAAAA,EAAW,IAAA;AACxC,yBAAA;wBAEA,MAAM+B,eAAAA,GAAkBtB,+BAAAA,CACtBV,oBAAAA,CAAqBC,SAAAA,CAAAA,EACrByB,kBAAAA,CAAAA;wBAEF,MAAMO,oBAAAA,GAAuBD,kBAAkBF,kBAAAA,GAAqBJ,kBAAAA;wBACpE,OAAOO,oBAAAA;AACT,oBAAA,CAAA,CAAA;oBACA,IAAIK,aAAAA;oBACJ,IAAIb,UAAAA,CAAWc,KAAK,CAAC,CAACtC,YAAcY,MAAAA,CAAO2B,MAAM,CAACvC,SAAAA,EAAW,MAAA,CAAA,CAAA,EAAU;wBACrEqC,aAAAA,GAAgB;4BACdG,YAAAA,EAAc,aAAA;AACdC,4BAAAA,OAAAA,EAAS3B,UAAUU,UAAU,CAACkB,MAAM,CAClC,CAACC,GAAAA,EAAK3C,SAAAA,GAAAA;AACJ2C,gCAAAA,GAAG,CAAC3C,SAAAA,CAAU,GAAGD,oBAAAA,CAAqBC,SAAAA,EAAW,IAAA,CAAA;gCACjD,OAAO2C,GAAAA;AACT,4BAAA,CAAA,EACA,EAAC;AAIL,yBAAA;AACF,oBAAA;oBAEAjC,gBAAgB,CAACC,KAAK,GAAG;wBACvBI,IAAAA,EAAM,OAAA;wBACNmB,KAAAA,EAAO;4BACLU,KAAAA,EAAOpB;AACT,yBAAA;AACAa,wBAAAA;AACF,qBAAA;AACA,oBAAA;AACF,gBAAA;YACA,KAAK,OAAA;AAAS,gBAAA;AACZ,oBAAA,MAAMQ,eAAAA,GAAkBtB,MAAAA,CAAOuB,WAAW,CAAC,uBAAuBzC,UAAU;oBAC5E,MAAM0C,gBAAAA,GAAmBjC,SAAAA,CAAUkC,QAAQ,IAAI,KAAA;AAE/C,oBAAA,IAAIxC,SAAAA,EAAW;AACb,wBAAA,MAAMyC,SAAAA,GAAoC;4BACxCrB,KAAAA,EAAO;AAAC,gCAAA;oCAAEb,IAAAA,EAAM;AAAU,iCAAA;AAAG,gCAAA;oCAAEA,IAAAA,EAAM;AAAS;AAAE,6BAAA;4BAChDE,OAAAA,EAAS;AACX,yBAAA;wBAEAP,gBAAgB,CAACC,IAAAA,CAAK,GAAGoC,gBAAAA,GACrB;4BAAEhC,IAAAA,EAAM,OAAA;4BAASmB,KAAAA,EAAOe;yBAAU,GAClCA,SAAAA;AACJ,wBAAA;AACF,oBAAA;AAEAvC,oBAAAA,gBAAgB,CAACC,IAAAA,CAAK,GAAGuC,aAAAA,CACvBH,gBAAAA,EACA3C,sBAAsByC,eAAAA,EAAiB;AAAEvC,wBAAAA,OAAAA;AAASG,wBAAAA;AAAgC,qBAAA,CAAA,CAAA;AAEpF,oBAAA;AACF,gBAAA;YAEA,KAAK,UAAA;AAAY,gBAAA;AACf,oBAAA,MAAMsC,gBAAAA,GAAmBjC,SAAAA,CAAUqC,QAAQ,CAACC,QAAQ,CAAC,QAAA,CAAA;AAErD,oBAAA,IAAI5C,SAAAA,EAAW;AACb,wBAAA,MAAMyC,SAAAA,GAAoC;4BACxCrB,KAAAA,EAAO;AAAC,gCAAA;oCAAEb,IAAAA,EAAM;AAAU,iCAAA;AAAG,gCAAA;oCAAEA,IAAAA,EAAM;AAAS;AAAE,6BAAA;4BAChDE,OAAAA,EAAS;AACX,yBAAA;wBAEAP,gBAAgB,CAACC,IAAAA,CAAK,GAAGoC,gBAAAA,GACrB;4BAAEhC,IAAAA,EAAM,OAAA;4BAASmB,KAAAA,EAAOe;yBAAU,GAClCA,SAAAA;AACJ,wBAAA;AACF,oBAAA;AAEA,oBAAA,IAAI,EAAE,QAAA,IAAYnC,SAAQ,KAAM,CAACA,SAAAA,CAAUuC,MAAM,IAAI/C,OAAAA,CAAQgD,GAAG,CAACxC,SAAAA,CAAUuC,MAAM,CAAA,EAAG;AAClF3C,wBAAAA,gBAAgB,CAACC,IAAAA,CAAK,GAAGuC,aAAAA,CAAcH,kBAAkB,EAAC,CAAA;AAE1D,wBAAA;AACF,oBAAA;AAEAzC,oBAAAA,OAAAA,CAAQiD,GAAG,CAACzC,SAAAA,CAAUuC,MAAM,EAAE,IAAA,CAAA;AAC9B,oBAAA,MAAMG,mBAAmBjC,MAAAA,CAAOuB,WAAW,CAAChC,SAAAA,CAAUuC,MAAM,EAAEhD,UAAU;AAExEK,oBAAAA,gBAAgB,CAACC,IAAAA,CAAK,GAAGuC,aAAAA,CACvBH,gBAAAA,EACA3C,sBAAsBoD,gBAAAA,EAAkB;AACtClD,wBAAAA,OAAAA;AACAE,wBAAAA,SAAAA;AACAC,wBAAAA;AACF,qBAAA,CAAA,CAAA;AAGF,oBAAA;AACF,gBAAA;AACA,YAAA;AAAS,gBAAA;;oBAEP,MAAM,IAAIgD,MAAM,CAAC,aAAa,EAAE3C,SAAAA,CAAUC,IAAI,CAAC,kCAAkC,CAAC,CAAA;AACpF,gBAAA;AACF;AACF,IAAA;IAEA,OAAOL,gBAAAA;AACT;;;;"}

package/dist/server/services/helpers/utils/get-api-responses.js

@@ -0,0 +1,88 @@
+'use strict';
+
+var pascalCase = require('./pascal-case.js');
+
+/**
+ * @description - Builds the Swagger response object for a given api
+ */ const getApiResponse = ({ uniqueName, route, isListOfEntities = false })=>{
+    const getSchema = ()=>{
+        if (route.method === 'DELETE') {
+            return {
+                type: 'integer',
+                format: 'int64'
+            };
+        }
+        if (isListOfEntities) {
+            return {
+                $ref: `#/components/schemas/${pascalCase(uniqueName)}ListResponse`
+            };
+        }
+        return {
+            $ref: `#/components/schemas/${pascalCase(uniqueName)}Response`
+        };
+    };
+    const schema = getSchema();
+    return {
+        200: {
+            description: 'OK',
+            content: {
+                'application/json': {
+                    schema
+                }
+            }
+        },
+        400: {
+            description: 'Bad Request',
+            content: {
+                'application/json': {
+                    schema: {
+                        $ref: '#/components/schemas/Error'
+                    }
+                }
+            }
+        },
+        401: {
+            description: 'Unauthorized',
+            content: {
+                'application/json': {
+                    schema: {
+                        $ref: '#/components/schemas/Error'
+                    }
+                }
+            }
+        },
+        403: {
+            description: 'Forbidden',
+            content: {
+                'application/json': {
+                    schema: {
+                        $ref: '#/components/schemas/Error'
+                    }
+                }
+            }
+        },
+        404: {
+            description: 'Not Found',
+            content: {
+                'application/json': {
+                    schema: {
+                        $ref: '#/components/schemas/Error'
+                    }
+                }
+            }
+        },
+        500: {
+            description: 'Internal Server Error',
+            content: {
+                'application/json': {
+                    schema: {
+                        $ref: '#/components/schemas/Error'
+                    }
+                }
+            }
+        }
+    };
+};
+
+module.exports = getApiResponse;
+//# sourceMappingURL=get-api-responses.js.map

package/dist/server/services/helpers/utils/get-api-responses.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-api-responses.js","sources":["../../../../../server/src/services/helpers/utils/get-api-responses.ts"],"sourcesContent":["import type { OpenAPIV3 } from 'openapi-types';\nimport pascalCase from './pascal-case';\n\ninterface Options {\n  uniqueName: string;\n  route: {\n    method: string;\n  };\n  isListOfEntities?: boolean;\n  isLocalizationPath?: boolean;\n}\n\n/**\n * @description - Builds the Swagger response object for a given api\n */\nconst getApiResponse = ({\n  uniqueName,\n  route,\n  isListOfEntities = false,\n}: Options): OpenAPIV3.ResponsesObject => {\n  const getSchema = (): OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject => {\n    if (route.method === 'DELETE') {\n      return {\n        type: 'integer',\n        format: 'int64',\n      };\n    }\n\n    if (isListOfEntities) {\n      return { $ref: `#/components/schemas/${pascalCase(uniqueName)}ListResponse` };\n    }\n\n    return { $ref: `#/components/schemas/${pascalCase(uniqueName)}Response` };\n  };\n\n  const schema = getSchema();\n\n  return {\n    200: {\n      description: 'OK',\n      content: {\n        'application/json': {\n          schema,\n        },\n      },\n    },\n    400: {\n      description: 'Bad Request',\n      content: {\n        'application/json': {\n          schema: {\n            $ref: '#/components/schemas/Error',\n          },\n        },\n      },\n    },\n    401: {\n      description: 'Unauthorized',\n      content: {\n        'application/json': {\n          schema: {\n            $ref: '#/components/schemas/Error',\n          },\n        },\n      },\n    },\n    403: {\n      description: 'Forbidden',\n      content: {\n        'application/json': {\n          schema: {\n            $ref: '#/components/schemas/Error',\n          },\n        },\n      },\n    },\n    404: {\n      description: 'Not Found',\n      content: {\n        'application/json': {\n          schema: {\n            $ref: '#/components/schemas/Error',\n          },\n        },\n      },\n    },\n    500: {\n      description: 'Internal Server Error',\n      content: {\n        'application/json': {\n          schema: {\n            $ref: '#/components/schemas/Error',\n          },\n        },\n      },\n    },\n  };\n};\n\nexport default getApiResponse;\n"],"names":["getApiResponse","uniqueName","route","isListOfEntities","getSchema","method","type","format","$ref","pascalCase","schema","description","content"],"mappings":";;;;AAYA;;IAGA,MAAMA,cAAAA,GAAiB,CAAC,EACtBC,UAAU,EACVC,KAAK,EACLC,gBAAAA,GAAmB,KAAK,EAChB,GAAA;AACR,IAAA,MAAMC,SAAAA,GAAY,IAAA;QAChB,IAAIF,KAAAA,CAAMG,MAAM,KAAK,QAAA,EAAU;YAC7B,OAAO;gBACLC,IAAAA,EAAM,SAAA;gBACNC,MAAAA,EAAQ;AACV,aAAA;AACF,QAAA;AAEA,QAAA,IAAIJ,gBAAAA,EAAkB;YACpB,OAAO;AAAEK,gBAAAA,IAAAA,EAAM,CAAC,qBAAqB,EAAEC,UAAAA,CAAWR,UAAAA,CAAAA,CAAY,YAAY;AAAE,aAAA;AAC9E,QAAA;QAEA,OAAO;AAAEO,YAAAA,IAAAA,EAAM,CAAC,qBAAqB,EAAEC,UAAAA,CAAWR,UAAAA,CAAAA,CAAY,QAAQ;AAAE,SAAA;AAC1E,IAAA,CAAA;AAEA,IAAA,MAAMS,MAAAA,GAASN,SAAAA,EAAAA;IAEf,OAAO;QACL,GAAA,EAAK;YACHO,WAAAA,EAAa,IAAA;YACbC,OAAAA,EAAS;gBACP,kBAAA,EAAoB;AAClBF,oBAAAA;AACF;AACF;AACF,SAAA;QACA,GAAA,EAAK;YACHC,WAAAA,EAAa,aAAA;YACbC,OAAAA,EAAS;gBACP,kBAAA,EAAoB;oBAClBF,MAAAA,EAAQ;wBACNF,IAAAA,EAAM;AACR;AACF;AACF;AACF,SAAA;QACA,GAAA,EAAK;YACHG,WAAAA,EAAa,cAAA;YACbC,OAAAA,EAAS;gBACP,kBAAA,EAAoB;oBAClBF,MAAAA,EAAQ;wBACNF,IAAAA,EAAM;AACR;AACF;AACF;AACF,SAAA;QACA,GAAA,EAAK;YACHG,WAAAA,EAAa,WAAA;YACbC,OAAAA,EAAS;gBACP,kBAAA,EAAoB;oBAClBF,MAAAA,EAAQ;wBACNF,IAAAA,EAAM;AACR;AACF;AACF;AACF,SAAA;QACA,GAAA,EAAK;YACHG,WAAAA,EAAa,WAAA;YACbC,OAAAA,EAAS;gBACP,kBAAA,EAAoB;oBAClBF,MAAAA,EAAQ;wBACNF,IAAAA,EAAM;AACR;AACF;AACF;AACF,SAAA;QACA,GAAA,EAAK;YACHG,WAAAA,EAAa,uBAAA;YACbC,OAAAA,EAAS;gBACP,kBAAA,EAAoB;oBAClBF,MAAAA,EAAQ;wBACNF,IAAAA,EAAM;AACR;AACF;AACF;AACF;AACF,KAAA;AACF;;;;"}

package/dist/server/services/helpers/utils/get-api-responses.mjs

@@ -0,0 +1,86 @@
+import pascalCase from './pascal-case.mjs';
+
+/**
+ * @description - Builds the Swagger response object for a given api
+ */ const getApiResponse = ({ uniqueName, route, isListOfEntities = false })=>{
+    const getSchema = ()=>{
+        if (route.method === 'DELETE') {
+            return {
+                type: 'integer',
+                format: 'int64'
+            };
+        }
+        if (isListOfEntities) {
+            return {
+                $ref: `#/components/schemas/${pascalCase(uniqueName)}ListResponse`
+            };
+        }
+        return {
+            $ref: `#/components/schemas/${pascalCase(uniqueName)}Response`
+        };
+    };
+    const schema = getSchema();
+    return {
+        200: {
+            description: 'OK',
+            content: {
+                'application/json': {
+                    schema
+                }
+            }
+        },
+        400: {
+            description: 'Bad Request',
+            content: {
+                'application/json': {
+                    schema: {
+                        $ref: '#/components/schemas/Error'
+                    }
+                }
+            }
+        },
+        401: {
+            description: 'Unauthorized',
+            content: {
+                'application/json': {
+                    schema: {
+                        $ref: '#/components/schemas/Error'
+                    }
+                }
+            }
+        },
+        403: {
+            description: 'Forbidden',
+            content: {
+                'application/json': {
+                    schema: {
+                        $ref: '#/components/schemas/Error'
+                    }
+                }
+            }
+        },
+        404: {
+            description: 'Not Found',
+            content: {
+                'application/json': {
+                    schema: {
+                        $ref: '#/components/schemas/Error'
+                    }
+                }
+            }
+        },
+        500: {
+            description: 'Internal Server Error',
+            content: {
+                'application/json': {
+                    schema: {
+                        $ref: '#/components/schemas/Error'
+                    }
+                }
+            }
+        }
+    };
+};
+
+export { getApiResponse as default };
+//# sourceMappingURL=get-api-responses.mjs.map

package/dist/server/services/helpers/utils/get-api-responses.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-api-responses.mjs","sources":["../../../../../server/src/services/helpers/utils/get-api-responses.ts"],"sourcesContent":["import type { OpenAPIV3 } from 'openapi-types';\nimport pascalCase from './pascal-case';\n\ninterface Options {\n  uniqueName: string;\n  route: {\n    method: string;\n  };\n  isListOfEntities?: boolean;\n  isLocalizationPath?: boolean;\n}\n\n/**\n * @description - Builds the Swagger response object for a given api\n */\nconst getApiResponse = ({\n  uniqueName,\n  route,\n  isListOfEntities = false,\n}: Options): OpenAPIV3.ResponsesObject => {\n  const getSchema = (): OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject => {\n    if (route.method === 'DELETE') {\n      return {\n        type: 'integer',\n        format: 'int64',\n      };\n    }\n\n    if (isListOfEntities) {\n      return { $ref: `#/components/schemas/${pascalCase(uniqueName)}ListResponse` };\n    }\n\n    return { $ref: `#/components/schemas/${pascalCase(uniqueName)}Response` };\n  };\n\n  const schema = getSchema();\n\n  return {\n    200: {\n      description: 'OK',\n      content: {\n        'application/json': {\n          schema,\n        },\n      },\n    },\n    400: {\n      description: 'Bad Request',\n      content: {\n        'application/json': {\n          schema: {\n            $ref: '#/components/schemas/Error',\n          },\n        },\n      },\n    },\n    401: {\n      description: 'Unauthorized',\n      content: {\n        'application/json': {\n          schema: {\n            $ref: '#/components/schemas/Error',\n          },\n        },\n      },\n    },\n    403: {\n      description: 'Forbidden',\n      content: {\n        'application/json': {\n          schema: {\n            $ref: '#/components/schemas/Error',\n          },\n        },\n      },\n    },\n    404: {\n      description: 'Not Found',\n      content: {\n        'application/json': {\n          schema: {\n            $ref: '#/components/schemas/Error',\n          },\n        },\n      },\n    },\n    500: {\n      description: 'Internal Server Error',\n      content: {\n        'application/json': {\n          schema: {\n            $ref: '#/components/schemas/Error',\n          },\n        },\n      },\n    },\n  };\n};\n\nexport default getApiResponse;\n"],"names":["getApiResponse","uniqueName","route","isListOfEntities","getSchema","method","type","format","$ref","pascalCase","schema","description","content"],"mappings":";;AAYA;;IAGA,MAAMA,cAAAA,GAAiB,CAAC,EACtBC,UAAU,EACVC,KAAK,EACLC,gBAAAA,GAAmB,KAAK,EAChB,GAAA;AACR,IAAA,MAAMC,SAAAA,GAAY,IAAA;QAChB,IAAIF,KAAAA,CAAMG,MAAM,KAAK,QAAA,EAAU;YAC7B,OAAO;gBACLC,IAAAA,EAAM,SAAA;gBACNC,MAAAA,EAAQ;AACV,aAAA;AACF,QAAA;AAEA,QAAA,IAAIJ,gBAAAA,EAAkB;YACpB,OAAO;AAAEK,gBAAAA,IAAAA,EAAM,CAAC,qBAAqB,EAAEC,UAAAA,CAAWR,UAAAA,CAAAA,CAAY,YAAY;AAAE,aAAA;AAC9E,QAAA;QAEA,OAAO;AAAEO,YAAAA,IAAAA,EAAM,CAAC,qBAAqB,EAAEC,UAAAA,CAAWR,UAAAA,CAAAA,CAAY,QAAQ;AAAE,SAAA;AAC1E,IAAA,CAAA;AAEA,IAAA,MAAMS,MAAAA,GAASN,SAAAA,EAAAA;IAEf,OAAO;QACL,GAAA,EAAK;YACHO,WAAAA,EAAa,IAAA;YACbC,OAAAA,EAAS;gBACP,kBAAA,EAAoB;AAClBF,oBAAAA;AACF;AACF;AACF,SAAA;QACA,GAAA,EAAK;YACHC,WAAAA,EAAa,aAAA;YACbC,OAAAA,EAAS;gBACP,kBAAA,EAAoB;oBAClBF,MAAAA,EAAQ;wBACNF,IAAAA,EAAM;AACR;AACF;AACF;AACF,SAAA;QACA,GAAA,EAAK;YACHG,WAAAA,EAAa,cAAA;YACbC,OAAAA,EAAS;gBACP,kBAAA,EAAoB;oBAClBF,MAAAA,EAAQ;wBACNF,IAAAA,EAAM;AACR;AACF;AACF;AACF,SAAA;QACA,GAAA,EAAK;YACHG,WAAAA,EAAa,WAAA;YACbC,OAAAA,EAAS;gBACP,kBAAA,EAAoB;oBAClBF,MAAAA,EAAQ;wBACNF,IAAAA,EAAM;AACR;AACF;AACF;AACF,SAAA;QACA,GAAA,EAAK;YACHG,WAAAA,EAAa,WAAA;YACbC,OAAAA,EAAS;gBACP,kBAAA,EAAoB;oBAClBF,MAAAA,EAAQ;wBACNF,IAAAA,EAAM;AACR;AACF;AACF;AACF,SAAA;QACA,GAAA,EAAK;YACHG,WAAAA,EAAa,uBAAA;YACbC,OAAAA,EAAS;gBACP,kBAAA,EAAoB;oBAClBF,MAAAA,EAAQ;wBACNF,IAAAA,EAAM;AACR;AACF;AACF;AACF;AACF,KAAA;AACF;;;;"}

package/dist/server/services/helpers/utils/get-schema-data.js

@@ -0,0 +1,57 @@
+'use strict';
+
+/**
+ * @description Determines the format of the data response
+ *
+ * @param {boolean} isListOfEntities - Checks for a multiple entities
+ * @param {object} attributes - The attributes found on a contentType
+
+ * @returns object | array of attributes
+ */ var getSchemaData = ((isListOfEntities, attributes)=>{
+    if (isListOfEntities) {
+        return {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    id: {
+                        oneOf: [
+                            {
+                                type: 'string'
+                            },
+                            {
+                                type: 'number'
+                            }
+                        ]
+                    },
+                    documentId: {
+                        type: 'string'
+                    },
+                    ...attributes
+                }
+            }
+        };
+    }
+    return {
+        type: 'object',
+        properties: {
+            id: {
+                oneOf: [
+                    {
+                        type: 'string'
+                    },
+                    {
+                        type: 'number'
+                    }
+                ]
+            },
+            documentId: {
+                type: 'string'
+            },
+            ...attributes
+        }
+    };
+});
+
+module.exports = getSchemaData;
+//# sourceMappingURL=get-schema-data.js.map

package/dist/server/services/helpers/utils/get-schema-data.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-schema-data.js","sources":["../../../../../server/src/services/helpers/utils/get-schema-data.ts"],"sourcesContent":["import type { OpenAPIV3 } from 'openapi-types';\n\n/**\n * @description Determines the format of the data response\n *\n * @param {boolean} isListOfEntities - Checks for a multiple entities\n * @param {object} attributes - The attributes found on a contentType\n\n * @returns object | array of attributes\n */\nexport default (\n  isListOfEntities: boolean,\n  attributes: Record<string, OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject>\n): OpenAPIV3.SchemaObject => {\n  if (isListOfEntities) {\n    return {\n      type: 'array',\n      items: {\n        type: 'object',\n        properties: {\n          id: { oneOf: [{ type: 'string' }, { type: 'number' }] },\n          documentId: { type: 'string' },\n          ...attributes,\n        },\n      },\n    };\n  }\n\n  return {\n    type: 'object',\n    properties: {\n      id: { oneOf: [{ type: 'string' }, { type: 'number' }] },\n      documentId: { type: 'string' },\n      ...attributes,\n    },\n  };\n};\n"],"names":["isListOfEntities","attributes","type","items","properties","id","oneOf","documentId"],"mappings":";;AAEA;;;;;;;IAQA,oBAAe,CAAA,CACbA,gBAAAA,EACAC,UAAAA,GAAAA;AAEA,IAAA,IAAID,gBAAAA,EAAkB;QACpB,OAAO;YACLE,IAAAA,EAAM,OAAA;YACNC,KAAAA,EAAO;gBACLD,IAAAA,EAAM,QAAA;gBACNE,UAAAA,EAAY;oBACVC,EAAAA,EAAI;wBAAEC,KAAAA,EAAO;AAAC,4BAAA;gCAAEJ,IAAAA,EAAM;AAAS,6BAAA;AAAG,4BAAA;gCAAEA,IAAAA,EAAM;AAAS;AAAE;AAAC,qBAAA;oBACtDK,UAAAA,EAAY;wBAAEL,IAAAA,EAAM;AAAS,qBAAA;AAC7B,oBAAA,GAAGD;AACL;AACF;AACF,SAAA;AACF,IAAA;IAEA,OAAO;QACLC,IAAAA,EAAM,QAAA;QACNE,UAAAA,EAAY;YACVC,EAAAA,EAAI;gBAAEC,KAAAA,EAAO;AAAC,oBAAA;wBAAEJ,IAAAA,EAAM;AAAS,qBAAA;AAAG,oBAAA;wBAAEA,IAAAA,EAAM;AAAS;AAAE;AAAC,aAAA;YACtDK,UAAAA,EAAY;gBAAEL,IAAAA,EAAM;AAAS,aAAA;AAC7B,YAAA,GAAGD;AACL;AACF,KAAA;AACF,CAAA;;;;"}

package/dist/server/services/helpers/utils/get-schema-data.mjs

@@ -0,0 +1,55 @@
+/**
+ * @description Determines the format of the data response
+ *
+ * @param {boolean} isListOfEntities - Checks for a multiple entities
+ * @param {object} attributes - The attributes found on a contentType
+
+ * @returns object | array of attributes
+ */ var getSchemaData = ((isListOfEntities, attributes)=>{
+    if (isListOfEntities) {
+        return {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    id: {
+                        oneOf: [
+                            {
+                                type: 'string'
+                            },
+                            {
+                                type: 'number'
+                            }
+                        ]
+                    },
+                    documentId: {
+                        type: 'string'
+                    },
+                    ...attributes
+                }
+            }
+        };
+    }
+    return {
+        type: 'object',
+        properties: {
+            id: {
+                oneOf: [
+                    {
+                        type: 'string'
+                    },
+                    {
+                        type: 'number'
+                    }
+                ]
+            },
+            documentId: {
+                type: 'string'
+            },
+            ...attributes
+        }
+    };
+});
+
+export { getSchemaData as default };
+//# sourceMappingURL=get-schema-data.mjs.map

package/dist/server/services/helpers/utils/get-schema-data.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-schema-data.mjs","sources":["../../../../../server/src/services/helpers/utils/get-schema-data.ts"],"sourcesContent":["import type { OpenAPIV3 } from 'openapi-types';\n\n/**\n * @description Determines the format of the data response\n *\n * @param {boolean} isListOfEntities - Checks for a multiple entities\n * @param {object} attributes - The attributes found on a contentType\n\n * @returns object | array of attributes\n */\nexport default (\n  isListOfEntities: boolean,\n  attributes: Record<string, OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject>\n): OpenAPIV3.SchemaObject => {\n  if (isListOfEntities) {\n    return {\n      type: 'array',\n      items: {\n        type: 'object',\n        properties: {\n          id: { oneOf: [{ type: 'string' }, { type: 'number' }] },\n          documentId: { type: 'string' },\n          ...attributes,\n        },\n      },\n    };\n  }\n\n  return {\n    type: 'object',\n    properties: {\n      id: { oneOf: [{ type: 'string' }, { type: 'number' }] },\n      documentId: { type: 'string' },\n      ...attributes,\n    },\n  };\n};\n"],"names":["isListOfEntities","attributes","type","items","properties","id","oneOf","documentId"],"mappings":"AAEA;;;;;;;IAQA,oBAAe,CAAA,CACbA,gBAAAA,EACAC,UAAAA,GAAAA;AAEA,IAAA,IAAID,gBAAAA,EAAkB;QACpB,OAAO;YACLE,IAAAA,EAAM,OAAA;YACNC,KAAAA,EAAO;gBACLD,IAAAA,EAAM,QAAA;gBACNE,UAAAA,EAAY;oBACVC,EAAAA,EAAI;wBAAEC,KAAAA,EAAO;AAAC,4BAAA;gCAAEJ,IAAAA,EAAM;AAAS,6BAAA;AAAG,4BAAA;gCAAEA,IAAAA,EAAM;AAAS;AAAE;AAAC,qBAAA;oBACtDK,UAAAA,EAAY;wBAAEL,IAAAA,EAAM;AAAS,qBAAA;AAC7B,oBAAA,GAAGD;AACL;AACF;AACF,SAAA;AACF,IAAA;IAEA,OAAO;QACLC,IAAAA,EAAM,QAAA;QACNE,UAAAA,EAAY;YACVC,EAAAA,EAAI;gBAAEC,KAAAA,EAAO;AAAC,oBAAA;wBAAEJ,IAAAA,EAAM;AAAS,qBAAA;AAAG,oBAAA;wBAAEA,IAAAA,EAAM;AAAS;AAAE;AAAC,aAAA;YACtDK,UAAAA,EAAY;gBAAEL,IAAAA,EAAM;AAAS,aAAA;AAC7B,YAAA,GAAGD;AACL;AACF,KAAA;AACF,CAAA;;;;"}