chore(swingset-liveslots): export TypeScript definitions

Agoric · Jan 21, 2025 · e51d7b0 · e51d7b0
1 parent b1998a7
commit e51d7b0
Show file tree

Hide file tree

Showing 8 changed files with 23 additions and 14 deletions.
diff --git a/packages/swingset-liveslots/package.json b/packages/swingset-liveslots/package.json
@@ -4,6 +4,7 @@
   "description": "SwingSet ocap support layer",
   "type": "module",
   "main": "src/index.js",
+  "types": "src/ts-types.d.ts",
   "engines": {
     "node": "^18.12 || ^20.9"
   },
@@ -14,7 +15,9 @@
     "lint-fix": "yarn lint:eslint --fix",
     "lint": "run-s --continue-on-error lint:*",
     "lint:types": "tsc",
-    "lint:eslint": "eslint ."
+    "lint:eslint": "eslint .",
+    "prepack": "tsc --build tsconfig.build.json",
+    "postpack": "git clean -f '*.d.ts*' '*.tsbuildinfo'"
   },
   "dependencies": {
     "@endo/errors": "^1.2.8",
@@ -38,6 +41,7 @@
   "files": [
     "src/**/*.js",
     "src/**/*.d.ts",
+    "src/**/*.map",
     "test/**/*.js",
     "tools",
     "exported.js"

diff --git a/packages/swingset-liveslots/src/index.js b/packages/swingset-liveslots/src/index.js
@@ -1,6 +1,5 @@
 /// <reference types="@agoric/store/exported.js" />
 
-/* eslint-disable import/export -- types files have no named runtime exports */
 export { makeLiveSlots, makeMarshaller } from './liveslots.js';
 
 export {
@@ -10,5 +9,3 @@ export {
   insistVatSyscallObject,
   insistVatSyscallResult,
 } from './message.js';
-
-export * from './types-index.js';
diff --git a/packages/swingset-liveslots/src/ts-types.ts b/packages/swingset-liveslots/src/ts-types.ts
@@ -0,0 +1,6 @@
+export * from './index.js';
+
+// Export any additional type this package provides
+// eslint-disable-next-line import/export
+export type * from './types.js';
+export type * from './vatDataTypes.ts';
diff --git a/packages/swingset-liveslots/src/types-index.d.ts b/packages/swingset-liveslots/src/types-index.d.ts
diff --git a/packages/swingset-liveslots/src/types-index.js b/packages/swingset-liveslots/src/types-index.js
diff --git a/packages/swingset-liveslots/src/types.js b/packages/swingset-liveslots/src/types.js
@@ -1,10 +1,6 @@
 // Ensure this is a module.
 export {};
 
-/**
- * @callback makeLiveSlots
- */
-
 /**
  * The MeterControl object gives liveslots a mechanism to disable metering for certain GC-sensitive
  * regions of code. Only the XS worker can actually do metering, but we track the enabled/disabled

diff --git a/packages/swingset-liveslots/tsconfig.build.json b/packages/swingset-liveslots/tsconfig.build.json
@@ -0,0 +1,10 @@
+{
+    "extends": [
+        "./tsconfig.json",
+        "../../tsconfig-build-options.json"
+    ],
+    "exclude": [
+        "./tools",
+        "./test"
+    ]
+}
diff --git a/packages/swingset-liveslots/tsconfig.json b/packages/swingset-liveslots/tsconfig.json
@@ -5,6 +5,8 @@
     "*.js",
     "scripts/**/*.js",
     "src/**/*.js",
+    "src/**/*.ts",
+    "src/**/*.d.ts",
     "test/**/*.js",
     "tools/**/*.js",
   ],