npm - @redocly/config - Versions diffs - 0.31.0 → 0.32.0 - Mend

@redocly/config 0.31.0 → 0.32.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (19) hide show

package/lib/default-theme-config-schema.d.ts +103 -0
package/lib/entities-catalog-config-schema.d.ts +426 -0
package/lib/entities-catalog-config-schema.js +100 -1
package/lib/root-config-schema.d.ts +755 -230
package/lib/root-config-schema.js +1 -1
package/lib/types/api-functions-types.d.ts +1 -1
package/lib/types/catalog-entity-types.d.ts +4 -2
package/lib/types/config-types.d.ts +0 -2
package/lib/types/portal-shared-types.d.ts +1 -1
package/lib-esm/default-theme-config-schema.d.ts +103 -0
package/lib-esm/entities-catalog-config-schema.d.ts +426 -0
package/lib-esm/entities-catalog-config-schema.js +99 -0
package/lib-esm/root-config-schema.d.ts +755 -230
package/lib-esm/root-config-schema.js +1 -1
package/lib-esm/types/api-functions-types.d.ts +1 -1
package/lib-esm/types/catalog-entity-types.d.ts +4 -2
package/lib-esm/types/config-types.d.ts +0 -2
package/lib-esm/types/portal-shared-types.d.ts +1 -1
package/package.json +1 -1

package/lib/default-theme-config-schema.d.ts CHANGED Viewed

@@ -3982,6 +3982,109 @@ export declare const themeConfigSchema: {
         readonly entitiesCatalog: {
             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: {

package/lib/entities-catalog-config-schema.d.ts CHANGED Viewed

@@ -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: {

package/lib/entities-catalog-config-schema.js CHANGED Viewed

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.entitiesCatalogConfigSchema = exports.entityCatalogSpecificCatalogSchema = exports.entityCatalogFilterSchema = exports.entityCatalogIncludeSchema = exports.entityCatalogExcludeSchema = void 0;
+exports.entitiesCatalogConfigSchema = exports.entityCatalogEntityTypesSchema = exports.entityCatalogEntityTypeSchema = exports.entityCatalogMetadataSchema = exports.entityCatalogMetadataSchemaPropertySchema = exports.entityCatalogSpecificCatalogSchema = exports.entityCatalogFilterSchema = exports.entityCatalogIncludeSchema = exports.entityCatalogExcludeSchema = void 0;
 exports.entityCatalogExcludeSchema = {
     type: 'object',
     required: ['key'],
@@ -63,9 +63,108 @@ exports.entityCatalogSpecificCatalogSchema = {
     },
     additionalProperties: false,
 };
+exports.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,
+};
+exports.entityCatalogMetadataSchema = {
+    type: 'object',
+    required: ['type', 'properties'],
+    properties: {
+        type: {
+            type: 'string',
+            enum: ['object'],
+        },
+        description: {
+            type: 'string',
+        },
+        properties: {
+            type: 'object',
+            additionalProperties: exports.entityCatalogMetadataSchemaPropertySchema,
+        },
+        required: {
+            type: 'array',
+            items: { type: 'string' },
+        },
+        additionalProperties: {
+            type: 'boolean',
+        },
+    },
+    additionalProperties: true,
+};
+exports.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: exports.entityCatalogMetadataSchema,
+        icon: {
+            type: 'object',
+            properties: {
+                src: {
+                    type: 'string',
+                },
+                srcSet: {
+                    type: 'string',
+                },
+            },
+            additionalProperties: false,
+        },
+    },
+    additionalProperties: false,
+};
+exports.entityCatalogEntityTypesSchema = {
+    type: 'object',
+    additionalProperties: exports.entityCatalogEntityTypeSchema,
+};
 exports.entitiesCatalogConfigSchema = {
     type: 'object',
     properties: {
+        entityTypes: exports.entityCatalogEntityTypesSchema,
         catalogs: {
             type: 'object',
             properties: {