@metamask/snaps-simulation 1.0.0

package/dist/validation.mjs

@@ -0,0 +1,64 @@
+import { DialogType } from "@metamask/snaps-sdk";
+import { getJsxChildren } from "@metamask/snaps-utils";
+import { assert, hasProperty } from "@metamask/utils";
+import { getElementByType } from "./interface.mjs";
+/**
+ * Ensure that the actual interface is an alert dialog.
+ *
+ * @param ui - The interface to verify.
+ */
+export function assertIsAlertDialog(ui) {
+    assert(hasProperty(ui, 'type') && ui.type === DialogType.Alert);
+}
+/**
+ * Ensure that the actual interface is a confirmation dialog.
+ *
+ * @param ui - The interface to verify.
+ */
+export function assertIsConfirmationDialog(ui) {
+    assert(hasProperty(ui, 'type') && ui.type === DialogType.Confirmation);
+}
+/**
+ * Ensure that the actual interface is a Prompt dialog.
+ *
+ * @param ui - The interface to verify.
+ */
+export function assertIsPromptDialog(ui) {
+    assert(hasProperty(ui, 'type') && ui.type === DialogType.Prompt);
+}
+/**
+ * Ensure that the actual interface is a custom dialog.
+ *
+ * @param ui - The interface to verify.
+ */
+export function assertIsCustomDialog(ui) {
+    assert(!hasProperty(ui, 'type'));
+}
+/**
+ * Ensure that the actual interface is a custom dialog with a complete footer.
+ *
+ * @param ui - The interface to verify.
+ */
+export function assertCustomDialogHasFooter(ui) {
+    const footer = getElementByType(ui.content, 'Footer');
+    assert(footer && getJsxChildren(footer).length === 2);
+}
+/**
+ * Ensure that the actual interface is a custom dialog with a partial footer.
+ *
+ * @param ui - The interface to verify.
+ */
+export function assertCustomDialogHasPartialFooter(ui) {
+    const footer = getElementByType(ui.content, 'Footer');
+    assert(footer && getJsxChildren(footer).length === 1);
+}
+/**
+ * Ensure that the actual interface is a custom dialog without a footer.
+ *
+ * @param ui - The interface to verify.
+ */
+export function assertCustomDialogHasNoFooter(ui) {
+    const footer = getElementByType(ui.content, 'Footer');
+    assert(!footer);
+}
+//# sourceMappingURL=validation.mjs.map

package/dist/validation.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.mjs","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,4BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,8BAA8B;AACvD,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,wBAAwB;AAEtD,OAAO,EAAE,gBAAgB,EAAE,wBAAoB;AAa/C;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CACjC,EAAiB;IAEjB,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,IAAI,KAAK,UAAU,CAAC,KAAK,CAAC,CAAC;AAClE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,0BAA0B,CACxC,EAAiB;IAEjB,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,IAAI,KAAK,UAAU,CAAC,YAAY,CAAC,CAAC;AACzE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAClC,EAAiB;IAEjB,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,IAAI,KAAK,UAAU,CAAC,MAAM,CAAC,CAAC;AACnE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAClC,EAAiB;IAEjB,MAAM,CAAC,CAAC,WAAW,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC;AACnC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,2BAA2B,CACzC,EAA+C;IAE/C,MAAM,MAAM,GAAG,gBAAgB,CAAgB,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAErE,MAAM,CAAC,MAAM,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;AACxD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kCAAkC,CAChD,EAA+C;IAE/C,MAAM,MAAM,GAAG,gBAAgB,CAAgB,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAErE,MAAM,CAAC,MAAM,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;AACxD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,6BAA6B,CAC3C,EAA+C;IAE/C,MAAM,MAAM,GAAG,gBAAgB,CAAgB,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAErE,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;AAClB,CAAC","sourcesContent":["import { DialogType } from '@metamask/snaps-sdk';\nimport type { FooterElement } from '@metamask/snaps-sdk/jsx';\nimport { getJsxChildren } from '@metamask/snaps-utils';\nimport { assert, hasProperty } from '@metamask/utils';\n\nimport { getElementByType } from './interface';\nimport type {\n  DefaultSnapInterface,\n  DefaultSnapInterfaceWithFooter,\n  DefaultSnapInterfaceWithoutFooter,\n  DefaultSnapInterfaceWithPartialFooter,\n  SnapAlertInterface,\n  SnapConfirmationInterface,\n  SnapInterface,\n  SnapInterfaceActions,\n  SnapPromptInterface,\n} from './types';\n\n/**\n * Ensure that the actual interface is an alert dialog.\n *\n * @param ui - The interface to verify.\n */\nexport function assertIsAlertDialog(\n  ui: SnapInterface,\n): asserts ui is SnapAlertInterface & SnapInterfaceActions {\n  assert(hasProperty(ui, 'type') && ui.type === DialogType.Alert);\n}\n\n/**\n * Ensure that the actual interface is a confirmation dialog.\n *\n * @param ui - The interface to verify.\n */\nexport function assertIsConfirmationDialog(\n  ui: SnapInterface,\n): asserts ui is SnapConfirmationInterface & SnapInterfaceActions {\n  assert(hasProperty(ui, 'type') && ui.type === DialogType.Confirmation);\n}\n\n/**\n * Ensure that the actual interface is a Prompt dialog.\n *\n * @param ui - The interface to verify.\n */\nexport function assertIsPromptDialog(\n  ui: SnapInterface,\n): asserts ui is SnapPromptInterface & SnapInterfaceActions {\n  assert(hasProperty(ui, 'type') && ui.type === DialogType.Prompt);\n}\n\n/**\n * Ensure that the actual interface is a custom dialog.\n *\n * @param ui - The interface to verify.\n */\nexport function assertIsCustomDialog(\n  ui: SnapInterface,\n): asserts ui is DefaultSnapInterface & SnapInterfaceActions {\n  assert(!hasProperty(ui, 'type'));\n}\n\n/**\n * Ensure that the actual interface is a custom dialog with a complete footer.\n *\n * @param ui - The interface to verify.\n */\nexport function assertCustomDialogHasFooter(\n  ui: DefaultSnapInterface & SnapInterfaceActions,\n): asserts ui is DefaultSnapInterfaceWithFooter & SnapInterfaceActions {\n  const footer = getElementByType<FooterElement>(ui.content, 'Footer');\n\n  assert(footer && getJsxChildren(footer).length === 2);\n}\n\n/**\n * Ensure that the actual interface is a custom dialog with a partial footer.\n *\n * @param ui - The interface to verify.\n */\nexport function assertCustomDialogHasPartialFooter(\n  ui: DefaultSnapInterface & SnapInterfaceActions,\n): asserts ui is DefaultSnapInterfaceWithPartialFooter & SnapInterfaceActions {\n  const footer = getElementByType<FooterElement>(ui.content, 'Footer');\n\n  assert(footer && getJsxChildren(footer).length === 1);\n}\n\n/**\n * Ensure that the actual interface is a custom dialog without a footer.\n *\n * @param ui - The interface to verify.\n */\nexport function assertCustomDialogHasNoFooter(\n  ui: DefaultSnapInterface & SnapInterfaceActions,\n): asserts ui is DefaultSnapInterfaceWithoutFooter & SnapInterfaceActions {\n  const footer = getElementByType<FooterElement>(ui.content, 'Footer');\n\n  assert(!footer);\n}\n"]}

package/package.json

@@ -0,0 +1,101 @@
+{
+  "name": "@metamask/snaps-simulation",
+  "version": "1.0.0",
+  "description": "A simulation framework for MetaMask Snaps, enabling headless testing of Snaps in a controlled environment",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/snaps.git"
+  },
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "default": "./dist/index.cjs",
+        "types": "./dist/index.d.cts"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.cts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "test": "jest && yarn posttest",
+    "posttest": "jest-it-up --margin 0.25",
+    "test:ci": "yarn test",
+    "lint:eslint": "eslint . --cache --ext js,ts,jsx,tsx",
+    "lint:misc": "prettier --no-error-on-unmatched-pattern --loglevel warn \"**/*.json\" \"**/*.md\" \"**/*.html\" \"!CHANGELOG.md\" --ignore-path ../../.gitignore",
+    "lint": "yarn lint:eslint && yarn lint:misc --check && yarn lint:changelog && yarn lint:dependencies",
+    "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write",
+    "lint:changelog": "../../scripts/validate-changelog.sh @metamask/snaps-simulation",
+    "build": "ts-bridge --project tsconfig.build.json --verbose --no-references",
+    "publish:preview": "yarn npm publish --tag preview",
+    "lint:ci": "yarn lint",
+    "lint:dependencies": "depcheck"
+  },
+  "dependencies": {
+    "@metamask/base-controller": "^6.0.2",
+    "@metamask/eth-json-rpc-middleware": "^14.0.0",
+    "@metamask/json-rpc-engine": "^9.0.2",
+    "@metamask/json-rpc-middleware-stream": "^8.0.2",
+    "@metamask/key-tree": "^9.1.2",
+    "@metamask/permission-controller": "^11.0.0",
+    "@metamask/phishing-controller": "^12.0.2",
+    "@metamask/snaps-controllers": "^9.7.0",
+    "@metamask/snaps-rpc-methods": "^11.1.1",
+    "@metamask/snaps-sdk": "^6.5.0",
+    "@metamask/snaps-utils": "^8.1.1",
+    "@metamask/superstruct": "^3.1.0",
+    "@metamask/utils": "^9.2.1",
+    "@reduxjs/toolkit": "^1.9.5",
+    "mime": "^3.0.0",
+    "readable-stream": "^3.6.2",
+    "redux-saga": "^1.2.3"
+  },
+  "devDependencies": {
+    "@lavamoat/allow-scripts": "^3.0.4",
+    "@metamask/auto-changelog": "^3.4.4",
+    "@metamask/eslint-config": "^12.1.0",
+    "@metamask/eslint-config-jest": "^12.1.0",
+    "@metamask/eslint-config-nodejs": "^12.1.0",
+    "@metamask/eslint-config-typescript": "^12.1.0",
+    "@ts-bridge/cli": "^0.5.1",
+    "@types/express": "^4.17.17",
+    "@types/jest": "^27.5.1",
+    "@types/mime": "^3.0.0",
+    "@types/readable-stream": "^4.0.15",
+    "@typescript-eslint/eslint-plugin": "^5.42.1",
+    "@typescript-eslint/parser": "^6.21.0",
+    "deepmerge": "^4.2.2",
+    "depcheck": "^1.4.7",
+    "eslint": "^8.27.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-jest": "^27.1.5",
+    "eslint-plugin-jsdoc": "^41.1.2",
+    "eslint-plugin-n": "^15.7.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-promise": "^6.1.1",
+    "express": "^4.18.2",
+    "jest": "^29.0.2",
+    "jest-it-up": "^2.0.0",
+    "prettier": "^2.7.1",
+    "prettier-plugin-packagejson": "^2.2.11",
+    "ts-jest": "^29.1.1",
+    "typescript": "~5.3.3"
+  },
+  "engines": {
+    "node": "^18.16 || >=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}