@redocly/config 0.30.0 → 0.32.0

package/lib-esm/entities-catalog-config-schema.d.ts

@@ -152,9 +152,435 @@ export declare const entityCatalogSpecificCatalogSchema: {
     };
     readonly additionalProperties: false;
 };
+export declare const entityCatalogMetadataSchemaPropertySchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly type: {
+            readonly type: "string";
+            readonly enum: readonly ["string", "number", "boolean", "array", "object"];
+        };
+        readonly description: {
+            readonly type: "string";
+        };
+        readonly example: {
+            readonly oneOf: readonly [{
+                readonly type: "string";
+            }, {
+                readonly type: "number";
+            }, {
+                readonly type: "boolean";
+            }, {
+                readonly type: "array";
+            }, {
+                readonly type: "object";
+            }];
+        };
+        readonly enum: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "string";
+            };
+        };
+        readonly pattern: {
+            readonly type: "string";
+        };
+        readonly format: {
+            readonly type: "string";
+        };
+        readonly minimum: {
+            readonly type: "number";
+        };
+        readonly maximum: {
+            readonly type: "number";
+        };
+        readonly items: {
+            readonly type: "object";
+        };
+    };
+    readonly additionalProperties: true;
+};
+export declare const entityCatalogMetadataSchema: {
+    readonly type: "object";
+    readonly required: readonly ["type", "properties"];
+    readonly properties: {
+        readonly type: {
+            readonly type: "string";
+            readonly enum: readonly ["object"];
+        };
+        readonly description: {
+            readonly type: "string";
+        };
+        readonly properties: {
+            readonly type: "object";
+            readonly additionalProperties: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly type: {
+                        readonly type: "string";
+                        readonly enum: readonly ["string", "number", "boolean", "array", "object"];
+                    };
+                    readonly description: {
+                        readonly type: "string";
+                    };
+                    readonly example: {
+                        readonly oneOf: readonly [{
+                            readonly type: "string";
+                        }, {
+                            readonly type: "number";
+                        }, {
+                            readonly type: "boolean";
+                        }, {
+                            readonly type: "array";
+                        }, {
+                            readonly type: "object";
+                        }];
+                    };
+                    readonly enum: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly pattern: {
+                        readonly type: "string";
+                    };
+                    readonly format: {
+                        readonly type: "string";
+                    };
+                    readonly minimum: {
+                        readonly type: "number";
+                    };
+                    readonly maximum: {
+                        readonly type: "number";
+                    };
+                    readonly items: {
+                        readonly type: "object";
+                    };
+                };
+                readonly additionalProperties: true;
+            };
+        };
+        readonly required: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "string";
+            };
+        };
+        readonly additionalProperties: {
+            readonly type: "boolean";
+        };
+    };
+    readonly additionalProperties: true;
+};
+export declare const entityCatalogEntityTypeSchema: {
+    readonly type: "object";
+    readonly required: readonly ["name", "description", "metadataSchema"];
+    readonly properties: {
+        readonly name: {
+            readonly type: "string";
+            readonly description: "Display name of the entity type";
+        };
+        readonly description: {
+            readonly type: "string";
+            readonly description: "Description of the entity type";
+        };
+        readonly metadataSchema: {
+            readonly type: "object";
+            readonly required: readonly ["type", "properties"];
+            readonly properties: {
+                readonly type: {
+                    readonly type: "string";
+                    readonly enum: readonly ["object"];
+                };
+                readonly description: {
+                    readonly type: "string";
+                };
+                readonly properties: {
+                    readonly type: "object";
+                    readonly additionalProperties: {
+                        readonly type: "object";
+                        readonly properties: {
+                            readonly type: {
+                                readonly type: "string";
+                                readonly enum: readonly ["string", "number", "boolean", "array", "object"];
+                            };
+                            readonly description: {
+                                readonly type: "string";
+                            };
+                            readonly example: {
+                                readonly oneOf: readonly [{
+                                    readonly type: "string";
+                                }, {
+                                    readonly type: "number";
+                                }, {
+                                    readonly type: "boolean";
+                                }, {
+                                    readonly type: "array";
+                                }, {
+                                    readonly type: "object";
+                                }];
+                            };
+                            readonly enum: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "string";
+                                };
+                            };
+                            readonly pattern: {
+                                readonly type: "string";
+                            };
+                            readonly format: {
+                                readonly type: "string";
+                            };
+                            readonly minimum: {
+                                readonly type: "number";
+                            };
+                            readonly maximum: {
+                                readonly type: "number";
+                            };
+                            readonly items: {
+                                readonly type: "object";
+                            };
+                        };
+                        readonly additionalProperties: true;
+                    };
+                };
+                readonly required: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+                readonly additionalProperties: {
+                    readonly type: "boolean";
+                };
+            };
+            readonly additionalProperties: true;
+        };
+        readonly icon: {
+            readonly type: "object";
+            readonly properties: {
+                readonly src: {
+                    readonly type: "string";
+                };
+                readonly srcSet: {
+                    readonly type: "string";
+                };
+            };
+            readonly additionalProperties: false;
+        };
+    };
+    readonly additionalProperties: false;
+};
+export declare const entityCatalogEntityTypesSchema: {
+    readonly type: "object";
+    readonly additionalProperties: {
+        readonly type: "object";
+        readonly required: readonly ["name", "description", "metadataSchema"];
+        readonly properties: {
+            readonly name: {
+                readonly type: "string";
+                readonly description: "Display name of the entity type";
+            };
+            readonly description: {
+                readonly type: "string";
+                readonly description: "Description of the entity type";
+            };
+            readonly metadataSchema: {
+                readonly type: "object";
+                readonly required: readonly ["type", "properties"];
+                readonly properties: {
+                    readonly type: {
+                        readonly type: "string";
+                        readonly enum: readonly ["object"];
+                    };
+                    readonly description: {
+                        readonly type: "string";
+                    };
+                    readonly properties: {
+                        readonly type: "object";
+                        readonly additionalProperties: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly type: {
+                                    readonly type: "string";
+                                    readonly enum: readonly ["string", "number", "boolean", "array", "object"];
+                                };
+                                readonly description: {
+                                    readonly type: "string";
+                                };
+                                readonly example: {
+                                    readonly oneOf: readonly [{
+                                        readonly type: "string";
+                                    }, {
+                                        readonly type: "number";
+                                    }, {
+                                        readonly type: "boolean";
+                                    }, {
+                                        readonly type: "array";
+                                    }, {
+                                        readonly type: "object";
+                                    }];
+                                };
+                                readonly enum: {
+                                    readonly type: "array";
+                                    readonly items: {
+                                        readonly type: "string";
+                                    };
+                                };
+                                readonly pattern: {
+                                    readonly type: "string";
+                                };
+                                readonly format: {
+                                    readonly type: "string";
+                                };
+                                readonly minimum: {
+                                    readonly type: "number";
+                                };
+                                readonly maximum: {
+                                    readonly type: "number";
+                                };
+                                readonly items: {
+                                    readonly type: "object";
+                                };
+                            };
+                            readonly additionalProperties: true;
+                        };
+                    };
+                    readonly required: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly additionalProperties: {
+                        readonly type: "boolean";
+                    };
+                };
+                readonly additionalProperties: true;
+            };
+            readonly icon: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly src: {
+                        readonly type: "string";
+                    };
+                    readonly srcSet: {
+                        readonly type: "string";
+                    };
+                };
+                readonly additionalProperties: false;
+            };
+        };
+        readonly additionalProperties: false;
+    };
+};
 export declare const entitiesCatalogConfigSchema: {
     readonly type: "object";
     readonly properties: {
+        readonly entityTypes: {
+            readonly type: "object";
+            readonly additionalProperties: {
+                readonly type: "object";
+                readonly required: readonly ["name", "description", "metadataSchema"];
+                readonly properties: {
+                    readonly name: {
+                        readonly type: "string";
+                        readonly description: "Display name of the entity type";
+                    };
+                    readonly description: {
+                        readonly type: "string";
+                        readonly description: "Description of the entity type";
+                    };
+                    readonly metadataSchema: {
+                        readonly type: "object";
+                        readonly required: readonly ["type", "properties"];
+                        readonly properties: {
+                            readonly type: {
+                                readonly type: "string";
+                                readonly enum: readonly ["object"];
+                            };
+                            readonly description: {
+                                readonly type: "string";
+                            };
+                            readonly properties: {
+                                readonly type: "object";
+                                readonly additionalProperties: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly type: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["string", "number", "boolean", "array", "object"];
+                                        };
+                                        readonly description: {
+                                            readonly type: "string";
+                                        };
+                                        readonly example: {
+                                            readonly oneOf: readonly [{
+                                                readonly type: "string";
+                                            }, {
+                                                readonly type: "number";
+                                            }, {
+                                                readonly type: "boolean";
+                                            }, {
+                                                readonly type: "array";
+                                            }, {
+                                                readonly type: "object";
+                                            }];
+                                        };
+                                        readonly enum: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                        readonly pattern: {
+                                            readonly type: "string";
+                                        };
+                                        readonly format: {
+                                            readonly type: "string";
+                                        };
+                                        readonly minimum: {
+                                            readonly type: "number";
+                                        };
+                                        readonly maximum: {
+                                            readonly type: "number";
+                                        };
+                                        readonly items: {
+                                            readonly type: "object";
+                                        };
+                                    };
+                                    readonly additionalProperties: true;
+                                };
+                            };
+                            readonly required: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "string";
+                                };
+                            };
+                            readonly additionalProperties: {
+                                readonly type: "boolean";
+                            };
+                        };
+                        readonly additionalProperties: true;
+                    };
+                    readonly icon: {
+                        readonly type: "object";
+                        readonly properties: {
+                            readonly src: {
+                                readonly type: "string";
+                            };
+                            readonly srcSet: {
+                                readonly type: "string";
+                            };
+                        };
+                        readonly additionalProperties: false;
+                    };
+                };
+                readonly additionalProperties: false;
+            };
+        };
         readonly catalogs: {
             readonly type: "object";
             readonly properties: {
@@ -895,7 +1321,98 @@ export declare const entitiesCatalogConfigSchema: {
                     readonly additionalProperties: false;
                 };
             };
-            readonly additionalProperties: false;
+            readonly additionalProperties: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly slug: {
+                        readonly type: "string";
+                    };
+                    readonly hide: {
+                        readonly type: "boolean";
+                    };
+                    readonly includes: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "object";
+                            readonly required: readonly ["type"];
+                            readonly properties: {
+                                readonly type: {
+                                    readonly type: "string";
+                                };
+                            };
+                            readonly additionalProperties: false;
+                        };
+                    };
+                    readonly excludes: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "object";
+                            readonly required: readonly ["key"];
+                            readonly properties: {
+                                readonly key: {
+                                    readonly type: "string";
+                                };
+                            };
+                            readonly additionalProperties: false;
+                        };
+                    };
+                    readonly filters: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "object";
+                            readonly required: readonly ["property", "title"];
+                            readonly properties: {
+                                readonly property: {
+                                    readonly type: "string";
+                                };
+                                readonly hide: {
+                                    readonly type: "boolean";
+                                };
+                                readonly label: {
+                                    readonly type: "string";
+                                };
+                                readonly options: {
+                                    readonly type: "array";
+                                    readonly items: {
+                                        readonly type: "string";
+                                    };
+                                };
+                                readonly type: {
+                                    readonly type: "string";
+                                    readonly enum: readonly ["select", "checkboxes", "date-range"];
+                                    readonly default: "checkboxes";
+                                };
+                                readonly title: {
+                                    readonly type: "string";
+                                };
+                                readonly titleTranslationKey: {
+                                    readonly type: "string";
+                                };
+                                readonly parentFilter: {
+                                    readonly type: "string";
+                                };
+                                readonly valuesMapping: {
+                                    readonly type: "object";
+                                    readonly additionalProperties: {
+                                        readonly type: "string";
+                                    };
+                                };
+                            };
+                            readonly additionalProperties: false;
+                        };
+                    };
+                    readonly titleTranslationKey: {
+                        readonly type: "string";
+                    };
+                    readonly descriptionTranslationKey: {
+                        readonly type: "string";
+                    };
+                    readonly catalogSwitcherLabelTranslationKey: {
+                        readonly type: "string";
+                    };
+                };
+                readonly additionalProperties: false;
+            };
         };
     };
     readonly additionalProperties: false;

package/lib-esm/entities-catalog-config-schema.js

@@ -60,9 +60,108 @@ export const entityCatalogSpecificCatalogSchema = {
     },
     additionalProperties: false,
 };
+export const entityCatalogMetadataSchemaPropertySchema = {
+    type: 'object',
+    properties: {
+        type: {
+            type: 'string',
+            enum: ['string', 'number', 'boolean', 'array', 'object'],
+        },
+        description: {
+            type: 'string',
+        },
+        example: {
+            oneOf: [
+                { type: 'string' },
+                { type: 'number' },
+                { type: 'boolean' },
+                { type: 'array' },
+                { type: 'object' },
+            ],
+        },
+        enum: {
+            type: 'array',
+            items: { type: 'string' },
+        },
+        pattern: {
+            type: 'string',
+        },
+        format: {
+            type: 'string',
+        },
+        minimum: {
+            type: 'number',
+        },
+        maximum: {
+            type: 'number',
+        },
+        items: {
+            type: 'object',
+        },
+    },
+    additionalProperties: true,
+};
+export const entityCatalogMetadataSchema = {
+    type: 'object',
+    required: ['type', 'properties'],
+    properties: {
+        type: {
+            type: 'string',
+            enum: ['object'],
+        },
+        description: {
+            type: 'string',
+        },
+        properties: {
+            type: 'object',
+            additionalProperties: entityCatalogMetadataSchemaPropertySchema,
+        },
+        required: {
+            type: 'array',
+            items: { type: 'string' },
+        },
+        additionalProperties: {
+            type: 'boolean',
+        },
+    },
+    additionalProperties: true,
+};
+export const entityCatalogEntityTypeSchema = {
+    type: 'object',
+    required: ['name', 'description', 'metadataSchema'],
+    properties: {
+        name: {
+            type: 'string',
+            description: 'Display name of the entity type',
+        },
+        description: {
+            type: 'string',
+            description: 'Description of the entity type',
+        },
+        metadataSchema: entityCatalogMetadataSchema,
+        icon: {
+            type: 'object',
+            properties: {
+                src: {
+                    type: 'string',
+                },
+                srcSet: {
+                    type: 'string',
+                },
+            },
+            additionalProperties: false,
+        },
+    },
+    additionalProperties: false,
+};
+export const entityCatalogEntityTypesSchema = {
+    type: 'object',
+    additionalProperties: entityCatalogEntityTypeSchema,
+};
 export const entitiesCatalogConfigSchema = {
     type: 'object',
     properties: {
+        entityTypes: entityCatalogEntityTypesSchema,
         catalogs: {
             type: 'object',
             properties: {
@@ -75,7 +174,7 @@ export const entitiesCatalogConfigSchema = {
                 dataSchemas: entityCatalogSpecificCatalogSchema,
                 apiOperations: entityCatalogSpecificCatalogSchema,
             },
-            additionalProperties: false,
+            additionalProperties: entityCatalogSpecificCatalogSchema,
         },
     },
     additionalProperties: false,

package/lib-esm/reunite-config-schema.d.ts

@@ -104,13 +104,6 @@ export declare const reuniteConfigSchema: {
                 readonly additionalProperties: false;
             };
         };
-        /**
-         * @deprecated Should use `scorecard.fromProjectUrl` instead
-         */
-        readonly projectUrl: {
-            readonly type: "string";
-            readonly format: "uri";
-        };
     };
     readonly additionalProperties: false;
 };

package/lib-esm/reunite-config-schema.js

@@ -85,10 +85,6 @@ export const reuniteConfigSchema = {
                 additionalProperties: false,
             },
         },
-        /**
-         * @deprecated Should use `scorecard.fromProjectUrl` instead
-         */
-        projectUrl: { type: 'string', format: 'uri' },
     },
     additionalProperties: false,
 };