@metamask-previews/claims-controller 0.0.0-preview-1f85e85a

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 (44) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/LICENSE +20 -0
  3. package/README.md +15 -0
  4. package/dist/ClaimsController.cjs +134 -0
  5. package/dist/ClaimsController.cjs.map +1 -0
  6. package/dist/ClaimsController.d.cts +48 -0
  7. package/dist/ClaimsController.d.cts.map +1 -0
  8. package/dist/ClaimsController.d.mts +48 -0
  9. package/dist/ClaimsController.d.mts.map +1 -0
  10. package/dist/ClaimsController.mjs +129 -0
  11. package/dist/ClaimsController.mjs.map +1 -0
  12. package/dist/ClaimsService.cjs +142 -0
  13. package/dist/ClaimsService.cjs.map +1 -0
  14. package/dist/ClaimsService.d.cts +87 -0
  15. package/dist/ClaimsService.d.cts.map +1 -0
  16. package/dist/ClaimsService.d.mts +87 -0
  17. package/dist/ClaimsService.d.mts.map +1 -0
  18. package/dist/ClaimsService.mjs +138 -0
  19. package/dist/ClaimsService.mjs.map +1 -0
  20. package/dist/constants.cjs +39 -0
  21. package/dist/constants.cjs.map +1 -0
  22. package/dist/constants.d.cts +22 -0
  23. package/dist/constants.d.cts.map +1 -0
  24. package/dist/constants.d.mts +22 -0
  25. package/dist/constants.d.mts.map +1 -0
  26. package/dist/constants.mjs +36 -0
  27. package/dist/constants.mjs.map +1 -0
  28. package/dist/index.cjs +12 -0
  29. package/dist/index.cjs.map +1 -0
  30. package/dist/index.d.cts +7 -0
  31. package/dist/index.d.cts.map +1 -0
  32. package/dist/index.d.mts +7 -0
  33. package/dist/index.d.mts.map +1 -0
  34. package/dist/index.mjs +4 -0
  35. package/dist/index.mjs.map +1 -0
  36. package/dist/types.cjs +3 -0
  37. package/dist/types.cjs.map +1 -0
  38. package/dist/types.d.cts +54 -0
  39. package/dist/types.d.cts.map +1 -0
  40. package/dist/types.d.mts +54 -0
  41. package/dist/types.d.mts.map +1 -0
  42. package/dist/types.mjs +2 -0
  43. package/dist/types.mjs.map +1 -0
  44. package/package.json +76 -0
@@ -0,0 +1,54 @@
1
+ import type { Hex } from "@metamask/utils";
2
+ import type { ClaimStatusEnum } from "./constants.mjs";
3
+ export type Attachment = {
4
+ publicUrl: string;
5
+ contentType: string;
6
+ originalname: string;
7
+ };
8
+ export type Claim = {
9
+ id: string;
10
+ shortId: string;
11
+ chainId: string;
12
+ email: string;
13
+ impactedWalletAddress: Hex;
14
+ impactedTxHash: Hex;
15
+ reimbursementWalletAddress: Hex;
16
+ description: string;
17
+ signature: Hex;
18
+ attachments?: Attachment[];
19
+ status: ClaimStatusEnum;
20
+ createdAt: string;
21
+ updatedAt: string;
22
+ intercomId?: string;
23
+ };
24
+ export type CreateClaimRequest = Omit<Claim, 'id' | 'shortId' | 'createdAt' | 'updatedAt' | 'intercomId' | 'status'>;
25
+ export type ClaimsControllerState = {
26
+ claims: Claim[];
27
+ };
28
+ export type SubmitClaimConfig = {
29
+ /**
30
+ * The sanitized and validated data to be submitted.
31
+ */
32
+ data: CreateClaimRequest;
33
+ /**
34
+ * The headers to be used in the request.
35
+ */
36
+ headers: Record<string, string>;
37
+ /**
38
+ * The HTTP method to submit.
39
+ */
40
+ method: 'POST';
41
+ /**
42
+ * The URL to submit the claim to.
43
+ */
44
+ url: string;
45
+ };
46
+ export type GenerateSignatureMessageResponse = {
47
+ message: string;
48
+ nonce: string;
49
+ };
50
+ export type VerifyClaimSignatureResponse = {
51
+ message: string;
52
+ success: boolean;
53
+ };
54
+ //# sourceMappingURL=types.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C,OAAO,KAAK,EAAE,eAAe,EAAE,wBAAoB;AAEnD,MAAM,MAAM,UAAU,GAAG;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,qBAAqB,EAAE,GAAG,CAAC;IAC3B,cAAc,EAAE,GAAG,CAAC;IACpB,0BAA0B,EAAE,GAAG,CAAC;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,GAAG,CAAC;IACf,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC;IAC3B,MAAM,EAAE,eAAe,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,IAAI,CACnC,KAAK,EACL,IAAI,GAAG,SAAS,GAAG,WAAW,GAAG,WAAW,GAAG,YAAY,GAAG,QAAQ,CACvE,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,IAAI,EAAE,kBAAkB,CAAC;IACzB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC"}
package/dist/types.mjs ADDED
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=types.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.mjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { Hex } from '@metamask/utils';\n\nimport type { ClaimStatusEnum } from './constants';\n\nexport type Attachment = {\n publicUrl: string;\n contentType: string;\n originalname: string;\n};\n\nexport type Claim = {\n id: string;\n shortId: string;\n chainId: string;\n email: string;\n impactedWalletAddress: Hex;\n impactedTxHash: Hex;\n reimbursementWalletAddress: Hex;\n description: string;\n signature: Hex;\n attachments?: Attachment[];\n status: ClaimStatusEnum;\n createdAt: string;\n updatedAt: string;\n intercomId?: string;\n};\n\nexport type CreateClaimRequest = Omit<\n Claim,\n 'id' | 'shortId' | 'createdAt' | 'updatedAt' | 'intercomId' | 'status'\n>;\n\nexport type ClaimsControllerState = {\n claims: Claim[];\n};\n\nexport type SubmitClaimConfig = {\n /**\n * The sanitized and validated data to be submitted.\n */\n data: CreateClaimRequest;\n /**\n * The headers to be used in the request.\n */\n headers: Record<string, string>;\n /**\n * The HTTP method to submit.\n */\n method: 'POST';\n /**\n * The URL to submit the claim to.\n */\n url: string;\n};\n\nexport type GenerateSignatureMessageResponse = {\n message: string;\n nonce: string;\n};\n\nexport type VerifyClaimSignatureResponse = {\n message: string;\n success: boolean;\n};\n"]}
package/package.json ADDED
@@ -0,0 +1,76 @@
1
+ {
2
+ "name": "@metamask-previews/claims-controller",
3
+ "version": "0.0.0-preview-1f85e85a",
4
+ "description": "Controller handling shield subscription claims logic",
5
+ "keywords": [
6
+ "MetaMask",
7
+ "Ethereum"
8
+ ],
9
+ "homepage": "https://github.com/MetaMask/core/tree/main/packages/claims-controller#readme",
10
+ "bugs": {
11
+ "url": "https://github.com/MetaMask/core/issues"
12
+ },
13
+ "repository": {
14
+ "type": "git",
15
+ "url": "https://github.com/MetaMask/core.git"
16
+ },
17
+ "license": "MIT",
18
+ "sideEffects": false,
19
+ "exports": {
20
+ ".": {
21
+ "import": {
22
+ "types": "./dist/index.d.mts",
23
+ "default": "./dist/index.mjs"
24
+ },
25
+ "require": {
26
+ "types": "./dist/index.d.cts",
27
+ "default": "./dist/index.cjs"
28
+ }
29
+ },
30
+ "./package.json": "./package.json"
31
+ },
32
+ "main": "./dist/index.cjs",
33
+ "types": "./dist/index.d.cts",
34
+ "files": [
35
+ "dist/"
36
+ ],
37
+ "scripts": {
38
+ "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
39
+ "build:all": "ts-bridge --project tsconfig.build.json --verbose --clean",
40
+ "build:docs": "typedoc",
41
+ "changelog:update": "../../scripts/update-changelog.sh @metamask/claims-controller",
42
+ "changelog:validate": "../../scripts/validate-changelog.sh @metamask/claims-controller",
43
+ "publish:preview": "yarn npm publish --tag preview",
44
+ "since-latest-release": "../../scripts/since-latest-release.sh",
45
+ "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
46
+ "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
47
+ "test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
48
+ "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
49
+ },
50
+ "dependencies": {
51
+ "@metamask/base-controller": "^9.0.0",
52
+ "@metamask/controller-utils": "^11.15.0",
53
+ "@metamask/messenger": "^0.3.0",
54
+ "@metamask/utils": "^11.8.1"
55
+ },
56
+ "devDependencies": {
57
+ "@metamask/auto-changelog": "^3.4.4",
58
+ "@metamask/keyring-controller": "^24.0.0",
59
+ "@metamask/profile-sync-controller": "^26.0.0",
60
+ "@ts-bridge/cli": "^0.6.4",
61
+ "@types/jest": "^27.4.1",
62
+ "deepmerge": "^4.2.2",
63
+ "jest": "^27.5.1",
64
+ "ts-jest": "^27.1.4",
65
+ "typedoc": "^0.24.8",
66
+ "typedoc-plugin-missing-exports": "^2.0.0",
67
+ "typescript": "~5.2.2"
68
+ },
69
+ "engines": {
70
+ "node": "^18.18 || >=20"
71
+ },
72
+ "publishConfig": {
73
+ "access": "public",
74
+ "registry": "https://registry.npmjs.org/"
75
+ }
76
+ }