Publishing a New Version

Publishing a new version of the sui-svelte-wallet-kit package involves a series of automated steps managed by pnpm scripts. These scripts handle version bumping, building the package from source, and publishing it to the npm registry. A pre-publish check script is also available to ensure the package is valid and complete before it is released.

The process is designed to be straightforward for developers, with dedicated commands for patch, minor, and major version updates. The build system uses svelte-package to compile the Svelte components and TypeScript code into a distributable format, which is placed in the dist directory.

Publishing Scripts

The package.json file defines several scripts to automate the publishing process. These scripts combine versioning, building, and publishing into single commands.

Sources: package.json:23-25

This diagram illustrates the sequence of actions when a developer runs a publishing script, such as pnpm run publish:patch.

Build Process

The core of the build process is handled by the package and build scripts, which utilize SvelteKit's packaging and build tools.

• package: svelte-kit sync && svelte-package. This command is responsible for creating the distributable package. It generates the necessary JavaScript and TypeScript declaration files in the dist directory.
• prepack: pnpm run package. This is a standard npm script that runs automatically before the package is packed for publishing. It ensures the package script is executed.
• build: svelte-kit sync && vite build. This command is used for building the demo application, which is deployed to Netlify. The output is placed in the build directory.

Sources: package.json:16-18, netlify.toml:2-3

The following flowchart shows how the prepack script triggers the packaging process.

Package Configuration

The package.json file specifies which files are included in the final npm package and defines the entry points for consumers.

Included Files

Only the dist directory is included in the published package. Test and spec files within dist are explicitly excluded.

"files": [
  "dist",
  "!dist/**/*.test.*",
  "!dist/**/*.spec.*"
],

Sources: package.json:27-31

Package Exports

The exports field defines the module entry points. This allows consumers to import specific components like ConnectButton or the main SuiModule. Each entry point maps to its corresponding JavaScript and TypeScript declaration files within the dist directory.

"exports": {
  ".": {
    "types": "./dist/index.d.ts",
    "svelte": "./dist/index.js"
  },
  "./ConnectButton": {
    "types": "./dist/ConnectButton/index.d.ts",
    "svelte": "./dist/ConnectButton/index.js"
  },
  "./ConnectModal": {
    "types": "./dist/ConnectModal/index.d.ts",
    "svelte": "./dist/ConnectModal/index.js"
  },
  "./SuiModule": {
    "types": "./dist/SuiModule/index.d.ts",
    "svelte": "./dist/SuiModule/index.js"
  }
},

Sources: package.json:38-59, src/lib/index.d.ts, src/lib/SuiModule/index.js

Pre-Publish Sanity Check

A shell script, scripts/publish-check.sh, is provided to manually verify that the package is ready for publication. This script is not run automatically by the publish:* commands but can be executed by a developer for confidence.

Sources: README.md:330-331, scripts/publish-check.sh

The script performs the following checks:

1. Verifies Required Files: Ensures package.json, README.md, LICENSE, and src/lib/index.ts exist.
2. Verifies package.json Fields: Checks for the presence of name, version, and description.
3. Builds the Package: Runs pnpm run prepack to build the distributable files.
4. Verifies Build Output: Confirms that the dist folder and the main entry files (dist/index.js, dist/index.d.ts) were created successfully.

This flowchart details the logic of the publish-check.sh script.

If all checks pass, the script prints instructions for publishing to npm.

🎉 Package is ready for publication!

To publish:
1. Make sure you're logged in to npm: npm login
2. Run: npm publish

Or for a dry run: npm publish --dry-run

Sources: scripts/publish-check.sh:46-53

Summary

The publishing process for sui-svelte-wallet-kit is a streamlined workflow centered around pnpm scripts. These scripts automate versioning, building, and publishing, while a separate check script provides a manual safeguard to ensure package integrity. The package.json file acts as the central configuration, defining the package structure, its entry points, and the scripts that manage its lifecycle.