@react-native-community/cli-types 7.0.0 → 7.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-community/cli-types",
-  "version": "7.0.0",
+  "version": "7.0.1",
   "main": "build",
   "publishConfig": {
     "access": "public"
@@ -16,6 +16,5 @@
     "type": "git",
     "url": "https://github.com/react-native-community/cli.git",
     "directory": "packages/cli-types"
-  },
-  "gitHead": "fcb746c46e6dc05225a26ab132ab380c841c849f"
+  }
 }

package/src/android.ts

@@ -0,0 +1,30 @@
+export interface AndroidProjectConfig {
+  sourceDir: string;
+  isFlat: boolean;
+  folder: string;
+  stringsPath: string;
+  manifestPath: string;
+  buildGradlePath: string;
+  settingsGradlePath: string;
+  assetsPath: string;
+  mainFilePath: string;
+  packageName: string;
+  packageFolder: string;
+  appName: string;
+  dependencyConfiguration?: string;
+}
+
+export type AndroidProjectParams = Partial<AndroidProjectConfig>;
+
+export interface AndroidDependencyConfig {
+  sourceDir: string;
+  folder: string;
+  packageImportPath: string;
+  packageInstance: string;
+  manifestPath: string;
+  packageName: string;
+  dependencyConfiguration?: string;
+  buildTypes: string[];
+}
+
+export type AndroidDependencyParams = Partial<AndroidDependencyConfig>;

package/src/index.ts

@@ -0,0 +1,198 @@
+import {
+  IOSProjectConfig,
+  IOSProjectParams,
+  IOSDependencyConfig,
+  IOSDependencyParams,
+  IOSNativeModulesConfig,
+} from './ios';
+import {
+  AndroidProjectConfig,
+  AndroidProjectParams,
+  AndroidDependencyConfig,
+  AndroidDependencyParams,
+} from './android';
+
+export type Prompt = any;
+
+export type CommandFunction<Args = Object> = (
+  argv: Array<string>,
+  ctx: Config,
+  args: Args,
+) => Promise<void> | void;
+
+export type OptionValue = string | boolean | number;
+
+export type CommandOption<T = (ctx: Config) => OptionValue> = {
+  name: string;
+  description?: string;
+  parse?: (val: string) => any;
+  default?: OptionValue | T;
+};
+
+export type DetachedCommandFunction<Args = Object> = (
+  argv: string[],
+  args: Args,
+) => Promise<void> | void;
+
+export type Command<IsDetached extends boolean = false> = {
+  name: string;
+  description?: string;
+  detached?: IsDetached;
+  examples?: Array<{
+    desc: string;
+    cmd: string;
+  }>;
+  pkg?: {
+    name: string;
+    version: string;
+  };
+  func: IsDetached extends true
+    ? DetachedCommandFunction<Object>
+    : CommandFunction<Object>;
+  options?: Array<
+    CommandOption<
+      IsDetached extends true ? () => OptionValue : (ctx: Config) => OptionValue
+    >
+  >;
+};
+
+export type DetachedCommand = Command<true>;
+
+interface PlatformConfig<
+  ProjectConfig,
+  ProjectParams,
+  DependencyConfig,
+  DependencyParams
+> {
+  npmPackageName?: string;
+  projectConfig: (
+    projectRoot: string,
+    projectParams: ProjectParams | void,
+  ) => ProjectConfig | void;
+  dependencyConfig: (
+    dependency: string,
+    params: DependencyParams,
+  ) => DependencyConfig | void;
+  linkConfig: () => {
+    isInstalled: (
+      projectConfig: ProjectConfig,
+      packageName: string,
+      dependencyConfig: DependencyConfig,
+    ) => boolean;
+    register: (
+      name: string,
+      dependencyConfig: DependencyConfig,
+      params: Object,
+      projectConfig: ProjectConfig,
+    ) => void;
+    unregister: (
+      name: string,
+      dependencyConfig: DependencyConfig,
+      projectConfig: ProjectConfig,
+      otherDependencies: Array<DependencyConfig>,
+    ) => void;
+    copyAssets: (assets: string[], projectConfig: ProjectConfig) => void;
+    unlinkAssets: (assets: string[], projectConfig: ProjectConfig) => void;
+  };
+}
+
+export interface Dependency {
+  name: string;
+  root: string;
+  platforms: {
+    android?: AndroidDependencyConfig | null;
+    ios?: IOSDependencyConfig | null;
+    [key: string]: any;
+  };
+  assets: string[];
+  hooks: {
+    prelink?: string;
+    postlink?: string;
+    preunlink?: string;
+    postunlink?: string;
+  };
+  params: Prompt[];
+}
+
+export type ProjectConfig = {
+  android?: AndroidProjectConfig;
+  ios?: IOSProjectConfig;
+  [key: string]: any;
+};
+
+/**
+ * @property root - Root where the configuration has been resolved from
+ * @property reactNativePath - Path to React Native source
+ * @property project - Object that contains configuration for a project (null, when platform not available)
+ * @property assets - An array of assets as defined by the user
+ * @property dependencies - Map of the dependencies that are present in the project
+ * @property platforms - Map of available platforms (build-ins and dynamically loaded)
+ * @property commands - An array of commands that are present in 3rd party packages
+ * @property healthChecks - An array of health check categories to add to doctor command
+ */
+export interface Config extends IOSNativeModulesConfig {
+  root: string;
+  reactNativePath: string;
+  project: ProjectConfig;
+  assets: string[];
+  dependencies: {[key: string]: Dependency};
+  platforms: {
+    android: PlatformConfig<
+      AndroidProjectConfig,
+      AndroidProjectParams,
+      AndroidDependencyConfig,
+      AndroidDependencyParams
+    >;
+    ios: PlatformConfig<
+      IOSProjectConfig,
+      IOSProjectParams,
+      IOSDependencyConfig,
+      IOSDependencyParams
+    >;
+    [name: string]: PlatformConfig<any, any, any, any>;
+  };
+  commands: Command[];
+  // @todo this should be removed: https://github.com/react-native-community/cli/issues/1261
+  healthChecks: [];
+}
+
+/**
+ * Shares some structure with Config, except that root is calculated and can't
+ * be defined
+ */
+
+export type UserConfig = Omit<Config, 'root'> & {
+  reactNativePath: string | void;
+  // Additional project settings
+  project: {
+    android?: AndroidProjectParams;
+    ios?: IOSProjectParams;
+    [key: string]: any;
+  };
+};
+
+export type UserDependencyConfig = {
+  // Additional dependency settings
+  dependency: Omit<Dependency, 'name' | 'root'>;
+  // An array of commands that ship with the dependency
+  commands: Command[];
+  // An array of extra platforms to load
+  platforms: Config['platforms'];
+  // Additional health checks
+  healthChecks: [];
+};
+
+export {
+  IOSProjectConfig,
+  IOSProjectParams,
+  IOSDependencyConfig,
+  IOSDependencyParams,
+  IOSNativeModulesConfig,
+};
+
+export {
+  AndroidProjectConfig,
+  AndroidProjectParams,
+  AndroidDependencyConfig,
+  AndroidDependencyParams,
+};

package/src/ios.ts

@@ -0,0 +1,97 @@
+/**
+ * Settings that user can define in the project configuration for iOS.
+ * Same for dependency - we share the type.
+ *
+ * See UserDependencyConfigT and UserConfigT for details
+ */
+export interface IOSProjectParams {
+  project?: string;
+  /**
+   * @deprecated A podspec should always be at the root of a package and
+   *             have the name of the package. This property will be
+   *             removed in a future major version.
+   *
+   * @todo Log a warning when this is used.
+   */
+  podspecPath?: string;
+  sharedLibraries?: string[];
+  libraryFolder?: string;
+  plist: Array<any>;
+  scriptPhases?: Array<any>;
+}
+
+export interface IOSDependencyParams extends IOSProjectParams {
+  configurations?: string[];
+}
+
+// The following types are used in untyped-parts of the codebase, so I am leaving them
+// until we actually need them.
+export interface IOSProjectConfig {
+  sourceDir: string;
+  folder: string;
+  pbxprojPath: string;
+  podfile: string;
+  podspecPath: string;
+  projectPath: string;
+  projectName: string;
+  libraryFolder: string;
+  sharedLibraries: Array<any>;
+  plist: Array<any>;
+}
+
+export interface IOSDependencyConfig extends IOSProjectConfig {
+  configurations: string[];
+}
+
+/**
+ * @see https://www.rubydoc.info/gems/cocoapods-core/Pod/Podfile/DSL#script_phase-instance_method
+ *
+ * The only difference is that `script` may be omitted in favour of a
+ * `path`, relative to the root of the package, whose content will be
+ * used.
+ */
+export type IOSScriptPhase = ({script: string} | {path: string}) & {
+  name: string;
+  shell_path?: string;
+  input_files?: string[];
+  output_files?: string[];
+  input_file_lists?: string[];
+  output_file_lists?: string[];
+  show_env_vars_in_log?: boolean;
+  dependency_file?: string;
+  execution_position?: 'before_compile' | 'after_compile' | 'any';
+};
+
+/**
+ * This describes the data that is expected by `native_modules.rb`. It is only
+ * meant to ensure the `Config` interface follows exactly what is needed, so
+ * only make changes to this interface (or `IOSScriptPhase`) if the data
+ * requirements of `native_modules.rb` change.
+ */
+export interface IOSNativeModulesConfig {
+  reactNativePath: string;
+  project: {
+    ios?: {
+      sourceDir: string;
+    };
+  };
+  dependencies: {
+    [name: string]: {
+      root: string;
+      platforms: {
+        ios?: null | {
+          /**
+           * @deprecated A podspec should always be at the root of a package and
+           *             have the name of the package. This property will be
+           *             removed in a future major version.
+           *
+           * @todo Log a warning when this is used.
+           */
+          podspecPath: string;
+          scriptPhases?: Array<IOSScriptPhase>;
+        };
+        android?: null | {};
+      };
+    };
+  };
+}

package/src/node-stream-zip.d.ts

@@ -0,0 +1,66 @@
+// https://github.com/antelle/node-stream-zip/issues/36#issuecomment-596249657
+declare module 'node-stream-zip' {
+  import {Stream} from 'stream';
+
+  interface StreamZipOptions {
+    /**
+     * File to read
+     */
+    file: string;
+    /**
+     * You will be able to work with entries inside zip archive, otherwise the only way to access them is entry event
+     *
+     * default: true
+     */
+    storeEntries?: boolean;
+    /**
+     * By default, entry name is checked for malicious characters, like ../ or c:\123, pass this flag to disable validation errors
+     *
+     * default: false
+     */
+    skipEntryNameValidation?: boolean;
+    /**
+     * Undocumented adjustment of chunk size
+     *
+     * default: automatic
+     */
+    chunkSize?: number;
+  }
+
+  class ZipEntry {
+    name: string;
+    isDirectory: boolean;
+    isFile: boolean;
+    comment: string;
+    size: number;
+  }
+
+  class StreamZip {
+    constructor(config: StreamZipOptions);
+
+    on(event: 'ready', handler: () => void): void;
+
+    entry(entry: string): ZipEntry;
+    entries(): ZipEntry[];
+
+    entriesCount: number;
+
+    stream(
+      entry: string,
+      callback: (err: any | null, stream?: Stream) => void,
+    ): void;
+    entryDataSync(entry: string): Buffer;
+    openEntry(
+      entry: string,
+      callback: (err: any | null, entry?: ZipEntry) => void,
+      sync: boolean,
+    ): void;
+    extract(
+      entry: string | null,
+      outPath: string,
+      callback: (err?: any) => void,
+    ): void;
+    close(callback?: (err?: any) => void): void;
+  }
+  export = StreamZip;
+}

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "build"
+  }
+}