@ingridab/sdk 0.1.0 → 0.3.0

package/README.md

@@ -1,8 +1,7 @@
 # @ingridab/sdk
 
 Vanilla JS SDK for embedding Ingrid Experience Kit compounds into any web
-application. Framework-agnostic; for a React-flavoured binding see
-[`@ingridab/sdk-react`](../sdk-react).
+application.
 
 The initial release ships the `address` molecule; additional molecules will
 be made available in future releases.
@@ -19,29 +18,39 @@ Initialize the SDK with your credentials and the molecules to render, then
 mount the returned compound into a container element in the DOM.
 
 ```ts
-import initIngrid, { createAddressMolecule } from '@ingridab/sdk';
+import ingrid, { createAddressMolecule } from '@ingridab/sdk';
 
-const ingrid = await initIngrid({
+const instance = await ingrid.init({
   token: 'your-auth-token',
+  refreshToken: () => fetch('/your-backend/ingrid-token').then(r => r.json()),
   siteId: 'your-site-id',
   locale: 'en-US',
+  countryCode: 'US',
+  currency: 'USD',
   molecules: [createAddressMolecule({ mode: 'addressForm' })],
 });
 
-await ingrid.compound.mount('#ingrid-container');
+await instance.compound.mount('#ingrid-container');
 ```
 
+### Auth
+
+The `refreshToken` parameter on `ingrid.init` is optional. Use it with
+short-lived Ingrid API tokens, which are preferred. The callback should call
+your backend, fetch a fresh Ingrid API token
+server-side, and return it with its expiration timestamp: `{ accessToken, expiresAt }`.
+
 ### Listening to events
 
 The compound exposes a catch-all `on(event, callback)` API. Subscriptions
 return an unsubscribe function.
 
 ```ts
-const unsubscribe = ingrid.compound.on('addressSubmit', ({ payload }) => {
+const unsubscribe = instance.compound.on('addressSubmit', ({ payload }) => {
   console.log('submitted address', payload);
 });
 
-ingrid.compound.on('ready', () => {
+instance.compound.on('ready', () => {
   console.log('compound mounted and interactive');
 });
 
@@ -52,17 +61,17 @@ unsubscribe();
 
 ```ts
 // Change locale across the mounted experience
-ingrid.setLocale('sv-SE');
+instance.setLocale('sv-SE');
 
 // Update theme tokens without remounting
-ingrid.compound.update({
+instance.compound.update({
   styles: {
-    '--ingrid-color-primary': '#0050ff',
+    '--color-bg-primary': '#0050ff',
   },
 });
 
 // Tear it all down
-ingrid.compound.unmount();
+instance.compound.unmount();
 ```
 
 ## Data providers
@@ -73,12 +82,14 @@ route requests through your own backend, inject auth, mock data in tests, or
 extend the default behaviour with logging.
 
 ```ts
-import initIngrid, { withDefaultProvider } from '@ingridab/sdk';
+import ingrid, { createAddressMolecule, withDefaultProvider } from '@ingridab/sdk';
 
-const ingrid = await initIngrid({
+const instance = await ingrid.init({
   token,
   siteId,
   locale: 'en-US',
+  countryCode: 'US',
+  currency: 'USD',
   molecules: [createAddressMolecule({ mode: 'addressForm' })],
   dataProviders: {
     services: {

package/dist/LICENSES.md

@@ -1,37 +1,3 @@
 # Licenses
 
-The app bundles dependencies which contain the following licenses:
-
-## axios - 1.16.1 (MIT)
-
-# Copyright (c) 2014-present Matt Zabriskie & Collaborators
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-## i18next - 25.5.2 (MIT)
-
-The MIT License (MIT)
-
-Copyright (c) 2025 i18next
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+The app does not bundle any dependencies with licenses.