@izumisy-tailor/omakase-modules 0.3.0 → 0.4.0

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)

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

@@ -0,0 +1,28 @@
+[**@izumisy-tailor/omakase-modules**](../../README.md)
+
+***
+
+[@izumisy-tailor/omakase-modules](../../modules.md) / [builder](../README.md) / TablesFromNames
+
+# Type Alias: TablesFromNames\<T\>
+
+> **TablesFromNames**\<`T`\> = `{ [K in T[number]]: TailorDBType }`
+
+Defined in: [builder/helpers.ts:390](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/builder/helpers.ts#L390)
+
+Derives a tables type from a tableNames array.
+Use this to avoid manually defining a separate Tables type.
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` *extends* readonly `string`[] |
+
+## Example
+
+```typescript
+export const tableNames = ["product", "category"] as const;
+type MyTables = TablesFromNames<typeof tableNames>;
+// Result: { product: TailorDBType; category: TailorDBType }
+```

package/docs/generated/config/README.md

@@ -0,0 +1,19 @@
+[**@izumisy-tailor/omakase-modules**](../README.md)
+
+***
+
+[@izumisy-tailor/omakase-modules](../modules.md) / config
+
+# config
+
+## Classes
+
+- [ModuleLoader](classes/ModuleLoader.md)
+
+## Type Aliases
+
+- [LoadedModules](type-aliases/LoadedModules.md)
+
+## Functions
+
+- [loadModules](functions/loadModules.md)

package/docs/generated/config/classes/ModuleLoader.md

@@ -0,0 +1,128 @@
+[**@izumisy-tailor/omakase-modules**](../../README.md)
+
+***
+
+[@izumisy-tailor/omakase-modules](../../modules.md) / [config](../README.md) / ModuleLoader
+
+# Class: ModuleLoader
+
+Defined in: [config/module-loader.ts:49](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/config/module-loader.ts#L49)
+
+Module loader for registering and configuring modules.
+
+The `ModuleLoader` is used within the [loadModules](../functions/loadModules.md) function to register
+configured modules. Modules can depend on each other, and the loader ensures
+proper dependency management.
+
+## Example
+
+```typescript
+import { loadModules } from "@izumisy-tailor/omakase-modules";
+import commerceModule from "omakase-module-commerce-core";
+import orderModule from "omakase-module-order";
+import inventoryModule from "omakase-module-inventory";
+
+export default loadModules((loader) => {
+  // Add a module without dependencies
+  const $commerce = loader.add(
+    commerceModule.configure({
+      config: {
+        dataModel: {
+          product: { docNumberPrefix: "PROD" },
+        },
+      },
+    })
+  );
+
+  // Add a module that depends on commerce
+  const $order = loader.add(
+    orderModule.configure({
+      config: { dataModel: {} },
+      dependencies: { commerce: $commerce },
+    })
+  );
+
+  // Add a module that depends on both commerce and order
+  loader.add(
+    inventoryModule.configure({
+      config: { dbNamespace: "main-db" },
+      dependencies: { commerce: $commerce, order: $order },
+    })
+  );
+
+  return loader;
+});
+```
+
+## Constructors
+
+### Constructor
+
+> **new ModuleLoader**(): `ModuleLoader`
+
+#### Returns
+
+`ModuleLoader`
+
+## Methods
+
+### add()
+
+> **add**\<`C`\>(`module`): [`ConfiguredModule`](../../builder/type-aliases/ConfiguredModule.md)\<`C`\>
+
+Defined in: [config/module-loader.ts:92](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/config/module-loader.ts#L92)
+
+Add a configured module to the loader.
+
+Returns the added module so it can be used as a dependency for other modules.
+This enables type-safe dependency wiring between modules.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `C` *extends* `Record`\<`string`, `unknown`\> |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `module` | [`ConfiguredModule`](../../builder/type-aliases/ConfiguredModule.md)\<`C`\> | A configured module created by calling `moduleDefinition.configure()` |
+
+#### Returns
+
+[`ConfiguredModule`](../../builder/type-aliases/ConfiguredModule.md)\<`C`\>
+
+The same configured module, to be used as a dependency for other modules
+
+#### Example
+
+```typescript
+loadModules((loader) => {
+  // Capture the returned value to use as a dependency
+  const $commerce = loader.add(
+    commerceModule.configure({
+      config: {
+        dataModel: {
+          product: {
+            docNumberPrefix: "PP-PROD",
+            customAttributes: {
+              customStatus: db.enum(["new", "used", "refurbished"]),
+            },
+          },
+        },
+      },
+    })
+  );
+
+  // Use the captured module as a dependency
+  loader.add(
+    orderModule.configure({
+      config: { dataModel: {} },
+      dependencies: { commerce: $commerce },
+    })
+  );
+
+  return loader;
+});
+```

package/docs/generated/config/functions/loadModules.md

@@ -0,0 +1,79 @@
+[**@izumisy-tailor/omakase-modules**](../../README.md)
+
+***
+
+[@izumisy-tailor/omakase-modules](../../modules.md) / [config](../README.md) / loadModules
+
+# Function: loadModules()
+
+> **loadModules**(`configurator`): [`LoadedModules`](../type-aliases/LoadedModules.md)
+
+Defined in: [config/module-loader.ts:277](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/config/module-loader.ts#L277)
+
+Load and configure modules for your Tailor application.
+
+This is the main entry point for setting up omakase modules. Use this function
+to register all modules your application needs, configure them with your settings,
+and wire up dependencies between modules.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `configurator` | (`loader`) => [`ModuleLoader`](../classes/ModuleLoader.md) | A function that receives a [ModuleLoader](../classes/ModuleLoader.md) and returns it after adding modules |
+
+## Returns
+
+[`LoadedModules`](../type-aliases/LoadedModules.md)
+
+A [LoadedModules](../type-aliases/LoadedModules.md) object containing all registered modules and utilities
+
+## Example
+
+```typescript
+// modules.ts - Define your module configuration
+import { loadModules } from "@izumisy-tailor/omakase-modules";
+import { db } from "@tailor-platform/sdk";
+import commerceModule from "omakase-module-commerce-core";
+import orderModule from "omakase-module-order";
+import inventoryModule from "omakase-module-inventory";
+
+export default loadModules((loader) => {
+  // Configure and add the commerce module
+  const $commerce = loader.add(
+    commerceModule.configure({
+      config: {
+        dataModel: {
+          product: {
+            docNumberPrefix: "PP-PROD",
+            customAttributes: {
+              customStatus: db.enum(["new", "used", "refurbished"]),
+            },
+          },
+        },
+      },
+    })
+  );
+
+  // Configure order module with commerce as a dependency
+  const $order = loader.add(
+    orderModule.configure({
+      config: { dataModel: {} },
+      dependencies: { commerce: $commerce },
+    })
+  );
+
+  // Configure inventory module with both dependencies
+  loader.add(
+    inventoryModule.configure({
+      config: {
+        dbNamespace: "main-db",
+        invantoryBootstrapBaseValue: 300,
+      },
+      dependencies: { commerce: $commerce, order: $order },
+    })
+  );
+
+  return loader;
+});
+```