npm - @redocly/config - Versions diffs - 0.26.2 → 0.26.3 - Mend

@redocly/config 0.26.2 → 0.26.3

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 (35) hide show

package/lib/common.d.ts +1 -1
package/lib/common.js +1 -1
package/lib/default-theme-config-schema.d.ts +573 -4326
package/lib/default-theme-config-schema.js +3 -2
package/lib/entities-catalog-config-schema.d.ts +718 -0
package/lib/entities-catalog-config-schema.js +84 -0
package/lib/ex-theme-config-schemas.d.ts +64 -0
package/lib/ex-theme-config-schemas.js +1 -1
package/lib/product-override-schema.d.ts +1 -1
package/lib/root-config-schema.d.ts +3449 -209
package/lib/root-config-schema.js +2 -1
package/lib/types/catalog-entity-types.d.ts +29 -0
package/lib/types/catalog-entity-types.js +3 -0
package/lib/types/config-types.d.ts +2 -0
package/lib/types/index.d.ts +1 -0
package/lib/types/index.js +1 -0
package/lib/types/portal-shared-types.d.ts +12 -1
package/lib-esm/common.d.ts +1 -1
package/lib-esm/common.js +1 -1
package/lib-esm/default-theme-config-schema.d.ts +573 -4326
package/lib-esm/default-theme-config-schema.js +2 -1
package/lib-esm/entities-catalog-config-schema.d.ts +718 -0
package/lib-esm/entities-catalog-config-schema.js +81 -0
package/lib-esm/ex-theme-config-schemas.d.ts +64 -0
package/lib-esm/ex-theme-config-schemas.js +2 -2
package/lib-esm/product-override-schema.d.ts +1 -1
package/lib-esm/root-config-schema.d.ts +3449 -209
package/lib-esm/root-config-schema.js +2 -1
package/lib-esm/types/catalog-entity-types.d.ts +29 -0
package/lib-esm/types/catalog-entity-types.js +2 -0
package/lib-esm/types/config-types.d.ts +2 -0
package/lib-esm/types/index.d.ts +1 -0
package/lib-esm/types/index.js +1 -0
package/lib-esm/types/portal-shared-types.d.ts +12 -1
package/package.json +2 -2

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

@@ -0,0 +1,718 @@
+export declare const entityCatalogExcludeSchema: {
+    readonly type: "object";
+    readonly required: readonly ["key"];
+    readonly properties: {
+        readonly key: {
+            readonly type: "string";
+        };
+    };
+    readonly additionalProperties: false;
+};
+export declare const entityCatalogIncludeSchema: {
+    readonly type: "object";
+    readonly required: readonly ["type"];
+    readonly properties: {
+        readonly type: {
+            readonly type: "string";
+        };
+    };
+    readonly additionalProperties: false;
+};
+export declare const entityCatalogFilterSchema: {
+    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;
+};
+export declare const entityCatalogSpecificCatalogSchema: {
+    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;
+};
+export declare const entitiesCatalogConfigSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly catalogs: {
+            readonly type: "object";
+            readonly properties: {
+                readonly all: {
+                    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 services: {
+                    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 domains: {
+                    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 teams: {
+                    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 users: {
+                    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 apiDescriptions: {
+                    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;
+        };
+    };
+    readonly additionalProperties: false;
+};