@redocly/config 0.4.0 → 0.82.2-rc.2

package/lib-esm/portal-shared-types.d.ts

@@ -36,8 +36,10 @@ export type ResolvedNavLinkItem = {
     version?: string;
     isDefault?: boolean;
     versionFolderId?: string;
+    badges?: ItemBadge[];
     httpVerb?: string;
     separatorLine?: boolean;
+    linePosition?: 'top' | 'bottom';
     routeSlug?: string;
     active?: boolean;
     icon?: string;
@@ -50,6 +52,11 @@ export type ResolvedNavLinkItem = {
     linkedSidebars?: string[];
     languageInsensitive?: boolean;
 };
+export type ItemBadge = {
+    name: string;
+    color?: string;
+    position?: 'before' | 'after';
+};
 export type ResolvedNavGroupItem = {
     type: 'group';
     fsPath?: string;
@@ -68,6 +75,7 @@ export type ResolvedNavGroupItem = {
     versionFolderId?: string;
     menuStyle?: MenuStyle;
     separatorLine?: boolean;
+    linePosition?: 'top' | 'bottom';
     routeSlug?: string;
     active?: boolean;
     icon?: string;
@@ -90,6 +98,7 @@ export type ResolvedNavItem = ResolvedNavLinkItem | ResolvedNavGroupItem | {
     version?: string;
     isDefault?: boolean;
     versionFolderId?: string;
+    variant?: 'primary' | 'secondary';
     separatorLine?: boolean;
     linePosition?: 'top' | 'bottom';
     link?: undefined;
@@ -98,12 +107,12 @@ export type ResolvedNavItem = ResolvedNavLinkItem | ResolvedNavGroupItem | {
     linkedSidebars?: string[];
     icon?: string;
     srcSet?: string;
+    languageInsensitive?: boolean;
     [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
     [REDOCLY_ROUTE_RBAC]?: {
         slug?: string;
         fsPath?: string;
     };
-    languageInsensitive?: boolean;
 } | {
     type: 'error';
     fsPath?: never;
@@ -118,20 +127,20 @@ export type ResolvedNavItem = ResolvedNavLinkItem | ResolvedNavGroupItem | {
     items?: ResolvedNavItem[];
     sidebar?: ResolvedNavItem[];
     linkedSidebars?: string[];
+    icon?: string;
+    srcSet?: string;
+    languageInsensitive?: boolean;
     [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
     [REDOCLY_ROUTE_RBAC]?: {
         slug?: string;
         fsPath?: string;
     };
-    icon?: string;
-    srcSet?: string;
-    languageInsensitive?: boolean;
 };
 export type ResolvedNavItemWithLink = (ResolvedNavLinkItem | ResolvedNavGroupItem) & {
     link: string;
 };
 export type ResolvedSidebar = {
-    relatedNavbarItem?: Breadcrumb;
+    relatedNavbarItem?: BreadcrumbItem;
     items: ResolvedNavItem[];
 };
 export interface PageProps {
@@ -166,6 +175,7 @@ export interface PageStaticData {
 export type UserData = {
     isAuthenticated: boolean;
     name: string;
+    email?: string;
     picture: string;
     logoutDisabled?: boolean;
 };
@@ -251,8 +261,8 @@ export type OpenAPIOptions = {
     layout?: LayoutVariant;
     collapsedSidebar?: boolean;
 };
-export type MenuStyle = 'drilldown';
-export type Breadcrumb = {
+export type MenuStyle = 'drilldown' | 'drilldown-header';
+export type BreadcrumbItem = {
     label: string;
     link?: string;
 };

package/lib-esm/remove-property-recursively.d.ts

@@ -0,0 +1,5 @@
+type Removed<T, Drop> = T extends Record<string, any> ? T extends ArrayLike<any> ? Array<Removed<T[number], Drop>> : {
+    [K in Exclude<keyof T, Drop>]: Removed<T[K], Drop>;
+} : T;
+export declare function removePropertyRecursively<TObject extends object, TProp extends string>(object: TObject, propToRemove: TProp): Removed<TObject, TProp>;
+export {};

package/lib-esm/remove-property-recursively.js

@@ -0,0 +1,22 @@
+export function removePropertyRecursively(object, propToRemove) {
+    return Object.fromEntries(Object.entries(object)
+        .map(([key, value]) => {
+        if (key === propToRemove) {
+            return undefined;
+        }
+        if (typeof value !== 'object' || !value) {
+            return [key, value];
+        }
+        if (Array.isArray(value)) {
+            return [
+                key,
+                value.map((arrayItem) => typeof arrayItem === 'object'
+                    ? removePropertyRecursively(arrayItem, propToRemove)
+                    : arrayItem),
+            ];
+        }
+        return [key, removePropertyRecursively(value, propToRemove)];
+    })
+        .filter(Boolean));
+}
+//# sourceMappingURL=remove-property-recursively.js.map

package/lib-esm/remove-property-recursively.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remove-property-recursively.js","sourceRoot":"","sources":["../src/remove-property-recursively.ts"],"names":[],"mappings":"AAQA,MAAM,UAAU,yBAAyB,CACvC,MAAe,EACf,YAAmB;IAEnB,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;SACnB,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACpB,IAAI,GAAG,KAAK,YAAY,EAAE;YACxB,OAAO,SAAS,CAAC;SAClB;QAED,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,EAAE;YACvC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;SACrB;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACxB,OAAO;gBACL,GAAG;gBACH,KAAK,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CACtB,OAAO,SAAS,KAAK,QAAQ;oBAC3B,CAAC,CAAC,yBAAyB,CAAC,SAAS,EAAE,YAAY,CAAC;oBACpD,CAAC,CAAC,SAAS,CACd;aACF,CAAC;SACH;QAED,OAAO,CAAC,GAAG,EAAE,yBAAyB,CAAC,KAAgC,EAAE,YAAY,CAAC,CAAC,CAAC;IAC1F,CAAC,CAAC;SACD,MAAM,CAAC,OAAO,CAAwB,CACf,CAAC;AAC/B,CAAC"}