@izumisy-tailor/omakase-modules 0.2.0 → 0.4.0

package/docs/generated/builder/README.md

@@ -0,0 +1,25 @@
+[**@izumisy-tailor/omakase-modules**](../README.md)
+
+***
+
+[@izumisy-tailor/omakase-modules](../modules.md) / builder
+
+# builder
+
+## Type Aliases
+
+- [AnyDefinedModule](type-aliases/AnyDefinedModule.md)
+- [ConfiguredDependencies](type-aliases/ConfiguredDependencies.md)
+- [ConfiguredModule](type-aliases/ConfiguredModule.md)
+- [DefinedModule](type-aliases/DefinedModule.md)
+- [DependencyModules](type-aliases/DependencyModules.md)
+- [EmptyDependencies](type-aliases/EmptyDependencies.md)
+- [ModuleBuilder](type-aliases/ModuleBuilder.md)
+- [ModuleBuilderProps](type-aliases/ModuleBuilderProps.md)
+- [ModuleFactoryContext](type-aliases/ModuleFactoryContext.md)
+- [TablesFromNames](type-aliases/TablesFromNames.md)
+
+## Functions
+
+- [defineModule](functions/defineModule.md)
+- [withModuleConfiguration](functions/withModuleConfiguration.md)

package/docs/generated/builder/functions/defineModule.md

@@ -0,0 +1,60 @@
+[**@izumisy-tailor/omakase-modules**](../../README.md)
+
+***
+
+[@izumisy-tailor/omakase-modules](../../modules.md) / [builder](../README.md) / defineModule
+
+# Function: defineModule()
+
+> **defineModule**\<`C`, `Tables`\>(`baseProps`): [`ModuleBuilder`](../type-aliases/ModuleBuilder.md)\<`C`, `Tables`\>
+
+Defined in: [builder/helpers.ts:341](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/builder/helpers.ts#L341)
+
+Defines a reusable module with optional dependencies on other modules.
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `C` *extends* `Record`\<`string`, `unknown`\> | - |
+| `Tables` *extends* `Record`\<`string`, `unknown`\> | `Record`\<`string`, `unknown`\> |
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `baseProps` | \{ `packageName`: `string`; \} |
+| `baseProps.packageName` | `string` |
+
+## Returns
+
+[`ModuleBuilder`](../type-aliases/ModuleBuilder.md)\<`C`, `Tables`\>
+
+## Example
+
+```typescript
+// Module without dependencies
+export default defineModule<ModuleConfig, Tables>({
+  packageName: "my-module",
+}).build();
+
+// Module with dependencies - Deps type is automatically inferred
+import commerceModule from "omakase-module-commerce-core";
+import orderModule from "omakase-module-order";
+
+export default defineModule<ModuleConfig, Tables>({
+  packageName: "my-module",
+}).withDependencies({
+  commerce: commerceModule,
+  order: orderModule,
+}).build();
+
+// When configuring a module with dependencies, pass them as a record:
+inventoryModule.configure({
+  config: { dbNamespace: "main-db" },
+  dependencies: {
+    commerce: $commerceModule,
+    order: $orderModule,
+  },
+});
+```

package/docs/generated/builder/functions/withModuleConfiguration.md

@@ -0,0 +1,68 @@
+[**@izumisy-tailor/omakase-modules**](../../README.md)
+
+***
+
+[@izumisy-tailor/omakase-modules](../../modules.md) / [builder](../README.md) / withModuleConfiguration
+
+# Function: withModuleConfiguration()
+
+> **withModuleConfiguration**\<`C`, `Tables`, `Deps`, `Result`\>(`module`, `factory`): (`loadedModules`) => `Promise`\<`Result`\>
+
+Defined in: [builder/register.ts:31](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/builder/register.ts#L31)
+
+Define module exports that depend on configuration from loadModules.
+
+This function returns a factory function that takes LoadedModules as input
+and produces the configured exports. The wrapper files generated by
+getModulesReference will call this factory with the app's loadModules result.
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `C` *extends* `Record`\<`string`, `unknown`\> |
+| `Tables` *extends* `Record`\<`string`, `unknown`\> |
+| `Deps` *extends* `Record`\<`string`, `any`\> |
+| `Result` |
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `module` | [`DefinedModule`](../type-aliases/DefinedModule.md)\<`C`, `Tables`, `Deps`\> |
+| `factory` | (`context`, `loadedModules`) => `Result` \| `Promise`\<`Result`\> |
+
+## Returns
+
+> (`loadedModules`): `Promise`\<`Result`\>
+
+### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `loadedModules` | [`LoadedModules`](../../config/type-aliases/LoadedModules.md) |
+
+### Returns
+
+`Promise`\<`Result`\>
+
+## Example
+
+```typescript
+// In module's tailordb/index.ts
+export default withModuleConfiguration(moduleDef, (context) => {
+  const inventory = buildInventoryTable(context);
+  return { inventory };
+});
+
+// In module's executors that need dependency module tables:
+export default withModuleConfiguration(moduleDef, async (context, loadedModules) => {
+  const { productVariant } = await loadedModules.getTables(commerceModuleTables);
+  return createExecutor({ ... });
+});
+
+// The wrapper file will call it like:
+// import factory from "module/backend/tailordb";
+// import modules from "../../modules";
+// export default await factory(modules);
+```

package/docs/generated/builder/type-aliases/AnyDefinedModule.md

@@ -0,0 +1,57 @@
+[**@izumisy-tailor/omakase-modules**](../../README.md)
+
+***
+
+[@izumisy-tailor/omakase-modules](../../modules.md) / [builder](../README.md) / AnyDefinedModule
+
+# Type Alias: AnyDefinedModule
+
+> **AnyDefinedModule** = `object`
+
+Defined in: [builder/helpers.ts:127](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/builder/helpers.ts#L127)
+
+A loosely-typed representation of any defined module.
+
+This type is used in dependency records where the exact type parameters
+of the module are not important. It provides the minimal interface needed
+to work with modules as dependencies.
+
+For strongly-typed module definitions, use [DefinedModule](DefinedModule.md) instead.
+
+## See
+
+[DefinedModule](DefinedModule.md) for the fully-typed module definition.
+
+## Properties
+
+### configure()
+
+> **configure**: (`props`) => [`ConfiguredModule`](ConfiguredModule.md)\<`any`\>
+
+Defined in: [builder/helpers.ts:130](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/builder/helpers.ts#L130)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `props` | `any` |
+
+#### Returns
+
+[`ConfiguredModule`](ConfiguredModule.md)\<`any`\>
+
+***
+
+### dependencies
+
+> **dependencies**: `Record`\<`string`, `any`\>
+
+Defined in: [builder/helpers.ts:129](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/builder/helpers.ts#L129)
+
+***
+
+### packageName
+
+> **packageName**: `string`
+
+Defined in: [builder/helpers.ts:128](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/builder/helpers.ts#L128)

package/docs/generated/builder/type-aliases/ConfiguredDependencies.md

@@ -0,0 +1,44 @@
+[**@izumisy-tailor/omakase-modules**](../../README.md)
+
+***
+
+[@izumisy-tailor/omakase-modules](../../modules.md) / [builder](../README.md) / ConfiguredDependencies
+
+# Type Alias: ConfiguredDependencies\<Deps\>
+
+> **ConfiguredDependencies**\<`Deps`\> = `{ [K in keyof Deps as K extends "__empty" ? never : K]: Deps[K] extends { __configBrand?: infer C } ? C extends Record<string, unknown> ? ConfiguredModule<C> : never : never }`
+
+Defined in: [builder/helpers.ts:170](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/builder/helpers.ts#L170)
+
+Transforms a record of [DefinedModule](DefinedModule.md)s into a record of [ConfiguredModule](ConfiguredModule.md)s.
+
+This utility type is used to derive the expected shape of the `dependencies`
+property when configuring a module that has dependencies. It preserves
+the exact configuration type for each dependency module.
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `Deps` *extends* [`DependencyModules`](DependencyModules.md) |
+
+## Example
+
+```typescript
+// When a module is defined with dependencies:
+defineModule<MyConfig, MyTables>({
+  packageName: "my-module",
+}).withDependencies({
+  commerce: commerceModule,
+  order: orderModule,
+}).build();
+
+// The configure() method will expect:
+myModule.configure({
+  config: { ... },
+  dependencies: {
+    commerce: ConfiguredModule<CommerceConfig>,
+    order: ConfiguredModule<OrderConfig>,
+  },
+});
+```

package/docs/generated/builder/type-aliases/ConfiguredModule.md

@@ -0,0 +1,60 @@
+[**@izumisy-tailor/omakase-modules**](../../README.md)
+
+***
+
+[@izumisy-tailor/omakase-modules](../../modules.md) / [builder](../README.md) / ConfiguredModule
+
+# Type Alias: ConfiguredModule\<C\>
+
+> **ConfiguredModule**\<`C`\> = `object`
+
+Defined in: [builder/helpers.ts:80](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/builder/helpers.ts#L80)
+
+A module that has been configured with specific settings.
+
+This type represents the result of calling `configure()` on a [DefinedModule](DefinedModule.md).
+Configured modules can be passed as dependencies to other modules or used
+directly in your application's Tailor configuration.
+
+## Example
+
+```typescript
+// Create a configured module
+const $commerceModule = commerceModule.configure({
+  config: { dbNamespace: "main-db" },
+});
+
+// Use as a dependency in another module
+const $inventoryModule = inventoryModule.configure({
+  config: { dbNamespace: "main-db" },
+  dependencies: {
+    commerce: $commerceModule,
+  },
+});
+```
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `C` *extends* `Record`\<`string`, `unknown`\> | `Record`\<`string`, `unknown`\> |
+
+## Properties
+
+### moduleProps
+
+> **moduleProps**: `object`
+
+Defined in: [builder/helpers.ts:87](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/builder/helpers.ts#L87)
+
+#### config
+
+> **config**: `C`
+
+***
+
+### packageName
+
+> **packageName**: `string`
+
+Defined in: [builder/helpers.ts:86](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/builder/helpers.ts#L86)

package/docs/generated/builder/type-aliases/DefinedModule.md

@@ -0,0 +1,93 @@
+[**@izumisy-tailor/omakase-modules**](../../README.md)
+
+***
+
+[@izumisy-tailor/omakase-modules](../../modules.md) / [builder](../README.md) / DefinedModule
+
+# Type Alias: DefinedModule\<C, Tables, Deps\>
+
+> **DefinedModule**\<`C`, `Tables`, `Deps`\> = `object`
+
+Defined in: [builder/helpers.ts:214](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/builder/helpers.ts#L214)
+
+A fully defined, reusable module that can be configured and composed.
+
+This is the primary type for modules created with [defineModule](../functions/defineModule.md).
+A `DefinedModule` encapsulates:
+- The module's package name for identification
+- Its dependencies on other modules
+- A `configure()` method to create a [ConfiguredModule](ConfiguredModule.md)
+- Optional development configuration for local testing
+
+## Example
+
+```typescript
+// Define a module
+const inventoryModule = defineModule<InventoryConfig, InventoryTables>({
+  packageName: "inventory-module",
+})
+  .withDependencies({ commerce: commerceModule })
+  .withDevConfig({ dbNamespace: "dev" })
+  .build();
+
+// Configure the module for use
+const $inventory = inventoryModule.configure({
+  config: { dbNamespace: "production" },
+  dependencies: {
+    commerce: $commerceModule,
+  },
+});
+```
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `C` *extends* `Record`\<`string`, `unknown`\> | - |
+| `Tables` *extends* `Record`\<`string`, `unknown`\> | `Record`\<`string`, `unknown`\> |
+| `Deps` *extends* [`DependencyModules`](DependencyModules.md) | [`EmptyDependencies`](EmptyDependencies.md) |
+
+## Properties
+
+### configure()
+
+> **configure**: (`props`) => [`ConfiguredModule`](ConfiguredModule.md)\<`C`\>
+
+Defined in: [builder/helpers.ts:230](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/builder/helpers.ts#L230)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `props` | [`ModuleBuilderProps`](ModuleBuilderProps.md)\<`C`, `Deps`\> |
+
+#### Returns
+
+[`ConfiguredModule`](ConfiguredModule.md)\<`C`\>
+
+***
+
+### dependencies
+
+> **dependencies**: `Deps`
+
+Defined in: [builder/helpers.ts:229](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/builder/helpers.ts#L229)
+
+***
+
+### devConfig?
+
+> `optional` **devConfig**: `C`
+
+Defined in: [builder/helpers.ts:235](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/builder/helpers.ts#L235)
+
+Default configuration for module development.
+Used by loadModuleForDev when no config is provided.
+
+***
+
+### packageName
+
+> **packageName**: `string`
+
+Defined in: [builder/helpers.ts:228](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/builder/helpers.ts#L228)

package/docs/generated/builder/type-aliases/DependencyModules.md

@@ -0,0 +1,29 @@
+[**@izumisy-tailor/omakase-modules**](../../README.md)
+
+***
+
+[@izumisy-tailor/omakase-modules](../../modules.md) / [builder](../README.md) / DependencyModules
+
+# Type Alias: DependencyModules
+
+> **DependencyModules** = `Record`\<`string`, [`AnyDefinedModule`](AnyDefinedModule.md)\> \| [`EmptyDependencies`](EmptyDependencies.md)
+
+Defined in: [builder/helpers.ts:112](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/builder/helpers.ts#L112)
+
+A record of module dependencies or an empty dependency set.
+
+This type represents the dependencies that a module can declare.
+It is either a record mapping dependency names to [AnyDefinedModule](AnyDefinedModule.md),
+or [EmptyDependencies](EmptyDependencies.md) for modules without dependencies.
+
+## Example
+
+```typescript
+// Used internally when defining module dependencies
+defineModule<MyConfig, MyTables>({
+  packageName: "my-module",
+}).withDependencies({
+  commerce: commerceModule,  // Record<string, AnyDefinedModule>
+  order: orderModule,
+}).build();
+```

package/docs/generated/builder/type-aliases/EmptyDependencies.md

@@ -0,0 +1,34 @@
+[**@izumisy-tailor/omakase-modules**](../../README.md)
+
+***
+
+[@izumisy-tailor/omakase-modules](../../modules.md) / [builder](../README.md) / EmptyDependencies
+
+# Type Alias: EmptyDependencies
+
+> **EmptyDependencies** = `object`
+
+Defined in: [builder/helpers.ts:18](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/builder/helpers.ts#L18)
+
+Represents a module with no dependencies.
+
+This is a branded type used internally to distinguish modules
+that have no dependencies from those that do. When defining a module
+without dependencies, you don't need to use this type directly.
+
+## Example
+
+```typescript
+// Modules without dependencies don't need to specify this type
+export default defineModule<MyConfig, MyTables>({
+  packageName: "my-module",
+}).build();
+```
+
+## Properties
+
+### \_\_empty?
+
+> `readonly` `optional` **\_\_empty**: `never`
+
+Defined in: [builder/helpers.ts:18](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/builder/helpers.ts#L18)

package/docs/generated/builder/type-aliases/ModuleBuilder.md

@@ -0,0 +1,124 @@
+[**@izumisy-tailor/omakase-modules**](../../README.md)
+
+***
+
+[@izumisy-tailor/omakase-modules](../../modules.md) / [builder](../README.md) / ModuleBuilder
+
+# Type Alias: ModuleBuilder\<C, Tables, Deps\>
+
+> **ModuleBuilder**\<`C`, `Tables`, `Deps`\> = `object`
+
+Defined in: [builder/helpers.ts:251](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/builder/helpers.ts#L251)
+
+Intermediate builder type returned by defineModule.
+Use .withDependencies() to add dependencies, then call .build() to finalize.
+Modules without dependencies can call .build() directly.
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `C` *extends* `Record`\<`string`, `unknown`\> | - |
+| `Tables` *extends* `Record`\<`string`, `unknown`\> | - |
+| `Deps` *extends* [`DependencyModules`](DependencyModules.md) | [`EmptyDependencies`](EmptyDependencies.md) |
+
+## Properties
+
+### build()
+
+> **build**: () => [`DefinedModule`](DefinedModule.md)\<`C`, `Tables`, `Deps`\>
+
+Defined in: [builder/helpers.ts:307](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/builder/helpers.ts#L307)
+
+Finalizes the module definition and returns the DefinedModule.
+This must be called at the end of the builder chain to get the actual module.
+
+#### Returns
+
+[`DefinedModule`](DefinedModule.md)\<`C`, `Tables`, `Deps`\>
+
+#### Example
+
+```typescript
+// Without dependencies
+export default defineModule<ModuleConfig, Tables>({
+  packageName: "my-module",
+}).build();
+
+// With dependencies and dev config
+export default defineModule<ModuleConfig, Tables>({
+  packageName: "my-module",
+})
+  .withDependencies({ commerce: commerceModule })
+  .withDevConfig({ dbNamespace: "dev" })
+  .build();
+```
+
+***
+
+### withDependencies()
+
+> **withDependencies**: \<`NewDeps`\>(`deps`) => `ModuleBuilder`\<`C`, `Tables`, `NewDeps`\>
+
+Defined in: [builder/helpers.ts:270](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/builder/helpers.ts#L270)
+
+Adds dependencies to the module definition.
+The Deps type is automatically inferred from the record.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `NewDeps` *extends* [`DependencyModules`](DependencyModules.md) |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `deps` | `NewDeps` |
+
+#### Returns
+
+`ModuleBuilder`\<`C`, `Tables`, `NewDeps`\>
+
+#### Example
+
+```typescript
+export default defineModule<ModuleConfig, Tables>({
+  packageName: "my-module",
+}).withDependencies({
+  commerce: commerceModule,
+  order: orderModule,
+}).build();
+```
+
+***
+
+### withDevConfig()
+
+> **withDevConfig**: (`config`) => `ModuleBuilder`\<`C`, `Tables`, `Deps`\>
+
+Defined in: [builder/helpers.ts:286](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/builder/helpers.ts#L286)
+
+Sets the default configuration for module development.
+This config is used by loadModuleForDev when no config is provided.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `config` | `C` |
+
+#### Returns
+
+`ModuleBuilder`\<`C`, `Tables`, `Deps`\>
+
+#### Example
+
+```typescript
+export default defineModule<ModuleConfig, Tables>({
+  packageName: "my-module",
+}).withDevConfig({
+  dbNamespace: "main-db",
+}).build();
+```

package/docs/generated/builder/type-aliases/ModuleBuilderProps.md

@@ -0,0 +1,42 @@
+[**@izumisy-tailor/omakase-modules**](../../README.md)
+
+***
+
+[@izumisy-tailor/omakase-modules](../../modules.md) / [builder](../README.md) / ModuleBuilderProps
+
+# Type Alias: ModuleBuilderProps\<C, Deps\>
+
+> **ModuleBuilderProps**\<`C`, `Deps`\> = `Deps` *extends* [`EmptyDependencies`](EmptyDependencies.md) ? `object` : `object`
+
+Defined in: [builder/helpers.ts:44](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/builder/helpers.ts#L44)
+
+Properties required when configuring a module via `configure()`.
+
+The shape of this type varies based on whether the module has dependencies:
+- **Without dependencies**: `{ config: C }`
+- **With dependencies**: `{ config: C; dependencies: ConfiguredDependencies<Deps> }`
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `C` *extends* `Record`\<`string`, `unknown`\> |
+| `Deps` *extends* [`DependencyModules`](DependencyModules.md) |
+
+## Example
+
+```typescript
+// Module without dependencies
+myModule.configure({
+  config: { dbNamespace: "main-db" },
+});
+
+// Module with dependencies
+inventoryModule.configure({
+  config: { dbNamespace: "main-db" },
+  dependencies: {
+    commerce: $commerceModule,
+    order: $orderModule,
+  },
+});
+```

package/docs/generated/builder/type-aliases/ModuleFactoryContext.md

@@ -0,0 +1,40 @@
+[**@izumisy-tailor/omakase-modules**](../../README.md)
+
+***
+
+[@izumisy-tailor/omakase-modules](../../modules.md) / [builder](../README.md) / ModuleFactoryContext
+
+# Type Alias: ModuleFactoryContext\<C\>
+
+> **ModuleFactoryContext**\<`C`\> = `object`
+
+Defined in: [builder/helpers.ts:409](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/builder/helpers.ts#L409)
+
+Context passed to table builder functions.
+Provides access to the module's configuration.
+
+## Example
+
+```typescript
+export const buildProductTable = (
+  { config }: ModuleFactoryContext<ModuleConfig>,
+  deps: { category: TailorDBType }
+) => {
+  const prefix = config.dataModel?.product?.docNumberPrefix ?? "PROD";
+  return db.type("Product", { ... });
+};
+```
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `C` *extends* `Record`\<`string`, `unknown`\> |
+
+## Properties
+
+### config
+
+> **config**: `C`
+
+Defined in: [builder/helpers.ts:410](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/builder/helpers.ts#L410)