@ingridab/sdk 0.1.0-alpha.1 → 0.2.0

package/README.md

@@ -1 +1,118 @@
 # @ingridab/sdk
+
+Vanilla JS SDK for embedding Ingrid Experience Kit compounds into any web
+application.
+
+The initial release ships the `address` molecule; additional molecules will
+be made available in future releases.
+
+## Install
+
+```sh
+pnpm add @ingridab/sdk
+```
+
+## Usage
+
+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 ingrid, { createAddressMolecule } from '@ingridab/sdk';
+
+const instance = await ingrid.init({
+  token: 'your-auth-token',
+  siteId: 'your-site-id',
+  locale: 'en-US',
+  countryCode: 'US',
+  currency: 'USD',
+  molecules: [createAddressMolecule({ mode: 'addressForm' })],
+});
+
+await instance.compound.mount('#ingrid-container');
+```
+
+### Auth
+
+`refreshToken` is optional. Use it with short-lived Ingrid API tokens, which are
+preferred. The callback should call your backend and return a fresh token issued by the
+integrator 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 = instance.compound.on('addressSubmit', ({ payload }) => {
+  console.log('submitted address', payload);
+});
+
+instance.compound.on('ready', () => {
+  console.log('compound mounted and interactive');
+});
+
+unsubscribe();
+```
+
+### Runtime updates
+
+```ts
+// Change locale across the mounted experience
+instance.setLocale('sv-SE');
+
+// Update theme tokens without remounting
+instance.compound.update({
+  styles: {
+    '--color-bg-primary': '#0050ff',
+  },
+});
+
+// Tear it all down
+instance.compound.unmount();
+```
+
+## Data providers
+
+The SDK ships with default data providers that talk to Ingrid's hosted API.
+You can override individual services at init time - useful when you want to
+route requests through your own backend, inject auth, mock data in tests, or
+extend the default behaviour with logging.
+
+```ts
+import ingrid, { createAddressMolecule, withDefaultProvider } from '@ingridab/sdk';
+
+const instance = await ingrid.init({
+  token,
+  siteId,
+  locale: 'en-US',
+  countryCode: 'US',
+  currency: 'USD',
+  molecules: [createAddressMolecule({ mode: 'addressForm' })],
+  dataProviders: {
+    services: {
+      address: {
+        // Replace the default implementation entirely.
+        listSuggestions: async args => {
+          const res = await fetch('/api/address/suggestions', {
+            method: 'POST',
+            body: JSON.stringify(args.params),
+          });
+          return res.json();
+        },
+        // Or wrap the default with `withDefaultProvider` to extend it.
+        validateAddress: withDefaultProvider(defaultFn => async args => {
+          console.log('validating address', args.params);
+          return defaultFn(args);
+        }),
+      },
+    },
+  },
+});
+```
+
+The request/response shapes used by the providers mirror Ingrid's public REST
+API. Refer to the OpenAPI specification for endpoint contracts, payload
+fields, and error responses:
+
+https://docs.ingrid.com/developer-resources/ingrid-api/openapi

package/dist/LICENSES.md

@@ -0,0 +1,37 @@
+# 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.