@adhese/sdk-user-sync 0.1.1 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,28 @@
1
1
  # @adhese/sdk-user-sync
2
2
 
3
+ ## 1.0.0
4
+
5
+ ### Major Changes
6
+
7
+ - ff93b63: 🎉🎉🎉 – Release 1.0.0 – 🎉🎉🎉
8
+
9
+ This release marks the first stable release of the Adhese SDK packages. From here on out we will follow semantic
10
+ versioning, meaning that all patch and minor updates will be backwards compatible. Major updates will introduce
11
+ breaking changes.
12
+
13
+ ### Patch Changes
14
+
15
+ - Updated dependencies [ff93b63]
16
+ - Updated dependencies [21aad18]
17
+ - @adhese/sdk@1.0.0
18
+ - @adhese/sdk-shared@1.0.0
19
+
20
+ ## 0.1.2
21
+
22
+ ### Patch Changes
23
+
24
+ - 1feb9ff: Fix types not being published
25
+
3
26
  ## 0.1.1
4
27
 
5
28
  ### Patch Changes
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
3
3
  const name = "@adhese/sdk-user-sync";
4
- const version = "0.1.1";
4
+ const version = "1.0.0";
5
5
  exports.name = name;
6
6
  exports.version = version;
7
7
  //# sourceMappingURL=package.json.cjs.map
@@ -1,5 +1,5 @@
1
1
  const name = "@adhese/sdk-user-sync";
2
- const version = "0.1.1";
2
+ const version = "1.0.0";
3
3
  export {
4
4
  name,
5
5
  version
@@ -0,0 +1,33 @@
1
+ import { AdhesePlugin } from '@adhese/sdk';
2
+
3
+ type SyncOptions = {
4
+ /**
5
+ * Service handler to sync with. This is provided by Adhese. Make sure to contact Adhese support to have access to this.
6
+ */
7
+ serviceHandler: string;
8
+ /**
9
+ * List of events to sync
10
+ */
11
+ events: ReadonlyArray<string>;
12
+ /**
13
+ * User ID that should be synced
14
+ */
15
+ userId: string;
16
+ /**
17
+ * Expiration time in minutes
18
+ */
19
+ expiration: number;
20
+ };
21
+ type UserSyncPlugin = {
22
+ name: 'userSync';
23
+ /**
24
+ * Sync user with Adhese. This will send a request to the Adhese user sync endpoint.
25
+ *
26
+ * @warning This method should only be called when the user has given consent to sync their data. Otherwise, it will
27
+ * throw an error.
28
+ */
29
+ sync(options: SyncOptions): Promise<void>;
30
+ };
31
+ declare const userSyncPlugin: AdhesePlugin<UserSyncPlugin>;
32
+
33
+ export { type SyncOptions, type UserSyncPlugin, userSyncPlugin };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@adhese/sdk-user-sync",
3
3
  "type": "module",
4
- "version": "0.1.1",
4
+ "version": "1.0.0",
5
5
  "description": "Adhese SDK",
6
6
  "repository": {
7
7
  "type": "git",
@@ -25,9 +25,9 @@
25
25
  "prepareRelease": "npm run build"
26
26
  },
27
27
  "peerDependencies": {
28
- "@adhese/sdk": ">= 0.20 < 1"
28
+ "@adhese/sdk": ">=1.0.0"
29
29
  },
30
30
  "dependencies": {
31
- "@adhese/sdk-shared": "^0.10.0"
31
+ "@adhese/sdk-shared": "^1.0.0"
32
32
  }
33
33
  }