@mintlify/models 0.0.14 → 0.0.15

package/README.md

@@ -1,5 +1,5 @@
-# @mintlify/models
-
-Commonly used models, types and interfaces.
-
-_Built with 💚 by the Mintlify community._
+# @mintlify/models
+
+Commonly used models, types and interfaces.
+
+_Built with 💚 by the Mintlify community._

package/dist/constants.js

@@ -0,0 +1 @@
+"use strict";

package/dist/entities/customerPageType.d.ts

@@ -1,8 +1,8 @@
-import { PageMetaTags } from '../types';
-export type CustomerPageType = {
-    subdomain: string;
-    path: string;
-    originalFileLocation: string;
-    content: string;
-    metadata: PageMetaTags;
-};
+import { PageMetaTags } from '../types';
+export type CustomerPageType = {
+    subdomain: string;
+    path: string;
+    originalFileLocation: string;
+    content: string;
+    metadata: PageMetaTags;
+};

package/dist/entities/customerPageType.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/entities/deploymentHistoryType.d.ts

@@ -1,15 +1,15 @@
-export type DeploymentHistoryType = {
-    deploymentId: string;
-    createdAt: Date;
-    endedAt?: Date;
-    status: 'in_progress' | 'success' | 'failure';
-    subdomain?: string;
-    commitSha?: string;
-    screenshot?: string;
-    screenshotLight?: string;
-    screenshotDark?: string;
-    author?: {
-        name?: string;
-        avatarUrl?: string;
-    };
-};
+export type DeploymentHistoryType = {
+    deploymentId: string;
+    createdAt: Date;
+    endedAt?: Date;
+    status: 'in_progress' | 'success' | 'failure';
+    subdomain?: string;
+    commitSha?: string;
+    screenshot?: string;
+    screenshotLight?: string;
+    screenshotDark?: string;
+    author?: {
+        name?: string;
+        avatarUrl?: string;
+    };
+};

package/dist/entities/deploymentHistoryType.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/entities/deploymentType.d.ts

@@ -1,17 +1,17 @@
-import { Analytics } from '../mintconfig';
-import { MintConfig } from '../mintconfig';
-import { GitSource } from '../types';
-export type DeploymentType = {
-    name: string;
-    subdomain: string;
-    orgId: string;
-    createdAt?: string;
-    gitSource: GitSource;
-    analytics?: Analytics;
-    basePath: string;
-    customDomains?: string[];
-    mintConfig: MintConfig;
-    hashedSubdomain?: string;
-    isPasswordProtected?: boolean;
-    vercelProjectId?: string;
-};
+import { Analytics } from '../mintconfig';
+import { MintConfig } from '../mintconfig';
+import { GitSource } from '../types';
+export type DeploymentType = {
+    name: string;
+    subdomain: string;
+    orgId: string;
+    createdAt?: string;
+    gitSource: GitSource;
+    analytics?: Analytics;
+    basePath: string;
+    customDomains?: string[];
+    mintConfig: MintConfig;
+    hashedSubdomain?: string;
+    isPasswordProtected?: boolean;
+    vercelProjectId?: string;
+};

package/dist/entities/deploymentType.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/entities/index.d.ts

@@ -1,12 +1,13 @@
-import { CustomerPageType } from './customerPageType';
-import { DeploymentHistoryType } from './deploymentHistoryType';
-import { DeploymentType } from './deploymentType';
-import { OrgType } from './orgType';
-import { SnippetType } from './snippetType';
-import { UserType } from './userType';
-export declare enum ENTITY_TYPE {
-    DEPLOYMENT = "deployment",
-    SNIPPET = "snippet",
-    PAGE = "page"
-}
-export type { CustomerPageType, DeploymentHistoryType, DeploymentType, OrgType, SnippetType, UserType, };
+import { CustomerPageType } from './customerPageType';
+import { DeploymentHistoryType } from './deploymentHistoryType';
+import { DeploymentType } from './deploymentType';
+import { OrgType } from './orgType';
+import { SnippetType } from './snippetType';
+import { UserType } from './userType';
+export declare enum ENTITY_TYPE {
+    DEPLOYMENT = "deployment",
+    SNIPPET = "snippet",
+    PAGE = "page",
+    ORG = "org"
+}
+export type { CustomerPageType, DeploymentHistoryType, DeploymentType, OrgType, SnippetType, UserType, };

package/dist/entities/index.js

@@ -1,6 +1,7 @@
-export var ENTITY_TYPE;
-(function (ENTITY_TYPE) {
-    ENTITY_TYPE["DEPLOYMENT"] = "deployment";
-    ENTITY_TYPE["SNIPPET"] = "snippet";
-    ENTITY_TYPE["PAGE"] = "page";
-})(ENTITY_TYPE || (ENTITY_TYPE = {}));
+export var ENTITY_TYPE;
+(function (ENTITY_TYPE) {
+    ENTITY_TYPE["DEPLOYMENT"] = "deployment";
+    ENTITY_TYPE["SNIPPET"] = "snippet";
+    ENTITY_TYPE["PAGE"] = "page";
+    ENTITY_TYPE["ORG"] = "org";
+})(ENTITY_TYPE || (ENTITY_TYPE = {}));

package/dist/entities/orgType.d.ts

@@ -1,10 +1,10 @@
-import { GitHubAppType } from '../types/gitHubAppType';
-import { GrowthDataType } from '../types/growthDataType';
-export type OrgType = {
-    name: string;
-    stytchOrgId: string;
-    githubApps: GitHubAppType[];
-    plan?: 'startup' | 'enterprise';
-    createdAt: Date;
-    growthData: GrowthDataType;
-};
+import { GitHubAppType } from '../types/gitHubAppType';
+import { GrowthDataType } from '../types/growthDataType';
+export type OrgType = {
+    name: string;
+    stytchOrgId: string;
+    githubApps: GitHubAppType[];
+    plan?: 'startup' | 'enterprise';
+    createdAt: Date;
+    growthData: GrowthDataType;
+};

package/dist/entities/orgType.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/entities/snippetType.d.ts

@@ -1,5 +1,5 @@
-export type SnippetType = {
-    subdomain: string;
-    snippetFileLocation: string;
-    content: string;
-};
+export type SnippetType = {
+    subdomain: string;
+    snippetFileLocation: string;
+    content: string;
+};

package/dist/entities/snippetType.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/entities/userType.d.ts

@@ -1,7 +1,7 @@
-import { GitAuthType } from '../types/gitAuthType';
-export type UserType = {
-    stytchMemberId: string;
-    orgId: string;
-    gitAuth: GitAuthType[];
-    createdAt: Date;
-};
+import { GitAuthType } from '../types/gitAuthType';
+export type UserType = {
+    stytchMemberId: string;
+    orgId: string;
+    gitAuth: GitAuthType[];
+    createdAt: Date;
+};

package/dist/entities/userType.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export * from './mintconfig';
-export * from './entities';
-export * from './types';
+export * from './mintconfig';
+export * from './entities';
+export * from './types';

package/dist/index.js

@@ -1,3 +1,3 @@
-export * from './mintconfig';
-export * from './entities';
-export * from './types';
+export * from './mintconfig';
+export * from './entities';
+export * from './types';

package/dist/mintconfig/analytics.d.ts

@@ -0,0 +1,52 @@
+export type FathomConfigInterface = {
+    siteId?: string;
+};
+export type GoogleAnalyticsConfigInterface = {
+    measurementId?: string;
+};
+export type GoogleTagManagerConfigInterface = {
+    tagId?: string;
+};
+export type HotjarConfigInterface = {
+    hjid?: string;
+    hjsv?: string;
+};
+export type KoalaConfigInterface = {
+    publicApiKey?: string;
+};
+export type LogrocketConfigInterface = {
+    appId?: string;
+};
+export type MixpanelConfigInterface = {
+    projectToken?: string;
+};
+export type PirschConfigInterface = {
+    id?: string;
+};
+export type PostHogConfigInterface = {
+    apiHost?: string;
+    apiKey?: string;
+};
+export type PlausibleInterface = {
+    domain?: string;
+};
+export type AmplitudeConfigInterface = {
+    apiKey?: string;
+};
+export type ClearbitConfigInterface = {
+    publicApiKey?: string;
+};
+export type Analytics = {
+    amplitude?: AmplitudeConfigInterface;
+    clearbit?: ClearbitConfigInterface;
+    fathom?: FathomConfigInterface;
+    ga4?: GoogleAnalyticsConfigInterface;
+    gtm?: GoogleTagManagerConfigInterface;
+    hotjar?: HotjarConfigInterface;
+    koala?: KoalaConfigInterface;
+    logrocket?: LogrocketConfigInterface;
+    mixpanel?: MixpanelConfigInterface;
+    pirsch?: PirschConfigInterface;
+    plausible?: PlausibleInterface;
+    posthog?: PostHogConfigInterface;
+};

package/dist/mintconfig/{topBarCta.js → analytics.js}

@@ -1 +1 @@
-export {};
+export {};

package/dist/mintconfig/anchor.d.ts

@@ -0,0 +1,9 @@
+import { Gradient } from './gradient';
+export type Anchor = {
+    color?: string | Gradient;
+    icon?: string;
+    isDefaultHidden?: boolean;
+    name: string;
+    url: string;
+    version?: string;
+};

package/dist/mintconfig/anchor.js

@@ -0,0 +1 @@
+export {};

package/dist/mintconfig/apiConfig.d.ts

@@ -0,0 +1,17 @@
+export type ApiConfig = {
+    baseUrl?: string | string[];
+    auth?: {
+        method: 'key' | 'bearer' | 'basic';
+        name?: string;
+        inputPrefix?: string;
+    };
+    playground?: {
+        mode: 'show' | 'simple' | 'hide';
+    };
+    request?: {
+        example?: {
+            showOptionalParams: boolean;
+        };
+    };
+    maintainOrder?: boolean;
+};

package/dist/mintconfig/apiConfig.js

@@ -0,0 +1 @@
+export {};

package/dist/mintconfig/author.d.ts

@@ -1,4 +1,4 @@
-export type Author = {
-    name: string;
-    image?: string;
-};
+export type Author = {
+    name: string;
+    image?: string;
+};

package/dist/mintconfig/author.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/mintconfig/configNavGroup.d.ts

@@ -0,0 +1,6 @@
+import { NavigationEntry } from './navigationEntry';
+export type ConfigNavGroup = {
+    group: string;
+    pages: NavigationEntry[];
+    version?: string;
+};

package/dist/mintconfig/configNavGroup.js

@@ -0,0 +1 @@
+export {};

package/dist/mintconfig/footerSocial.d.ts

@@ -1,4 +1,4 @@
-export type FooterSocial = {
-    type: string;
-    url: string;
-};
+export type FooterSocial = {
+    type: string;
+    url: string;
+};

package/dist/mintconfig/footerSocial.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/mintconfig/footerSocials.d.ts

@@ -1 +1 @@
-export type FooterSocials = Record<string, string>;
+export type FooterSocials = Record<string, string>;

package/dist/mintconfig/footerSocials.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/mintconfig/gradient.d.ts

@@ -1,5 +1,5 @@
-export type Gradient = {
-    from: string;
-    via?: string;
-    to: string;
-};
+export type Gradient = {
+    from: string;
+    via?: string;
+    to: string;
+};

package/dist/mintconfig/gradient.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/mintconfig/iconTypes.d.ts

@@ -1,2 +1,2 @@
-export declare const iconTypes: readonly ["brands", "duotone", "light", "regular", "sharp-solid", "solid", "thin"];
-export type IconType = (typeof iconTypes)[number];
+export declare const iconTypes: readonly ["brands", "duotone", "light", "regular", "sharp-solid", "solid", "thin"];
+export type IconType = (typeof iconTypes)[number];

package/dist/mintconfig/iconTypes.js

@@ -1,9 +1,9 @@
-export var iconTypes = [
-    'brands',
-    'duotone',
-    'light',
-    'regular',
-    'sharp-solid',
-    'solid',
-    'thin',
-];
+export var iconTypes = [
+    'brands',
+    'duotone',
+    'light',
+    'regular',
+    'sharp-solid',
+    'solid',
+    'thin',
+];

package/dist/mintconfig/index.d.ts

@@ -1,21 +1,21 @@
-import { AnalyticsType as Analytics, AnchorsType as Anchors, AnchorType as Anchor, ColorsType as Colors, ConfigType, NavigationEntry, NavigationType as Navigation, ApiConfigType as ApiConfig } from '@mintlify/validation';
-import { FooterSocials } from './footerSocials';
-import { Gradient } from './gradient';
-import { IconType, iconTypes } from './iconTypes';
-import { Logo } from './logo';
-import { NavbarLink } from './navbarLink';
-import { Tab } from './tab';
-import { TopBarCta } from './topBarCta';
-export { iconTypes };
-export type MintConfig = ConfigType & {
-    repo?: {
-        github?: {
-            owner: string;
-            repo: string;
-            deployBranch: string;
-            contentDirectory: string;
-            isPrivate?: boolean;
-        };
-    };
-};
-export type { Logo, NavbarLink, Navigation, Anchor, Anchors, Analytics, FooterSocials, ApiConfig, Gradient, Tab, NavigationEntry, TopBarCta, IconType, Colors, };
+import { AnalyticsType as Analytics, AnchorsType as Anchors, AnchorType as Anchor, ColorsType as Colors, ConfigType, NavigationEntry, NavigationType as Navigation, ApiConfigType as ApiConfig } from '@mintlify/validation';
+import { FooterSocials } from './footerSocials';
+import { Gradient } from './gradient';
+import { IconType, iconTypes } from './iconTypes';
+import { Logo } from './logo';
+import { NavbarLink } from './navbarLink';
+import { Tab } from './tab';
+import { TopBarCta } from './topBarCta';
+export { iconTypes };
+export type MintConfig = ConfigType & {
+    repo?: {
+        github?: {
+            owner: string;
+            repo: string;
+            deployBranch: string;
+            contentDirectory: string;
+            isPrivate?: boolean;
+        };
+    };
+};
+export type { Logo, NavbarLink, Navigation, Anchor, Anchors, Analytics, FooterSocials, ApiConfig, Gradient, Tab, NavigationEntry, TopBarCta, IconType, Colors, };

package/dist/mintconfig/index.js

@@ -1,2 +1,2 @@
-import { iconTypes } from './iconTypes';
-export { iconTypes };
+import { iconTypes } from './iconTypes';
+export { iconTypes };

package/dist/mintconfig/logo.d.ts

@@ -1,5 +1,5 @@
-export type Logo = string | {
-    light: string;
-    dark: string;
-    href?: string;
-};
+export type Logo = string | {
+    light: string;
+    dark: string;
+    href?: string;
+};

package/dist/mintconfig/logo.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/mintconfig/mintConfigIntegrations.d.ts

@@ -1,4 +1,4 @@
-export type MintConfigIntegrations = {
-    intercom?: string;
-    frontchat?: string;
-};
+export type MintConfigIntegrations = {
+    intercom?: string;
+    frontchat?: string;
+};

package/dist/mintconfig/mintConfigIntegrations.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/mintconfig/navbarLink.d.ts

@@ -1,5 +1,5 @@
-export type NavbarLink = {
-    name?: string;
-    type?: 'github' | 'link' | string;
-    url: string;
-};
+export type NavbarLink = {
+    name?: string;
+    type?: 'github' | 'link' | string;
+    url: string;
+};

package/dist/mintconfig/navbarLink.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/mintconfig/navigation.d.ts

@@ -0,0 +1,6 @@
+import { NavigationEntry } from './navigationEntry';
+export type Navigation = {
+    group: string;
+    pages: NavigationEntry[];
+    version?: string;
+};

package/dist/mintconfig/navigation.js

@@ -0,0 +1 @@
+export {};

package/dist/mintconfig/navigationEntry.d.ts

@@ -0,0 +1,2 @@
+import { ConfigNavGroup } from './configNavGroup';
+export type NavigationEntry = string | ConfigNavGroup;

package/dist/mintconfig/navigationEntry.js

@@ -0,0 +1 @@
+export {};

package/dist/mintconfig/tab.d.ts

@@ -1,4 +1,4 @@
-export type Tab = {
-    name: string;
-    url: string;
-};
+export type Tab = {
+    name: string;
+    url: string;
+};

package/dist/mintconfig/tab.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/mintconfig/{topBarCta.d.ts → topbarCta.d.ts}

@@ -1,2 +1,2 @@
-import { NavbarLink } from './navbarLink';
-export type TopBarCta = NavbarLink;
+import { NavbarLink } from './navbarLink';
+export type TopBarCta = NavbarLink;

package/dist/mintconfig/topbarCta.js

@@ -0,0 +1 @@
+export {};