@namiml/web-sdk 0.0.1-alpha.5 → 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,49 @@
+# 1.0.0 (June 13, 2024)
+
+## Changelog
+
+### New Features
+- **Nami** - Introduced `Nami` to provide core functionality to initialize the SDK.
+  - **Nami.configure** -Method to initialize and configure the SDK using a `NamiConfiguration` object.
+  - **NamiConfiguration** - Defines the structure of the configuration object used by `Nami.configure`.
+  - **NamiLanguageCodes** - Defines the languages supported by Nami paywalls.
+
+ - **NamiCampaignManager** - Introduced `NamiCampaignManager` to launch paywalls and manage campaigns.
+   - **NamiCampaignManager.launch** - Method to launch paywalls.
+   - **NamiCampaignManager.allCampaigns** - Method to get a list of available `NamiCampaign`s.
+   - **NamiCampaignManager.isCampaignAvailable** - Method to check if a matching campaign is available, returning a boolean.
+   - **NamiCampaignManager.refresh** - Method to request that available campaigns be refreshed.
+   - **NamiCampaignManager.registerAvailableCampaignsHandler** - Method to register a callback that is called when campaigns are updated.
+   - **NamiCampaign** - Defines the structure of the campaign objects.
+   
+- **NamiCustomerManager** - Introduced `NamiCustomerManager` to manager customer related functionality.
+  - **NamiCustomerManager.isLoggedIn** - Method to check if a customer is logged in, returning a boolean.
+  - **NamiCustomerManager.loggedInId** - Method to get the unique customer identifier associated with the current device.
+  - **NamiCustomerManager.login** - Method to provide a customer id to link one or more devices to a known customer.
+  - **NamiCustomerManager.logout** - Method to disassociate a device from a customer identifier.
+  - **NamiCustomerManager.registerAccountStateHandler** - Method to register a callback that is called when a customer is logged in or logged out.
+  - **NamiCustomerManager.setCustomerAttribute** - Method to set an attribute in an on-device key/value store for use for paywall personalization uses cases.
+  - **NamiCustomerManager.getCustomerAttribute** - Method to get the current stored value, if available, for the provided key in the on-device customer key/value store.
+  - **NamiCustomerManager.clearCustomerAttribute** - Method to remove a key from the on-device customer key/value store.
+  - **NamiCustomerManager.clearAllCustomerAttributes** - Method to clear all customer attributes in the on-device key/value store.
+  - **NamiCustomerManager.setAnonymousMode** - Method to set the anonymous mode for the customer.
+
+- **NamiPaywallManager** - Introduce `NamiPaywallManager` to manage paywalls.
+  - **NamiPaywallManager.setProductDetails** - Method to set product and price details to be used by the paywall.
+  - **NamiPaywallManager.registerSignInHandler** - Method to register a callback for when the customer clicks a sign in button on the paywall.
+  - **NamiPaywallManager.registerCloseHandler** - Method to register a callback for when the customer clicks on a close button on the paywall.
+  - **NamiPaywallManager.registerDeeplinkActionHandler** - Method to register a callback for when a customer clicks on a deeplink button on the paywall.
+  - **NamiPaywallManager.registerBuySkuHandler** - Method to register a callback for when a customer clicks on a buy button on the paywall.
+  - **NamiPaywallManager.registerRestoreHandler** - Method to register a callback wfor when a customer clicks to restore a previous purchase.
+  - **NamiPaywallManager.buySkuComplete** - Method to notify Nami SDK when a purchase succeeded for conversion reporting.
+  - **NamiPaywallManager.buySkuCancel** - Method to notify Nami SDK when a user cancelled the purchase flow, or an error occurred.
+
+### Known Issues
+- When user actions are taken on the paywall, paywall callbacks are not being called. 
+- `NamiPaywallManager`'s `buySkuComplete` and `buySkuCancel` methods are not fully implemented.
+- `NamiCustomerManager`'s `setAnonymousMode` method is not fully implemented.
+- Impression or conversion reporting not yet implemented
+- Launch context is not yet implemented
+
+### Additional Notes
+Please refer to the documentation for detailed usage instructions and examples.

package/LICENSE

@@ -0,0 +1 @@
+Your use is subject to the terms of the agreement at: https://www.nami.ml/legal/tos

package/README.md

@@ -1,52 +1,36 @@
-# sdk-web
+![Nami SDK logo](https://cdn.namiml.com/brand/sdk/Nami-SDK@0.5x.png)
 
-Nami SDK for Web Source
+# Nami Web SDK
 
-## Build SDK
+Nami is easy subscriptions & in-app purchases, with powerful built-in paywalls and A/B testing.
 
-### Install dependecies
+ This library helps you easily offer in-app purchases and subscriptions.
+  - No IAP code to write.
+  - Focus on your app experience.
+  - All edge cases are handled and no server is required.
+  - Includes is powerful built-in paywalls templates
+  - Update paywalls easily using a browser-based paywall CMS.
+  - Conduct paywall A/B tests, to improve your conversion rate.
+  - Robust subscription analytics, webhooks, and much more.
 
-```
-npm install || yarn install
-```
+Requires an account with Nami. The free tier is generous and includes everything you need to get up and running.
 
-### Build SDK
+See https://www.namiml.com for more details and to create a free account.
 
-```
-npm run build-sdk || yarn build-sdk
-```
+## Getting started with Nami's Web SDK
 
----
+### Install the Web SDK in your project
 
-## To enable pre-commit hook
+You can install the SDK via NPM or Yarn
 
 ```
-git config core.hooksPath .githooks
+npm install @namiml/web-sdk --save
 ```
 
-## To see the Lit Example:
-
-In one terminal, have microbundle watch your code for changes
 ```
-yarn watch-modern-sdk
+yarn add @namiml/web-sdk
 ```
 
-In another terminal:
-- Go to the `examples/lit` directory
-- Create a `nami-dist` folder (if it doesn't exist)
-- Create a symlink to the built SDK 
-- Start the Web Dev Server
+Example apps showing how to use the SDK are available in our [Nami Web SDK repo](https://github.com/namiml/nami-web-sdk).
 
-```
-cd examples/lit
-mkdir nami-dist
-ln -s ../../dist/nami.modern.mjs ./nami-dist/nami.modern.mjs
-yarn serve
-``` 
-
-## Demo APPs
-
-- [Vanilla JS](https://github.com/namiml/sdk-web/blob/main/examples/vanilla-js-demo/README.md)
-- [React](https://github.com/namiml/sdk-web/blob/main/examples/react-demo/README.md)
-- [Vue](https://github.com/namiml/sdk-web/blob/main/examples/vue-demo/README.md)
-- [Lit](https://github.com/namiml/sdk-web/blob/main/examples/lit/README.md)
+More information on configuring and using the SDK is available in our docs at [https://docs.namiml.com](https://docs.namiml.com).