refactor(patterns): Migrate JSDoc types to TypeScript

Author: rekmarks

.gitignore

@@ -101,6 +101,7 @@ api-docs
 !packages/far/src/exports.d.ts
 !packages/lp32/types.d.ts
 !packages/pass-style/src/types.d.ts
+!packages/patterns/types.d.ts
 !packages/ses/src/reporting-types.d.ts
 !packages/ses/types.d.ts
 !packages/stream/types.d.ts

packages/patterns/index.js

@@ -75,9 +75,6 @@ export {
   getInterfaceMethodKeys,
 } from './src/patterns/getGuardPayloads.js';
 
-// eslint-disable-next-line import/export
-export * from './src/types.js';
-
 // /////////////////////////// Deprecated //////////////////////////////////////
 
 export {

packages/patterns/package.json

@@ -18,7 +18,10 @@
   "main": "./index.js",
   "module": "./index.js",
   "exports": {
-    ".": "./index.js",
+    ".": {
+      "types": "./types.d.ts",
+      "default": "./index.js"
+    },
     "./package.json": "./package.json"
   },
   "scripts": {

packages/patterns/src/patterns/types.js

@@ -0,0 +1,59 @@
+/// <reference types="ses"/>
+
+import type { Rejector } from '@endo/errors/rejector.js';
+import type { Passable } from '@endo/pass-style';
+import type {
+  MatcherNamespace,
+  Pattern,
+  GetRankCover,
+  Kind,
+} from '../types.js';
+
+/**
+ * This factors out only the parts specific to each kind of Matcher. It is
+ * encapsulated, and its methods can make the stated unchecked assumptions
+ * enforced by the common calling logic.
+ */
+export type MatchHelper = {
+  /**
+   * Reports whether `allegedPayload` is valid as the payload of a CopyTagged
+   * whose tag corresponds with this MatchHelper's Matchers.
+   */
+  confirmIsWellFormed: (allegedPayload: Passable, reject: Rejector) => boolean;
+
+  /**
+   * Assuming validity of `matcherPayload` as the payload of a Matcher corresponding
+   * with this MatchHelper, reports whether `specimen` is matched by that Matcher.
+   */
+  confirmMatches: (
+    specimen: Passable,
+    matcherPayload: Passable,
+    reject: Rejector,
+  ) => boolean;
+
+  /**
+   * Assumes this is the payload of a CopyTagged with the corresponding
+   * matchTag. Return a RankCover to bound from below and above,
+   * in rank order, all possible Passables that would match this Matcher.
+   * The left element must be before or the same rank as any possible
+   * matching specimen. The right element must be after or the same
+   * rank as any possible matching specimen.
+   */
+  getRankCover: GetRankCover;
+};
+
+export type PatternKit = {
+  confirmMatches: (
+    specimen: any,
+    patt: Passable,
+    reject: Rejector,
+    label?: string | number,
+  ) => boolean;
+  matches: (specimen: any, patt: Pattern) => boolean;
+  mustMatch: (specimen: any, patt: Pattern, label?: string | number) => void;
+  assertPattern: (patt: Pattern) => void;
+  isPattern: (patt: any) => boolean;
+  getRankCover: GetRankCover;
+  M: MatcherNamespace;
+  kindOf: (specimen: Passable, reject: Rejector) => Kind | undefined;
+};