@dtwo/module-builder v0.2.1

📦 Dtwo Module Builder

Complete solution to build Dtwo Modules.

Features

• Compatible with Dtwo 3 and Dtwo Kit
• Automated build config using last module spec
• Typescript and ESM support
• Auto generated CommonJS stubs
• Auto generated types and shims for @dtwo/schema

Learn More

Requirements

For a user to use a module generated from module-builder, it's recommended they have:

• Node.js >= 14.x. Latest Node LTS preferred
• Dtwo 3 or Dtwo Bridge. Dtwo 2 is functional but not advised

Quick start

You can quickly get started with the pre-configured module starter:

$ npx @dtwo/cli init -t module my-module

Project structure

src/module.ts

This is the entrypoint for module definition.

A default export using defineDtwoModule and ModuleOptions type export is expected.

You could also optionally export ModuleHooks to annotate any custom hooks the module uses.

import { defineDtwoModule } from '@dtwo/kit'

export interface ModuleOptions {
  apiKey: string
}

export interface ModuleHooks {
  'my-module:init': any
}

export interface ModulePublicRuntimeConfig {
  NAME: string
}

export interface ModulePrivateRuntimeConfig {
  PRIVATE_NAME: string
}

export default defineDtwoModule<ModuleOptions>({
  meta: {
    name: 'my-module',
    configKey: 'myModule'
  },
  defaults: {
    apiKey: 'test'
  },
  async setup (moduleOptions, dtwo) {
    // Write module logic in setup function
  }
})

src/runtime/

Any runtime file and code that we need to provide by module including plugins, composables and server api, should be in this directory.

Each file will be transformed individually using unjs/mkdist to dist/runtime/.

package.json:

A minimum package.json should look like this:

{
  "name": "my-module",
  "license": "MIT",
  "version": "1.0.0",
  "exports": {
    ".": {
      "import": "./dist/module.mjs",
      "require": "./dist/module.cjs"
    }
  },
  "main": "./dist/module.cjs",
  "types": "./dist/types.d.ts",
  "files": [
    "dist"
  ],
  "scripts": {
    "prepack": "dtwo-module-build"
  },
  "dependencies": {
    "@dtwo/kit": "npm:@dtwo/kit-edge@latest"
  },
  "devDependencies": {
    "@dtwo/module-builder": "latest"
  }
}

Dist files

Module builder generates dist files in dist/ directory:

• module.mjs: Module entrypoint build from src/module
• module.json: Module meta extracted from module.mjs + package.json
• module.cjs: ESM proxy to allow require module in CommonJS context
• types.d.ts: Exported types in addition to shims for dtwo.config auto completion.
• runtime/*: Individually transformed files using unjs/mkdist
  • Javascript and .ts files will be transformed to .mjs with extracted types on .d.ts file with same name
  • .kdu files will be transformed with extracted .d.ts file
  • Other files will be copied as is

License

MIT