@metamask/keyring-api 0.2.1 → 0.2.3

package/dist/superstruct.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"superstruct.js","sourceRoot":"","sources":["../src/superstruct.ts"],"names":[],"mappings":";;;AAAA,yDAAyD;AACzD,6CAKqB;AA+CrB;;;;;;GAMG;AACH,SAAgB,MAAM,CACpB,MAAS;IAET,OAAO,IAAA,oBAAQ,EAAC,MAAM,CAAQ,CAAC;AACjC,CAAC;AAJD,wBAIC;AAED;;;;;GAKG;AACH,SAAS,WAAW,CAAC,GAAY;IAC/B,MAAM,QAAQ,GAAW,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACvD,MAAM,MAAM,GAA4B,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAE1E,OAAO,QAAQ,IAAI,MAAM,CAAC;AAC5B,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,aAAa,CAC3B,MAAoB;IAEpB,OAAO,IAAI,oBAAM,CAAC;QAChB,GAAG,MAAM;QAET,SAAS,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CACxB,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC;QAEnD,OAAO,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CACtB,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAU,EAAE,GAAG,CAAC;KACvD,CAAC,CAAC;AACL,CAAC;AAZD,sCAYC","sourcesContent":["/* eslint-disable @typescript-eslint/naming-convention */\nimport {\n  type Infer,\n  type Context,\n  Struct,\n  object as stObject,\n} from 'superstruct';\nimport type {\n  ObjectSchema,\n  OmitBy,\n  Optionalize,\n  PickBy,\n  Simplify,\n} from 'superstruct/dist/utils';\n\ndeclare const ExactOptionalSymbol: unique symbol;\n\nexport type ExactOptionalTag = {\n  type: typeof ExactOptionalSymbol;\n};\n\n/**\n * Exclude a type from the properties of a type.\n *\n * ```ts\n * type Foo = { a: string | null; b: number };\n * type Bar = ExcludeType<Foo, null>;\n * // Bar = { a: string, b: number }\n * ```\n */\nexport type ExcludeType<T, V> = {\n  [K in keyof T]: Exclude<T[K], V>;\n};\n\n/**\n * Make optional all properties that have the `ExactOptionalTag` type.\n *\n * ```ts\n * type Foo = { a: string | ExactOptionalTag; b: number};\n * type Bar = ExactOptionalize<Foo>;\n * // Bar = { a?: string; b: number}\n * ```\n */\nexport type ExactOptionalize<S extends object> = OmitBy<S, ExactOptionalTag> &\n  Partial<ExcludeType<PickBy<S, ExactOptionalTag>, ExactOptionalTag>>;\n\n/**\n * Infer a type from an superstruct object schema.\n */\nexport type ObjectType<S extends ObjectSchema> = Simplify<\n  ExactOptionalize<Optionalize<{ [K in keyof S]: Infer<S[K]> }>>\n>;\n\n/**\n * Change the return type of a superstruct object struct to support exact\n * optional properties.\n *\n * @param schema - The object schema.\n * @returns A struct representing an object with a known set of properties.\n */\nexport function object<S extends ObjectSchema>(\n  schema: S,\n): Struct<ObjectType<S>, S> {\n  return stObject(schema) as any;\n}\n\n/**\n * Check if the current property is present in its parent object.\n *\n * @param ctx - The context to check.\n * @returns `true` if the property is present, `false` otherwise.\n */\nfunction hasOptional(ctx: Context): boolean {\n  const property: string = ctx.path[ctx.path.length - 1];\n  const parent: Record<string, unknown> = ctx.branch[ctx.branch.length - 2];\n\n  return property in parent;\n}\n\n/**\n * Augment a struct to allow exact-optional values. Exact-optional values can\n * be omitted but cannot be `undefined`.\n *\n * ```ts\n * const foo = object({ bar: exactOptional(string()) });\n * type Foo = Infer<typeof foo>;\n * // Foo = { bar?: string }\n * ```\n *\n * @param struct - The struct to augment.\n * @returns The augmented struct.\n */\nexport function exactOptional<T, S>(\n  struct: Struct<T, S>,\n): Struct<T | ExactOptionalTag, S> {\n  return new Struct({\n    ...struct,\n\n    validator: (value, ctx) =>\n      !hasOptional(ctx) || struct.validator(value, ctx),\n\n    refiner: (value, ctx) =>\n      !hasOptional(ctx) || struct.refiner(value as T, ctx),\n  });\n}\n"]}

package/dist/superstruct.test-d.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/superstruct.test-d.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const superstruct_1 = require("superstruct");
+const tsd_1 = require("tsd");
+const _1 = require(".");
+const exactOptionalObject = (0, _1.object)({
+    a: (0, superstruct_1.number)(),
+    b: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+    c: (0, _1.exactOptional)((0, superstruct_1.boolean)()),
+});
+(0, tsd_1.expectAssignable)({ a: 0 });
+(0, tsd_1.expectAssignable)({ a: 0, b: 'test' });
+(0, tsd_1.expectAssignable)({ a: 0, b: 'test', c: true });
+(0, tsd_1.expectAssignable)({ a: 0, b: undefined });
+(0, tsd_1.expectNotAssignable)({ a: 0, b: 'test', c: 0 });
+(0, tsd_1.expectNotAssignable)({ a: 0, b: 'test', c: undefined });
+//# sourceMappingURL=superstruct.test-d.js.map

package/dist/superstruct.test-d.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"superstruct.test-d.js","sourceRoot":"","sources":["../src/superstruct.test-d.ts"],"names":[],"mappings":";;AACA,6CAAgE;AAChE,6BAA4D;AAE5D,wBAA0C;AAE1C,MAAM,mBAAmB,GAAG,IAAA,SAAM,EAAC;IACjC,CAAC,EAAE,IAAA,oBAAM,GAAE;IACX,CAAC,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;IACrB,CAAC,EAAE,IAAA,gBAAa,EAAC,IAAA,qBAAO,GAAE,CAAC;CAC5B,CAAC,CAAC;AAIH,IAAA,sBAAgB,EAAsB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;AAChD,IAAA,sBAAgB,EAAsB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;AAC3D,IAAA,sBAAgB,EAAsB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;AACpE,IAAA,sBAAgB,EAAsB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;AAC9D,IAAA,yBAAmB,EAAsB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;AACpE,IAAA,yBAAmB,EAAsB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC","sourcesContent":["import type { Infer } from 'superstruct';\nimport { boolean, number, optional, string } from 'superstruct';\nimport { expectAssignable, expectNotAssignable } from 'tsd';\n\nimport { exactOptional, object } from '.';\n\nconst exactOptionalObject = object({\n  a: number(),\n  b: optional(string()),\n  c: exactOptional(boolean()),\n});\n\ntype ExactOptionalObject = Infer<typeof exactOptionalObject>;\n\nexpectAssignable<ExactOptionalObject>({ a: 0 });\nexpectAssignable<ExactOptionalObject>({ a: 0, b: 'test' });\nexpectAssignable<ExactOptionalObject>({ a: 0, b: 'test', c: true });\nexpectAssignable<ExactOptionalObject>({ a: 0, b: undefined });\nexpectNotAssignable<ExactOptionalObject>({ a: 0, b: 'test', c: 0 });\nexpectNotAssignable<ExactOptionalObject>({ a: 0, b: 'test', c: undefined });\n"]}

package/dist/utils.d.ts

@@ -1,4 +1,4 @@
-import { type Struct } from 'superstruct';
+import type { Struct } from 'superstruct';
 /**
  * UUIDv4 struct.
  */

package/dist/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAAA,6CAAmE;AAEnE;;GAEG;AACU,QAAA,UAAU,GAAG,IAAA,qBAAO,EAC/B,IAAA,oBAAM,GAAE,EACR,yEAAyE,CAC1E,CAAC;AAcF;;;;;;;;;;GAUG;AACH,SAAgB,UAAU,CACxB,KAAc,EACd,MAA4B,EAC5B,OAAgB;IAEhB,IAAA,oBAAM,EAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,OAAO,KAAK,CAAC;AACf,CAAC;AAPD,gCAOC","sourcesContent":["import { type Struct, assert, pattern, string } from 'superstruct';\n\n/**\n * UUIDv4 struct.\n */\nexport const UuidStruct = pattern(\n  string(),\n  /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/iu,\n);\n\n/**\n * Omit keys from a union type.\n *\n * The normal `Omit` type does not distribute over unions. So we use this\n * workaround that applies `Omit` to each member of the union.\n *\n * See: <https://github.com/microsoft/TypeScript/issues/31501#issuecomment-1280579305>\n */\nexport type OmitUnion<Type, Key extends keyof any> = Type extends any\n  ? Omit<Type, Key>\n  : never;\n\n/**\n * Assert that a value is valid according to a struct.\n *\n * It is similar to superstruct's mask function, but it does not ignore extra\n * properties.\n *\n * @param value - Value to check.\n * @param struct - Struct to validate the value against.\n * @param message - Error message to throw if the value is not valid.\n * @returns The value if it is valid.\n */\nexport function strictMask<Type, Schema>(\n  value: unknown,\n  struct: Struct<Type, Schema>,\n  message?: string,\n): Type {\n  assert(value, struct, message);\n  return value;\n}\n"]}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAAA,6CAAsD;AAGtD;;GAEG;AACU,QAAA,UAAU,GAAG,IAAA,qBAAO,EAC/B,IAAA,oBAAM,GAAE,EACR,yEAAyE,CAC1E,CAAC;AAcF;;;;;;;;;;GAUG;AACH,SAAgB,UAAU,CACxB,KAAc,EACd,MAA4B,EAC5B,OAAgB;IAEhB,IAAA,oBAAM,EAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,OAAO,KAAK,CAAC;AACf,CAAC;AAPD,gCAOC","sourcesContent":["import { assert, pattern, string } from 'superstruct';\nimport type { Struct } from 'superstruct';\n\n/**\n * UUIDv4 struct.\n */\nexport const UuidStruct = pattern(\n  string(),\n  /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/iu,\n);\n\n/**\n * Omit keys from a union type.\n *\n * The normal `Omit` type does not distribute over unions. So we use this\n * workaround that applies `Omit` to each member of the union.\n *\n * See: <https://github.com/microsoft/TypeScript/issues/31501#issuecomment-1280579305>\n */\nexport type OmitUnion<Type, Key extends keyof any> = Type extends any\n  ? Omit<Type, Key>\n  : never;\n\n/**\n * Assert that a value is valid according to a struct.\n *\n * It is similar to superstruct's mask function, but it does not ignore extra\n * properties.\n *\n * @param value - Value to check.\n * @param struct - Struct to validate the value against.\n * @param message - Error message to throw if the value is not valid.\n * @returns The value if it is valid.\n */\nexport function strictMask<Type, Schema>(\n  value: unknown,\n  struct: Struct<Type, Schema>,\n  message?: string,\n): Type {\n  assert(value, struct, message);\n  return value;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/keyring-api",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "MetaMask Keyring API",
   "keywords": [
     "metamask",
@@ -32,15 +32,17 @@
     "lint:fix": "yarn lint:eslint --fix && yarn lint:constraints --fix && yarn lint:misc --write && yarn lint:dependencies && yarn lint:changelog",
     "lint:misc": "prettier '**/*.json' '**/*.md' '!CHANGELOG.md' '**/*.yml' '!.yarnrc.yml' --ignore-path .gitignore --no-error-on-unmatched-pattern",
     "prepack": "./scripts/prepack.sh",
-    "test": "jest && jest-it-up",
+    "test": "yarn test:source && yarn test:types",
+    "test:source": "jest && jest-it-up",
+    "test:types": "tsd",
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@metamask/providers": "^11.0.0",
+    "@metamask/providers": "^12.0.0",
     "@metamask/rpc-methods": "^0.38.1-flask.1",
     "@metamask/snaps-controllers": "^0.38.2-flask.1",
     "@metamask/snaps-utils": "^0.38.2-flask.1",
-    "@metamask/utils": "^8.0.0",
+    "@metamask/utils": "^8.1.0",
     "@types/uuid": "^9.0.1",
     "superstruct": "^1.0.3",
     "uuid": "^9.0.0"
@@ -73,6 +75,7 @@
     "rimraf": "^3.0.2",
     "ts-jest": "^28.0.7",
     "ts-node": "^10.7.0",
+    "tsd": "^0.29.0",
     "typedoc": "^0.23.15",
     "typescript": "~4.8.4"
   },
@@ -96,5 +99,8 @@
       "@metamask/rpc-methods>@metamask/permission-controller>@metamask/controller-utils>ethereumjs-util>ethereum-cryptography>keccak": false,
       "@metamask/rpc-methods>@metamask/permission-controller>@metamask/controller-utils>ethereumjs-util>ethereum-cryptography>secp256k1": false
     }
+  },
+  "tsd": {
+    "directory": "src"
   }
 }