@cbnventures/docusaurus-preset-nova 0.0.0 → 0.15.0

package/build/src/types/shared.d.ts

@@ -0,0 +1,385 @@
+/**
+ * Shared - Color Scale.
+ *
+ * @since 0.15.0
+ */
+export type SharedColorScaleKey = 50 | 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900 | 950;
+
+export type SharedColorScaleValue = string;
+
+export type SharedColorScale = Record<SharedColorScaleKey, SharedColorScaleValue>;
+
+/**
+ * Shared - Hast Node.
+ *
+ * @since 0.15.0
+ */
+export type SharedHastNodeType = string;
+
+export type SharedHastNodeTagName = string | undefined;
+
+export type SharedHastNodeProperties = Record<string, unknown>;
+
+export type SharedHastNodeChildren = SharedHastNode[];
+
+export type SharedHastNodeValue = string | undefined;
+
+export type SharedHastNodeData = Record<string, unknown> | undefined;
+
+export type SharedHastNode = {
+  type: SharedHastNodeType;
+  tagName?: SharedHastNodeTagName;
+  properties?: SharedHastNodeProperties;
+  children?: SharedHastNodeChildren;
+  value?: SharedHastNodeValue;
+  data?: SharedHastNodeData;
+};
+
+/**
+ * Shared - Hast Node Result.
+ *
+ * @since 0.15.0
+ */
+export type SharedHastNodeResultNode = SharedHastNode;
+
+export type SharedHastNodeResultIndex = number;
+
+export type SharedHastNodeResultParent = SharedHastNode;
+
+export type SharedHastNodeResult = {
+  node: SharedHastNodeResultNode;
+  index: SharedHastNodeResultIndex;
+  parent: SharedHastNodeResultParent;
+};
+
+/**
+ * Shared - Hex Color.
+ *
+ * @since 0.15.0
+ */
+export type SharedHexColor = string;
+
+/**
+ * Shared - Hsl Color.
+ *
+ * @since 0.15.0
+ */
+export type SharedHslColorHue = number;
+
+export type SharedHslColorSaturation = number;
+
+export type SharedHslColorLightness = number;
+
+export type SharedHslColor = {
+  hue: SharedHslColorHue;
+  saturation: SharedHslColorSaturation;
+  lightness: SharedHslColorLightness;
+};
+
+/**
+ * Shared - Mermaid.
+ *
+ * @since 0.15.0
+ */
+export type SharedMermaidRenderOutputSvg = string;
+
+export type SharedMermaidRenderOutputBindFunctions = ((element: Element) => void) | undefined;
+
+export type SharedMermaidRenderOutput = {
+  svg: SharedMermaidRenderOutputSvg;
+  bindFunctions?: SharedMermaidRenderOutputBindFunctions;
+};
+
+export type SharedMermaidConfigStartOnLoad = boolean;
+
+export type SharedMermaidConfigTheme = string;
+
+export type SharedMermaidConfigColorMode = string;
+
+export type SharedMermaidConfig = {
+  startOnLoad: SharedMermaidConfigStartOnLoad;
+  theme: SharedMermaidConfigTheme;
+  colorMode: SharedMermaidConfigColorMode;
+  [key: string]: unknown;
+};
+
+/**
+ * Shared - Preset.
+ *
+ * @since 0.15.0
+ */
+export type SharedPresetName = 'foundry' | 'sentinel' | 'signal' | 'envoy';
+
+export type SharedPresetColorsPrimary = SharedHexColor;
+
+export type SharedPresetColorsAccent = SharedHexColor;
+
+export type SharedPresetColorsNeutral = SharedHexColor;
+
+export type SharedPresetColors = {
+  primary: SharedPresetColorsPrimary;
+  accent: SharedPresetColorsAccent;
+  neutral: SharedPresetColorsNeutral;
+};
+
+export type SharedPresetFontsDisplay = string;
+
+export type SharedPresetFontsBody = string;
+
+export type SharedPresetFontsCode = string;
+
+export type SharedPresetFonts = {
+  display: SharedPresetFontsDisplay;
+  body: SharedPresetFontsBody;
+  code: SharedPresetFontsCode;
+};
+
+export type SharedPresetShapeRadius = 'sharp' | 'rounded' | 'pill';
+
+export type SharedPresetShapeDensity = 'compact' | 'comfortable' | 'spacious';
+
+export type SharedPresetShape = {
+  radius: SharedPresetShapeRadius;
+  density: SharedPresetShapeDensity;
+};
+
+export type SharedPresetDepthCards = 'flat' | 'elevated' | 'glass';
+
+export type SharedPresetDepthCodeBlocks = 'flat' | 'bordered' | 'elevated';
+
+export type SharedPresetDepth = {
+  cards: SharedPresetDepthCards;
+  codeBlocks: SharedPresetDepthCodeBlocks;
+};
+
+export type SharedPresetMotionSpeed = 'none' | 'subtle' | 'normal' | 'expressive';
+
+export type SharedPresetMotionStaggeredReveals = boolean;
+
+export type SharedPresetMotionHoverEffects = boolean;
+
+export type SharedPresetMotion = {
+  speed: SharedPresetMotionSpeed;
+  staggeredReveals: SharedPresetMotionStaggeredReveals;
+  hoverEffects: SharedPresetMotionHoverEffects;
+};
+
+export type SharedPresetNavbar = 'bridge' | 'canopy' | 'monolith' | 'compass';
+
+export type SharedPresetFooter = 'commons' | 'embassy' | 'ledger' | 'launchpad';
+
+export type SharedPresetLogoTitle = string;
+
+export type SharedPresetLogoAlt = string;
+
+export type SharedPresetLogoSrc = string;
+
+export type SharedPresetLogo = {
+  title: SharedPresetLogoTitle;
+  alt: SharedPresetLogoAlt;
+  src: SharedPresetLogoSrc;
+};
+
+export type SharedPreset = {
+  logo: SharedPresetLogo;
+  colors: SharedPresetColors;
+  fonts: SharedPresetFonts;
+  shape: SharedPresetShape;
+  depth: SharedPresetDepth;
+  motion: SharedPresetMotion;
+  navbar: SharedPresetNavbar;
+  footer: SharedPresetFooter;
+};
+
+/**
+ * Shared - Search Worker Document.
+ *
+ * @since 0.15.0
+ */
+export type SharedSearchWorkerDocumentPath = string;
+
+export type SharedSearchWorkerDocumentTitle = string;
+
+export type SharedSearchWorkerDocumentSnippet = string;
+
+export type SharedSearchWorkerDocumentBody = string;
+
+export type SharedSearchWorkerDocument = {
+  path: SharedSearchWorkerDocumentPath;
+  title: SharedSearchWorkerDocumentTitle;
+  snippet: SharedSearchWorkerDocumentSnippet;
+  body: SharedSearchWorkerDocumentBody;
+};
+
+export type SharedSearchWorkerDocuments = SharedSearchWorkerDocument[];
+
+/**
+ * Shared - Search Worker Error Response.
+ *
+ * @since 0.15.0
+ */
+export type SharedSearchWorkerErrorResponseType = 'error';
+
+export type SharedSearchWorkerErrorResponseReason = string;
+
+export type SharedSearchWorkerErrorResponse = {
+  type: SharedSearchWorkerErrorResponseType;
+  reason: SharedSearchWorkerErrorResponseReason;
+};
+
+/**
+ * Shared - Search Worker Init Message.
+ *
+ * @since 0.15.0
+ */
+export type SharedSearchWorkerInitMessageType = 'init';
+
+export type SharedSearchWorkerInitMessageIndexUrl = string;
+
+export type SharedSearchWorkerInitMessage = {
+  type: SharedSearchWorkerInitMessageType;
+  indexUrl: SharedSearchWorkerInitMessageIndexUrl;
+};
+
+/**
+ * Shared - Search Worker Lunr Result.
+ *
+ * @since 0.15.0
+ */
+export type SharedSearchWorkerLunrResultRef = string;
+
+export type SharedSearchWorkerLunrResultScore = number;
+
+export type SharedSearchWorkerLunrResultMatchDataMetadata = Record<string, unknown>;
+
+export type SharedSearchWorkerLunrResultMatchData = {
+  metadata: SharedSearchWorkerLunrResultMatchDataMetadata;
+};
+
+export type SharedSearchWorkerLunrResult = {
+  ref: SharedSearchWorkerLunrResultRef;
+  score: SharedSearchWorkerLunrResultScore;
+  matchData: SharedSearchWorkerLunrResultMatchData;
+};
+
+/**
+ * Shared - Search Worker Message.
+ *
+ * @since 0.15.0
+ */
+export type SharedSearchWorkerMessage = SharedSearchWorkerInitMessage | SharedSearchWorkerSearchMessage;
+
+/**
+ * Shared - Search Worker Ready Response.
+ *
+ * @since 0.15.0
+ */
+export type SharedSearchWorkerReadyResponseType = 'ready';
+
+export type SharedSearchWorkerReadyResponse = {
+  type: SharedSearchWorkerReadyResponseType;
+};
+
+/**
+ * Shared - Search Worker Response.
+ *
+ * @since 0.15.0
+ */
+export type SharedSearchWorkerResponse = SharedSearchWorkerReadyResponse | SharedSearchWorkerResultsResponse | SharedSearchWorkerErrorResponse;
+
+/**
+ * Shared - Search Worker Results Response.
+ *
+ * @since 0.15.0
+ */
+export type SharedSearchWorkerResultsResponseType = 'results';
+
+export type SharedSearchWorkerResultsResponseHits = SharedSearchWorkerSearchHit[];
+
+export type SharedSearchWorkerResultsResponse = {
+  type: SharedSearchWorkerResultsResponseType;
+  hits: SharedSearchWorkerResultsResponseHits;
+};
+
+/**
+ * Shared - Search Worker Search Hit.
+ *
+ * @since 0.15.0
+ */
+export type SharedSearchWorkerSearchHitPath = string;
+
+export type SharedSearchWorkerSearchHitTitle = string;
+
+export type SharedSearchWorkerSearchHitSnippet = string;
+
+export type SharedSearchWorkerSearchHitScore = number;
+
+export type SharedSearchWorkerSearchHitSnippetSegmentText = string;
+
+export type SharedSearchWorkerSearchHitSnippetSegmentHighlight = boolean;
+
+export type SharedSearchWorkerSearchHitSnippetSegment = {
+  text: SharedSearchWorkerSearchHitSnippetSegmentText;
+  highlight: SharedSearchWorkerSearchHitSnippetSegmentHighlight;
+};
+
+export type SharedSearchWorkerSearchHitSnippetSegments = SharedSearchWorkerSearchHitSnippetSegment[];
+
+export type SharedSearchWorkerSearchHit = {
+  path: SharedSearchWorkerSearchHitPath;
+  title: SharedSearchWorkerSearchHitTitle;
+  snippet: SharedSearchWorkerSearchHitSnippet;
+  snippetSegments: SharedSearchWorkerSearchHitSnippetSegments;
+  score: SharedSearchWorkerSearchHitScore;
+};
+
+/**
+ * Shared - Search Worker Search Message.
+ *
+ * @since 0.15.0
+ */
+export type SharedSearchWorkerSearchMessageType = 'search';
+
+export type SharedSearchWorkerSearchMessageQuery = string;
+
+export type SharedSearchWorkerSearchMessageLimit = number;
+
+export type SharedSearchWorkerSearchMessage = {
+  type: SharedSearchWorkerSearchMessageType;
+  query: SharedSearchWorkerSearchMessageQuery;
+  limit: SharedSearchWorkerSearchMessageLimit;
+};
+
+/**
+ * Shared - Search Worker Test Document.
+ *
+ * @since 0.15.0
+ */
+export type SharedSearchWorkerTestDocumentPath = string;
+
+export type SharedSearchWorkerTestDocumentTitle = string;
+
+export type SharedSearchWorkerTestDocumentSnippet = string;
+
+export type SharedSearchWorkerTestDocumentBody = string;
+
+export type SharedSearchWorkerTestDocument = {
+  path: SharedSearchWorkerTestDocumentPath;
+  title: SharedSearchWorkerTestDocumentTitle;
+  snippet: SharedSearchWorkerTestDocumentSnippet;
+  body: SharedSearchWorkerTestDocumentBody;
+};
+
+/**
+ * Shared - Shade Level.
+ *
+ * @since 0.15.0
+ */
+export type SharedShadeLevel = 50 | 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900 | 950;
+
+/**
+ * Shared - Surface.
+ *
+ * @since 0.15.0
+ */
+export type SharedSurface = 'alt';

package/build/src/types/tests/config-drift.test.d.ts

@@ -0,0 +1,199 @@
+import type { OptionsPluginOptions } from '../options.d.ts';
+
+/**
+ * Tests - Config Drift - ConfigDrift ValidateOptions.
+ *
+ * @since 0.15.0
+ */
+export type TestsConfigDriftValidatedResult = OptionsPluginOptions;
+
+export type TestsConfigDriftJoiSchemaValidate = (value: unknown) => TestsConfigDriftJoiSchemaValidateResult;
+
+export type TestsConfigDriftJoiSchema = {
+  validate: TestsConfigDriftJoiSchemaValidate;
+};
+
+export type TestsConfigDriftJoiSchemaValidateResultValue = unknown;
+
+export type TestsConfigDriftJoiSchemaValidateResult = {
+  value: TestsConfigDriftJoiSchemaValidateResultValue;
+  error?: Error;
+};
+
+export type TestsConfigDriftPresetValue = string;
+
+export type TestsConfigDriftOverrides = OptionsPluginOptions['overrides'];
+
+export type TestsConfigDriftOverridesColorsPrimary = string | undefined;
+
+export type TestsConfigDriftOverridesColorsAccent = string | undefined;
+
+export type TestsConfigDriftOverridesColorsNeutral = string | undefined;
+
+export type TestsConfigDriftOverridesFontsDisplay = string | undefined;
+
+export type TestsConfigDriftOverridesFontsBody = string | undefined;
+
+export type TestsConfigDriftOverridesFontsCode = string | undefined;
+
+export type TestsConfigDriftOverridesShapeRadius = string | undefined;
+
+export type TestsConfigDriftOverridesShapeDensity = string | undefined;
+
+export type TestsConfigDriftOverridesDepthCards = string | undefined;
+
+export type TestsConfigDriftOverridesDepthCodeBlocks = string | undefined;
+
+export type TestsConfigDriftOverridesMotionSpeed = string | undefined;
+
+export type TestsConfigDriftOverridesMotionStaggeredReveals = boolean | undefined;
+
+export type TestsConfigDriftOverridesMotionHoverEffects = boolean | undefined;
+
+export type TestsConfigDriftOverridesNavbar = string | undefined;
+
+export type TestsConfigDriftOverridesFooter = string | undefined;
+
+export type TestsConfigDriftPlugins = OptionsPluginOptions['plugins'];
+
+export type TestsConfigDriftPluginsDocs = Record<string, unknown> | undefined;
+
+export type TestsConfigDriftPluginsBlog = Record<string, unknown> | false | undefined;
+
+export type TestsConfigDriftPluginsPages = Record<string, unknown> | false | undefined;
+
+export type TestsConfigDriftPluginsSitemap = Record<string, unknown> | false | undefined;
+
+export type TestsConfigDriftAnalytics = OptionsPluginOptions['analytics'];
+
+export type TestsConfigDriftAnalyticsGtmContainerId = string;
+
+export type TestsConfigDriftProgressBar = boolean | Record<string, unknown>;
+
+export type TestsConfigDriftSearch = OptionsPluginOptions['search'];
+
+export type TestsConfigDriftSearchLanguage = string[];
+
+export type TestsConfigDriftSearchIndexDocs = boolean;
+
+export type TestsConfigDriftSearchIndexBlog = boolean;
+
+export type TestsConfigDriftSearchIndexPages = boolean;
+
+export type TestsConfigDriftSearchHashed = boolean;
+
+export type TestsConfigDriftSearchResultLimits = number;
+
+export type TestsConfigDriftSearchHighlightSearchTermsOnTargetPage = boolean;
+
+export type TestsConfigDriftSearchBarShortcutKeymap = string;
+
+export type TestsConfigDriftSearchFuzzyMatchingDistance = number;
+
+export type TestsConfigDriftSearchIgnorePatterns = string[];
+
+export type TestsConfigDriftSearchDocsRouteBasePath = string;
+
+/**
+ * Tests - Config Drift - ConfigDrift ValidateThemeConfig.
+ *
+ * @since 0.15.0
+ */
+export type TestsConfigDriftThemeConfigValidatedResult = Record<string, unknown>;
+
+export type TestsConfigDriftThemeConfigJoiSchemaValidate = (value: unknown) => TestsConfigDriftThemeConfigJoiSchemaValidateResult;
+
+export type TestsConfigDriftThemeConfigJoiSchema = {
+  validate: TestsConfigDriftThemeConfigJoiSchemaValidate;
+};
+
+export type TestsConfigDriftThemeConfigJoiSchemaValidateResultValue = unknown;
+
+export type TestsConfigDriftThemeConfigJoiSchemaValidateResult = {
+  value: TestsConfigDriftThemeConfigJoiSchemaValidateResultValue;
+  error?: Error;
+};
+
+export type TestsConfigDriftThemeConfigSite = Record<string, unknown>;
+
+export type TestsConfigDriftThemeConfigSiteTitle = string;
+
+export type TestsConfigDriftThemeConfigSiteLogo = Record<string, unknown>;
+
+export type TestsConfigDriftThemeConfigSiteLogoAlt = string;
+
+export type TestsConfigDriftThemeConfigSiteLogoSrc = string;
+
+export type TestsConfigDriftThemeConfigSiteLogoSrcDark = string | undefined;
+
+export type TestsConfigDriftThemeConfigSiteLogoHref = string | undefined;
+
+export type TestsConfigDriftThemeConfigSiteLogoWordmark = string | undefined;
+
+export type TestsConfigDriftThemeConfigSiteLogoWordmarkDark = string | undefined;
+
+export type TestsConfigDriftThemeConfigSiteLogoTitle = string | undefined;
+
+export type TestsConfigDriftThemeConfigSiteImage = string;
+
+export type TestsConfigDriftThemeConfigSiteMetadata = unknown[];
+
+export type TestsConfigDriftThemeConfigColorMode = Record<string, unknown>;
+
+export type TestsConfigDriftThemeConfigColorModeDefaultMode = string;
+
+export type TestsConfigDriftThemeConfigColorModeDisableSwitch = boolean;
+
+export type TestsConfigDriftThemeConfigNavbar = Record<string, unknown>;
+
+export type TestsConfigDriftThemeConfigNavbarHideOnScroll = boolean;
+
+export type TestsConfigDriftThemeConfigNavbarItems = unknown[];
+
+export type TestsConfigDriftThemeConfigDocs = Record<string, unknown>;
+
+export type TestsConfigDriftThemeConfigDocsVersionPersistence = string;
+
+export type TestsConfigDriftThemeConfigDocsSidebar = Record<string, unknown>;
+
+export type TestsConfigDriftThemeConfigDocsSidebarHideable = boolean;
+
+export type TestsConfigDriftThemeConfigDocsSidebarAutoCollapseCategories = boolean;
+
+export type TestsConfigDriftThemeConfigBlog = Record<string, unknown>;
+
+export type TestsConfigDriftThemeConfigBlogSidebar = Record<string, unknown>;
+
+export type TestsConfigDriftThemeConfigBlogSidebarGroupByYear = boolean;
+
+export type TestsConfigDriftThemeConfigBlogLayout = Record<string, unknown>;
+
+export type TestsConfigDriftThemeConfigBlogLayoutHeading = string;
+
+export type TestsConfigDriftThemeConfigBlogLayoutDescription = string;
+
+export type TestsConfigDriftThemeConfigBlogShare = Record<string, unknown>;
+
+export type TestsConfigDriftThemeConfigBlogSharePlatforms = string[];
+
+export type TestsConfigDriftThemeConfigTableOfContents = Record<string, unknown>;
+
+export type TestsConfigDriftThemeConfigTableOfContentsMinHeadingLevel = number;
+
+export type TestsConfigDriftThemeConfigTableOfContentsMaxHeadingLevel = number;
+
+export type TestsConfigDriftThemeConfigAnnouncementBar = Record<string, unknown>;
+
+export type TestsConfigDriftThemeConfigAnnouncementBarId = string;
+
+export type TestsConfigDriftThemeConfigAnnouncementBarContent = string;
+
+export type TestsConfigDriftThemeConfigAnnouncementBarBackgroundColor = string | undefined;
+
+export type TestsConfigDriftThemeConfigAnnouncementBarTextColor = string | undefined;
+
+export type TestsConfigDriftThemeConfigAnnouncementBarIsCloseable = boolean;
+
+export type TestsConfigDriftThemeConfigFooter = Record<string, unknown>;
+
+export type TestsConfigDriftThemeConfigFooterCta = string | undefined;

package/build/src/types/tests/lib/color.test.d.ts

@@ -0,0 +1,113 @@
+import type { Color } from '../../../lib/color.js';
+
+import type {
+  SharedColorScale,
+  SharedHexColor,
+  SharedShadeLevel,
+} from '../../shared.d.ts';
+
+/**
+ * Tests - Lib - Color - Color Constructor.
+ *
+ * @since 0.15.0
+ */
+export type TestsLibColorInstance = Color;
+
+/**
+ * Tests - Lib - Color - Color Edge Cases.
+ *
+ * @since 0.15.0
+ */
+export type TestsLibColorEdgeCaseInstance = Color;
+
+export type TestsLibColorEdgeCaseScale = SharedColorScale;
+
+export type TestsLibColorEdgeCaseShadeKeys = string[];
+
+/**
+ * Tests - Lib - Color - Color GenerateScale.
+ *
+ * @since 0.15.0
+ */
+export type TestsLibColorGenerateScaleInstance = Color;
+
+export type TestsLibColorGenerateScaleResult = SharedColorScale;
+
+export type TestsLibColorGenerateScaleShadeKeys = string[];
+
+export type TestsLibColorGenerateScaleExpectedLevel = SharedShadeLevel;
+
+export type TestsLibColorGenerateScaleShade600 = SharedHexColor;
+
+export type TestsLibColorGenerateScaleShade600RedSlice = string;
+
+export type TestsLibColorGenerateScaleShade600Red = number;
+
+export type TestsLibColorGenerateScaleShade600GreenSlice = string;
+
+export type TestsLibColorGenerateScaleShade600Green = number;
+
+export type TestsLibColorGenerateScaleShade600BlueSlice = string;
+
+export type TestsLibColorGenerateScaleShade600Blue = number;
+
+export type TestsLibColorGenerateScaleInputRedString = string;
+
+export type TestsLibColorGenerateScaleInputRed = number;
+
+export type TestsLibColorGenerateScaleInputGreenString = string;
+
+export type TestsLibColorGenerateScaleInputGreen = number;
+
+export type TestsLibColorGenerateScaleInputBlueString = string;
+
+export type TestsLibColorGenerateScaleInputBlue = number;
+
+export type TestsLibColorGenerateScaleRedDiff = number;
+
+export type TestsLibColorGenerateScaleGreenDiff = number;
+
+export type TestsLibColorGenerateScaleBlueDiff = number;
+
+export type TestsLibColorGenerateScaleAnchorHex = SharedHexColor;
+
+export type TestsLibColorGenerateScaleAnchorLightness = number;
+
+export type TestsLibColorGenerateScaleLighterHex = SharedHexColor;
+
+export type TestsLibColorGenerateScaleLighterLightness = number;
+
+export type TestsLibColorGenerateScaleDarkerHex = SharedHexColor;
+
+export type TestsLibColorGenerateScaleDarkerLightness = number;
+
+/**
+ * Tests - Lib - Color - Hex To Lightness.
+ *
+ * @since 0.15.0
+ */
+export type TestsLibColorHexToLightnessHex = string;
+
+export type TestsLibColorHexToLightnessReturns = number;
+
+export type TestsLibColorHexToLightnessRedSlice = string;
+
+export type TestsLibColorHexToLightnessRed = number;
+
+export type TestsLibColorHexToLightnessGreenSlice = string;
+
+export type TestsLibColorHexToLightnessGreen = number;
+
+export type TestsLibColorHexToLightnessBlueSlice = string;
+
+export type TestsLibColorHexToLightnessBlue = number;
+
+export type TestsLibColorHexToLightnessNormalizedRed = number;
+
+export type TestsLibColorHexToLightnessNormalizedGreen = number;
+
+export type TestsLibColorHexToLightnessNormalizedBlue = number;
+
+export type TestsLibColorHexToLightnessChannelMax = number;
+
+export type TestsLibColorHexToLightnessChannelMin = number;