@storagehub/api-augment 0.1.0

package/README.md

@@ -0,0 +1,54 @@
+# @storagehub/api-augment
+
+This package is used to generate TypeScript types for the Storage Hub Runtime using the Polkadot{.js} typegen package. It automates the process of:
+
+1. Launching a local Storage Hub node
+2. Fetching the metadata blob
+3. Running the blob through the Polkadot{.js} typegen package to create TypeScript type interfaces
+
+> [!TIP]  
+> For more information on this process, see the [Polkadot{.js} docs](https://polkadot.js.org/docs/api/examples/promise/typegen)
+
+## Generating
+
+To generate the types, run the following commands:
+
+```sh
+pnpm i
+pnpm scrape
+pnpm generate:all
+```
+
+## Importing into Files for Type Completion
+
+At the top of your file, add:
+
+```ts
+import "@storagehub/api-augment";
+```
+
+>[!TIP]  
+> This step is also achievable by running `pnpm typegen` from within the `/test` folder.
+
+## Available Scripts
+
+In addition to the generation scripts, the following scripts are available:
+
+- `pnpm fmt`: Format the codebase using Biome.
+- `pnpm fmt:fix`: Format and fix the codebase using Biome.
+- `pnpm tsc`: Run TypeScript compiler without emitting files.
+- `pnpm build`: Build the TypeScript project.
+- `pnpm scrape`: Scrape metadata from the local Storage Hub node.
+- `pnpm generate:all`: Generate all types (definitions and metadata).
+- `pnpm generate:defs`: Generate type definitions.
+- `pnpm generate:meta`: Generate metadata types.
+
+## CI/CD Workflow
+
+### `api-augment-publish.yml`
+
+This workflow will publish the `@storagehub/api-augment` at a given git hash.
+
+### `api-augment-update.yml`
+
+This workflow will update the `api-augment` package and raise a PR with the changes.

package/biome.json

@@ -0,0 +1,10 @@
+{
+    "$schema": "https://biomejs.dev/schemas/1.7.3/schema.json",
+    "extends": ["../biome.json"],
+    "files": {
+      "include": ["*.js", "*.ts", "*.json", "*.yml", "*.md"],
+      "ignore": [
+        "./node_modules/*"
+      ]
+    }
+  }

package/dist/index.js

@@ -0,0 +1,4 @@
+import "./interfaces/types-lookup.js";
+import "./interfaces/augment-api.js";
+import "./interfaces/augment-types.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,8BAA8B,CAAC;AACtC,OAAO,6BAA6B,CAAC;AACrC,OAAO,+BAA+B,CAAC"}

package/dist/interfaces/augment-api-consts.js

@@ -0,0 +1,6 @@
+// Auto-generated via `yarn polkadot-types-from-chain`, do not edit
+/* eslint-disable */
+// import type lookup before we augment - in some environments
+// this is required to allow for ambient/previous definitions
+import "@polkadot/api-base/types/consts";
+//# sourceMappingURL=augment-api-consts.js.map

package/dist/interfaces/augment-api-consts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"augment-api-consts.js","sourceRoot":"","sources":["../../src/interfaces/augment-api-consts.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,oBAAoB;AAEpB,8DAA8D;AAC9D,6DAA6D;AAC7D,OAAO,iCAAiC,CAAC"}

package/dist/interfaces/augment-api-errors.js

@@ -0,0 +1,6 @@
+// Auto-generated via `yarn polkadot-types-from-chain`, do not edit
+/* eslint-disable */
+// import type lookup before we augment - in some environments
+// this is required to allow for ambient/previous definitions
+import "@polkadot/api-base/types/errors";
+//# sourceMappingURL=augment-api-errors.js.map

package/dist/interfaces/augment-api-errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"augment-api-errors.js","sourceRoot":"","sources":["../../src/interfaces/augment-api-errors.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,oBAAoB;AAEpB,8DAA8D;AAC9D,6DAA6D;AAC7D,OAAO,iCAAiC,CAAC"}

package/dist/interfaces/augment-api-events.js

@@ -0,0 +1,6 @@
+// Auto-generated via `yarn polkadot-types-from-chain`, do not edit
+/* eslint-disable */
+// import type lookup before we augment - in some environments
+// this is required to allow for ambient/previous definitions
+import "@polkadot/api-base/types/events";
+//# sourceMappingURL=augment-api-events.js.map

package/dist/interfaces/augment-api-events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"augment-api-events.js","sourceRoot":"","sources":["../../src/interfaces/augment-api-events.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,oBAAoB;AAEpB,8DAA8D;AAC9D,6DAA6D;AAC7D,OAAO,iCAAiC,CAAC"}

package/dist/interfaces/augment-api-query.js

@@ -0,0 +1,6 @@
+// Auto-generated via `yarn polkadot-types-from-chain`, do not edit
+/* eslint-disable */
+// import type lookup before we augment - in some environments
+// this is required to allow for ambient/previous definitions
+import "@polkadot/api-base/types/storage";
+//# sourceMappingURL=augment-api-query.js.map

package/dist/interfaces/augment-api-query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"augment-api-query.js","sourceRoot":"","sources":["../../src/interfaces/augment-api-query.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,oBAAoB;AAEpB,8DAA8D;AAC9D,6DAA6D;AAC7D,OAAO,kCAAkC,CAAC"}

package/dist/interfaces/augment-api-rpc.js

@@ -0,0 +1,6 @@
+// Auto-generated via `yarn polkadot-types-from-chain`, do not edit
+/* eslint-disable */
+// import type lookup before we augment - in some environments
+// this is required to allow for ambient/previous definitions
+import "@polkadot/rpc-core/types/jsonrpc";
+//# sourceMappingURL=augment-api-rpc.js.map

package/dist/interfaces/augment-api-rpc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"augment-api-rpc.js","sourceRoot":"","sources":["../../src/interfaces/augment-api-rpc.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,oBAAoB;AAEpB,8DAA8D;AAC9D,6DAA6D;AAC7D,OAAO,kCAAkC,CAAC"}

package/dist/interfaces/augment-api-runtime.js

@@ -0,0 +1,6 @@
+// Auto-generated via `yarn polkadot-types-from-chain`, do not edit
+/* eslint-disable */
+// import type lookup before we augment - in some environments
+// this is required to allow for ambient/previous definitions
+import "@polkadot/api-base/types/calls";
+//# sourceMappingURL=augment-api-runtime.js.map

package/dist/interfaces/augment-api-runtime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"augment-api-runtime.js","sourceRoot":"","sources":["../../src/interfaces/augment-api-runtime.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,oBAAoB;AAEpB,8DAA8D;AAC9D,6DAA6D;AAC7D,OAAO,gCAAgC,CAAC"}

package/dist/interfaces/augment-api-tx.js

@@ -0,0 +1,6 @@
+// Auto-generated via `yarn polkadot-types-from-chain`, do not edit
+/* eslint-disable */
+// import type lookup before we augment - in some environments
+// this is required to allow for ambient/previous definitions
+import "@polkadot/api-base/types/submittable";
+//# sourceMappingURL=augment-api-tx.js.map

package/dist/interfaces/augment-api-tx.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"augment-api-tx.js","sourceRoot":"","sources":["../../src/interfaces/augment-api-tx.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,oBAAoB;AAEpB,8DAA8D;AAC9D,6DAA6D;AAC7D,OAAO,sCAAsC,CAAC"}

package/dist/interfaces/augment-api.js

@@ -0,0 +1,10 @@
+// Auto-generated via `yarn polkadot-types-from-chain`, do not edit
+/* eslint-disable */
+import "./augment-api-consts.js";
+import "./augment-api-errors.js";
+import "./augment-api-events.js";
+import "./augment-api-query.js";
+import "./augment-api-tx.js";
+import "./augment-api-rpc.js";
+import "./augment-api-runtime.js";
+//# sourceMappingURL=augment-api.js.map

package/dist/interfaces/augment-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"augment-api.js","sourceRoot":"","sources":["../../src/interfaces/augment-api.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,oBAAoB;AAEpB,OAAO,yBAAyB,CAAC;AACjC,OAAO,yBAAyB,CAAC;AACjC,OAAO,yBAAyB,CAAC;AACjC,OAAO,wBAAwB,CAAC;AAChC,OAAO,qBAAqB,CAAC;AAC7B,OAAO,sBAAsB,CAAC;AAC9B,OAAO,0BAA0B,CAAC"}

package/dist/interfaces/augment-types.js

@@ -0,0 +1,6 @@
+// Auto-generated via `yarn polkadot-types-from-defs`, do not edit
+/* eslint-disable */
+// import type lookup before we augment - in some environments
+// this is required to allow for ambient/previous definitions
+import "@polkadot/types/types/registry";
+//# sourceMappingURL=augment-types.js.map

package/dist/interfaces/augment-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"augment-types.js","sourceRoot":"","sources":["../../src/interfaces/augment-types.ts"],"names":[],"mappings":"AAAA,kEAAkE;AAClE,oBAAoB;AAEpB,8DAA8D;AAC9D,6DAA6D;AAC7D,OAAO,gCAAgC,CAAC"}

package/dist/interfaces/definitions.js

@@ -0,0 +1,2 @@
+export { default as storagehubclient } from "./storagehubclient/definitions.js";
+//# sourceMappingURL=definitions.js.map

package/dist/interfaces/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/interfaces/definitions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,mCAAmC,CAAC"}

package/dist/interfaces/index.js

@@ -0,0 +1,4 @@
+// Auto-generated via `yarn polkadot-types-from-defs`, do not edit
+/* eslint-disable */
+export * from "./types.js";
+//# sourceMappingURL=index.js.map

package/dist/interfaces/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/interfaces/index.ts"],"names":[],"mappings":"AAAA,kEAAkE;AAClE,oBAAoB;AAEpB,cAAc,YAAY,CAAC"}