react-native-sdk-pianoio 0.2.2 → 0.2.3

package/README.md

@@ -2,162 +2,84 @@
 
 Lo scopo di questo pacchetto npm è quello di avere la possibilità di interagire con i metodi messi a disposizione dalle SDK di Piano sia di iOS che di Android, così da avere un unico pacchetto da installare nel momento in cui si vuole utilizzare Piano.io.
 
+Il tutto deve essere compatibile con la version **Expo SDK51** ed è su questa versione che sono stati effettuati i test.
+
 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)
+  - [Prerequisiti (adattamento del pacchetto a Expo < 52)](#prerequisiti-adattamento-del-pacchetto-a-expo--52)
+  - [iOS](#ios)
+  - [Android](#android)
+  - [Avviare progetto](#avviare-progetto)
 - [Utilizzo](#utilizzo)
   - [Importazione](#importazione)
   - [Creazione del Composer](#creazione-del-composer)
   - [Metodi del Composer](#metodi-del-composer)
+    - [`addTag(tag: string)`](#addtagtag-string)
+    - [`addTags(tags: string[])`](#addtagstags-string)
+    - [`setZoneId(zoneId: string)`](#setzoneidzoneid-string)
+    - [`setReferrer(referrer: string)`](#setreferrerreferrer-string)
+    - [`setUrl(url: string)`](#seturlurl-string)
+    - [`setCustomVariable(name: string, value: string)`](#setcustomvariablename-string-value-string)
+    - [`setUserToken(token: string)`](#setusertokentoken-string)
+    - [`toString()`](#tostring)
   - [Metodi statici](#metodi-statici)
+    - [`PianoComposer.create(aid: string): Promise<PianoComposer>`](#pianocomposercreateaid-string-promisepianocomposer)
+    - [`PianoComposer.isInitialized(): Promise<boolean>`](#pianocomposerisinitialized-promiseboolean)
+    - [`PianoComposer.getComposerFromSdkIOS(): Promise<Object>`](#pianocomposergetcomposerfromsdkios-promiseobject)
 - [Esempio completo](#esempio-completo)
 <!-- - [Contributing](#contributing)
 - [License](#license) -->
 
 ## Installazione
 
-### Expo
-
-#### Installazione di Expo
+### Prerequisiti (adattamento del pacchetto a Expo < 52)
 
 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
+Bisogna rendere come prima cosa il progetto in expo predisposto all'utilizzo di moduli nativi, per farlo c'è il seguente comando:
 
 ```sh
-npx expo run:ios
+npx expo prebuild
 ```
+Questo creerà la cartella per iOS e per Android.
 
-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:
+Dopodiché si può passare all'installazione del pacchetto npm:
 
 ```sh
-npx expo start
+npm install react-native-sdk-pianoio
 ```
 
-### 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:
+### iOS
 
-```sh
-npx expo run:ios
-```
-
-Dovrebbe comparire una serie di errori simili a questo:
+Nel progetto di react native entrare nella cartella per ios ed installare le dipendenze:
 
 ```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
+pod install
 ```
 
-### React native
+### Android
 
-Nel progetto di react native eseguire:
+Nel progetto di react native entrare nella cartella per android e [...]
 
 ```sh
-npm install react-native-sdk-pianoio
+work in progress
 ```
 
-#### iOS
+#### Avviare progetto
 
-Nel progetto di react native entrare nella cartella per ios ed installare le dipendenze:
+In seguito si può far partire il progetto, tramite il comando:
 
 ```sh
-pod install
+npx expo run:ios
 ```
 
-#### Android
-
-Nel progetto di react native entrare nella cartella per android e [...]
+**Importante:** non usare ExpoGo per il progetto, potrebbe causare errori.
 
-```sh
-work in progress
-```
 
 ## Utilizzo
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-sdk-pianoio",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "Piano io sdk integration",
   "source": "./src/index.tsx",
   "main": "./lib/commonjs/index.js",