@adhese/sdk-react 0.9.13 → 1.0.0

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @adhese/sdk-react
 
+## 1.0.0
+
+### Major Changes
+
+- ff93b63: 🎉🎉🎉 – Release 1.0.0 – 🎉🎉🎉
+
+  This release marks the first stable release of the Adhese SDK packages. From here on out we will follow semantic
+  versioning, meaning that all patch and minor updates will be backwards compatible. Major updates will introduce
+  breaking changes.
+
+### Patch Changes
+
+- Updated dependencies [ff93b63]
+- Updated dependencies [21aad18]
+  - @adhese/sdk@1.0.0
+  - @adhese/sdk-shared@1.0.0
+
+## 0.9.14
+
+### Patch Changes
+
+- 1feb9ff: Fix types not being published
+
 ## 0.9.13
 
 ### Patch Changes

package/dist/sdkReact.d.ts

@@ -0,0 +1,37 @@
+import { PropsWithChildren, ReactElement, RefObject } from 'react';
+import { AdheseOptions, Adhese, AdheseSlotOptions, AdheseSlot as AdheseSlot$1 } from '@adhese/sdk';
+
+/**
+ * Provider to create an Adhese instance with the given options. Via the `useAdhese` hook, the Adhese instance can be
+ * used in all child components.
+ * @constructor
+ */
+declare function AdheseProvider({ children, options }: PropsWithChildren<{
+    options: AdheseOptions;
+}>): ReactElement;
+/**
+ * Hook to get the Adhese instance from the nearest `AdheseProvider`. When the Adhese instance is not available yet, `null`
+ */
+declare function useAdhese(): Adhese | undefined;
+
+/**
+ * Hook to create an Adhese slot. The slot will be disposed when the component is unmounted. The slot will be created
+ * when the containing element is available and the Adhese instance is available.
+ * @param elementRef The ref to the containing element
+ * @param options The options to create the slot
+ */
+declare function useAdheseSlot(elementRef: RefObject<HTMLElement>, options: Omit<AdheseSlotOptions, 'containingElement' | 'context'>): AdheseSlot$1 | null;
+
+type AdheseSlotProps = {
+    /**
+     * Callback to be called when the slot is created or disposed
+     */
+    onChange?(slot: AdheseSlot$1 | null): void;
+} & Omit<AdheseSlotOptions, 'containingElement' | 'context'>;
+/**
+ * Component to create an Adhese slot. The slot will be disposed when the component is unmounted. The slot will be
+ * created when the containing element is available and the Adhese instance is available.
+ */
+declare function AdheseSlot({ onChange, ...options }: AdheseSlotProps): ReactElement;
+
+export { AdheseProvider, AdheseSlot, useAdhese, useAdheseSlot };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@adhese/sdk-react",
   "type": "module",
-  "version": "0.9.13",
+  "version": "1.0.0",
   "description": "Adhese SDK",
   "repository": {
     "type": "git",
@@ -25,12 +25,12 @@
     "prepareRelease": "npm run build"
   },
   "peerDependencies": {
-    "@adhese/sdk": ">= 0.16 < 1",
+    "@adhese/sdk": ">=1.0.0",
     "react": ">=16.13",
     "react-dom": ">=16.13"
   },
   "dependencies": {
-    "@adhese/sdk-shared": "^0.10.0",
+    "@adhese/sdk-shared": "^1.0.0",
     "use-deep-compare-effect": "^1.8.1"
   },
   "devDependencies": {