@segment/analytics-browser-actions-rupt 1.1.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.
Files changed (48) hide show
  1. package/README.md +31 -0
  2. package/dist/cjs/attach/generated-types.d.ts +9 -0
  3. package/dist/cjs/attach/generated-types.js +3 -0
  4. package/dist/cjs/attach/generated-types.js.map +1 -0
  5. package/dist/cjs/attach/index.d.ts +6 -0
  6. package/dist/cjs/attach/index.js +76 -0
  7. package/dist/cjs/attach/index.js.map +1 -0
  8. package/dist/cjs/attach.types.d.ts +9 -0
  9. package/dist/cjs/attach.types.js +3 -0
  10. package/dist/cjs/attach.types.js.map +1 -0
  11. package/dist/cjs/generated-types.d.ts +7 -0
  12. package/dist/cjs/generated-types.js +3 -0
  13. package/dist/cjs/generated-types.js.map +1 -0
  14. package/dist/cjs/index.d.ts +11 -0
  15. package/dist/cjs/index.js +69 -0
  16. package/dist/cjs/index.js.map +1 -0
  17. package/dist/cjs/types.d.ts +50 -0
  18. package/dist/cjs/types.js +3 -0
  19. package/dist/cjs/types.js.map +1 -0
  20. package/dist/esm/attach/generated-types.d.ts +9 -0
  21. package/dist/esm/attach/generated-types.js +2 -0
  22. package/dist/esm/attach/generated-types.js.map +1 -0
  23. package/dist/esm/attach/index.d.ts +6 -0
  24. package/dist/esm/attach/index.js +74 -0
  25. package/dist/esm/attach/index.js.map +1 -0
  26. package/dist/esm/attach.types.d.ts +9 -0
  27. package/dist/esm/attach.types.js +2 -0
  28. package/dist/esm/attach.types.js.map +1 -0
  29. package/dist/esm/generated-types.d.ts +7 -0
  30. package/dist/esm/generated-types.js +2 -0
  31. package/dist/esm/generated-types.js.map +1 -0
  32. package/dist/esm/index.d.ts +11 -0
  33. package/dist/esm/index.js +65 -0
  34. package/dist/esm/index.js.map +1 -0
  35. package/dist/esm/types.d.ts +50 -0
  36. package/dist/esm/types.js +2 -0
  37. package/dist/esm/types.js.map +1 -0
  38. package/dist/tsconfig.tsbuildinfo +1 -0
  39. package/package.json +25 -0
  40. package/src/__tests__/index.test.ts +28 -0
  41. package/src/attach/__tests__/index.test.ts +77 -0
  42. package/src/attach/generated-types.ts +26 -0
  43. package/src/attach/index.ts +79 -0
  44. package/src/attach.types.ts +26 -0
  45. package/src/generated-types.ts +24 -0
  46. package/src/index.ts +77 -0
  47. package/src/types.ts +76 -0
  48. package/tsconfig.json +9 -0
package/src/types.ts ADDED
@@ -0,0 +1,76 @@
1
+ interface Redirects {
2
+ logout_url?: string
3
+ new_account_url: string
4
+ success_url?: string
5
+ suspended_url?: string
6
+ }
7
+
8
+ interface DetachConfig {
9
+ client_id: string
10
+ secret?: string
11
+ device: string
12
+ account?: string
13
+ domain?: string
14
+ }
15
+ export interface LimitConfig {
16
+ /**
17
+ * @description The maximum devices that can be attached to a single account.
18
+ */
19
+ overall_device_limit?: number
20
+ /**
21
+ * @description The number of people allowed to use the same account. This is useful for family plans. If Rupt detects more than this number of people using the same account (even if not using at the same time), it will trigger the on_limit_exceeded callback.
22
+ */
23
+ people_limit?: number
24
+ }
25
+
26
+ export interface AttachResponse {
27
+ success: boolean
28
+ attached_devices: number
29
+ device_id: string
30
+ default_device_limit: number
31
+ block_over_usage: boolean
32
+ suspended?: boolean
33
+ access: string
34
+ identity: string
35
+ }
36
+
37
+ export interface AttachConfig {
38
+ client_id: string
39
+ secret?: string
40
+ account: string
41
+ email?: string
42
+ phone?: string
43
+ metadata?: object
44
+ debug?: boolean
45
+ identity?: string
46
+ include_page?: boolean
47
+ limit_config?: LimitConfig
48
+ redirect_urls?: Redirects
49
+ on_challenge?: () => boolean
50
+ on_limit_exceeded?: () => void
51
+ domain?: string
52
+ }
53
+
54
+ type attach = ({
55
+ client_id,
56
+ secret,
57
+ account,
58
+ email,
59
+ phone,
60
+ metadata,
61
+ debug,
62
+ identity,
63
+ include_page,
64
+ domain,
65
+ limit_config,
66
+ redirect_urls,
67
+ on_challenge,
68
+ on_limit_exceeded
69
+ }: AttachConfig) => Promise<AttachResponse | null>
70
+
71
+ type detach = ({ device, account, client_id, secret, domain }: DetachConfig) => Promise<any>
72
+
73
+ export default interface Rupt {
74
+ attach: attach
75
+ detach: detach
76
+ }
package/tsconfig.json ADDED
@@ -0,0 +1,9 @@
1
+ {
2
+ "extends": "../../tsconfig.build.json",
3
+ "compilerOptions": {
4
+ "rootDir": "./src",
5
+ "baseUrl": "."
6
+ },
7
+ "include": ["src"],
8
+ "exclude": ["dist", "**/__tests__"]
9
+ }