react-native-sdk-pianoio 0.1.1 → 0.2.1

package/README.md

@@ -4,8 +4,135 @@ Lo scopo di questo pacchetto npm è quello di avere la possibilità di interagir
 
 Il progetto è ancora in **work in progress**.
 
+## Indice
+
+- [Installazione](#installazione)
+  - [Expo](#expo)
+  - [Adattamento del pacchetto a expo < 52](#adattamento-del-pacchetto-a-expo--52)
+  - [React native](#react-native)
+- [Utilizzo](#utilizzo)
+  - [Importazione](#importazione)
+  - [Creazione del Composer](#creazione-del-composer)
+  - [Metodi del Composer](#metodi-del-composer)
+  - [Metodi statici](#metodi-statici)
+- [Esempio completo](#esempio-completo)
+<!-- - [Contributing](#contributing)
+- [License](#license) -->
+
 ## Installazione
 
+### Expo
+
+#### Installazione di Expo
+
+Seguendo la guida presente al link https://docs.expo.dev/get-started/create-a-project/ è possibile effettuare la creazione di un progetto in expo.
+
+Una volta effettuato questo è possibile installare questo pacchetto all'interno del progetto.
+
+Per installare il pacchetto all'interno del progetto, bisogna fare come prima cosa, l'installazione del pacchetto npm:
+
+```sh
+npm install react-native-sdk-pianoio
+```
+
+In seguito effettuare la dev build così da permettere l'utilizzo dell'SDK
+
+```sh
+npx expo run:ios
+```
+
+Con il comando verrà creata la cartella relativa di ios, che **non** sarà necessario toccare in nessun modo.
+
+In seguito si può far partire il progetto, tramite il comando:
+
+```sh
+npx expo start
+```
+
+### Adattamento del pacchetto a Expo < 52
+
+Con l’introduzione della versione Expo SDK 52, il team di Expo ha adottato la **New Architecture** di React Native, che introduce importanti novità come i TurboModules, il Codegen e un nuovo sistema di gestione degli eventi (incluso EventEmitterCallback). Questi cambiamenti migliorano performance, interoperabilità con pacchetti nativi complessi e garantiscono una maggiore compatibilità futura con React Native.
+
+Tuttavia, questa evoluzione comporta incompatibilità con versioni precedenti (Expo 51 o inferiori), che non includono le definizioni e i meccanismi introdotti dalla nuova architettura. 
+
+Un esempio concreto è l’uso del tipo facebook::react::EventEmitterCallback, che esiste solo all’interno della New Architecture. 
+
+Per far funzionare il pacchetto con versioni precedenti alla 52, è necessario usare un approccio un po' forzato, modificando manualmente il codice generato per evitare riferimenti non supportati.
+
+Una volta installato il pacchetto e aver eseguito: 
+```sh
+npx expo run:ios
+```
+
+Dovrebbe comparire una serie di errori simili a questo:
+
+```sh
+❌  (node_modules/react-native-sdk-pianoio/ios/generated/RNSdkPianoioSpec/RNSdkPianoioSpec.h:72:18)
+
+  70 | @interface NativeSdkPianoioSpecBase : NSObject {
+  71 | @protected
+> 72 | facebook::react::EventEmitterCallback _eventEmitterCallback;
+     |                  ^ no type named 'EventEmitterCallback' in namespace 'facebook::react'
+  73 | }
+  74 | - (void)setEventEmitterCallback:(EventEmitterCallbackWrapper *) eventEmitterCallbackWrapper;
+  75 | 
+```
+
+I file causanti di questi errori sono:
+- RNSdkPianoioSpec.h
+- RNSdkPianoioSpec-generated.mm
+
+Quindi, cliccare sulla referenza del file e andare alla linea dell'errore.
+
+#### Modifica del file RNSdkPianoioSpec.h
+
+```
+@interface NativeSdkPianoioSpecBase : NSObject {
+@protected
+  facebook::react::EventEmitterCallback _eventEmitterCallback;
+}
+- (void)setEventEmitterCallback:(EventEmitterCallbackWrapper *) eventEmitterCallbackWrapper;
+
+@end
+```
+Sostituire il codice sovrastante con:
+
+```
+@interface NativeSdkPianoioSpecBase : NSObject {
+@protected
+  void *_eventEmitterCallback;
+}
+- (void)setEventEmitterCallback:(void *)eventEmitterCallbackWrapper;
+
+@end
+```
+
+#### Modifica del file RNSdkPianoioSpec.h
+
+```
+@implementation NativeSdkPianoioSpecBase
+
+
+- (void)setEventEmitterCallback:(EventEmitterCallbackWrapper *)eventEmitterCallbackWrapper
+{
+  _eventEmitterCallback = std::move(eventEmitterCallbackWrapper->_eventEmitterCallback);
+}
+@end
+```
+
+Sostituire il codice sovrastante con:
+
+```
+@implementation NativeSdkPianoioSpecBase
+
+- (void)setEventEmitterCallback:(void *)eventEmitterCallbackWrapper;
+{
+  _eventEmitterCallback = std::move(eventEmitterCallbackWrapper);
+}
+@end
+```
+
+
 ### React native 
 
 Nel progetto di react native eseguire:
@@ -14,7 +141,7 @@ Nel progetto di react native eseguire:
 npm install react-native-sdk-pianoio
 ```
 
-### iOS 
+#### iOS 
 
 Nel progetto di react native entrare nella cartella per ios ed installare le dipendenze:
 
@@ -22,7 +149,7 @@ Nel progetto di react native entrare nella cartella per ios ed installare le dip
 pod install
 ```
 
-### Android 
+#### Android 
 
 Nel progetto di react native entrare nella cartella per android e [...]
 
@@ -46,7 +173,7 @@ import PianoComposer from './PianoComposer';
 const composer = await PianoComposer.create('your_aid');
 ```
 
-## ✨ API del Composer
+## Metodi del Composer
 
 ### `addTag(tag: string)`
 
@@ -118,16 +245,6 @@ await composer.setUserToken('token123');
 
 ---
 
-### `execute()`
-
-Esegue il Composer dopo la configurazione.
-
-```ts
-await composer.execute();
-```
-
----
-
 ### `toString()`
 
 Restituisce una rappresentazione leggibile dello stato del Composer.
@@ -152,7 +269,7 @@ PianoComposer {
 
 ---
 
-## 🔍 Metodi statici
+## Metodi statici
 
 ### `PianoComposer.create(aid: string): Promise<PianoComposer>`
 
@@ -183,7 +300,7 @@ Recupera i dati correnti dal modulo nativo iOS. Questo oggetto include:
 }
 ```
 
-## 📋 Esempio completo
+## Esempio completo
 
 ```ts
 const composer = await PianoComposer.create('YOUR_AID');
@@ -195,8 +312,6 @@ await composer.setUrl('https://my.site/article');
 await composer.setUserToken('jwt-token');
 await composer.setCustomVariable('device', 'mobile');
 
-await composer.execute();
-
 console.log(await composer.toString());
 ```
 

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "react-native-sdk-pianoio",
-  "version": "0.1.1",
+  "version": "0.2.1",
   "description": "Piano io sdk integration",
   "source": "./src/index.tsx",
   "main": "./lib/commonjs/index.js",
   "module": "./lib/module/index.js",
+  "types": "lib/typescript/module/src/index.d.ts",
   "exports": {
     ".": {
       "import": {