@redocly/theme 0.0.0-react18-20231120182601

package/lib/mocks/hooks/index.js

@@ -0,0 +1,109 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.usePageVersions = exports.useCurrentProduct = exports.useI18nConfig = exports.useGlobalData = exports.useI18n = exports.useTranslate = exports.useCatalog = exports.usePageSharedData = exports.useSidebarSiblingsData = exports.useThemeConfig = void 0;
+function useThemeConfig(_useProductConfig = true) {
+    return {
+        search: {
+            hide: false,
+            placement: 'navbar',
+            shortcuts: ['ctrl+f', 'cmd+k', '/'],
+        },
+        codeSnippet: {
+            copy: {
+                hide: false,
+                buttonText: 'Copy',
+                tooltipText: 'Copy to clipboard',
+                toasterText: 'Copied',
+                toasterDuration: 1500,
+            },
+            report: {
+                hide: false,
+                tooltipText: 'Report a problem',
+            },
+        },
+        markdown: {
+            toc: { depth: 3, header: 'Table of contents', hide: false },
+            lastUpdatedBlock: { hide: false, format: 'timeago', locale: 'en-US' },
+            editPage: {
+                baseUrl: '',
+            },
+            frontMatterKeysToResolve: ['image', 'links'],
+        },
+        navigation: {
+            nextButton: { text: 'next page theme config label' },
+            previousButton: { text: 'prev page theme config label' },
+        },
+        colorMode: {
+            modes: ['light', 'dark'],
+        },
+        feedback: {
+            type: 'sentiment',
+        },
+        userProfile: {
+            hide: false,
+        },
+    };
+}
+exports.useThemeConfig = useThemeConfig;
+function useSidebarSiblingsData() {
+    return {
+        nextPage: {
+            type: 'link',
+            label: 'Page',
+            link: '#next',
+        },
+        prevPage: {
+            type: 'link',
+            label: 'Page',
+            link: '#prev',
+        },
+    };
+}
+exports.useSidebarSiblingsData = useSidebarSiblingsData;
+function usePageSharedData(_id) {
+    throw new Error('Mock not implemented yet.');
+}
+exports.usePageSharedData = usePageSharedData;
+function useCatalog(_items, _config) {
+    throw new Error('Mock not implemented yet.');
+}
+exports.useCatalog = useCatalog;
+const useTranslate = () => ({
+    translate: (value, options) => (typeof options === 'string' ? options : options === null || options === void 0 ? void 0 : options.defaultValue) || value || '',
+});
+exports.useTranslate = useTranslate;
+function useI18n() {
+    const changeLanguage = (...args) => args.value;
+    return { changeLanguage };
+}
+exports.useI18n = useI18n;
+var useGlobalData_1 = require("../useGlobalData");
+Object.defineProperty(exports, "useGlobalData", { enumerable: true, get: function () { return useGlobalData_1.useGlobalData; } });
+function useI18nConfig() {
+    return {
+        currentLocale: 'en',
+        defaultLocale: 'en',
+        locales: [{ code: 'en', name: 'en' }],
+    };
+}
+exports.useI18nConfig = useI18nConfig;
+function useCurrentProduct() {
+    return undefined;
+}
+exports.useCurrentProduct = useCurrentProduct;
+function usePageVersions() {
+    return {
+        versions: [
+            {
+                version: '1.0',
+                label: 'First',
+                link: '',
+                default: true,
+                active: true,
+                folderId: 'id',
+            },
+        ],
+    };
+}
+exports.usePageVersions = usePageVersions;
+//# sourceMappingURL=index.js.map

package/lib/mocks/hooks/usePageData.d.ts

@@ -0,0 +1,6 @@
+import type { ResolvedNavLinkItem } from '../../types/portal';
+export declare function usePageData(): {
+    prevPage: ResolvedNavLinkItem | null;
+    nextPage: ResolvedNavLinkItem | null;
+    props?: any;
+} | null;

package/lib/mocks/hooks/usePageData.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.usePageData = void 0;
+function usePageData() {
+    return {
+        prevPage: { label: 'Intro', type: 'link', link: '#prev' },
+        nextPage: { label: 'FAQ', type: 'link', link: '#next' },
+    };
+}
+exports.usePageData = usePageData;
+//# sourceMappingURL=usePageData.js.map

package/lib/mocks/media-css.d.ts

@@ -0,0 +1,5 @@
+export declare const breakpoints: {
+    small: string;
+    medium: string;
+    large: string;
+};

package/lib/mocks/media-css.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.breakpoints = void 0;
+exports.breakpoints = { small: '550px', medium: '900px', large: '1200px' };
+//# sourceMappingURL=media-css.js.map

package/lib/mocks/search.d.ts

@@ -0,0 +1,32 @@
+interface OperationParameter {
+    name: string | string[];
+    description: string | string[];
+    place: string;
+    path?: string[];
+}
+interface SearchDocument {
+    id: string;
+    url: string;
+    title: string | string[];
+    text: string | string[];
+    path?: string[];
+    httpVerb?: string;
+    pathName?: string | string[];
+    parameters?: OperationParameter[];
+}
+export declare function useFuseSearch(_product?: string): {
+    query: string;
+    setQuery: (val: string) => void;
+    items: SearchDocument[] | null;
+    isLoading: boolean;
+};
+export declare const useRecentSearches: () => {
+    items: string[];
+    addSearchHistoryItem: (value: string) => string;
+    removeSearchHistoryItem: (value: string) => string;
+};
+export declare const useSuggestedPages: () => {
+    link: string;
+    label: string;
+}[];
+export {};

package/lib/mocks/search.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useSuggestedPages = exports.useRecentSearches = exports.useFuseSearch = void 0;
+const react_1 = require("react");
+function useFuseSearch(_product) {
+    const [query, setQuery] = (0, react_1.useState)('');
+    return {
+        query,
+        setQuery,
+        isLoading: false,
+        items: [
+            {
+                id: '1',
+                url: '#someUrl1',
+                title: 'Some Dummy Result Item 1',
+                text: 'Some sample search text',
+            },
+            {
+                id: '2',
+                url: '#someUrl2',
+                title: 'Some Dummy Result Item 2',
+                text: 'Some sample search text 2',
+            },
+        ],
+    };
+}
+exports.useFuseSearch = useFuseSearch;
+const useRecentSearches = () => {
+    const items = ['test'];
+    return {
+        items,
+        addSearchHistoryItem: (value) => value,
+        removeSearchHistoryItem: (value) => value,
+    };
+};
+exports.useRecentSearches = useRecentSearches;
+const useSuggestedPages = () => {
+    return [
+        {
+            link: '/',
+            label: 'some page',
+        },
+    ];
+};
+exports.useSuggestedPages = useSuggestedPages;
+//# sourceMappingURL=search.js.map

package/lib/mocks/telemetry.d.ts

@@ -0,0 +1,2 @@
+import type { ClientTelemetry } from '@redocly/portal-types';
+export declare const telemetry: ClientTelemetry;

package/lib/mocks/telemetry.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.telemetry = void 0;
+exports.telemetry = {
+    send: () => undefined,
+};
+//# sourceMappingURL=telemetry.js.map

package/lib/mocks/types/index.d.ts

@@ -0,0 +1 @@
+export type ResolvedNavLinkItem = any;

package/lib/mocks/types/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/lib/mocks/types.d.ts

@@ -0,0 +1,3 @@
+export type ActiveItem<T> = T;
+export type SearchDocument = any;
+export type OperationParameter = any;

package/lib/mocks/types.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// TODO: get rid of these types
+//# sourceMappingURL=types.js.map

package/lib/mocks/useGlobalData.d.ts

@@ -0,0 +1 @@
+export declare function useGlobalData(): Record<string, unknown>;

package/lib/mocks/useGlobalData.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useGlobalData = void 0;
+function useGlobalData() {
+    return {};
+}
+exports.useGlobalData = useGlobalData;
+//# sourceMappingURL=useGlobalData.js.map

package/lib/mocks/usePreloadHistory.d.ts

@@ -0,0 +1,3 @@
+export declare function usePreloadHistory(): {
+    push: (url: string) => void;
+};

package/lib/mocks/usePreloadHistory.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.usePreloadHistory = void 0;
+function usePreloadHistory() {
+    const history = [];
+    return {
+        push: (url) => {
+            history.push(url);
+        },
+    };
+}
+exports.usePreloadHistory = usePreloadHistory;
+//# sourceMappingURL=usePreloadHistory.js.map

package/lib/mocks/utils.d.ts

@@ -0,0 +1,7 @@
+export declare function withPathPrefix(link: string): string;
+export declare function withoutPathPrefix(link: string): string;
+export declare function timeAgo(lastModified: string | Date): string;
+export declare function getPathnameForLocale(pathname: string, _defaultLocale: string, _newLocale: string, _allLocales: {
+    code: string;
+    name: string;
+}[]): string;

package/lib/mocks/utils.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPathnameForLocale = exports.timeAgo = exports.withoutPathPrefix = exports.withPathPrefix = void 0;
+function withPathPrefix(link) {
+    return link;
+}
+exports.withPathPrefix = withPathPrefix;
+function withoutPathPrefix(link) {
+    return link;
+}
+exports.withoutPathPrefix = withoutPathPrefix;
+function timeAgo(lastModified) {
+    // should return format(lastModified) in portal
+    const d = new Date(lastModified);
+    return `${d.getDate()}-${d.getMonth() + 1}-${d.getFullYear()}`;
+}
+exports.timeAgo = timeAgo;
+function getPathnameForLocale(pathname, _defaultLocale, _newLocale, _allLocales) {
+    return `${pathname}`;
+}
+exports.getPathnameForLocale = getPathnameForLocale;
+//# sourceMappingURL=utils.js.map

package/lib/types/config.d.ts

@@ -0,0 +1,5 @@
+export type DefaultThemeUIConfig = {
+    lastUpdatedBlock?: {
+        hide?: boolean;
+    };
+};

package/lib/types/config.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=config.js.map

package/lib/types/portal/index.d.ts

@@ -0,0 +1,3 @@
+export * from './src/shared/types/nav';
+export * from './src/shared/types/i18n';
+export type { MdHeading } from './src/shared/types/markdown';

package/lib/types/portal/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./src/shared/types/nav"), exports);
+__exportStar(require("./src/shared/types/i18n"), exports);
+//# sourceMappingURL=index.js.map

package/lib/types/portal/src/shared/constants.d.ts

@@ -0,0 +1,21 @@
+export declare const DEFAULT_THEME_NAME = "@redocly/theme";
+export declare const USER_THEME_ALIAS = "@theme";
+export declare const REDOCLY_TEAMS_RBAC = "redocly::teams-rbac";
+export declare const DEFAULT_LOCALE_PLACEHOLDER = "default_locale";
+export type REQUIRED_OIDC_SCOPES = string[];
+export type DEFAULT_COOKIE_EXPIRATION = number;
+export declare enum FEEDBACK_TYPES {
+    RATING = "rating",
+    SENTIMENT = "sentiment",
+    COMMENT = "comment",
+    MOOD = "mood",
+    PROBLEM = "problem",
+    SCALE = "scale"
+}
+export declare const DEV_LOGIN_SLUG = "/login/";
+export declare enum ExternalRoutes {
+    AUTH0_PASS = "/auth/auth0-pass"
+}
+export declare enum FsErrors {
+    NotExist = "ENOENT"
+}

package/lib/types/portal/src/shared/constants.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FsErrors = exports.ExternalRoutes = exports.DEV_LOGIN_SLUG = exports.FEEDBACK_TYPES = exports.DEFAULT_LOCALE_PLACEHOLDER = exports.REDOCLY_TEAMS_RBAC = exports.USER_THEME_ALIAS = exports.DEFAULT_THEME_NAME = void 0;
+exports.DEFAULT_THEME_NAME = '@redocly/theme';
+exports.USER_THEME_ALIAS = '@theme';
+exports.REDOCLY_TEAMS_RBAC = 'redocly::teams-rbac';
+exports.DEFAULT_LOCALE_PLACEHOLDER = 'default_locale';
+var FEEDBACK_TYPES;
+(function (FEEDBACK_TYPES) {
+    FEEDBACK_TYPES["RATING"] = "rating";
+    FEEDBACK_TYPES["SENTIMENT"] = "sentiment";
+    FEEDBACK_TYPES["COMMENT"] = "comment";
+    FEEDBACK_TYPES["MOOD"] = "mood";
+    FEEDBACK_TYPES["PROBLEM"] = "problem";
+    FEEDBACK_TYPES["SCALE"] = "scale";
+})(FEEDBACK_TYPES || (exports.FEEDBACK_TYPES = FEEDBACK_TYPES = {}));
+exports.DEV_LOGIN_SLUG = '/login/';
+var ExternalRoutes;
+(function (ExternalRoutes) {
+    ExternalRoutes["AUTH0_PASS"] = "/auth/auth0-pass";
+})(ExternalRoutes || (exports.ExternalRoutes = ExternalRoutes = {}));
+var FsErrors;
+(function (FsErrors) {
+    FsErrors["NotExist"] = "ENOENT";
+})(FsErrors || (exports.FsErrors = FsErrors = {}));
+//# sourceMappingURL=constants.js.map

package/lib/types/portal/src/shared/types/activeItem.d.ts

@@ -0,0 +1,3 @@
+export type ActiveItem<T> = T & {
+    active?: boolean;
+};

package/lib/types/portal/src/shared/types/activeItem.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=activeItem.js.map

package/lib/types/portal/src/shared/types/catalog.d.ts

@@ -0,0 +1,43 @@
+import { CatalogFilterConfig } from '../../../../../index.js';
+export type FilteredCatalog = {
+    groups: {
+        title: string;
+        items: CatalogItem[];
+    }[];
+    filters: ResolvedFilter[];
+    filterTerm: string;
+    setFilterTerm: (term: string) => void;
+};
+export type ResolvedFilter = Omit<CatalogFilterConfig, 'options'> & {
+    options: {
+        value: string;
+        count: number;
+    }[];
+    filteredOptions: {
+        value: string;
+        count: number;
+    }[];
+    toggleOption: (option: string) => void;
+    selectOption: (option: string) => void;
+    parentUsed: boolean;
+    selectedOptions: Set<string> | {
+        from?: string;
+        to?: string;
+    };
+};
+export type CatalogItem = {
+    title: string;
+    link: string;
+    description?: string;
+    image?: string;
+    docsLink?: string;
+    scorecardLevel?: string;
+    scorecardLevelIdx?: number;
+    scorecardLevels?: Record<string, {
+        uniqueErrors: number;
+        uniqueWarnings: number;
+    }>;
+    scoreCardSlug?: string;
+    tags?: unknown[];
+    [k: string]: unknown;
+};

package/lib/types/portal/src/shared/types/catalog.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=catalog.js.map

package/lib/types/portal/src/shared/types/feedback.d.ts

@@ -0,0 +1,13 @@
+import type { FEEDBACK_TYPES } from '../constants';
+import type { RatingProps, SentimentProps, CommentProps, MoodProps, ScaleProps } from '../../../../../components/Feedback';
+export type SubmitFeedbackParams = {
+    type: string;
+    values: Record<string, unknown>;
+    path?: string;
+    location?: string;
+    lang?: string;
+};
+export type FeedbackProps = {
+    type: FEEDBACK_TYPES;
+    settings: (RatingProps | SentimentProps | CommentProps | MoodProps | ScaleProps)['settings'];
+};

package/lib/types/portal/src/shared/types/feedback.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=feedback.js.map

package/lib/types/portal/src/shared/types/markdown.d.ts

@@ -0,0 +1,5 @@
+export type MdHeading = {
+    id: string;
+    value: string;
+    depth: number;
+};

package/lib/types/portal/src/shared/types/markdown.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=markdown.js.map

package/lib/types/portal/src/shared/types/nav.d.ts

@@ -0,0 +1,173 @@
+import type { REDOCLY_TEAMS_RBAC } from '../constants';
+type Rbac = Record<string, string> | undefined;
+export type ResolvedNavLinkItem = {
+    type: 'link';
+    metadata?: Record<string, unknown>;
+    link: string;
+    label: string;
+    labelTranslationKey?: string;
+    items?: ResolvedNavItem[];
+    sidebar?: ResolvedNavItem[];
+    external?: boolean;
+    target?: '_self' | '_blank';
+    languageInsensitive?: boolean;
+    version?: string;
+    isDefault?: boolean;
+    versionFolderId?: string;
+    httpVerb?: string;
+    separatorLine?: boolean;
+    routeSlug?: string;
+    fsPath?: string;
+    active?: boolean;
+    icon?: string;
+    srcSet?: string;
+    [REDOCLY_TEAMS_RBAC]?: Rbac;
+};
+export type ResolvedNavGroupItem = {
+    type: 'group';
+    metadata?: Record<string, unknown>;
+    link?: string;
+    label?: string;
+    labelTranslationKey?: string;
+    items?: ResolvedNavItem[];
+    sidebar?: ResolvedNavItem[];
+    external?: boolean;
+    target?: '_self' | '_blank';
+    expanded?: string;
+    selectFirstItemOnExpand?: boolean;
+    languageInsensitive?: boolean;
+    version?: string;
+    isDefault?: boolean;
+    versionFolderId?: string;
+    menuStyle?: MenuStyle;
+    separatorLine?: boolean;
+    routeSlug?: string;
+    fsPath?: string;
+    active?: boolean;
+    icon?: string;
+    srcSet?: string;
+    [REDOCLY_TEAMS_RBAC]?: Rbac;
+};
+export type ResolvedNavItem = ResolvedNavLinkItem | ResolvedNavGroupItem | {
+    type: 'separator';
+    metadata?: Record<string, unknown>;
+    label?: string;
+    labelTranslationKey?: string;
+    routeSlug?: never;
+    fsPath?: never;
+    version?: string;
+    isDefault?: boolean;
+    versionFolderId?: string;
+    separatorLine?: boolean;
+    link?: undefined;
+    items?: ResolvedNavItem[];
+    sidebar?: ResolvedNavItem[];
+    icon?: string;
+    srcSet?: string;
+    languageInsensitive?: boolean;
+    [REDOCLY_TEAMS_RBAC]?: Rbac;
+} | {
+    type: 'error';
+    version?: string;
+    isDefault?: boolean;
+    versionFolderId?: string;
+    metadata?: Record<string, unknown>;
+    routeSlug?: never;
+    fsPath?: never;
+    label: string;
+    labelTranslationKey?: string;
+    link?: undefined;
+    items?: ResolvedNavItem[];
+    sidebar?: ResolvedNavItem[];
+    icon?: string;
+    srcSet?: string;
+    languageInsensitive?: boolean;
+    [REDOCLY_TEAMS_RBAC]?: Rbac;
+};
+export type ResolvedNavItemWithLink = (ResolvedNavLinkItem | ResolvedNavGroupItem) & {
+    link: string;
+};
+export interface PageProps {
+    seo?: {
+        title?: string;
+    };
+    frontmatter?: Omit<PageProps, 'frontmatter'> & {
+        settings?: any;
+    };
+    disableAutoScroll?: boolean;
+    lastModified?: string | null;
+    [k: string]: any;
+}
+export interface PageStaticData {
+    props?: PageProps;
+    [k: string]: unknown;
+}
+export type UserData = {
+    isAuthenticated: boolean;
+    name: string;
+    picture: string;
+};
+export interface PageData {
+    templateId: string;
+    sharedDataIds: Record<string, string>;
+    props: PageProps;
+    versions?: Version[];
+    userData: UserData;
+}
+export declare enum MenuStyle {
+    Drilldown = "drilldown"
+}
+export type NavItem = {
+    page?: string;
+    directory?: string;
+    group?: string;
+    groupTranslationKey?: string;
+    label?: string;
+    labelTranslationKey?: string;
+    href?: never;
+    items?: NavItem[];
+    separator?: string;
+    separatorTranslationKey?: string;
+    separatorLine?: boolean;
+    version?: string;
+    menuStyle?: MenuStyle;
+    external?: boolean;
+    target?: '_self' | '_blank';
+    expanded?: boolean | 'always';
+    selectFirstItemOnExpand?: boolean;
+    flatten?: boolean;
+};
+export interface LogoConfig {
+    image?: string;
+    srcSet?: string;
+    altText?: string;
+    link?: string;
+    favicon?: string;
+}
+export type Version = {
+    version: string;
+    label: string;
+    link: string;
+    default: boolean;
+    active: boolean;
+    notExists?: boolean;
+    folderId: string;
+};
+export type VersionConfigItem = {
+    version: string;
+    name?: string;
+};
+export type VersionsConfigType = {
+    versions: VersionConfigItem[];
+    default?: string;
+};
+export type VersionedFolderConfig = {
+    versionedFiles: Map<string, Set<string>>;
+    defaultVersion?: string;
+    versions: VersionConfigItem[];
+    hasVersionsConfig?: boolean;
+};
+export type NavGroup = ResolvedNavItem[] | undefined | string | boolean | number;
+export type NavGroupRecord = Record<string, NavGroup>;
+export type ResolvedConfigLinks = NavGroup | NavGroupRecord;
+export {};