@react-native-windows/codegen 0.0.0-canary.4 → 0.0.0-canary.41

package/src/generators/GenerateNM2.ts

@@ -6,14 +6,11 @@
 
 'use strict';
 
-import {
-  SchemaType,
-  MethodTypeShape,
-  // FunctionTypeAnnotation,
-  FunctionTypeAnnotationParam,
-  FunctionTypeAnnotationParamTypeAnnotation,
-  FunctionTypeAnnotationReturn,
-} from 'react-native-tscodegen';
+import type {SchemaType} from 'react-native-tscodegen';
+import {AliasMap, setPreferredModuleName} from './AliasManaging';
+import {createAliasMap, generateAliases} from './AliasGen';
+import {generateValidateConstants} from './ValidateConstants';
+import {generateValidateMethods} from './ValidateMethods';
 
 type FilesOutput = Map<string, string>;
 
@@ -31,281 +28,28 @@ const moduleTemplate = `
 #include <tuple>
 
 namespace ::_NAMESPACE_:: {
-
+::_MODULE_ALIASED_STRUCTS_::
 struct ::_MODULE_NAME_::Spec : winrt::Microsoft::ReactNative::TurboModuleSpec {
-  static constexpr auto methods = std::tuple{
-::_MODULE_PROPERTIES_TUPLE_::
-  };
+::_MODULE_MEMBERS_TUPLES_::
 
   template <class TModule>
   static constexpr void ValidateModule() noexcept {
-    constexpr auto methodCheckResults = CheckMethods<TModule, ::_MODULE_NAME_::Spec>();
+::_MODULE_MEMBERS_CHECKS_::
 
-::_MODULE_PROPERTIES_SPEC_ERRORS_::
+::_MODULE_MEMBERS_ERRORS_::
   }
 };
 
 } // namespace ::_NAMESPACE_::
 `;
 
-function translateSpecFunctionParam(
-  param: FunctionTypeAnnotationParam,
-): string {
-  switch (param.typeAnnotation.type) {
-    case 'StringTypeAnnotation':
-      return 'std::string';
-    case 'NumberTypeAnnotation':
-    case 'FloatTypeAnnotation':
-      return 'double';
-    case 'Int32TypeAnnotation':
-      return 'int';
-    case 'BooleanTypeAnnotation':
-      return 'bool';
-    case 'FunctionTypeAnnotation': {
-      // Ideally we'd get more information about the expected parameters of the callback
-      // But the current schema doesn't seem to provide the necessary information.
-      return 'Callback<React::JSValue>';
-    }
-    case 'ArrayTypeAnnotation':
-      // Ideally we'd get more information about the expected type of the array
-      // But the current schema doesn't seem to provide the necessary information.
-      return 'React::JSValueArray';
-    case 'GenericObjectTypeAnnotation':
-      return 'React::JSValueObject';
-    case 'ObjectTypeAnnotation':
-      // TODO we have more information here, and could create a more specific type
-      return 'React::JSValueObject';
-    case 'ReservedFunctionValueTypeAnnotation':
-      // (#6597)
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-      if (param.typeAnnotation.name !== 'RootTag')
-        throw new Error(
-          `Unknown reserved function: ${param.typeAnnotation.name} in translateSpecFunctionParam`,
-        );
-      return 'double';
-    default:
-      throw new Error(
-        `Unhandled type in translateSpecFunctionParam: ${param.typeAnnotation.type}`,
-      );
-  }
-}
-
-function translateFunctionParam(param: FunctionTypeAnnotationParam): string {
-  switch (param.typeAnnotation.type) {
-    case 'StringTypeAnnotation':
-      return 'std::string';
-    case 'NumberTypeAnnotation':
-    case 'FloatTypeAnnotation':
-      return 'double';
-    case 'Int32TypeAnnotation':
-      return 'int';
-    case 'BooleanTypeAnnotation':
-      return 'bool';
-    case 'FunctionTypeAnnotation': {
-      // Ideally we'd get more information about the expected parameters of the callback
-      // But the current schema doesn't seem to provide the necessary information.
-      return 'std::function<void(React::JSValue const &)> const &';
-    }
-    case 'ArrayTypeAnnotation':
-      // Ideally we'd get more information about the expected type of the array
-      // But the current schema doesn't seem to provide the necessary information.
-      return 'React::JSValueArray &&';
-    case 'GenericObjectTypeAnnotation':
-      return 'React::JSValueObject &&';
-    case 'ObjectTypeAnnotation':
-      // TODO we have more information here, and could create a more specific type
-      return 'React::JSValueObject &&';
-    case 'ReservedFunctionValueTypeAnnotation':
-      // (#6597)
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-      if (param.typeAnnotation.name !== 'RootTag')
-        throw new Error(
-          `Unknown reserved function: ${param.typeAnnotation.name} in translateFunctionParam`,
-        );
-      return 'double';
-    default:
-      throw new Error(
-        `Unhandled type in translateFunctionParam: ${param.typeAnnotation.type} in translateFunctionParam`,
-      );
-  }
-}
-
-function translateSpecReturnType(
-  type:
-    | FunctionTypeAnnotationParamTypeAnnotation
-    | FunctionTypeAnnotationReturn,
-) {
-  switch (type.type) {
-    case 'VoidTypeAnnotation':
-      return 'void';
-    case 'StringTypeAnnotation':
-      return 'std::string';
-    case 'NumberTypeAnnotation':
-    case 'FloatTypeAnnotation':
-      return 'double';
-    case 'Int32TypeAnnotation':
-      return 'int';
-    case 'BooleanTypeAnnotation':
-      return 'bool';
-    case 'GenericPromiseTypeAnnotation':
-      return 'void';
-    case 'ArrayTypeAnnotation':
-      // Ideally we'd get more information about the expected type of the array
-      // But the current schema doesn't seem to provide the necessary information.
-      return 'React::JSValueArray';
-    case 'GenericObjectTypeAnnotation':
-      return 'React::JSValueObject';
-    case 'ReservedFunctionValueTypeAnnotation':
-      // (#6597)
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-      if (type.name !== 'RootTag')
-        throw new Error(
-          `Unknown reserved function: ${type.name} in translateSpecReturnType`,
-        );
-      return 'double';
-    default:
-      throw new Error(
-        `Unhandled type in translateSpecReturnType: ${type.type}`,
-      );
-  }
-}
-
-function translateImplReturnType(
-  type:
-    | FunctionTypeAnnotationParamTypeAnnotation
-    | FunctionTypeAnnotationReturn,
-) {
-  switch (type.type) {
-    case 'VoidTypeAnnotation':
-      return 'void';
-    case 'StringTypeAnnotation':
-      return 'std::string';
-    case 'NumberTypeAnnotation':
-    case 'FloatTypeAnnotation':
-      return 'double';
-    case 'Int32TypeAnnotation':
-      return 'int';
-    case 'BooleanTypeAnnotation':
-      return 'bool';
-    case 'GenericPromiseTypeAnnotation':
-      return 'void';
-    case 'ArrayTypeAnnotation':
-      // Ideally we'd get more information about the expected type of the array
-      // But the current schema doesn't seem to provide the necessary information.
-      return 'React::JSValueArray';
-    case 'GenericObjectTypeAnnotation':
-      return 'React::JSValueObject';
-    case 'ReservedFunctionValueTypeAnnotation':
-      // (#6597)
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-      if (type.name !== 'RootTag')
-        throw new Error(
-          `Unknown reserved function: ${type.name} in translateSpecReturnType`,
-        );
-      return 'double';
-    default:
-      throw new Error(
-        `Unhandled type in translateImplReturnType: ${type.type}`,
-      );
-  }
-}
-
-function translateSpecArgs(params: ReadonlyArray<FunctionTypeAnnotationParam>) {
-  return params.map(param => {
-    const translatedParam = translateSpecFunctionParam(param);
-    return `${translatedParam}`;
-  });
-}
-
-function translateArgs(params: ReadonlyArray<FunctionTypeAnnotationParam>) {
-  return params.map(param => {
-    const translatedParam = translateFunctionParam(param);
-    return `${translatedParam} ${param.name}`;
-  });
-}
-
-function isMethodSync(prop: MethodTypeShape) {
-  return (
-    prop.typeAnnotation.returnTypeAnnotation.type !== 'VoidTypeAnnotation' &&
-    prop.typeAnnotation.returnTypeAnnotation.type !==
-      'GenericPromiseTypeAnnotation'
-  );
-}
-
-function isPromise(prop: MethodTypeShape) {
-  return (
-    prop.typeAnnotation.returnTypeAnnotation.type ===
-    'GenericPromiseTypeAnnotation'
-  );
-}
-
-function getPossibleMethodSignatures(prop: MethodTypeShape): string[] {
-  const args = translateArgs(prop.typeAnnotation.params);
-  if (isPromise(prop)) {
-    // Sadly, currently, the schema doesn't currently provide us information on the type of the promise.
-    args.push('React::ReactPromise<React::JSValue> &&result');
-  }
-
-  // TODO be much more exhastive on the possible method signatures that can be used..
-  const sig = `REACT_${isMethodSync(prop) ? 'SYNC_' : ''}METHOD(${
-    prop.name
-  }) ${translateImplReturnType(prop.typeAnnotation.returnTypeAnnotation)} ${
-    prop.name
-  }(${args.join(', ')}) noexcept { /* implementation */ }}`;
-
-  const staticsig = `REACT_${isMethodSync(prop) ? 'SYNC_' : ''}METHOD(${
-    prop.name
-  }) static ${translateImplReturnType(
-    prop.typeAnnotation.returnTypeAnnotation,
-  )} ${prop.name}(${args.join(', ')}) noexcept { /* implementation */ }}`;
-
-  return [sig, staticsig];
-}
-
-function translatePossibleMethodSignatures(prop: MethodTypeShape): string {
-  return getPossibleMethodSignatures(prop)
-    .map(sig => `"    ${sig}\\n"`)
-    .join('\n          ');
-}
-
-function renderProperties(
-  properties: ReadonlyArray<MethodTypeShape>,
-  tuple: boolean,
-): string {
-  // We skip the constants for now, since we dont have Spec file validation of them.
-  return properties
-    .filter(prop => prop.name !== 'getConstants')
-    .map((prop, index) => {
-      const params = prop.typeAnnotation.params;
-
-      const traversedArgs = translateSpecArgs(params);
-
-      const translatedReturnParam = translateSpecReturnType(
-        prop.typeAnnotation.returnTypeAnnotation,
-      );
-
-      if (isPromise(prop)) {
-        // Sadly, currently, the schema doesn't currently provide us information on the type of the promise.
-        traversedArgs.push('Promise<React::JSValue>');
-      }
-
-      if (tuple) {
-        return `      ${
-          isMethodSync(prop) ? 'Sync' : ''
-        }Method<${translatedReturnParam}(${traversedArgs.join(
-          ', ',
-        )}) noexcept>{${index}, L"${prop.name}"},`;
-      } else {
-        return `    REACT_SHOW_METHOD_SPEC_ERRORS(
-          ${index},
-          "${prop.name}",
-          ${translatePossibleMethodSignatures(prop)});`;
-      }
-    })
-    .join('\n');
-}
-
-export function createNM2Generator({namespace}: {namespace: string}) {
+export function createNM2Generator({
+  namespace,
+  methodonly,
+}: {
+  namespace: string;
+  methodonly: boolean;
+}) {
   return (
     _libraryName: string,
     schema: SchemaType,
@@ -313,33 +57,61 @@ export function createNM2Generator({namespace}: {namespace: string}) {
   ): FilesOutput => {
     const files = new Map<string, string>();
 
-    const nativeModules = Object.keys(schema.modules)
-      .map(moduleName => {
-        const modules = schema.modules[moduleName].nativeModules;
-        if (!modules) {
-          throw new Error('modules does not exist');
+    for (const moduleName of Object.keys(schema.modules)) {
+      const nativeModule = schema.modules[moduleName];
+      // from 0.65 facebook's react-native-codegen
+      // the module name has the Native prefix comparing to 0.63
+      // when reading files we provided
+      const preferredModuleName = moduleName.startsWith('Native')
+        ? moduleName.substr(6)
+        : moduleName;
+      setPreferredModuleName(preferredModuleName);
+
+      if (nativeModule.type === 'NativeModule') {
+        console.log(`Generating Native${preferredModuleName}Spec.g.h`);
+
+        // copy all explicit to a map
+        const aliases: AliasMap = createAliasMap(nativeModule.aliases);
+
+        // prepare methods
+        const methods = generateValidateMethods(nativeModule, aliases);
+        let tuples = `
+  static constexpr auto methods = std::tuple{
+${methods[0]}
+  };`;
+        let checks = `
+    constexpr auto methodCheckResults = CheckMethods<TModule, ::_MODULE_NAME_::Spec>();`;
+        let errors = methods[1];
+
+        // prepare constants
+        const constants = generateValidateConstants(nativeModule, aliases);
+        if (constants !== undefined && !methodonly) {
+          tuples = `
+  static constexpr auto constants = std::tuple{
+${constants[0]}
+  };${tuples}`;
+          checks = `
+    constexpr auto constantCheckResults = CheckConstants<TModule, ::_MODULE_NAME_::Spec>();${checks}`;
+          errors = `${constants[1]}
+
+${errors}`;
         }
 
-        return modules;
-      })
-      .filter(Boolean)
-      .reduce((acc, components) => Object.assign(acc, components), {});
-
-    Object.keys(nativeModules).forEach(name => {
-      console.log(`Generating Native${name}Spec.g.h`);
-      const {properties} = nativeModules[name];
-      const traversedProperties = renderProperties(properties, false);
-      const traversedPropertyTuples = renderProperties(properties, true);
-
-      files.set(
-        `Native${name}Spec.g.h`,
-        moduleTemplate
-          .replace(/::_MODULE_PROPERTIES_TUPLE_::/g, traversedPropertyTuples)
-          .replace(/::_MODULE_PROPERTIES_SPEC_ERRORS_::/g, traversedProperties)
-          .replace(/::_MODULE_NAME_::/g, name)
-          .replace(/::_NAMESPACE_::/g, namespace),
-      );
-    });
+        // generate code for structs
+        const traversedAliasedStructs = generateAliases(aliases);
+
+        files.set(
+          `Native${preferredModuleName}Spec.g.h`,
+          moduleTemplate
+            .replace(/::_MODULE_ALIASED_STRUCTS_::/g, traversedAliasedStructs)
+            .replace(/::_MODULE_MEMBERS_TUPLES_::/g, tuples.substring(1))
+            .replace(/::_MODULE_MEMBERS_CHECKS_::/g, checks.substring(1))
+            .replace(/::_MODULE_MEMBERS_ERRORS_::/g, errors)
+            .replace(/::_MODULE_NAME_::/g, preferredModuleName)
+            .replace(/::_NAMESPACE_::/g, namespace),
+        );
+      }
+    }
 
     return files;
   };

package/src/generators/GenerateTypeScript.ts

@@ -0,0 +1,247 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ * @format
+ */
+
+'use strict';
+
+import type {
+  NamedShape,
+  NativeModuleBaseTypeAnnotation,
+  NativeModuleFunctionTypeAnnotation,
+  NativeModuleObjectTypeAnnotation,
+  NativeModuleParamTypeAnnotation,
+  NativeModuleReturnTypeAnnotation,
+  NativeModuleSchema,
+  Nullable,
+  SchemaType,
+} from 'react-native-tscodegen';
+
+interface CodegenNativeModuleSchema extends NativeModuleSchema {
+  optionalTurboModule?: boolean;
+}
+
+export function setOptionalTurboModule(
+  schema: NativeModuleSchema,
+  optional: boolean,
+): void {
+  const cs = <CodegenNativeModuleSchema>schema;
+  cs.optionalTurboModule = optional;
+}
+
+export function getOptionalTurboModule(schema: NativeModuleSchema): boolean {
+  return (<CodegenNativeModuleSchema>schema).optionalTurboModule ?? false;
+}
+
+type ObjectProp = NamedShape<Nullable<NativeModuleBaseTypeAnnotation>>;
+type FunctionParam = NamedShape<Nullable<NativeModuleParamTypeAnnotation>>;
+type FunctionDecl = NamedShape<Nullable<NativeModuleFunctionTypeAnnotation>>;
+type FilesOutput = Map<string, string>;
+
+const moduleTemplate = `
+/*
+ * This file is auto-generated from a NativeModule spec file in js.
+ *
+ * This is a TypeScript turbo module definition file.
+ */
+
+import {TurboModule, TurboModuleRegistry} from 'react-native';
+'use strict';
+::_MODULE_ALIASED_STRUCTS_::
+export interface Spec extends TurboModule {
+::_MODULE_MEMBERS_::
+}
+
+export default TurboModuleRegistry.::_MODULE_GETTER_::<Spec>('::_MODULE_NAME_::');
+`;
+
+function optionalSign<T>(obj: NamedShape<T>): string {
+  return obj.optional ? '?' : '';
+}
+
+function translateType(
+  type: Nullable<
+    | NativeModuleBaseTypeAnnotation
+    | NativeModuleParamTypeAnnotation
+    | NativeModuleReturnTypeAnnotation
+  >,
+): string {
+  // avoid: Property 'type' does not exist on type 'never'
+  const returnType = type.type;
+  switch (type.type) {
+    case 'StringTypeAnnotation':
+      return 'string';
+    case 'NumberTypeAnnotation':
+    case 'FloatTypeAnnotation':
+    case 'DoubleTypeAnnotation':
+    case 'Int32TypeAnnotation':
+      return 'number';
+    case 'BooleanTypeAnnotation':
+      return 'boolean';
+    case 'ArrayTypeAnnotation':
+      if (type.elementType) {
+        return `${translateType(type.elementType)}[]`;
+      } else {
+        return `Array`;
+      }
+    case 'GenericObjectTypeAnnotation':
+      return 'object';
+    case 'ObjectTypeAnnotation':
+      return `{${type.properties
+        .map((prop: ObjectProp) => {
+          return `${prop.name}${optionalSign(prop)}: ${translateType(
+            prop.typeAnnotation,
+          )}`;
+        })
+        .join(', ')}}`;
+    case 'ReservedTypeAnnotation': {
+      // avoid: Property 'name' does not exist on type 'never'
+      const name = type.name;
+      // (#6597)
+      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+      if (name !== 'RootTag')
+        throw new Error(
+          `Unknown reserved function: ${name} in translateReturnType`,
+        );
+      return 'number';
+    }
+    case 'TypeAliasTypeAnnotation':
+      return type.name;
+    case 'NullableTypeAnnotation':
+      return `(${translateType(type.typeAnnotation)} | null | undefined)`;
+    case 'VoidTypeAnnotation':
+      return `void`;
+    case 'PromiseTypeAnnotation':
+      return `Promise`;
+    case `FunctionTypeAnnotation`:
+      return `((${type.params
+        .map((param: FunctionParam) => {
+          return `${param.name}${optionalSign(param)}: ${translateType(
+            param.typeAnnotation,
+          )}`;
+        })
+        .join(', ')}) => ${translateType(type.returnTypeAnnotation)})`;
+    default:
+      throw new Error(`Unhandled type in translateReturnType: ${returnType}`);
+  }
+}
+
+function translateAlias(
+  name: string,
+  type: NativeModuleObjectTypeAnnotation,
+): string {
+  return `
+export interface ${name} {
+${type.properties
+  .map((prop: ObjectProp) => {
+    return `  ${prop.name}${optionalSign(prop)}: ${translateType(
+      prop.typeAnnotation,
+    )};`;
+  })
+  .join('\n')}
+}
+`;
+}
+
+function tryGetConstantType(
+  nativeModule: NativeModuleSchema,
+): NativeModuleObjectTypeAnnotation | undefined {
+  const candidates = nativeModule.spec.properties.filter(
+    prop => prop.name === 'getConstants',
+  );
+  if (candidates.length === 0) {
+    return undefined;
+  }
+
+  const getConstant = candidates[0];
+  const funcType =
+    getConstant.typeAnnotation.type === 'NullableTypeAnnotation'
+      ? getConstant.typeAnnotation.typeAnnotation
+      : getConstant.typeAnnotation;
+  if (
+    funcType.params.length > 0 ||
+    funcType.returnTypeAnnotation.type !== 'ObjectTypeAnnotation'
+  ) {
+    return undefined;
+  }
+
+  const constantType = funcType.returnTypeAnnotation;
+  if (constantType.properties.length === 0) {
+    return undefined;
+  }
+
+  return constantType;
+}
+
+function translateMethod(func: FunctionDecl): string {
+  const funcType =
+    func.typeAnnotation.type === 'NullableTypeAnnotation'
+      ? func.typeAnnotation.typeAnnotation
+      : func.typeAnnotation;
+
+  return `
+  ${func.name}(${funcType.params
+    .map((param: FunctionParam) => {
+      return `${param.name}${optionalSign(param)}: ${translateType(
+        param.typeAnnotation,
+      )}`;
+    })
+    .join(', ')})${optionalSign(func)}: ${translateType(
+    funcType.returnTypeAnnotation,
+  )}${
+    funcType.returnTypeAnnotation.type === 'ObjectTypeAnnotation' ? '' : ';'
+  }`;
+}
+
+export function generateTypeScript(
+  _libraryName: string,
+  schema: SchemaType,
+  _moduleSpecName: string,
+): FilesOutput {
+  const files = new Map<string, string>();
+
+  for (const moduleName of Object.keys(schema.modules)) {
+    const nativeModule = schema.modules[moduleName];
+    // from 0.65 facebook's react-native-codegen
+    // the module name has the Native prefix comparing to 0.63
+    // when reading files we provided
+    const nativePrefix = 'Native';
+    const preferredModuleName = moduleName.startsWith(nativePrefix)
+      ? moduleName.substr(nativePrefix.length)
+      : moduleName;
+
+    if (nativeModule.type === 'NativeModule') {
+      console.log(`Generating ${preferredModuleName}Spec.g.ts`);
+
+      const aliasCode = Object.keys(nativeModule.aliases)
+        .map(name => translateAlias(name, nativeModule.aliases[name]))
+        .join('');
+
+      const constantType = tryGetConstantType(nativeModule);
+      const constantCode =
+        constantType === undefined
+          ? ''
+          : `  getConstants(): ${translateType(constantType)}`;
+
+      const methods = nativeModule.spec.properties.filter(
+        prop => prop.name !== 'getConstants',
+      );
+      const membersCode = methods.map(translateMethod).join('');
+
+      files.set(
+        `${preferredModuleName}Spec.g.ts`,
+        moduleTemplate
+          .replace(/::_MODULE_ALIASED_STRUCTS_::/g, aliasCode)
+          .replace(/::_MODULE_MEMBERS_::/g, constantCode + membersCode)
+          .replace(/::_MODULE_NAME_::/g, preferredModuleName)
+          .replace(
+            /::_MODULE_GETTER_::/g,
+            getOptionalTurboModule(nativeModule) ? 'get' : 'getEnforcing',
+          ),
+      );
+    }
+  }
+
+  return files;
+}