@embeddable/sdk 1.0.0 → 1.0.2

package/README.md

@@ -12,7 +12,6 @@ A TypeScript/JavaScript SDK with React utilities and hooks for embeddable applic
 - 📦 **TypeScript**: Full TypeScript support with type definitions
 - ⚛️ **React Hooks**: Custom hooks for common patterns
 - 🛠️ **Utilities**: Useful utility functions
-- 🎨 **Theme Support**: Built-in theme management
 - 📱 **Storage**: Enhanced localStorage utilities
 - 🌐 **API Client**: Type-safe API client with error handling
 - 🧪 **Well Tested**: Comprehensive test coverage
@@ -45,6 +44,55 @@ import { useLocalStorage } from '@embeddable/sdk/hooks';
 import { debounce } from '@embeddable/sdk/utils';
 ```
 
+## Global Configuration
+
+The SDK supports global configuration through the `EmbeddableProvider` context. This allows you to set a `widgetId` and `version` and `mode` once and access them throughout your application.
+
+### Setup
+
+Wrap your application with the `EmbeddableProvider`:
+
+```typescript
+import { EmbeddableProvider } from '@embeddable/sdk';
+import type { EmbeddableConfig } from '@embeddable/sdk';
+
+function App() {
+  const config: EmbeddableConfig = {
+    widgetId: 'my-widget-123',
+    version: '1.0.0', // 'dev' | 'latest' | string
+    mode: 'embeddable', // 'embeddable' | 'standalone' | 'preview'
+  };
+
+  return (
+    <EmbeddableProvider config={config}>
+      <YourAppComponents />
+    </EmbeddableProvider>
+  );
+}
+```
+
+### Using Global Configuration
+
+Access the global configuration in any component:
+
+```typescript
+import { useEmbeddableConfig, useApi } from '@embeddable/sdk';
+
+function WidgetComponent() {
+  const config = useEmbeddableConfig();
+  const api = useApi(); // Automatically uses global config
+
+  return (
+    <div>
+      <h2>Widget: {config.widgetId}</h2>
+      <p>Version: {config.version}</p>
+      <p>Mode: {config.mode}</p>
+      {/* Your widget content */}
+    </div>
+  );
+}
+```
+
 ## API Reference
 
 ### Hooks
@@ -119,6 +167,28 @@ function DataComponent() {
 }
 ```
 
+#### `useEmbeddableConfig()`
+
+A React hook to access the global SDK configuration.
+
+```typescript
+import { useEmbeddableConfig } from '@embeddable/sdk/hooks';
+
+function MyWidget() {
+  const config = useEmbeddableConfig();
+
+  return (
+    <div>
+      <h3>Widget ID: {config.widgetId}</h3>
+      <p>Version: {config.version}</p>
+      <p>Mode: {config.mode}</p>
+    </div>
+  );
+}
+```
+
+**Note:** This hook must be used within an `EmbeddableProvider`.
+
 ### Utilities
 
 #### `debounce<T>(func: T, wait: number)`
@@ -174,10 +244,9 @@ The SDK exports TypeScript types for better development experience:
 
 ```typescript
 import type {
+  EmbeddableConfig,
   EmbeddableApiConfig,
   ApiResponse,
-  Theme,
-  ThemeConfig,
   LocalStorageOptions,
 } from '@embeddable/sdk';
 ```

package/dist/context/EmbeddableProvider.d.ts

@@ -0,0 +1,14 @@
+import { ReactNode } from 'react';
+import { EmbeddableConfig } from '../types';
+
+interface EmbeddableContextType {
+    config: EmbeddableConfig | null;
+}
+interface EmbeddableProviderProps {
+    config: EmbeddableConfig;
+    children: ReactNode;
+}
+export declare function EmbeddableProvider({ config, children }: EmbeddableProviderProps): import("react/jsx-runtime").JSX.Element;
+export declare function useEmbeddableContext(): EmbeddableContextType;
+export {};
+//# sourceMappingURL=EmbeddableProvider.d.ts.map

package/dist/context/EmbeddableProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EmbeddableProvider.d.ts","sourceRoot":"","sources":["../../src/context/EmbeddableProvider.tsx"],"names":[],"mappings":"AACA,OAAO,EAAiB,SAAS,EAAc,MAAM,OAAO,CAAC;AAC7D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAEjD,UAAU,qBAAqB;IAC7B,MAAM,EAAE,gBAAgB,GAAG,IAAI,CAAC;CACjC;AAiBD,UAAU,uBAAuB;IAC/B,MAAM,EAAE,gBAAgB,CAAC;IACzB,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED,wBAAgB,kBAAkB,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,uBAAuB,2CAM/E;AAED,wBAAgB,oBAAoB,IAAI,qBAAqB,CAM5D"}

package/dist/hooks/index.d.ts

@@ -1,4 +1,5 @@
 export { useApi } from './useApi';
 export { useDebounce } from './useDebounce';
+export { useEmbeddableConfig, useEmbeddableConfigSafe } from './useEmbeddableConfig';
 export { useLocalStorage } from './useLocalStorage';
 //# sourceMappingURL=index.d.ts.map

package/dist/hooks/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AACrF,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/hooks/useApi.d.ts

@@ -2,10 +2,10 @@ import { ApiResponse, EmbeddableApiConfig } from '../types';
 
 /**
  * React hook for API calls with loading and error states
- * @param config - API configuration
+ * @param config - API configuration (optional, will use global config if not provided)
  * @returns API client with state management
  */
-export declare function useApi(config: EmbeddableApiConfig): {
+export declare function useApi(config?: EmbeddableApiConfig): {
     get: <T = any>(endpoint: string) => Promise<ApiResponse<T>>;
     post: <T = any>(endpoint: string, body?: any) => Promise<ApiResponse<T>>;
     put: <T = any>(endpoint: string, body?: any) => Promise<ApiResponse<T>>;

package/dist/hooks/useApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useApi.d.ts","sourceRoot":"","sources":["../../src/hooks/useApi.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AASjE;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE,mBAAmB;UA8DvB,CAAC,kBAAkB,MAAM;WAG/C,CAAC,kBAAkB,MAAM,SAAS,GAAG;UAKrC,CAAC,kBAAkB,MAAM,SAAS,GAAG;aAIf,CAAC,kBAAkB,MAAM;;;aAnFzC,OAAO;WACT,MAAM,GAAG,IAAI;EAoGrB"}
+{"version":3,"file":"useApi.d.ts","sourceRoot":"","sources":["../../src/hooks/useApi.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AASjE;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,MAAM,CAAC,EAAE,mBAAmB;UAsExB,CAAC,kBAAkB,MAAM;WAG/C,CAAC,kBAAkB,MAAM,SAAS,GAAG;UAKrC,CAAC,kBAAkB,MAAM,SAAS,GAAG;aAIf,CAAC,kBAAkB,MAAM;;;aA3FzC,OAAO;WACT,MAAM,GAAG,IAAI;EA4GrB"}

package/dist/hooks/useEmbeddableConfig.d.ts

@@ -0,0 +1,14 @@
+import { EmbeddableConfig } from '../types';
+
+/**
+ * Hook to access the global Embeddable SDK configuration
+ * @returns The current SDK configuration
+ * @throws Error if used outside of EmbeddableProvider
+ */
+export declare function useEmbeddableConfig(): EmbeddableConfig;
+/**
+ * Hook to safely access the global Embeddable SDK configuration
+ * @returns The current SDK configuration or null if not available
+ */
+export declare function useEmbeddableConfigSafe(): EmbeddableConfig | null;
+//# sourceMappingURL=useEmbeddableConfig.d.ts.map

package/dist/hooks/useEmbeddableConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useEmbeddableConfig.d.ts","sourceRoot":"","sources":["../../src/hooks/useEmbeddableConfig.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAEjD;;;;GAIG;AACH,wBAAgB,mBAAmB,IAAI,gBAAgB,CAUtD;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,IAAI,gBAAgB,GAAG,IAAI,CAGjE"}

package/dist/hooks.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./useLocalStorage-C4q-PhVk.cjs");exports.useApi=e.useApi,exports.useDebounce=e.useDebounce,exports.useLocalStorage=e.useLocalStorage;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./useLocalStorage-DrXEgrK7.cjs");exports.useApi=e.useApi,exports.useDebounce=e.useDebounce,exports.useEmbeddableConfig=e.useEmbeddableConfig,exports.useEmbeddableConfigSafe=e.useEmbeddableConfigSafe,exports.useLocalStorage=e.useLocalStorage;

package/dist/hooks.js

@@ -1,6 +1,8 @@
-import { u, a, b } from "./useLocalStorage-BYg8a4Ry.js";
+import { a, b, c, d, e } from "./useLocalStorage-DHUi0T4S.js";
 export {
-  u as useApi,
-  a as useDebounce,
-  b as useLocalStorage
+  a as useApi,
+  b as useDebounce,
+  c as useEmbeddableConfig,
+  d as useEmbeddableConfigSafe,
+  e as useLocalStorage
 };

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./useLocalStorage-C4q-PhVk.cjs"),o=require("./storage-3dk6ww91.cjs"),r=require("./utils.cjs");exports.useApi=e.useApi,exports.useDebounce=e.useDebounce,exports.useLocalStorage=e.useLocalStorage,exports.createApiClient=o.createApiClient,exports.storage=o.storage,exports.debounce=r.debounce;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./useLocalStorage-DrXEgrK7.cjs"),o=require("./storage-3dk6ww91.cjs"),s=require("./utils.cjs");exports.EmbeddableProvider=e.EmbeddableProvider,exports.useApi=e.useApi,exports.useDebounce=e.useDebounce,exports.useEmbeddableConfig=e.useEmbeddableConfig,exports.useEmbeddableConfigSafe=e.useEmbeddableConfigSafe,exports.useEmbeddableContext=e.useEmbeddableContext,exports.useLocalStorage=e.useLocalStorage,exports.createApiClient=o.createApiClient,exports.storage=o.storage,exports.debounce=s.debounce;

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+export * from './context/EmbeddableProvider';
 export * from './hooks';
 export * from './utils';
 export type * from './types';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AAGxB,mBAAmB,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,8BAA8B,CAAC;AAC7C,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AAGxB,mBAAmB,SAAS,CAAC"}

package/dist/index.js

@@ -1,11 +1,15 @@
-import { u, a, b } from "./useLocalStorage-BYg8a4Ry.js";
-import { c, s } from "./storage-CRPDfSRn.js";
+import { E, a, b, c, d, u, e } from "./useLocalStorage-DHUi0T4S.js";
+import { c as c2, s } from "./storage-CRPDfSRn.js";
 import { debounce } from "./utils.js";
 export {
-  c as createApiClient,
+  E as EmbeddableProvider,
+  c2 as createApiClient,
   debounce,
   s as storage,
-  u as useApi,
-  a as useDebounce,
-  b as useLocalStorage
+  a as useApi,
+  b as useDebounce,
+  c as useEmbeddableConfig,
+  d as useEmbeddableConfigSafe,
+  u as useEmbeddableContext,
+  e as useLocalStorage
 };

package/dist/types/index.d.ts

@@ -14,14 +14,15 @@ export interface LocalStorageOptions {
     serialize?: (value: any) => string;
     deserialize?: (value: string) => any;
 }
-export type Theme = 'light' | 'dark' | 'auto';
-export interface ThemeConfig {
-    theme: Theme;
-    colors?: {
-        primary?: string;
-        secondary?: string;
-        background?: string;
-        text?: string;
-    };
+export type EmbeddableMode = 'embeddable' | 'standalone' | 'preview';
+export interface EmbeddableConfig {
+    widgetId: string;
+    version: 'dev' | 'latest' | string;
+    mode: EmbeddableMode;
+    ignoreCache: boolean;
+    lazyLoad: boolean;
+    loader: boolean;
+    _containerId?: string;
+    _shadowRoot?: ShadowRoot;
 }
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,GAAG;IAClC,IAAI,EAAE,CAAC,CAAC;IACR,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,MAAM,CAAC;IACnC,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,GAAG,CAAC;CACtC;AAED,MAAM,MAAM,KAAK,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;AAE9C,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,KAAK,CAAC;IACb,MAAM,CAAC,EAAE;QACP,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,GAAG;IAClC,IAAI,EAAE,CAAC,CAAC;IACR,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,MAAM,CAAC;IACnC,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,GAAG,CAAC;CACtC;AAED,MAAM,MAAM,cAAc,GAAG,YAAY,GAAG,YAAY,GAAG,SAAS,CAAC;AAErE,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC;IACnC,IAAI,EAAE,cAAc,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,EAAE,OAAO,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,UAAU,CAAC;CAC1B"}