From 083ac4375576b3ddb31281f291d297b53e4188b2 Mon Sep 17 00:00:00 2001 From: Turadg Aleahmad Date: Mon, 8 Jan 2024 11:09:23 -0800 Subject: [PATCH 1/7] docs: include @agoric/vats in typedoc --- packages/vats/typedoc.json | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 packages/vats/typedoc.json diff --git a/packages/vats/typedoc.json b/packages/vats/typedoc.json new file mode 100644 index 00000000000..300607022e5 --- /dev/null +++ b/packages/vats/typedoc.json @@ -0,0 +1,9 @@ +{ + "extends": [ + "../../typedoc.base.json" + ], + "entryPoints": [ + "index.js", + "./src/core/types-ambient.d.ts", + ] +} From fe6feebffd0f4bbf8641c83457e14f5640ddff6b Mon Sep 17 00:00:00 2001 From: Turadg Aleahmad Date: Mon, 8 Jan 2024 11:20:16 -0800 Subject: [PATCH 2/7] docs: README for vats --- packages/vats/README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 packages/vats/README.md diff --git a/packages/vats/README.md b/packages/vats/README.md new file mode 100644 index 00000000000..78080069759 --- /dev/null +++ b/packages/vats/README.md @@ -0,0 +1,3 @@ +# Vats + +Builders for Vats on the Agoric chain that aren't contracts. From 4239c7356c589727cbc44023408f33f240ca89c7 Mon Sep 17 00:00:00 2001 From: Turadg Aleahmad Date: Mon, 8 Jan 2024 11:20:21 -0800 Subject: [PATCH 3/7] docs: include @agoric/vats in typedoc --- packages/smart-wallet/typedoc.json | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 packages/smart-wallet/typedoc.json diff --git a/packages/smart-wallet/typedoc.json b/packages/smart-wallet/typedoc.json new file mode 100644 index 00000000000..070a2e04533 --- /dev/null +++ b/packages/smart-wallet/typedoc.json @@ -0,0 +1,12 @@ +{ + "extends": [ + "../../typedoc.base.json" + ], + "entryPoints": [ + "src/invitations.js", + "src/offers.js", + "src/smartWallet.js", + "src/types.d.ts", + "src/walletFactory.js", + ] +} From 27e87e40802da2871b6dbc887b8de729aa800551 Mon Sep 17 00:00:00 2001 From: Turadg Aleahmad Date: Mon, 8 Jan 2024 11:23:47 -0800 Subject: [PATCH 4/7] docs: include @agoric/swingset-vat in typedoc --- packages/SwingSet/typedoc.json | 8 ++++++++ packages/swingset-liveslots/typedoc.json | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) create mode 100644 packages/SwingSet/typedoc.json diff --git a/packages/SwingSet/typedoc.json b/packages/SwingSet/typedoc.json new file mode 100644 index 00000000000..ebbd5e24e8f --- /dev/null +++ b/packages/SwingSet/typedoc.json @@ -0,0 +1,8 @@ +{ + "extends": [ + "../../typedoc.base.json" + ], + "entryPoints": [ + "src/index.js", + ] +} diff --git a/packages/swingset-liveslots/typedoc.json b/packages/swingset-liveslots/typedoc.json index 148dc687071..45b08568128 100644 --- a/packages/swingset-liveslots/typedoc.json +++ b/packages/swingset-liveslots/typedoc.json @@ -5,6 +5,6 @@ "entryPoints": [ "src/index.js", "src/types.js", - "src/vatDataTypes.js", + "src/vatDataTypes.d.ts", ] } From 95c0b647909ff2d7b23b490f7f1c9dd473ddf66a Mon Sep 17 00:00:00 2001 From: Turadg Aleahmad Date: Mon, 8 Jan 2024 11:24:20 -0800 Subject: [PATCH 5/7] docs: include @agoric/zone in typedoc --- packages/zone/typedoc.json | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 packages/zone/typedoc.json diff --git a/packages/zone/typedoc.json b/packages/zone/typedoc.json new file mode 100644 index 00000000000..ebbd5e24e8f --- /dev/null +++ b/packages/zone/typedoc.json @@ -0,0 +1,8 @@ +{ + "extends": [ + "../../typedoc.base.json" + ], + "entryPoints": [ + "src/index.js", + ] +} From 2fadbe885fe39d9f7fb38d8d9e37cd69ba91b182 Mon Sep 17 00:00:00 2001 From: Turadg Aleahmad Date: Wed, 17 Jan 2024 09:56:20 -0800 Subject: [PATCH 6/7] chore(types): * -> any for typedoc fixes, ``` [warning] Failed to convert type node with kind: JSDocAllType and text *. Please report a bug. ``` --- packages/SwingSet/src/types-external.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/SwingSet/src/types-external.js b/packages/SwingSet/src/types-external.js index c539baa04d1..14709b11928 100644 --- a/packages/SwingSet/src/types-external.js +++ b/packages/SwingSet/src/types-external.js @@ -183,7 +183,7 @@ export {}; * @property {SwingSetConfigDescriptor} [bundles] * @property {BundleFormat} [bundleFormat] the bundle source / import bundle * format. - * @property {*} [devices] + * @property {any} [devices] */ /** * @typedef {KernelOptions & SwingSetOptions} SwingSetConfig a swingset config object @@ -232,7 +232,7 @@ export {}; * Vat Creation and Management * * @typedef { string } BundleID - * @typedef {*} BundleCap + * @typedef {any} BundleCap * @typedef { { moduleFormat: 'endoZipBase64', endoZipBase64: string, endoZipBase64Sha512: string } } EndoZipBase64Bundle * * @typedef { unknown } Meter From b6f8b6d0900f04521b65fc410546b3d06343fdb3 Mon Sep 17 00:00:00 2001 From: Turadg Aleahmad Date: Wed, 17 Jan 2024 09:57:02 -0800 Subject: [PATCH 7/7] docs: more @agoric/zoe in typedoc --- packages/zoe/typedoc.json | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/packages/zoe/typedoc.json b/packages/zoe/typedoc.json index 1998769b97c..e5a2997cfc2 100644 --- a/packages/zoe/typedoc.json +++ b/packages/zoe/typedoc.json @@ -3,14 +3,16 @@ "../../typedoc.base.json" ], "entryPoints": [ + "src/contractFacet/internal-types.js", + "src/contractFacet/types-ambient.d.ts", "src/contractSupport/index.js", "src/contractSupport/types.js", - "src/contractFacet/types-ambient.d.ts", - "src/contractFacet/types.ts", + "src/types.js", "src/zoeService/types.js", "src/zoeService/utils.d.ts", "src/zoeService/zoe.js", - "src/types.js", + "tools/internal-types.js", "tools/manualTimer.js", + "tools/types-ambient.js", ] }