expo-module-template-local 0.1.0

package/android/build.gradle

@@ -0,0 +1,91 @@
+apply plugin: 'com.android.library'
+apply plugin: 'kotlin-android'
+apply plugin: 'maven-publish'
+
+group = '<%- project.package %>'
+version = '0.1.0'
+
+buildscript {
+  def expoModulesCorePlugin = new File(project(":expo-modules-core").projectDir.absolutePath, "ExpoModulesCorePlugin.gradle")
+  if (expoModulesCorePlugin.exists()) {
+    apply from: expoModulesCorePlugin
+    applyKotlinExpoModulesCorePlugin()
+  }
+
+  // Simple helper that allows the root project to override versions declared by this library.
+  ext.safeExtGet = { prop, fallback ->
+    rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
+  }
+
+  // Ensures backward compatibility
+  ext.getKotlinVersion = {
+    if (ext.has("kotlinVersion")) {
+      ext.kotlinVersion()
+    } else {
+      ext.safeExtGet("kotlinVersion", "1.8.10")
+    }
+  }
+
+  repositories {
+    mavenCentral()
+  }
+
+  dependencies {
+    classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:${getKotlinVersion()}")
+  }
+}
+
+// Creating sources with comments
+task androidSourcesJar(type: Jar) {
+  classifier = 'sources'
+  from android.sourceSets.main.java.srcDirs
+}
+
+afterEvaluate {
+  publishing {
+    publications {
+      release(MavenPublication) {
+        from components.release
+        // Add additional sourcesJar to artifacts
+        artifact(androidSourcesJar)
+      }
+    }
+    repositories {
+      maven {
+        url = mavenLocal().url
+      }
+    }
+  }
+}
+
+android {
+  compileSdkVersion safeExtGet("compileSdkVersion", 33)
+
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_11
+    targetCompatibility JavaVersion.VERSION_11
+  }
+
+  kotlinOptions {
+    jvmTarget = JavaVersion.VERSION_11.majorVersion
+  }
+
+  defaultConfig {
+    minSdkVersion safeExtGet("minSdkVersion", 21)
+    targetSdkVersion safeExtGet("targetSdkVersion", 33)
+    versionCode 1
+    versionName "0.1.0"
+  }
+  lintOptions {
+    abortOnError false
+  }
+}
+
+repositories {
+  mavenCentral()
+}
+
+dependencies {
+  implementation project(':expo-modules-core')
+  implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:${getKotlinVersion()}"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,2 @@
+<manifest package="<%- project.package %>">
+</manifest>

package/android/src/main/java/{%= project.package %}/{%- project.moduleName %}.kt

@@ -0,0 +1,47 @@
+package <%- project.package %>
+
+import expo.modules.kotlin.modules.Module
+import expo.modules.kotlin.modules.ModuleDefinition
+
+class <%- project.moduleName %> : Module() {
+  // Each module class must implement the definition function. The definition consists of components
+  // that describes the module's functionality and behavior.
+  // See https://docs.expo.dev/modules/module-api for more details about available components.
+  override fun definition() = ModuleDefinition {
+    // Sets the name of the module that JavaScript code will use to refer to the module. Takes a string as an argument.
+    // Can be inferred from module's class name, but it's recommended to set it explicitly for clarity.
+    // The module will be accessible from `requireNativeModule('<%- project.name %>')` in JavaScript.
+    Name("<%- project.name %>")
+
+    // Sets constant properties on the module. Can take a dictionary or a closure that returns a dictionary.
+    Constants(
+      "PI" to Math.PI
+    )
+
+    // Defines event names that the module can send to JavaScript.
+    Events("onChange")
+
+    // Defines a JavaScript synchronous function that runs the native code on the JavaScript thread.
+    Function("hello") {
+      "Hello world! 👋"
+    }
+
+    // Defines a JavaScript function that always returns a Promise and whose native code
+    // is by default dispatched on the different thread than the JavaScript runtime runs on.
+    AsyncFunction("setValueAsync") { value: String ->
+      // Send an event to JavaScript.
+      sendEvent("onChange", mapOf(
+        "value" to value
+      ))
+    }
+
+    // Enables the module to be used as a native view. Definition components that are accepted as part of
+    // the view definition: Prop, Events.
+    View(<%- project.viewName %>::class) {
+      // Defines a setter for the `name` prop.
+      Prop("name") { view: <%- project.viewName %>, prop: String ->
+        println(prop)
+      }
+    }
+  }
+}

package/android/src/main/java/{%= project.package %}/{%- project.viewName %}.kt

@@ -0,0 +1,7 @@
+package <%- project.package %>
+
+import android.content.Context
+import expo.modules.kotlin.AppContext
+import expo.modules.kotlin.views.ExpoView
+
+class <%- project.viewName %>(context: Context, appContext: AppContext) : ExpoView(context, appContext)

package/expo-module.config.json

@@ -0,0 +1,9 @@
+{
+  "platforms": ["ios", "android", "web"],
+  "ios": {
+    "modules": ["<%- project.moduleName %>"]
+  },
+  "android": {
+    "modules": ["<%- project.package %>.<%- project.moduleName %>"]
+  }
+}

package/index.ts

@@ -0,0 +1,26 @@
+import { NativeModulesProxy, EventEmitter, Subscription } from 'expo-modules-core';
+
+// Import the native module. On web, it will be resolved to <%- project.name %>.web.ts
+// and on native platforms to <%- project.name %>.ts
+import <%- project.moduleName %> from './src/<%- project.moduleName %>';
+import <%- project.viewName %> from './src/<%- project.viewName %>';
+import { ChangeEventPayload, <%- project.viewName %>Props } from './src/<%- project.name %>.types';
+
+// Get the native constant value.
+export const PI = <%- project.moduleName %>.PI;
+
+export function hello(): string {
+  return <%- project.moduleName %>.hello();
+}
+
+export async function setValueAsync(value: string) {
+  return await <%- project.moduleName %>.setValueAsync(value);
+}
+
+const emitter = new EventEmitter(<%- project.moduleName %> ?? NativeModulesProxy.<%- project.name %>);
+
+export function addChangeListener(listener: (event: ChangeEventPayload) => void): Subscription {
+  return emitter.addListener<ChangeEventPayload>('onChange', listener);
+}
+
+export { <%- project.viewName %>, <%- project.viewName %>Props, ChangeEventPayload };

package/ios/{%- project.moduleName %}.swift

@@ -0,0 +1,44 @@
+import ExpoModulesCore
+
+public class <%- project.moduleName %>: Module {
+  // Each module class must implement the definition function. The definition consists of components
+  // that describes the module's functionality and behavior.
+  // See https://docs.expo.dev/modules/module-api for more details about available components.
+  public func definition() -> ModuleDefinition {
+    // Sets the name of the module that JavaScript code will use to refer to the module. Takes a string as an argument.
+    // Can be inferred from module's class name, but it's recommended to set it explicitly for clarity.
+    // The module will be accessible from `requireNativeModule('<%- project.name %>')` in JavaScript.
+    Name("<%- project.name %>")
+
+    // Sets constant properties on the module. Can take a dictionary or a closure that returns a dictionary.
+    Constants([
+      "PI": Double.pi
+    ])
+
+    // Defines event names that the module can send to JavaScript.
+    Events("onChange")
+
+    // Defines a JavaScript synchronous function that runs the native code on the JavaScript thread.
+    Function("hello") {
+      return "Hello world! 👋"
+    }
+
+    // Defines a JavaScript function that always returns a Promise and whose native code
+    // is by default dispatched on the different thread than the JavaScript runtime runs on.
+    AsyncFunction("setValueAsync") { (value: String) in
+      // Send an event to JavaScript.
+      self.sendEvent("onChange", [
+        "value": value
+      ])
+    }
+
+    // Enables the module to be used as a native view. Definition components that are accepted as part of the
+    // view definition: Prop, Events.
+    View(<%- project.viewName %>.self) {
+      // Defines a setter for the `name` prop.
+      Prop("name") { (view: <%- project.viewName %>, prop: String) in
+        print(prop)
+      }
+    }
+  }
+}

package/ios/{%- project.name %}.podspec

@@ -0,0 +1,21 @@
+Pod::Spec.new do |s|
+  s.name           = '<%- project.name %>'
+  s.version        = '1.0.0'
+  s.summary        = 'A sample project summary'
+  s.description    = 'A sample project description'
+  s.author         = ''
+  s.homepage       = 'https://docs.expo.dev/modules/'
+  s.platform       = :ios, '13.0'
+  s.source         = { git: '' }
+  s.static_framework = true
+
+  s.dependency 'ExpoModulesCore'
+
+  # Swift/Objective-C compatibility
+  s.pod_target_xcconfig = {
+    'DEFINES_MODULE' => 'YES',
+    'SWIFT_COMPILATION_MODE' => 'wholemodule'
+  }
+  
+  s.source_files = "**/*.{h,m,mm,swift,hpp,cpp}"
+end

package/ios/{%- project.viewName %}.swift

@@ -0,0 +1,7 @@
+import ExpoModulesCore
+
+// This view will be used as a native component. Make sure to inherit from `ExpoView`
+// to apply the proper styling (e.g. border radius and shadows).
+class <%- project.viewName %>: ExpoView {
+  
+}

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "expo-module-template-local",
+  "version": "0.1.0",
+  "description": "ExpoModuleTemplate standalone module",
+  "scripts": {},
+  "keywords": [
+    "react-native",
+    "expo",
+    "expo-module-template-local"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/expo/expo.git",
+    "directory": "packages/expo-module-template-local"
+  },
+  "bugs": {
+    "url": "https://github.com/expo/expo/issues"
+  },
+  "author": "650 Industries, Inc.",
+  "license": "MIT",
+  "homepage": "https://docs.expo.dev/modules",
+  "dependencies": {},
+  "devDependencies": {},
+  "peerDependencies": {},
+  "gitHead": "5222dff5bbfeb88d610dac5215809285700fb819"
+}

package/src/{%- project.moduleName %}.ts

@@ -0,0 +1,5 @@
+import { requireNativeModule } from 'expo-modules-core';
+
+// It loads the native module object from the JSI or falls back to
+// the bridge module (from NativeModulesProxy) if the remote debugger is on.
+export default requireNativeModule('<%- project.name %>');

package/src/{%- project.moduleName %}.web.ts

@@ -0,0 +1,13 @@
+import { EventEmitter } from 'expo-modules-core';
+
+const emitter = new EventEmitter({} as any);
+
+export default {
+  PI: Math.PI,
+  async setValueAsync(value: string): Promise<void> {
+    emitter.emit('onChange', { value });
+  },
+  hello() {
+    return 'Hello world! 👋';
+  },
+};

package/src/{%- project.name %}.types.ts

@@ -0,0 +1,7 @@
+export type ChangeEventPayload = {
+  value: string;
+};
+
+export type <%- project.viewName %>Props = {
+  name: string;
+};

package/src/{%- project.viewName %}.tsx

@@ -0,0 +1,11 @@
+import { requireNativeViewManager } from 'expo-modules-core';
+import * as React from 'react';
+
+import { <%- project.viewName %>Props } from './<%- project.name %>.types';
+
+const NativeView: React.ComponentType<<%- project.viewName %>Props> =
+  requireNativeViewManager('<%- project.name %>');
+
+export default function <%- project.viewName %>(props: <%- project.viewName %>Props) {
+  return <NativeView {...props} />;
+}

package/src/{%- project.viewName %}.web.tsx

@@ -0,0 +1,11 @@
+import * as React from 'react';
+
+import { <%- project.viewName %>Props } from './<%- project.name %>.types';
+
+export default function <%- project.viewName %>(props: <%- project.viewName %>Props) {
+  return (
+    <div>
+      <span>{props.name}</span>
+    </div>
+  );
+}