1import { Command } from '@expo/commander';
2import chalk from 'chalk';
3import { PromisyClass, TaskQueue } from 'cwait';
4import { Application, TSConfigReader, TypeDocReader } from 'typedoc';
5import fs from 'fs-extra';
6import os from 'os';
7import path from 'path';
8import recursiveOmitBy from 'recursive-omit-by';
9
10import { EXPO_DIR, PACKAGES_DIR } from '../Constants';
11import logger from '../Logger';
12
13type ActionOptions = {
14  packageName?: string;
15  version?: string;
16};
17
18type EntryPoint = string | string[];
19
20type CommandAdditionalParams = [
21  entryPoint: EntryPoint,
22  packageName?: string
23];
24
25const MINIFY_JSON = true;
26
27const PACKAGES_MAPPING: Record<string, CommandAdditionalParams> = {
28  'expo-analytics-amplitude': ['Amplitude.ts'],
29  'expo-analytics-segment': ['Segment.ts'],
30  'expo-app-loading': ['index.ts'],
31  'expo-apple-authentication': ['index.ts'],
32  'expo-application': ['Application.ts'],
33  'expo-auth-session': ['AuthSession.ts'],
34  'expo-asset': [['Asset.ts', 'AssetHooks.ts']],
35  'expo-background-fetch': ['BackgroundFetch.ts'],
36  'expo-battery': ['Battery.ts'],
37  'expo-barcode-scanner': ['BarCodeScanner.tsx'],
38  'expo-blur': ['index.ts'],
39  'expo-brightness': ['Brightness.ts'],
40  'expo-calendar': ['Calendar.ts'],
41  'expo-camera': ['index.ts'],
42  'expo-cellular': ['Cellular.ts'],
43  'expo-checkbox': ['Checkbox.ts'],
44  'expo-clipboard': [['Clipboard.ts', 'Clipboard.types.ts']],
45  'expo-constants': [['Constants.ts', 'Constants.types.ts']],
46  'expo-crypto': ['Crypto.ts'],
47  'expo-document-picker': ['index.ts'],
48  'expo-error-recovery': ['ErrorRecovery.ts'],
49  'expo-face-detector': ['FaceDetector.ts'],
50  'expo-firebase-analytics': ['Analytics.ts'],
51  'expo-firebase-core': ['FirebaseCore.ts'],
52  'expo-facebook': [['Facebook.ts', 'Facebook.types.ts']],
53  'expo-font': ['index.ts'],
54  'expo-haptics': ['Haptics.ts'],
55  'expo-image-manipulator': ['ImageManipulator.ts'],
56  'expo-image-picker': ['ImagePicker.ts'],
57  'expo-in-app-purchases': ['InAppPurchases.ts'],
58  'expo-intent-launcher': ['IntentLauncher.ts'],
59  'expo-keep-awake': ['index.ts'],
60  'expo-linking': ['Linking.ts'],
61  'expo-linear-gradient': ['LinearGradient.tsx'],
62  'expo-local-authentication': ['LocalAuthentication.ts'],
63  'expo-localization': ['Localization.ts'],
64  'expo-location': ['Location.ts'],
65  'expo-mail-composer': ['MailComposer.ts'],
66  'expo-media-library': ['MediaLibrary.ts'],
67  'expo-navigation-bar': ['NavigationBar.ts'],
68  'expo-network': ['Network.ts'],
69  'expo-pedometer': ['Pedometer.ts', 'expo-sensors'],
70  'expo-print': ['Print.ts'],
71  'expo-random': ['Random.ts'],
72  'expo-screen-capture': ['ScreenCapture.ts'],
73  'expo-screen-orientation': ['ScreenOrientation.ts'],
74  'expo-secure-store': ['SecureStore.ts'],
75  'expo-sharing': ['Sharing.ts'],
76  'expo-sms': ['SMS.ts'],
77  'expo-speech': ['Speech/Speech.ts'],
78  'expo-splash-screen': ['SplashScreen.ts'],
79  'expo-sqlite': ['index.ts'],
80  'expo-status-bar': ['StatusBar.ts'],
81  'expo-store-review': ['StoreReview.ts'],
82  'expo-system-ui': ['SystemUI.ts'],
83  'expo-task-manager': ['TaskManager.ts'],
84  'expo-tracking-transparency': ['TrackingTransparency.ts'],
85  'expo-updates': ['index.ts'],
86  'expo-video': ['Video.tsx', 'expo-av'],
87  'expo-video-thumbnails': ['VideoThumbnails.ts'],
88  'expo-web-browser': ['WebBrowser.ts'],
89};
90
91const executeCommand = async (
92  jsonFileName: string,
93  version: string,
94  entryPoint: EntryPoint = 'index.ts',
95  packageName: string = jsonFileName
96) => {
97  const app = new Application();
98
99  app.options.addReader(new TSConfigReader());
100  app.options.addReader(new TypeDocReader());
101
102  const dataPath = path.join(EXPO_DIR, 'docs', 'public', 'static', 'data', version);
103  const basePath = path.join(PACKAGES_DIR, packageName);
104  const entriesPath = path.join(basePath, 'src');
105  const tsConfigPath = path.join(basePath, 'tsconfig.json');
106  const jsonOutputPath = path.join(dataPath, `${jsonFileName}.json`);
107
108  const entryPoints = Array.isArray(entryPoint) ? (
109    entryPoint.map(entry => path.join(entriesPath, entry))
110  ) : (
111    [path.join(entriesPath, entryPoint)]
112  );
113
114  app.bootstrap({
115    entryPoints,
116    tsconfig: tsConfigPath,
117    disableSources: true,
118    hideGenerator: true,
119    excludePrivate: true,
120    excludeProtected: true,
121  });
122
123  const project = app.convert();
124
125  if (project) {
126    await app.generateJson(project, jsonOutputPath);
127    const output = await fs.readJson(jsonOutputPath);
128    output.name = jsonFileName;
129
130    if (Array.isArray(entryPoint)) {
131      const filterEntries = entryPoint.map(entry => entry.substring(0, entry.lastIndexOf('.')));
132      output.children = output.children
133        .filter(entry => filterEntries.includes(entry.name))
134        .map(entry => entry.children)
135        .flat()
136        .sort((a, b) => a.name.localeCompare(b.name));
137    }
138
139    if (MINIFY_JSON) {
140      const minifiedJson = recursiveOmitBy(output, ({key, node}) =>
141        ['id', 'groups', 'target'].includes(key) ||
142        (key === 'flags' && !Object.keys(node).length)
143      );
144      await fs.writeFile(jsonOutputPath, JSON.stringify(minifiedJson, null, 0));
145    } else {
146      await fs.writeFile(jsonOutputPath, JSON.stringify(output));
147    }
148  } else {
149    throw new Error(`�� Failed to extract API data from source code for '${packageName}' package.`);
150  }
151};
152
153async function action({ packageName, version = 'unversioned' }: ActionOptions) {
154  const taskQueue = new TaskQueue(Promise as PromisyClass, os.cpus().length);
155
156  try {
157    if (packageName) {
158      const packagesEntries = Object.entries(PACKAGES_MAPPING)
159        .filter(([key, value]) => key == packageName || value.includes(packageName))
160        .map(([key, value]) => taskQueue.add(() => executeCommand(key, version, ...value)));
161      if (packagesEntries.length) {
162        await Promise.all(packagesEntries);
163        logger.log(chalk.green(`\n�� Successful extraction of docs API data for the selected package!`));
164      } else {
165        logger.warn(`�� Package '${packageName}' API data generation is not supported yet!`);
166      }
167    } else {
168      const packagesEntries = Object.entries(PACKAGES_MAPPING)
169        .map(([key, value]) => taskQueue.add(() => executeCommand(key, version, ...value)));
170      await Promise.all(packagesEntries);
171      logger.log(chalk.green(`\n�� Successful extraction of docs API data for all available packages!`));
172    }
173  } catch (error) {
174    logger.error(error);
175  }
176}
177
178export default (program: Command) => {
179  program
180    .command('generate-docs-api-data')
181    .alias('gdad')
182    .description(`Extract API data JSON files for docs using TypeDoc.`)
183    .option('-p, --packageName <packageName>', 'Extract API data only for the specific package.')
184    .option('-v, --version <version>', 'Set the data output path to the specific version.', 'unversioned')
185    .asyncAction(action);
186};
187