@izumisy-tailor/omakase-modules 0.3.0 → 0.4.1

package/docs/generated/config/sdk/README.md

@@ -0,0 +1,16 @@
+[**@izumisy-tailor/omakase-modules**](../../README.md)
+
+***
+
+[@izumisy-tailor/omakase-modules](../../modules.md) / config/sdk
+
+# config/sdk
+
+## Type Aliases
+
+- [GetModulesReferenceOptions](type-aliases/GetModulesReferenceOptions.md)
+
+## Functions
+
+- [getModulesReference](functions/getModulesReference.md)
+- [loadModuleForDev](functions/loadModuleForDev.md)

package/docs/generated/config/sdk/functions/getModulesReference.md

@@ -0,0 +1,81 @@
+[**@izumisy-tailor/omakase-modules**](../../../README.md)
+
+***
+
+[@izumisy-tailor/omakase-modules](../../../modules.md) / [config/sdk](../README.md) / getModulesReference
+
+# Function: getModulesReference()
+
+> **getModulesReference**(`loadedModules`, `options`): `Promise`\<\{ `executor`: `string`[]; `resolver`: `string`[]; `tailordb`: `string`[]; \}\>
+
+Defined in: [config/sdk/paths.ts:98](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/config/sdk/paths.ts#L98)
+
+Get file path patterns for modules to use in Tailor configuration.
+
+This function processes your loaded modules and returns glob patterns
+that can be spread into your `defineConfig`. It handles all the necessary
+setup to make module TailorDB types, resolvers, and executors available
+to Tailor's configuration system.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `loadedModules` | [`LoadedModules`](../../type-aliases/LoadedModules.md) | The result of calling `loadModules()` |
+| `options` | [`GetModulesReferenceOptions`](../type-aliases/GetModulesReferenceOptions.md) | Optional configuration for path resolution and logging |
+
+## Returns
+
+`Promise`\<\{ `executor`: `string`[]; `resolver`: `string`[]; `tailordb`: `string`[]; \}\>
+
+An object containing glob patterns for `tailordb`, `resolver`, and `executor` files
+
+## Examples
+
+```typescript
+// tailor.config.ts
+import { defineConfig, defineGenerators } from "@tailor-platform/sdk";
+import { getModulesReference } from "@izumisy-tailor/omakase-modules/config/sdk";
+import modules from "./modules";
+
+// Get module path patterns
+const moduleReference = await getModulesReference(modules);
+
+export default defineConfig({
+  name: "my-app",
+
+  // Spread module paths alongside your local files
+  db: {
+    "main-db": {
+      files: ["./src/tailordb/*.ts", ...moduleReference.tailordb],
+    },
+  },
+
+  resolver: {
+    "main-pipeline": {
+      files: ["./src/resolvers/*.ts", ...moduleReference.resolver],
+    },
+  },
+
+  executor: {
+    files: ["./src/executors/*.ts", ...moduleReference.executor],
+  },
+});
+```
+
+```typescript
+// With custom options
+const moduleReference = await getModulesReference(modules, {
+  basePath: import.meta.dirname, // Use ESM module directory
+  silent: true, // No console output
+});
+```
+
+## Remarks
+
+The returned object contains three arrays:
+- `tailordb` - Paths to TailorDB type definitions from modules
+- `resolver` - Paths to GraphQL resolver definitions from modules
+- `executor` - Paths to event executor definitions from modules
+
+If a module has no files of a certain type, that array will be empty.

package/docs/generated/config/sdk/functions/loadModuleForDev.md

@@ -0,0 +1,53 @@
+[**@izumisy-tailor/omakase-modules**](../../../README.md)
+
+***
+
+[@izumisy-tailor/omakase-modules](../../../modules.md) / [config/sdk](../README.md) / loadModuleForDev
+
+# Function: loadModuleForDev()
+
+> **loadModuleForDev**\<`C`, `Tables`, `Deps`\>(`module`, `config?`): [`LoadedModules`](../../type-aliases/LoadedModules.md)
+
+Defined in: [config/sdk/dev-context.ts:29](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/config/sdk/dev-context.ts#L29)
+
+Creates a LoadedModules context for individual module development.
+
+This allows using `getModulesReference` in a module's own `tailor.config.ts`,
+enabling the kysely-type generator to work during module development.
+
+Dependencies declared in the module's `defineModule` are automatically
+registered with default (empty) configurations.
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `C` *extends* `Record`\<`string`, `unknown`\> |
+| `Tables` *extends* `Record`\<`string`, `unknown`\> |
+| `Deps` *extends* [`DependencyModules`](../../../builder/type-aliases/DependencyModules.md) |
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `module` | [`DefinedModule`](../../../builder/type-aliases/DefinedModule.md)\<`C`, `Tables`, `Deps`\> | The module being developed |
+| `config?` | `C` | Optional development configuration. If omitted, uses module.devConfig. |
+
+## Returns
+
+[`LoadedModules`](../../type-aliases/LoadedModules.md)
+
+A LoadedModules object that can be passed to getModulesReference
+
+## Example
+
+```typescript
+// tailor.config.ts
+import { loadModuleForDev, getModulesReference } from "@izumisy-tailor/omakase-modules/config/sdk";
+import inventoryModule from "./src/module";
+
+const modules = loadModuleForDev(inventoryModule);
+const moduleReference = await getModulesReference(modules);
+
+export default defineConfig({ ... });
+```

package/docs/generated/config/sdk/type-aliases/GetModulesReferenceOptions.md

@@ -0,0 +1,60 @@
+[**@izumisy-tailor/omakase-modules**](../../../README.md)
+
+***
+
+[@izumisy-tailor/omakase-modules](../../../modules.md) / [config/sdk](../README.md) / GetModulesReferenceOptions
+
+# Type Alias: GetModulesReferenceOptions
+
+> **GetModulesReferenceOptions** = `object`
+
+Defined in: [config/sdk/paths.ts:16](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/config/sdk/paths.ts#L16)
+
+Options for configuring [getModulesReference](../functions/getModulesReference.md) behavior.
+
+## Example
+
+```typescript
+const moduleReference = await getModulesReference(modules, {
+  basePath: "/custom/path",
+  silent: true, // Suppress console output
+});
+```
+
+## Properties
+
+### basePath?
+
+> `optional` **basePath**: `string`
+
+Defined in: [config/sdk/paths.ts:25](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/config/sdk/paths.ts#L25)
+
+Base path for the application.
+
+This determines where wrapper files are generated and where module
+paths are resolved from. Defaults to `process.cwd()`.
+
+#### Default
+
+```ts
+process.cwd()
+```
+
+***
+
+### silent?
+
+> `optional` **silent**: `boolean`
+
+Defined in: [config/sdk/paths.ts:34](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/config/sdk/paths.ts#L34)
+
+Whether to suppress log output.
+
+When `true`, no console output will be printed during module loading.
+Useful for testing or when you want cleaner build output.
+
+#### Default
+
+```ts
+false
+```

package/docs/generated/config/type-aliases/LoadedModules.md

@@ -0,0 +1,162 @@
+[**@izumisy-tailor/omakase-modules**](../../README.md)
+
+***
+
+[@izumisy-tailor/omakase-modules](../../modules.md) / [config](../README.md) / LoadedModules
+
+# Type Alias: LoadedModules
+
+> **LoadedModules** = `object`
+
+Defined in: [config/module-loader.ts:135](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/config/module-loader.ts#L135)
+
+The result of loading modules, providing access to module configurations and tables.
+
+This type is returned by [loadModules](../functions/loadModules.md) and passed to module factory functions.
+It provides utilities for:
+- Accessing configured module instances
+- Loading module configurations
+- Retrieving tables from dependency modules
+
+## Example
+
+```typescript
+// In tailor.config.ts - using getModulesReference with LoadedModules
+import { getModulesReference } from "@izumisy-tailor/omakase-modules/config/sdk";
+import modules from "./modules";
+
+const moduleReference = await getModulesReference(modules);
+
+export default defineConfig({
+  db: {
+    "main-db": {
+      files: ["./src/tailordb/*.ts", ...moduleReference.tailordb],
+    },
+  },
+  // ...
+});
+```
+
+## Properties
+
+### getTables()
+
+> **getTables**: \<`T`\>(`factory`) => `Promise`\<`T`\>
+
+Defined in: [config/module-loader.ts:204](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/config/module-loader.ts#L204)
+
+Get the tables from a dependency module by calling its factory function.
+
+Use this when a module needs to reference tables from another module,
+such as creating foreign key relationships or using shared types.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `factory` | (`loadedModules`) => `Promise`\<`T`\> | The factory function exported by the dependency module's `tailordb/index.ts` |
+
+#### Returns
+
+`Promise`\<`T`\>
+
+A promise resolving to the tables created by the factory
+
+#### Example
+
+```typescript
+// In inventory-module's tailordb/index.ts
+import commerceModuleTables from "omakase-module-commerce-core/backend/tailordb";
+import orderModuleTables from "omakase-module-order/backend/tailordb";
+
+export default withModuleConfiguration(
+  moduleDef,
+  async (context, loadedModules) => {
+    // Get tables from commerce module to reference product/productVariant
+    const { product, productVariant } = await loadedModules.getTables(
+      commerceModuleTables
+    );
+
+    // Get tables from order module to reference order
+    const { order } = await loadedModules.getTables(orderModuleTables);
+
+    // Use dependency tables when building this module's tables
+    const inventory = buildInventoryTable(context, { product, productVariant });
+    const inventoryTransaction = buildInventoryTransactionTable(context, {
+      inventory,
+      order,
+    });
+
+    return { inventory, inventoryTransaction };
+  }
+);
+```
+
+***
+
+### loadConfig()
+
+> **loadConfig**: \<`C`\>(`module`) => `object`
+
+Defined in: [config/module-loader.ts:161](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/config/module-loader.ts#L161)
+
+Load the configuration for a specific module.
+
+Use this in module factory functions to access the user-provided configuration.
+Throws an error if the module has not been registered via `loadModules`.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `C` *extends* `Record`\<`string`, `unknown`\> |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `module` | \{ `packageName`: `string`; \} | An object with `packageName` (typically the module definition) |
+| `module.packageName` | `string` | - |
+
+#### Returns
+
+`object`
+
+An object containing the module's configuration
+
+##### config
+
+> **config**: `C`
+
+#### Throws
+
+Error if the module has not been configured
+
+#### Example
+
+```typescript
+// In a module's tailordb/index.ts
+import moduleDef from "../module";
+
+export default withModuleConfiguration(moduleDef, (context, loadedModules) => {
+  // Access this module's configuration
+  const { config } = loadedModules.loadConfig<ModuleConfig>(moduleDef);
+  const prefix = config.dataModel?.product?.docNumberPrefix ?? "PROD";
+
+  return { product: buildProductTable(context) };
+});
+```
+
+***
+
+### loadedModules
+
+> **loadedModules**: `Record`\<`string`, [`ConfiguredModule`](../../builder/type-aliases/ConfiguredModule.md)\<`any`\>\>
+
+Defined in: [config/module-loader.ts:136](https://github.com/tailor-sandbox/omakase-modules/blob/c8d6563533665d8bb159b4602b5c906b40e938f2/packages/core/src/config/module-loader.ts#L136)

package/docs/generated/modules.md

@@ -0,0 +1,11 @@
+[**@izumisy-tailor/omakase-modules**](README.md)
+
+***
+
+# @izumisy-tailor/omakase-modules
+
+## Modules
+
+- [builder](builder/README.md)
+- [config](config/README.md)
+- [config/sdk](config/sdk/README.md)

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@izumisy-tailor/omakase-modules",
   "private": false,
-  "version": "0.3.0",
+  "version": "0.4.1",
   "description": "Modularization mechanism for Tailor Platform application powered by Tailor SDK",
   "type": "module",
   "files": [
-    "src",
-    "docs"
+    "docs/generated",
+    "src"
   ],
   "exports": {
     ".": "./src/config/index.ts",
@@ -22,18 +22,22 @@
   "author": "Tailor Inc.",
   "license": "MIT",
   "devDependencies": {
-    "@types/node": "^25.0.3",
+    "@types/node": "^25.0.8",
+    "typedoc": "^0.28.16",
+    "typedoc-plugin-markdown": "^4.9.0",
     "typescript": "^5",
-    "vitest": "^4.0.16"
+    "vite-tsconfig-paths": "^6.0.4",
+    "vitest": "^4.0.17"
   },
   "peerDependencies": {
-    "@tailor-platform/sdk": "^0.20.0"
+    "@tailor-platform/sdk": "^1.2.6"
   },
   "dependencies": {
     "dedent": "^1.7.1"
   },
   "scripts": {
     "type-check": "tsc",
-    "test": "vitest run"
+    "test": "vitest run",
+    "docsgen": "typedoc"
   }
 }