@mintlify/models 0.0.7 → 0.0.8

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 (76) hide show
  1. package/LICENSE +93 -0
  2. package/README.md +5 -5
  3. package/dist/entities/customerPageType.d.ts +8 -8
  4. package/dist/entities/customerPageType.js +1 -1
  5. package/dist/entities/deploymentHistoryType.d.ts +15 -15
  6. package/dist/entities/deploymentHistoryType.js +1 -1
  7. package/dist/entities/deploymentType.d.ts +17 -17
  8. package/dist/entities/deploymentType.js +1 -1
  9. package/dist/entities/index.d.ts +12 -12
  10. package/dist/entities/index.js +6 -6
  11. package/dist/entities/orgType.d.ts +10 -10
  12. package/dist/entities/orgType.js +1 -1
  13. package/dist/entities/snippetType.d.ts +5 -5
  14. package/dist/entities/snippetType.js +1 -1
  15. package/dist/entities/userType.d.ts +7 -7
  16. package/dist/entities/userType.js +1 -1
  17. package/dist/index.d.ts +3 -3
  18. package/dist/index.js +3 -3
  19. package/dist/mintconfig/author.d.ts +4 -4
  20. package/dist/mintconfig/author.js +1 -1
  21. package/dist/mintconfig/footerSocial.d.ts +4 -4
  22. package/dist/mintconfig/footerSocial.js +1 -1
  23. package/dist/mintconfig/footerSocials.d.ts +1 -1
  24. package/dist/mintconfig/footerSocials.js +1 -1
  25. package/dist/mintconfig/gradient.d.ts +5 -5
  26. package/dist/mintconfig/gradient.js +1 -1
  27. package/dist/mintconfig/iconTypes.d.ts +2 -2
  28. package/dist/mintconfig/iconTypes.js +9 -9
  29. package/dist/mintconfig/index.d.ts +21 -21
  30. package/dist/mintconfig/index.js +2 -2
  31. package/dist/mintconfig/logo.d.ts +5 -5
  32. package/dist/mintconfig/logo.js +1 -1
  33. package/dist/mintconfig/mintConfigIntegrations.d.ts +4 -4
  34. package/dist/mintconfig/mintConfigIntegrations.js +1 -1
  35. package/dist/mintconfig/navbarLink.d.ts +5 -5
  36. package/dist/mintconfig/navbarLink.js +1 -1
  37. package/dist/mintconfig/tab.d.ts +4 -4
  38. package/dist/mintconfig/tab.js +1 -1
  39. package/dist/mintconfig/{topbarCta.d.ts → topBarCta.d.ts} +2 -2
  40. package/dist/mintconfig/{anchor.js → topBarCta.js} +1 -1
  41. package/dist/tsconfig.tsbuildinfo +1 -1
  42. package/dist/types/editContext.d.ts +6 -6
  43. package/dist/types/editContext.js +1 -1
  44. package/dist/types/gitAuthType.d.ts +6 -6
  45. package/dist/types/gitAuthType.js +1 -1
  46. package/dist/types/gitHubAppType.d.ts +6 -6
  47. package/dist/types/gitHubAppType.js +1 -1
  48. package/dist/types/gitSource.d.ts +9 -9
  49. package/dist/types/gitSource.js +1 -1
  50. package/dist/types/gitType.d.ts +1 -1
  51. package/dist/types/gitType.js +1 -1
  52. package/dist/types/growthDataType.d.ts +3 -3
  53. package/dist/types/growthDataType.js +1 -1
  54. package/dist/types/index.d.ts +10 -10
  55. package/dist/types/index.js +1 -1
  56. package/dist/types/navGroups.d.ts +8 -8
  57. package/dist/types/navGroups.js +1 -1
  58. package/dist/types/pageMetaTags.d.ts +23 -23
  59. package/dist/types/pageMetaTags.js +1 -1
  60. package/dist/types/pathType.d.ts +6 -6
  61. package/dist/types/pathType.js +1 -1
  62. package/package.json +79 -78
  63. package/dist/constants.d.ts +0 -0
  64. package/dist/constants.js +0 -1
  65. package/dist/mintconfig/analytics.d.ts +0 -52
  66. package/dist/mintconfig/analytics.js +0 -1
  67. package/dist/mintconfig/anchor.d.ts +0 -11
  68. package/dist/mintconfig/apiConfig.d.ts +0 -17
  69. package/dist/mintconfig/apiConfig.js +0 -1
  70. package/dist/mintconfig/configNavGroup.d.ts +0 -6
  71. package/dist/mintconfig/configNavGroup.js +0 -1
  72. package/dist/mintconfig/navigation.d.ts +0 -6
  73. package/dist/mintconfig/navigation.js +0 -1
  74. package/dist/mintconfig/navigationEntry.d.ts +0 -2
  75. package/dist/mintconfig/navigationEntry.js +0 -1
  76. package/dist/mintconfig/topbarCta.js +0 -1
@@ -1,6 +1,6 @@
1
- import { GitType } from './gitType';
2
- export type GitAuthType = {
3
- type: GitType;
4
- accessToken: string;
5
- owner?: string;
6
- };
1
+ import { GitType } from './gitType';
2
+ export type GitAuthType = {
3
+ type: GitType;
4
+ accessToken: string;
5
+ owner?: string;
6
+ };
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,6 +1,6 @@
1
- export type GitHubAppType = {
2
- owner: string;
3
- accessToken: string | undefined;
4
- installationId?: number;
5
- expiresAt?: string;
6
- };
1
+ export type GitHubAppType = {
2
+ owner: string;
3
+ accessToken: string | undefined;
4
+ installationId?: number;
5
+ expiresAt?: string;
6
+ };
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,9 +1,9 @@
1
- import { GitType } from './gitType';
2
- export type GitSource = {
3
- type: GitType;
4
- owner: string;
5
- repo: string;
6
- deployBranch: string;
7
- contentDirectory: string;
8
- isPrivate: boolean;
9
- };
1
+ import { GitType } from './gitType';
2
+ export type GitSource = {
3
+ type: GitType;
4
+ owner: string;
5
+ repo: string;
6
+ deployBranch: string;
7
+ contentDirectory: string;
8
+ isPrivate: boolean;
9
+ };
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1 +1 @@
1
- export type GitType = 'github' | 'gitlab';
1
+ export type GitType = 'github' | 'gitlab';
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,3 +1,3 @@
1
- export type GrowthDataType = {
2
- updatedDocsBefore: boolean;
3
- };
1
+ export type GrowthDataType = {
2
+ updatedDocsBefore: boolean;
3
+ };
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,10 +1,10 @@
1
- import { EditContext } from './editContext';
2
- import { GitAuthType } from './gitAuthType';
3
- import { GitHubAppType } from './gitHubAppType';
4
- import { GitSource } from './gitSource';
5
- import { GitType } from './gitType';
6
- import { GrowthDataType } from './growthDataType';
7
- import { NavGroups, NavGroup } from './navGroups';
8
- import { PageMetaTags } from './pageMetaTags';
9
- import { PathType } from './pathType';
10
- export type { EditContext, GitAuthType, GitHubAppType, GitSource, GitType, GrowthDataType, PathType, PageMetaTags, NavGroups, NavGroup, };
1
+ import { EditContext } from './editContext';
2
+ import { GitAuthType } from './gitAuthType';
3
+ import { GitHubAppType } from './gitHubAppType';
4
+ import { GitSource } from './gitSource';
5
+ import { GitType } from './gitType';
6
+ import { GrowthDataType } from './growthDataType';
7
+ import { NavGroups, NavGroup } from './navGroups';
8
+ import { PageMetaTags } from './pageMetaTags';
9
+ import { PathType } from './pathType';
10
+ export type { EditContext, GitAuthType, GitHubAppType, GitSource, GitType, GrowthDataType, PathType, PageMetaTags, NavGroups, NavGroup, };
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,8 +1,8 @@
1
- import { PageMetaTags } from './pageMetaTags';
2
- export type NavGroups = NavGroup[];
3
- export type NavGroup = {
4
- group: string;
5
- pages: NavPage[];
6
- icon?: string;
7
- };
8
- export type NavPage = PageMetaTags | NavGroup;
1
+ import { PageMetaTags } from './pageMetaTags';
2
+ export type NavGroups = NavGroup[];
3
+ export type NavGroup = {
4
+ group: string;
5
+ pages: NavPage[];
6
+ icon?: string;
7
+ };
8
+ export type NavPage = PageMetaTags | NavGroup;
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,23 +1,23 @@
1
- export type PageMetaTags = {
2
- href?: string;
3
- title?: string;
4
- sidebarTitle?: string;
5
- description?: string;
6
- api?: string;
7
- openapi?: string;
8
- contentType?: string;
9
- authMethod?: string;
10
- auth?: string;
11
- version?: string;
12
- mode?: string;
13
- hideFooterPagination?: boolean;
14
- authors?: unknown;
15
- lastUpdatedDate?: string;
16
- createdDate?: string;
17
- size?: string;
18
- 'openapi-schema'?: string;
19
- icon?: string;
20
- tag?: string;
21
- url?: string;
22
- hideApiMarker?: boolean;
23
- } & Record<string, any>;
1
+ export type PageMetaTags = {
2
+ href?: string;
3
+ title?: string;
4
+ sidebarTitle?: string;
5
+ description?: string;
6
+ api?: string;
7
+ openapi?: string;
8
+ contentType?: string;
9
+ authMethod?: string;
10
+ auth?: string;
11
+ version?: string;
12
+ mode?: string;
13
+ hideFooterPagination?: boolean;
14
+ authors?: unknown;
15
+ lastUpdatedDate?: string;
16
+ createdDate?: string;
17
+ size?: string;
18
+ 'openapi-schema'?: string;
19
+ icon?: string;
20
+ tag?: string;
21
+ url?: string;
22
+ hideApiMarker?: boolean;
23
+ } & Record<string, unknown>;
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,6 +1,6 @@
1
- export type PathType = {
2
- [key: string]: {
3
- summary: string;
4
- description: string;
5
- };
6
- };
1
+ export type PathType = {
2
+ [key: string]: {
3
+ summary: string;
4
+ description: string;
5
+ };
6
+ };
@@ -1 +1 @@
1
- export {};
1
+ export {};
package/package.json CHANGED
@@ -1,78 +1,79 @@
1
- {
2
- "name": "@mintlify/models",
3
- "version": "0.0.7",
4
- "description": "Mintlify models",
5
- "engines": {
6
- "node": ">=18.0.0"
7
- },
8
- "author": "Mintlify, Inc.",
9
- "repository": {
10
- "type": "git",
11
- "url": "https://github.com/mintlify/mint",
12
- "directory": "packages/mintlify-models"
13
- },
14
- "bugs": {
15
- "url": "https://github.com/mintlify/mint/issues"
16
- },
17
- "license": "Elastic-2.0",
18
- "keywords": [
19
- "mintlify",
20
- "mint",
21
- "models"
22
- ],
23
- "main": "./dist/index.js",
24
- "types": "./dist/index.d.ts",
25
- "files": [
26
- "dist"
27
- ],
28
- "type": "module",
29
- "publishConfig": {
30
- "access": "public",
31
- "registry": "https://registry.npmjs.org/"
32
- },
33
- "scripts": {
34
- "prepare": "npm run build",
35
- "build": "tsc",
36
- "watch": "tsc --watch",
37
- "format": "prettier \"./src/**/*.ts\" --write",
38
- "format:check": "prettier \"./src/**/*.ts\" --check",
39
- "lint": "eslint src --cache",
40
- "test": "jest --passWithNoTests"
41
- },
42
- "jest": {
43
- "preset": "ts-jest",
44
- "resolver": "ts-jest-resolver",
45
- "testEnvironment": "node",
46
- "moduleDirectories": [
47
- "node_modules",
48
- "<rootDir>/"
49
- ],
50
- "setupFilesAfterEnv": [
51
- "<rootDir>/setup-jest.ts"
52
- ]
53
- },
54
- "peerDependencies": {
55
- "@mintlify/validation": ">= 0.1.43 < 1"
56
- },
57
- "devDependencies": {
58
- "@mintlify/eslint-config": "1.0.3",
59
- "@mintlify/eslint-config-typescript": "1.0.7",
60
- "@mintlify/prettier-config": "1.0.1",
61
- "@mintlify/ts-config": "1.0.7",
62
- "@mintlify/validation": "*",
63
- "@testing-library/jest-dom": "^5.16.5",
64
- "@trivago/prettier-plugin-sort-imports": "3.x",
65
- "@tsconfig/recommended": "1.x",
66
- "@types/node": "^18.7.13",
67
- "@typescript-eslint/eslint-plugin": "5.x",
68
- "@typescript-eslint/parser": "5.x",
69
- "eslint": "8.x",
70
- "eslint-config-prettier": "8.x",
71
- "eslint-plugin-unused-imports": "2.x",
72
- "jest": "^29.4.3",
73
- "prettier": "2.x",
74
- "ts-jest": "^29.0.5",
75
- "ts-jest-resolver": "^2.0.1",
76
- "typescript": "^4.8.2"
77
- }
78
- }
1
+ {
2
+ "name": "@mintlify/models",
3
+ "version": "0.0.8",
4
+ "description": "Mintlify models",
5
+ "engines": {
6
+ "node": ">=18.0.0"
7
+ },
8
+ "author": "Mintlify, Inc.",
9
+ "repository": {
10
+ "type": "git",
11
+ "url": "https://github.com/mintlify/mint",
12
+ "directory": "packages/mintlify-models"
13
+ },
14
+ "bugs": {
15
+ "url": "https://github.com/mintlify/mint/issues"
16
+ },
17
+ "license": "Elastic-2.0",
18
+ "keywords": [
19
+ "mintlify",
20
+ "mint",
21
+ "models"
22
+ ],
23
+ "main": "./dist/index.js",
24
+ "types": "./dist/index.d.ts",
25
+ "files": [
26
+ "dist"
27
+ ],
28
+ "type": "module",
29
+ "publishConfig": {
30
+ "access": "public",
31
+ "registry": "https://registry.npmjs.org/"
32
+ },
33
+ "scripts": {
34
+ "prepare": "npm run build",
35
+ "build": "tsc",
36
+ "watch": "tsc --watch",
37
+ "format": "prettier \"./src/**/*.ts\" --write",
38
+ "format:check": "prettier \"./src/**/*.ts\" --check",
39
+ "lint": "eslint src --cache",
40
+ "test": "jest --passWithNoTests"
41
+ },
42
+ "jest": {
43
+ "preset": "ts-jest",
44
+ "resolver": "ts-jest-resolver",
45
+ "testEnvironment": "node",
46
+ "moduleDirectories": [
47
+ "node_modules",
48
+ "<rootDir>/"
49
+ ],
50
+ "setupFilesAfterEnv": [
51
+ "<rootDir>/setup-jest.ts"
52
+ ]
53
+ },
54
+ "peerDependencies": {
55
+ "@mintlify/validation": ">= 0.1.46 < 1"
56
+ },
57
+ "devDependencies": {
58
+ "@mintlify/eslint-config": "1.0.3",
59
+ "@mintlify/eslint-config-typescript": "1.0.7",
60
+ "@mintlify/prettier-config": "1.0.1",
61
+ "@mintlify/ts-config": "1.0.7",
62
+ "@mintlify/validation": "0.1.47",
63
+ "@testing-library/jest-dom": "^5.16.5",
64
+ "@trivago/prettier-plugin-sort-imports": "3.x",
65
+ "@tsconfig/recommended": "1.x",
66
+ "@types/node": "^18.7.13",
67
+ "@typescript-eslint/eslint-plugin": "5.x",
68
+ "@typescript-eslint/parser": "5.x",
69
+ "eslint": "8.x",
70
+ "eslint-config-prettier": "8.x",
71
+ "eslint-plugin-unused-imports": "2.x",
72
+ "jest": "^29.4.3",
73
+ "prettier": "2.x",
74
+ "ts-jest": "^29.0.5",
75
+ "ts-jest-resolver": "^2.0.1",
76
+ "typescript": "^4.8.2"
77
+ },
78
+ "gitHead": "fbd9d3db1899d7acfbff961012afbaefa731a25a"
79
+ }
File without changes
package/dist/constants.js DELETED
@@ -1 +0,0 @@
1
- "use strict";
@@ -1,52 +0,0 @@
1
- export type FathomConfigInterface = {
2
- siteId?: string;
3
- };
4
- export type GoogleAnalyticsConfigInterface = {
5
- measurementId?: string;
6
- };
7
- export type GoogleTagManagerConfigInterface = {
8
- tagId?: string;
9
- };
10
- export type HotjarConfigInterface = {
11
- hjid?: string;
12
- hjsv?: string;
13
- };
14
- export type KoalaConfigInterface = {
15
- publicApiKey?: string;
16
- };
17
- export type LogrocketConfigInterface = {
18
- appId?: string;
19
- };
20
- export type MixpanelConfigInterface = {
21
- projectToken?: string;
22
- };
23
- export type PirschConfigInterface = {
24
- id?: string;
25
- };
26
- export type PostHogConfigInterface = {
27
- apiHost?: string;
28
- apiKey?: string;
29
- };
30
- export type PlausibleInterface = {
31
- domain?: string;
32
- };
33
- export type AmplitudeConfigInterface = {
34
- apiKey?: string;
35
- };
36
- export type ClearbitConfigInterface = {
37
- publicApiKey?: string;
38
- };
39
- export type Analytics = {
40
- amplitude?: AmplitudeConfigInterface;
41
- clearbit?: ClearbitConfigInterface;
42
- fathom?: FathomConfigInterface;
43
- ga4?: GoogleAnalyticsConfigInterface;
44
- gtm?: GoogleTagManagerConfigInterface;
45
- hotjar?: HotjarConfigInterface;
46
- koala?: KoalaConfigInterface;
47
- logrocket?: LogrocketConfigInterface;
48
- mixpanel?: MixpanelConfigInterface;
49
- pirsch?: PirschConfigInterface;
50
- plausible?: PlausibleInterface;
51
- posthog?: PostHogConfigInterface;
52
- };
@@ -1 +0,0 @@
1
- export {};
@@ -1,11 +0,0 @@
1
- import { Gradient } from './gradient';
2
- import { IconType } from "./iconTypes";
3
- export type Anchor = {
4
- color?: string | Gradient;
5
- icon?: string;
6
- isDefaultHidden?: boolean;
7
- name: string;
8
- url: string;
9
- version?: string;
10
- iconType?: IconType;
11
- };
@@ -1,17 +0,0 @@
1
- export type ApiConfig = {
2
- baseUrl?: string | string[];
3
- auth?: {
4
- method?: 'key' | 'bearer' | 'basic';
5
- name?: string;
6
- inputPrefix?: string;
7
- };
8
- playground?: {
9
- mode: 'show' | 'simple' | 'hide';
10
- };
11
- request?: {
12
- example?: {
13
- showOptionalParams: boolean;
14
- };
15
- };
16
- maintainOrder?: boolean;
17
- };
@@ -1 +0,0 @@
1
- export {};
@@ -1,6 +0,0 @@
1
- import { NavigationEntry } from './navigationEntry';
2
- export type ConfigNavGroup = {
3
- group: string;
4
- pages: NavigationEntry[];
5
- version?: string;
6
- };
@@ -1 +0,0 @@
1
- export {};
@@ -1,6 +0,0 @@
1
- import { NavigationEntry } from './navigationEntry';
2
- export type Navigation = {
3
- group: string;
4
- pages: NavigationEntry[];
5
- version?: string;
6
- };
@@ -1 +0,0 @@
1
- export {};
@@ -1,2 +0,0 @@
1
- import { Navigation } from './navigation';
2
- export type NavigationEntry = string | Navigation;
@@ -1 +0,0 @@
1
- export {};
@@ -1 +0,0 @@
1
- export {};