nestjs-auth/typedoc.config.mjs at main · zitadel/nestjs-auth · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
// noinspection JSUnusedGlobalSymbols
/** @type {import('typedoc').TypeDocOptions} */
export default {
  entryPoints: ['src/index.ts', 'src/adapter.ts'],
  out: '.out/docs',
  tsconfig: './tsconfig.json',
  readme: 'README.md',
  excludeInternal: true,
  excludePrivate: true,
  highlightLanguages: [
    'typescript',
    'javascript',
    'json',
    'jsx',
    'tsx',
    'bash',
    'sh',
    'html',
  ],
  externalSymbolLinkMappings: {
    oauth4webapi: {
      'TokenEndpointResponse.expires_in':
        'https://github.com/panva/oauth4webapi/blob/HEAD/docs/interfaces/TokenEndpointResponse.md',
      'TokenEndpointResponse.access_token':
        'https://github.com/panva/oauth4webapi/blob/HEAD/docs/interfaces/TokenEndpointResponse.md',
      'TokenEndpointResponse.refresh_token':
        'https://github.com/panva/oauth4webapi/blob/HEAD/docs/interfaces/TokenEndpointResponse.md',
    },
    '@auth/core': {
      'AuthConfig.adapter': 'https://authjs.dev/reference/core#adapter',
      'AuthConfig.session': 'https://authjs.dev/reference/core#session',
      JWT: 'https://authjs.dev/reference/core/jwt',
      'AuthConfig.logger': 'https://authjs.dev/guides/debugging#logging',
      'AuthConfig.debug': 'https://authjs.dev/guides/debugging',
      'AuthConfig.pages':
        'https://authjs.dev/getting-started/session-management/custom-pages',
      OAuthConfig: 'https://authjs.dev/reference/core/providers#oauthconfig',
      'OAuthConfig.profile':
        'https://authjs.dev/reference/core/providers#profile',
      CredentialsConfig:
        'https://authjs.dev/reference/core/providers/credentials',
      'CredentialsConfig.authorize':
        'https://authjs.dev/reference/core/providers/credentials#authorize',
      TokenSet: 'https://authjs.dev/reference/core/types#account',
      OAuth2Config: 'https://authjs.dev/reference/core/providers#oauth2config',
      'OAuth2Config.checks':
        'https://authjs.dev/reference/core/providers#checks',
    },
    '@auth/core/types': {
      'AuthConfig.adapter': 'https://authjs.dev/reference/core#adapter',
      'AuthConfig.session': 'https://authjs.dev/reference/core#session',
      JWT: 'https://authjs.dev/reference/core/jwt',
      'AuthConfig.logger': 'https://authjs.dev/guides/debugging#logging',
      'AuthConfig.debug': 'https://authjs.dev/guides/debugging',
      'AuthConfig.pages':
        'https://authjs.dev/getting-started/session-management/custom-pages',
      OAuthConfig: 'https://authjs.dev/reference/core/providers#oauthconfig',
      'OAuthConfig.profile':
        'https://authjs.dev/reference/core/providers#profile',
      CredentialsConfig:
        'https://authjs.dev/reference/core/providers/credentials',
      'CredentialsConfig.authorize':
        'https://authjs.dev/reference/core/providers/credentials#authorize',
      TokenSet: 'https://authjs.dev/reference/core/types#account',
      OAuth2Config: 'https://authjs.dev/reference/core/providers#oauth2config',
      'OAuth2Config.checks':
        'https://authjs.dev/reference/core/providers#checks',
    },
  },
  cleanOutputDir: true,
  treatWarningsAsErrors: false,
  validation: {
    invalidLink: true,
    notExported: true,
    notDocumented: false,
  },
};