@tailor-platform/erp-kit 0.2.0 → 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -0
- package/README.md +3 -26
- package/dist/cli.mjs +1613 -0
- package/package.json +14 -13
- package/schemas/app-compose/business-flow.yml +3 -0
- package/schemas/app-compose/story.yml +13 -1
- package/schemas/module/command.yml +9 -0
- package/schemas/module/module.yml +4 -0
- package/schemas/module/query.yml +9 -0
- package/skills/erp-kit-app-1-requirements/SKILL.md +8 -14
- package/skills/erp-kit-app-2-requirements-review/SKILL.md +102 -0
- package/skills/erp-kit-app-2-requirements-review/references/best-practices-check.md +66 -0
- package/skills/erp-kit-app-2-requirements-review/references/boundary-consistency-check.md +69 -0
- package/skills/erp-kit-app-2-requirements-review/references/requirements-report-format.md +25 -0
- package/skills/erp-kit-app-3-plan/SKILL.md +157 -0
- package/skills/erp-kit-app-3-plan/references/resolver-extraction.md +107 -0
- package/skills/erp-kit-app-3-plan/references/screen-extraction.md +74 -0
- package/skills/erp-kit-app-3-plan/references/story-extraction.md +86 -0
- package/skills/erp-kit-app-4-plan-review/SKILL.md +177 -0
- package/skills/erp-kit-app-4-plan-review/references/actor-flow-parity.md +73 -0
- package/skills/erp-kit-app-4-plan-review/references/business-flow-story-parity.md +86 -0
- package/skills/erp-kit-app-4-plan-review/references/orphan-detection.md +69 -0
- package/skills/erp-kit-app-4-plan-review/references/parity-report-format.md +52 -0
- package/skills/erp-kit-app-4-plan-review/references/story-resolver-parity.md +83 -0
- package/skills/erp-kit-app-4-plan-review/references/story-screen-parity.md +73 -0
- package/skills/erp-kit-app-5-impl-backend/SKILL.md +105 -0
- package/skills/erp-kit-app-5-impl-backend/references/app-config.md +38 -0
- package/skills/erp-kit-app-5-impl-backend/references/module-wiring.md +48 -0
- package/skills/erp-kit-app-5-impl-backend/references/resolver-patterns.md +68 -0
- package/skills/erp-kit-app-6-impl-frontend/SKILL.md +74 -0
- package/skills/erp-kit-app-6-impl-frontend/references/pages.md +160 -0
- package/skills/erp-kit-app-7-impl-review/SKILL.md +176 -0
- package/skills/erp-kit-app-7-impl-review/references/impl-parity-report-format.md +52 -0
- package/skills/erp-kit-app-7-impl-review/references/module-wiring-parity.md +84 -0
- package/skills/erp-kit-app-7-impl-review/references/resolver-doc-code-parity.md +86 -0
- package/skills/erp-kit-app-7-impl-review/references/screen-doc-code-parity.md +86 -0
- package/skills/erp-kit-module-1-requirements/SKILL.md +126 -0
- package/skills/erp-kit-module-1-requirements/references/boundary-analysis.md +51 -0
- package/skills/erp-kit-module-1-requirements/references/erp-research.md +57 -0
- package/skills/erp-kit-module-1-requirements/references/feature-doc.md +61 -0
- package/skills/erp-kit-module-2-requirements-review/SKILL.md +112 -0
- package/skills/erp-kit-module-2-requirements-review/references/best-practices-check.md +79 -0
- package/skills/erp-kit-module-2-requirements-review/references/boundary-consistency-check.md +70 -0
- package/skills/erp-kit-module-2-requirements-review/references/requirements-report-format.md +25 -0
- package/skills/erp-kit-module-3-plan/SKILL.md +107 -0
- package/skills/erp-kit-module-3-plan/references/command-extraction.md +87 -0
- package/skills/erp-kit-module-3-plan/references/model-extraction.md +72 -0
- package/skills/erp-kit-module-3-plan/references/query-extraction.md +59 -0
- package/skills/erp-kit-module-4-plan-review/SKILL.md +158 -0
- package/skills/erp-kit-module-4-plan-review/references/command-model-consistency.md +46 -0
- package/skills/erp-kit-module-4-plan-review/references/feature-command-parity.md +97 -0
- package/skills/erp-kit-module-4-plan-review/references/feature-model-parity.md +47 -0
- package/skills/erp-kit-module-4-plan-review/references/feature-query-parity.md +70 -0
- package/skills/erp-kit-module-4-plan-review/references/parity-report-format.md +52 -0
- package/skills/erp-kit-module-5-impl/SKILL.md +118 -0
- package/skills/erp-kit-module-5-impl/references/command-impl.md +68 -0
- package/skills/erp-kit-module-5-impl/references/exports.md +10 -0
- package/skills/erp-kit-module-5-impl/references/model-impl.md +45 -0
- package/skills/erp-kit-module-5-impl/references/query-impl.md +53 -0
- package/skills/erp-kit-module-6-impl-review/SKILL.md +187 -0
- package/skills/erp-kit-module-6-impl-review/references/command-doc-code-parity.md +92 -0
- package/skills/erp-kit-module-6-impl-review/references/command-doc-test-parity.md +93 -0
- package/skills/erp-kit-module-6-impl-review/references/error-implementation-parity.md +95 -0
- package/skills/{erp-kit-module-5-impl-review → erp-kit-module-6-impl-review}/references/errors.md +1 -1
- package/skills/erp-kit-module-6-impl-review/references/impl-parity-report-format.md +52 -0
- package/skills/erp-kit-module-6-impl-review/references/model-doc-code-parity.md +80 -0
- package/skills/erp-kit-module-shared/SKILL.md +1 -1
- package/skills/erp-kit-module-shared/references/commands.md +1 -1
- package/skills/erp-kit-module-shared/references/errors.md +12 -9
- package/skills/erp-kit-module-shared/references/queries.md +109 -36
- package/skills/erp-kit-module-shared/references/testing.md +10 -0
- package/skills/erp-kit-update/SKILL.md +2 -2
- package/src/app.ts +1 -1
- package/src/commands/check.ts +1 -1
- package/src/commands/index.ts +16 -5
- package/src/commands/init.test.ts +22 -69
- package/src/commands/init.ts +28 -115
- package/src/commands/lib/distribute.test.ts +126 -0
- package/src/commands/lib/distribute.ts +129 -0
- package/src/commands/parse-doc-test-cases.ts +55 -0
- package/src/commands/scaffold.test.ts +74 -33
- package/src/commands/scaffold.ts +54 -18
- package/src/commands/sync-check.test.ts +173 -0
- package/src/commands/sync-check.ts +103 -2
- package/src/commands/update.test.ts +87 -0
- package/src/commands/update.ts +41 -0
- package/src/generator/generate-code.test.ts +23 -12
- package/src/generator/generate-code.ts +22 -16
- package/src/integration.test.ts +1 -1
- package/src/module.ts +20 -65
- package/src/modules/item-management/README.md +8 -0
- package/src/modules/item-management/command/activateItem.generated.ts +1 -1
- package/src/modules/item-management/command/activateItem.test.ts +12 -18
- package/src/modules/item-management/command/activateItem.ts +9 -5
- package/src/modules/item-management/command/assignItemToTaxonomy.generated.ts +1 -1
- package/src/modules/item-management/command/assignItemToTaxonomy.test.ts +10 -24
- package/src/modules/item-management/command/assignItemToTaxonomy.ts +19 -16
- package/src/modules/item-management/command/createItem.generated.ts +1 -1
- package/src/modules/item-management/command/createItem.test.ts +11 -11
- package/src/modules/item-management/command/createItem.ts +16 -7
- package/src/modules/item-management/command/createTaxonomyNode.generated.ts +1 -1
- package/src/modules/item-management/command/createTaxonomyNode.test.ts +9 -9
- package/src/modules/item-management/command/createTaxonomyNode.ts +33 -14
- package/src/modules/item-management/command/deactivateItem.generated.ts +1 -1
- package/src/modules/item-management/command/deactivateItem.test.ts +12 -18
- package/src/modules/item-management/command/deactivateItem.ts +9 -5
- package/src/modules/item-management/command/deleteItem.generated.ts +1 -1
- package/src/modules/item-management/command/deleteItem.test.ts +10 -16
- package/src/modules/item-management/command/deleteItem.ts +9 -5
- package/src/modules/item-management/command/deleteTaxonomyNode.generated.ts +1 -1
- package/src/modules/item-management/command/deleteTaxonomyNode.test.ts +10 -16
- package/src/modules/item-management/command/deleteTaxonomyNode.ts +22 -12
- package/src/modules/item-management/command/moveTaxonomyNode.generated.ts +1 -1
- package/src/modules/item-management/command/moveTaxonomyNode.test.ts +10 -10
- package/src/modules/item-management/command/moveTaxonomyNode.ts +63 -19
- package/src/modules/item-management/command/reactivateItem.generated.ts +1 -1
- package/src/modules/item-management/command/reactivateItem.test.ts +12 -18
- package/src/modules/item-management/command/reactivateItem.ts +9 -5
- package/src/modules/item-management/command/removeItemFromTaxonomy.generated.ts +1 -1
- package/src/modules/item-management/command/removeItemFromTaxonomy.test.ts +9 -16
- package/src/modules/item-management/command/removeItemFromTaxonomy.ts +11 -6
- package/src/modules/item-management/command/updateItem.generated.ts +1 -1
- package/src/modules/item-management/command/updateItem.test.ts +16 -16
- package/src/modules/item-management/command/updateItem.ts +11 -6
- package/src/modules/item-management/command/updateTaxonomyNode.generated.ts +1 -1
- package/src/modules/item-management/command/updateTaxonomyNode.test.ts +14 -20
- package/src/modules/item-management/command/updateTaxonomyNode.ts +9 -6
- package/src/modules/item-management/docs/commands/ActivateItem.md +8 -0
- package/src/modules/item-management/docs/commands/AssignItemToTaxonomy.md +7 -0
- package/src/modules/item-management/docs/commands/CreateItem.md +10 -0
- package/src/modules/item-management/docs/commands/CreateTaxonomyNode.md +9 -0
- package/src/modules/item-management/docs/commands/DeactivateItem.md +8 -0
- package/src/modules/item-management/docs/commands/DeleteItem.md +7 -0
- package/src/modules/item-management/docs/commands/DeleteTaxonomyNode.md +7 -0
- package/src/modules/item-management/docs/commands/MoveTaxonomyNode.md +10 -0
- package/src/modules/item-management/docs/commands/ReactivateItem.md +8 -0
- package/src/modules/item-management/docs/commands/RemoveItemFromTaxonomy.md +5 -0
- package/src/modules/item-management/docs/commands/UpdateItem.md +15 -0
- package/src/modules/item-management/docs/commands/UpdateTaxonomyNode.md +9 -0
- package/src/modules/item-management/docs/queries/CalculateNodeDepth.md +8 -0
- package/src/modules/item-management/docs/queries/CalculateSubtreeDepth.md +7 -0
- package/src/modules/item-management/docs/queries/DetectCircularReference.md +9 -0
- package/src/modules/item-management/docs/queries/GetItem.md +9 -0
- package/src/modules/item-management/docs/queries/GetItemTaxonomyAssignment.md +5 -0
- package/src/modules/item-management/docs/queries/GetTaxonomyNode.md +7 -0
- package/src/modules/item-management/docs/queries/GetTaxonomyNodeAssignments.md +5 -0
- package/src/modules/item-management/docs/queries/GetTaxonomyNodeChildren.md +6 -0
- package/src/modules/item-management/index.ts +0 -51
- package/src/modules/item-management/lib/errors.generated.ts +24 -24
- package/src/modules/item-management/lib/permissions.generated.ts +1 -1
- package/src/modules/item-management/lib/types.ts +1 -1
- package/src/modules/item-management/module.ts +1 -1
- package/src/modules/item-management/query/calculateNodeDepth.generated.ts +1 -1
- package/src/modules/item-management/query/calculateNodeDepth.test.ts +21 -6
- package/src/modules/item-management/query/calculateNodeDepth.ts +2 -2
- package/src/modules/item-management/query/calculateSubtreeDepth.generated.ts +1 -1
- package/src/modules/item-management/query/calculateSubtreeDepth.test.ts +17 -5
- package/src/modules/item-management/query/calculateSubtreeDepth.ts +2 -2
- package/src/modules/item-management/query/detectCircularReference.generated.ts +1 -1
- package/src/modules/item-management/query/detectCircularReference.test.ts +25 -7
- package/src/modules/item-management/query/detectCircularReference.ts +4 -4
- package/src/modules/item-management/query/getItem.generated.ts +1 -1
- package/src/modules/item-management/query/getItem.test.ts +25 -7
- package/src/modules/item-management/query/getItem.ts +2 -2
- package/src/modules/item-management/query/getItemTaxonomyAssignment.generated.ts +1 -1
- package/src/modules/item-management/query/getItemTaxonomyAssignment.test.ts +9 -3
- package/src/modules/item-management/query/getItemTaxonomyAssignment.ts +2 -2
- package/src/modules/item-management/query/getTaxonomyNode.generated.ts +1 -1
- package/src/modules/item-management/query/getTaxonomyNode.test.ts +17 -5
- package/src/modules/item-management/query/getTaxonomyNode.ts +2 -2
- package/src/modules/item-management/query/getTaxonomyNodeAssignments.generated.ts +1 -1
- package/src/modules/item-management/query/getTaxonomyNodeAssignments.test.ts +9 -3
- package/src/modules/item-management/query/getTaxonomyNodeAssignments.ts +2 -2
- package/src/modules/item-management/query/getTaxonomyNodeChildren.generated.ts +1 -1
- package/src/modules/item-management/query/getTaxonomyNodeChildren.test.ts +13 -4
- package/src/modules/item-management/query/getTaxonomyNodeChildren.ts +2 -2
- package/src/modules/item-management/tailor.config.ts +6 -4
- package/src/modules/item-management/tailor.d.ts +13 -0
- package/src/modules/primitives/README.md +8 -0
- package/src/modules/primitives/command/activateCategory.generated.ts +1 -1
- package/src/modules/primitives/command/activateCategory.test.ts +8 -18
- package/src/modules/primitives/command/activateCategory.ts +9 -5
- package/src/modules/primitives/command/activateCurrency.generated.ts +1 -1
- package/src/modules/primitives/command/activateCurrency.test.ts +8 -18
- package/src/modules/primitives/command/activateCurrency.ts +9 -5
- package/src/modules/primitives/command/activateUnit.generated.ts +1 -1
- package/src/modules/primitives/command/activateUnit.test.ts +8 -15
- package/src/modules/primitives/command/activateUnit.ts +9 -5
- package/src/modules/primitives/command/createCategory.generated.ts +1 -1
- package/src/modules/primitives/command/createCategory.test.ts +29 -44
- package/src/modules/primitives/command/createCategory.ts +9 -5
- package/src/modules/primitives/command/createCurrency.generated.ts +1 -1
- package/src/modules/primitives/command/createCurrency.test.ts +53 -78
- package/src/modules/primitives/command/createCurrency.ts +9 -6
- package/src/modules/primitives/command/createExchangeRate.generated.ts +1 -1
- package/src/modules/primitives/command/createExchangeRate.test.ts +59 -97
- package/src/modules/primitives/command/createExchangeRate.ts +13 -7
- package/src/modules/primitives/command/createUnit.generated.ts +1 -1
- package/src/modules/primitives/command/createUnit.test.ts +59 -90
- package/src/modules/primitives/command/createUnit.ts +9 -6
- package/src/modules/primitives/command/deactivateCategory.generated.ts +1 -1
- package/src/modules/primitives/command/deactivateCategory.test.ts +15 -33
- package/src/modules/primitives/command/deactivateCategory.ts +9 -5
- package/src/modules/primitives/command/deactivateCurrency.generated.ts +1 -1
- package/src/modules/primitives/command/deactivateCurrency.test.ts +12 -26
- package/src/modules/primitives/command/deactivateCurrency.ts +9 -5
- package/src/modules/primitives/command/deactivateUnit.generated.ts +1 -1
- package/src/modules/primitives/command/deactivateUnit.test.ts +15 -30
- package/src/modules/primitives/command/deactivateUnit.ts +14 -7
- package/src/modules/primitives/command/setBaseCurrency.generated.ts +1 -1
- package/src/modules/primitives/command/setBaseCurrency.test.ts +18 -40
- package/src/modules/primitives/command/setBaseCurrency.ts +15 -7
- package/src/modules/primitives/command/setReferenceUnit.generated.ts +1 -1
- package/src/modules/primitives/command/setReferenceUnit.test.ts +22 -44
- package/src/modules/primitives/command/setReferenceUnit.ts +21 -9
- package/src/modules/primitives/docs/commands/ActivateCategory.md +6 -0
- package/src/modules/primitives/docs/commands/ActivateCurrency.md +6 -0
- package/src/modules/primitives/docs/commands/ActivateUnit.md +6 -0
- package/src/modules/primitives/docs/commands/CreateCategory.md +6 -0
- package/src/modules/primitives/docs/commands/CreateCurrency.md +10 -0
- package/src/modules/primitives/docs/commands/CreateExchangeRate.md +11 -0
- package/src/modules/primitives/docs/commands/CreateUnit.md +10 -0
- package/src/modules/primitives/docs/commands/DeactivateCategory.md +7 -0
- package/src/modules/primitives/docs/commands/DeactivateCurrency.md +7 -0
- package/src/modules/primitives/docs/commands/DeactivateUnit.md +7 -0
- package/src/modules/primitives/docs/commands/SetBaseCurrency.md +7 -0
- package/src/modules/primitives/docs/commands/SetReferenceUnit.md +7 -0
- package/src/modules/primitives/docs/queries/ConvertAmount.md +14 -0
- package/src/modules/primitives/docs/queries/ConvertQuantity.md +13 -0
- package/src/modules/primitives/docs/queries/GetBaseCurrency.md +5 -0
- package/src/modules/primitives/docs/queries/GetCurrency.md +7 -0
- package/src/modules/primitives/docs/queries/GetUnit.md +7 -0
- package/src/modules/primitives/docs/queries/GetUoMCategory.md +7 -0
- package/src/modules/primitives/docs/queries/ListUnitsByCategory.md +15 -5
- package/src/modules/primitives/index.ts +0 -49
- package/src/modules/primitives/lib/errors.generated.ts +23 -23
- package/src/modules/primitives/lib/permissions.generated.ts +1 -1
- package/src/modules/primitives/lib/types.ts +1 -1
- package/src/modules/primitives/module.ts +1 -1
- package/src/modules/primitives/query/convertAmount.generated.ts +1 -1
- package/src/modules/primitives/query/convertAmount.test.ts +110 -77
- package/src/modules/primitives/query/convertAmount.ts +61 -47
- package/src/modules/primitives/query/convertQuantity.generated.ts +1 -1
- package/src/modules/primitives/query/convertQuantity.test.ts +99 -69
- package/src/modules/primitives/query/convertQuantity.ts +12 -10
- package/src/modules/primitives/query/getBaseCurrency.generated.ts +1 -1
- package/src/modules/primitives/query/getBaseCurrency.test.ts +10 -4
- package/src/modules/primitives/query/getBaseCurrency.ts +2 -2
- package/src/modules/primitives/query/getCurrency.generated.ts +1 -1
- package/src/modules/primitives/query/getCurrency.test.ts +17 -5
- package/src/modules/primitives/query/getCurrency.ts +2 -2
- package/src/modules/primitives/query/getUnit.generated.ts +1 -1
- package/src/modules/primitives/query/getUnit.test.ts +17 -5
- package/src/modules/primitives/query/getUnit.ts +2 -2
- package/src/modules/primitives/query/getUoMCategory.generated.ts +1 -1
- package/src/modules/primitives/query/getUoMCategory.test.ts +17 -5
- package/src/modules/primitives/query/getUoMCategory.ts +2 -2
- package/src/modules/primitives/query/listUnitsByCategory.generated.ts +1 -1
- package/src/modules/primitives/query/listUnitsByCategory.test.ts +80 -0
- package/src/modules/primitives/query/listUnitsByCategory.ts +19 -3
- package/src/modules/primitives/tailor.config.ts +6 -4
- package/src/modules/primitives/tailor.d.ts +13 -0
- package/src/modules/product-management/README.md +52 -0
- package/src/modules/product-management/command/activateProduct.generated.ts +6 -0
- package/src/modules/product-management/command/activateProduct.test.ts +40 -0
- package/src/modules/product-management/command/activateProduct.ts +42 -0
- package/src/modules/product-management/command/assignProductToCategory.generated.ts +6 -0
- package/src/modules/product-management/command/assignProductToCategory.test.ts +90 -0
- package/src/modules/product-management/command/assignProductToCategory.ts +62 -0
- package/src/modules/product-management/command/createProduct.generated.ts +6 -0
- package/src/modules/product-management/command/createProduct.test.ts +149 -0
- package/src/modules/product-management/command/createProduct.ts +73 -0
- package/src/modules/product-management/command/createProductAttribute.generated.ts +6 -0
- package/src/modules/product-management/command/createProductAttribute.test.ts +70 -0
- package/src/modules/product-management/command/createProductAttribute.ts +53 -0
- package/src/modules/product-management/command/createProductAttributeValue.generated.ts +6 -0
- package/src/modules/product-management/command/createProductAttributeValue.test.ts +68 -0
- package/src/modules/product-management/command/createProductAttributeValue.ts +63 -0
- package/src/modules/product-management/command/createProductCategory.generated.ts +6 -0
- package/src/modules/product-management/command/createProductCategory.test.ts +135 -0
- package/src/modules/product-management/command/createProductCategory.ts +82 -0
- package/src/modules/product-management/command/deactivateProduct.generated.ts +6 -0
- package/src/modules/product-management/command/deactivateProduct.test.ts +40 -0
- package/src/modules/product-management/command/deactivateProduct.ts +42 -0
- package/src/modules/product-management/command/deleteProduct.generated.ts +6 -0
- package/src/modules/product-management/command/deleteProduct.test.ts +42 -0
- package/src/modules/product-management/command/deleteProduct.ts +42 -0
- package/src/modules/product-management/command/deleteProductAttribute.generated.ts +6 -0
- package/src/modules/product-management/command/deleteProductAttribute.test.ts +49 -0
- package/src/modules/product-management/command/deleteProductAttribute.ts +45 -0
- package/src/modules/product-management/command/deleteProductAttributeValue.generated.ts +6 -0
- package/src/modules/product-management/command/deleteProductAttributeValue.test.ts +71 -0
- package/src/modules/product-management/command/deleteProductAttributeValue.ts +68 -0
- package/src/modules/product-management/command/deleteProductCategory.generated.ts +6 -0
- package/src/modules/product-management/command/deleteProductCategory.test.ts +74 -0
- package/src/modules/product-management/command/deleteProductCategory.ts +53 -0
- package/src/modules/product-management/command/generateVariants.generated.ts +6 -0
- package/src/modules/product-management/command/generateVariants.test.ts +365 -0
- package/src/modules/product-management/command/generateVariants.ts +168 -0
- package/src/modules/product-management/command/moveProductCategory.generated.ts +6 -0
- package/src/modules/product-management/command/moveProductCategory.test.ts +170 -0
- package/src/modules/product-management/command/moveProductCategory.ts +124 -0
- package/src/modules/product-management/command/reactivateProduct.generated.ts +6 -0
- package/src/modules/product-management/command/reactivateProduct.test.ts +40 -0
- package/src/modules/product-management/command/reactivateProduct.ts +42 -0
- package/src/modules/product-management/command/removeProductFromCategory.generated.ts +6 -0
- package/src/modules/product-management/command/removeProductFromCategory.test.ts +42 -0
- package/src/modules/product-management/command/removeProductFromCategory.ts +32 -0
- package/src/modules/product-management/command/setProductAttributeAssignment.generated.ts +6 -0
- package/src/modules/product-management/command/setProductAttributeAssignment.test.ts +206 -0
- package/src/modules/product-management/command/setProductAttributeAssignment.ts +102 -0
- package/src/modules/product-management/command/updateProduct.generated.ts +6 -0
- package/src/modules/product-management/command/updateProduct.test.ts +168 -0
- package/src/modules/product-management/command/updateProduct.ts +95 -0
- package/src/modules/product-management/command/updateProductAttribute.generated.ts +6 -0
- package/src/modules/product-management/command/updateProductAttribute.test.ts +101 -0
- package/src/modules/product-management/command/updateProductAttribute.ts +68 -0
- package/src/modules/product-management/command/updateProductAttributeValue.generated.ts +6 -0
- package/src/modules/product-management/command/updateProductAttributeValue.test.ts +80 -0
- package/src/modules/product-management/command/updateProductAttributeValue.ts +58 -0
- package/src/modules/product-management/command/updateProductCategory.generated.ts +6 -0
- package/src/modules/product-management/command/updateProductCategory.test.ts +80 -0
- package/src/modules/product-management/command/updateProductCategory.ts +66 -0
- package/src/modules/product-management/db/product.ts +47 -0
- package/src/modules/product-management/db/productAttribute.ts +26 -0
- package/src/modules/product-management/db/productAttributeAssignment.ts +58 -0
- package/src/modules/product-management/db/productAttributeValue.ts +39 -0
- package/src/modules/product-management/db/productCategory.ts +34 -0
- package/src/modules/product-management/db/productCategoryAssignment.ts +49 -0
- package/src/modules/product-management/db/productVariant.ts +52 -0
- package/src/modules/product-management/docs/commands/ActivateProduct.md +39 -0
- package/src/modules/product-management/docs/commands/AssignProductToCategory.md +43 -0
- package/src/modules/product-management/docs/commands/CreateProduct.md +48 -0
- package/src/modules/product-management/docs/commands/CreateProductAttribute.md +39 -0
- package/src/modules/product-management/docs/commands/CreateProductAttributeValue.md +42 -0
- package/src/modules/product-management/docs/commands/CreateProductCategory.md +54 -0
- package/src/modules/product-management/docs/commands/DeactivateProduct.md +39 -0
- package/src/modules/product-management/docs/commands/DeleteProduct.md +42 -0
- package/src/modules/product-management/docs/commands/DeleteProductAttribute.md +39 -0
- package/src/modules/product-management/docs/commands/DeleteProductAttributeValue.md +42 -0
- package/src/modules/product-management/docs/commands/DeleteProductCategory.md +43 -0
- package/src/modules/product-management/docs/commands/GenerateVariants.md +68 -0
- package/src/modules/product-management/docs/commands/MoveProductCategory.md +54 -0
- package/src/modules/product-management/docs/commands/ReactivateProduct.md +38 -0
- package/src/modules/product-management/docs/commands/RemoveProductFromCategory.md +34 -0
- package/src/modules/product-management/docs/commands/SetProductAttributeAssignment.md +62 -0
- package/src/modules/product-management/docs/commands/UpdateProduct.md +61 -0
- package/src/modules/product-management/docs/commands/UpdateProductAttribute.md +46 -0
- package/src/modules/product-management/docs/commands/UpdateProductAttributeValue.md +47 -0
- package/src/modules/product-management/docs/commands/UpdateProductCategory.md +46 -0
- package/src/modules/product-management/docs/features/attribute-management.md +48 -0
- package/src/modules/product-management/docs/features/product-category.md +71 -0
- package/src/modules/product-management/docs/features/product-lifecycle.md +66 -0
- package/src/modules/product-management/docs/features/variant-generation.md +77 -0
- package/src/modules/product-management/docs/models/Product.md +58 -0
- package/src/modules/product-management/docs/models/ProductAttribute.md +37 -0
- package/src/modules/product-management/docs/models/ProductAttributeAssignment.md +41 -0
- package/src/modules/product-management/docs/models/ProductAttributeValue.md +40 -0
- package/src/modules/product-management/docs/models/ProductCategory.md +46 -0
- package/src/modules/product-management/docs/models/ProductCategoryAssignment.md +37 -0
- package/src/modules/product-management/docs/models/ProductVariant.md +41 -0
- package/src/modules/product-management/docs/queries/CalculateCategoryDepth.md +47 -0
- package/src/modules/product-management/docs/queries/DetectCategoryCircularReference.md +51 -0
- package/src/modules/product-management/docs/queries/GetProduct.md +42 -0
- package/src/modules/product-management/docs/queries/GetProductAttribute.md +42 -0
- package/src/modules/product-management/docs/queries/GetProductAttributeAssignment.md +34 -0
- package/src/modules/product-management/docs/queries/GetProductAttributeValue.md +40 -0
- package/src/modules/product-management/docs/queries/GetProductCategory.md +42 -0
- package/src/modules/product-management/docs/queries/GetProductCategoryAssignment.md +34 -0
- package/src/modules/product-management/docs/queries/GetProductVariant.md +41 -0
- package/src/modules/product-management/docs/queries/ListAttributeAssignmentsByAttribute.md +34 -0
- package/src/modules/product-management/docs/queries/ListCategoryAssignmentsByProduct.md +35 -0
- package/src/modules/product-management/docs/queries/ListProductAttributeAssignments.md +34 -0
- package/src/modules/product-management/docs/queries/ListProductAttributeValues.md +36 -0
- package/src/modules/product-management/docs/queries/ListProductCategoryAssignments.md +34 -0
- package/src/modules/product-management/docs/queries/ListProductCategoryChildren.md +34 -0
- package/src/modules/product-management/docs/queries/ListProductVariants.md +34 -0
- package/src/modules/product-management/generated/enums.ts +9 -0
- package/src/modules/product-management/generated/kysely-tailordb.ts +100 -0
- package/src/modules/product-management/index.ts +2 -0
- package/src/modules/product-management/lib/_db_deps.ts +17 -0
- package/src/modules/product-management/lib/errors.generated.ts +152 -0
- package/src/modules/product-management/lib/permissions.generated.ts +25 -0
- package/src/modules/product-management/lib/types.ts +51 -0
- package/src/modules/product-management/module.ts +201 -0
- package/src/modules/product-management/query/calculateCategoryDepth.generated.ts +5 -0
- package/src/modules/product-management/query/calculateCategoryDepth.test.ts +72 -0
- package/src/modules/product-management/query/calculateCategoryDepth.ts +37 -0
- package/src/modules/product-management/query/detectCategoryCircularReference.generated.ts +5 -0
- package/src/modules/product-management/query/detectCategoryCircularReference.test.ts +72 -0
- package/src/modules/product-management/query/detectCategoryCircularReference.ts +44 -0
- package/src/modules/product-management/query/getProduct.generated.ts +5 -0
- package/src/modules/product-management/query/getProduct.test.ts +59 -0
- package/src/modules/product-management/query/getProduct.ts +18 -0
- package/src/modules/product-management/query/getProductAttribute.generated.ts +5 -0
- package/src/modules/product-management/query/getProductAttribute.test.ts +59 -0
- package/src/modules/product-management/query/getProductAttribute.ts +18 -0
- package/src/modules/product-management/query/getProductAttributeAssignment.generated.ts +5 -0
- package/src/modules/product-management/query/getProductAttributeAssignment.test.ts +37 -0
- package/src/modules/product-management/query/getProductAttributeAssignment.ts +18 -0
- package/src/modules/product-management/query/getProductAttributeValue.generated.ts +5 -0
- package/src/modules/product-management/query/getProductAttributeValue.test.ts +31 -0
- package/src/modules/product-management/query/getProductAttributeValue.ts +16 -0
- package/src/modules/product-management/query/getProductCategory.generated.ts +5 -0
- package/src/modules/product-management/query/getProductCategory.test.ts +59 -0
- package/src/modules/product-management/query/getProductCategory.ts +18 -0
- package/src/modules/product-management/query/getProductCategoryAssignment.generated.ts +5 -0
- package/src/modules/product-management/query/getProductCategoryAssignment.test.ts +37 -0
- package/src/modules/product-management/query/getProductCategoryAssignment.ts +18 -0
- package/src/modules/product-management/query/getProductVariant.generated.ts +5 -0
- package/src/modules/product-management/query/getProductVariant.test.ts +43 -0
- package/src/modules/product-management/query/getProductVariant.ts +20 -0
- package/src/modules/product-management/query/listAttributeAssignmentsByAttribute.generated.ts +5 -0
- package/src/modules/product-management/query/listAttributeAssignmentsByAttribute.test.ts +31 -0
- package/src/modules/product-management/query/listAttributeAssignmentsByAttribute.ts +16 -0
- package/src/modules/product-management/query/listCategoryAssignmentsByProduct.generated.ts +5 -0
- package/src/modules/product-management/query/listCategoryAssignmentsByProduct.test.ts +31 -0
- package/src/modules/product-management/query/listCategoryAssignmentsByProduct.ts +16 -0
- package/src/modules/product-management/query/listProductAttributeAssignments.generated.ts +5 -0
- package/src/modules/product-management/query/listProductAttributeAssignments.test.ts +31 -0
- package/src/modules/product-management/query/listProductAttributeAssignments.ts +16 -0
- package/src/modules/product-management/query/listProductAttributeValues.generated.ts +5 -0
- package/src/modules/product-management/query/listProductAttributeValues.test.ts +31 -0
- package/src/modules/product-management/query/listProductAttributeValues.ts +17 -0
- package/src/modules/product-management/query/listProductCategoryAssignments.generated.ts +5 -0
- package/src/modules/product-management/query/listProductCategoryAssignments.test.ts +31 -0
- package/src/modules/product-management/query/listProductCategoryAssignments.ts +16 -0
- package/src/modules/product-management/query/listProductCategoryChildren.generated.ts +5 -0
- package/src/modules/product-management/query/listProductCategoryChildren.test.ts +31 -0
- package/src/modules/product-management/query/listProductCategoryChildren.ts +16 -0
- package/src/modules/product-management/query/listProductVariants.generated.ts +5 -0
- package/src/modules/product-management/query/listProductVariants.test.ts +31 -0
- package/src/modules/product-management/query/listProductVariants.ts +16 -0
- package/src/modules/product-management/tailor.config.ts +13 -0
- package/src/modules/product-management/tailor.d.ts +13 -0
- package/src/modules/product-management/testing/fixtures.ts +151 -0
- package/src/modules/user-management/README.md +9 -3
- package/src/modules/user-management/command/activateUser.generated.ts +1 -1
- package/src/modules/user-management/command/activateUser.test.ts +12 -65
- package/src/modules/user-management/command/activateUser.ts +5 -20
- package/src/modules/user-management/command/assignPermissionToRole.generated.ts +1 -1
- package/src/modules/user-management/command/assignPermissionToRole.test.ts +25 -60
- package/src/modules/user-management/command/assignPermissionToRole.ts +5 -24
- package/src/modules/user-management/command/assignRoleToUser.generated.ts +1 -1
- package/src/modules/user-management/command/assignRoleToUser.test.ts +35 -87
- package/src/modules/user-management/command/assignRoleToUser.ts +5 -24
- package/src/modules/user-management/command/createPermission.generated.ts +1 -1
- package/src/modules/user-management/command/createPermission.test.ts +23 -33
- package/src/modules/user-management/command/createPermission.ts +4 -5
- package/src/modules/user-management/command/createRole.generated.ts +1 -1
- package/src/modules/user-management/command/createRole.test.ts +17 -27
- package/src/modules/user-management/command/createRole.ts +4 -5
- package/src/modules/user-management/command/createUser.generated.ts +1 -1
- package/src/modules/user-management/command/createUser.test.ts +31 -118
- package/src/modules/user-management/command/createUser.ts +7 -25
- package/src/modules/user-management/command/deactivateUser.generated.ts +1 -1
- package/src/modules/user-management/command/deactivateUser.test.ts +12 -65
- package/src/modules/user-management/command/deactivateUser.ts +6 -21
- package/src/modules/user-management/command/reactivateUser.generated.ts +1 -1
- package/src/modules/user-management/command/reactivateUser.test.ts +13 -66
- package/src/modules/user-management/command/reactivateUser.ts +5 -20
- package/src/modules/user-management/command/revokePermissionFromRole.generated.ts +1 -1
- package/src/modules/user-management/command/revokePermissionFromRole.test.ts +24 -62
- package/src/modules/user-management/command/revokePermissionFromRole.ts +5 -24
- package/src/modules/user-management/command/revokeRoleFromUser.generated.ts +1 -1
- package/src/modules/user-management/command/revokeRoleFromUser.test.ts +24 -60
- package/src/modules/user-management/command/revokeRoleFromUser.ts +5 -24
- package/src/modules/user-management/docs/commands/ActivateUser.md +7 -0
- package/src/modules/user-management/docs/commands/AssignPermissionToRole.md +7 -0
- package/src/modules/user-management/docs/commands/AssignRoleToUser.md +9 -0
- package/src/modules/user-management/docs/commands/CreatePermission.md +12 -0
- package/src/modules/user-management/docs/commands/CreateRole.md +9 -0
- package/src/modules/user-management/docs/commands/CreateUser.md +11 -0
- package/src/modules/user-management/docs/commands/DeactivateUser.md +7 -0
- package/src/modules/user-management/docs/commands/ReactivateUser.md +7 -0
- package/src/modules/user-management/docs/commands/RevokePermissionFromRole.md +7 -0
- package/src/modules/user-management/docs/commands/RevokeRoleFromUser.md +7 -0
- package/src/modules/user-management/index.ts +0 -30
- package/src/modules/user-management/lib/errors.generated.ts +14 -14
- package/src/modules/user-management/lib/permissions.generated.ts +1 -2
- package/src/modules/user-management/lib/recomputeUserPermissions.ts +4 -3
- package/src/modules/user-management/lib/types.ts +1 -1
- package/src/modules/user-management/module.ts +2 -7
- package/src/modules/user-management/tailor.config.ts +6 -4
- package/src/modules/user-management/tailor.d.ts +13 -0
- package/src/modules/user-management/testing/fixtures.ts +1 -20
- package/src/schemas.ts +1 -1
- package/src/{modules/shared → shared}/defineCommand.test.ts +23 -7
- package/src/{modules/shared → shared}/defineCommand.ts +19 -10
- package/src/{modules/shared/internal.ts → shared/index.ts} +9 -1
- package/src/shared/pagination.test.ts +43 -0
- package/src/shared/pagination.ts +22 -0
- package/src/{modules/shared → shared}/types.ts +13 -0
- package/src/{modules/testing → testing}/index.ts +14 -7
- package/src/testing.ts +1 -1
- package/src/util.ts +8 -0
- package/templates/config/license.config.json +4 -0
- package/templates/scaffold/app/backend/.env.example +1 -0
- package/templates/scaffold/app/backend/__dot__gitignore +4 -0
- package/templates/scaffold/app/backend/eslint.config.js +32 -0
- package/templates/scaffold/app/backend/package.json +31 -0
- package/templates/scaffold/app/backend/seed/data/AuditEvent.jsonl +0 -0
- package/templates/scaffold/app/backend/seed/data/Permission.jsonl +0 -0
- package/templates/scaffold/app/backend/seed/data/Permission.schema.ts +20 -0
- package/templates/scaffold/app/backend/seed/data/Role.jsonl +0 -0
- package/templates/scaffold/app/backend/seed/data/Role.schema.ts +20 -0
- package/templates/scaffold/app/backend/seed/data/RolePermission.jsonl +0 -0
- package/templates/scaffold/app/backend/seed/data/RolePermission.schema.ts +24 -0
- package/templates/scaffold/app/backend/seed/data/User.jsonl +1 -0
- package/templates/scaffold/app/backend/seed/data/User.schema.ts +20 -0
- package/templates/scaffold/app/backend/seed/data/UserRole.jsonl +0 -0
- package/templates/scaffold/app/backend/seed/data/UserRole.schema.ts +24 -0
- package/templates/scaffold/app/backend/seed/data/_User.jsonl +1 -0
- package/templates/scaffold/app/backend/seed/data/_User.schema.ts +30 -0
- package/templates/scaffold/app/backend/seed/exec.mjs +659 -0
- package/templates/scaffold/app/backend/src/executors/permissionCreated.ts +3 -0
- package/templates/scaffold/app/backend/src/executors/permissionDeleted.ts +3 -0
- package/templates/scaffold/app/backend/src/generated/kysely-tailordb.ts +83 -0
- package/templates/scaffold/app/backend/src/modules.ts +9 -0
- package/templates/scaffold/app/backend/src/resolvers/createUser.ts +46 -0
- package/templates/scaffold/app/backend/tailor.config.ts +68 -0
- package/templates/scaffold/app/backend/tailor.d.ts +15 -0
- package/templates/scaffold/app/backend/tsconfig.json +19 -0
- package/templates/scaffold/app/docs/actors/.gitkeep +0 -0
- package/templates/scaffold/app/docs/business-flow/.gitkeep +0 -0
- package/templates/scaffold/app/docs/resolver/.gitkeep +0 -0
- package/templates/scaffold/app/docs/screen/.gitkeep +0 -0
- package/templates/scaffold/app/frontend/.env.example +2 -0
- package/templates/scaffold/app/frontend/__dot__gitignore +3 -0
- package/templates/scaffold/app/frontend/components.json +23 -0
- package/templates/scaffold/app/frontend/eslint.config.js +48 -0
- package/templates/scaffold/app/frontend/index.html +13 -0
- package/templates/scaffold/app/frontend/package.json +53 -0
- package/templates/scaffold/app/frontend/scripts/generate-graphql.mjs +6 -0
- package/templates/scaffold/app/frontend/src/App.tsx +58 -0
- package/templates/scaffold/app/frontend/src/components/composed/empty-state.tsx +26 -0
- package/templates/scaffold/app/frontend/src/components/composed/error-fallback.tsx +28 -0
- package/templates/scaffold/app/frontend/src/components/composed/loading.tsx +13 -0
- package/templates/scaffold/app/frontend/src/components/ui/badge.tsx +39 -0
- package/templates/scaffold/app/frontend/src/components/ui/button.tsx +60 -0
- package/templates/scaffold/app/frontend/src/components/ui/card.tsx +75 -0
- package/templates/scaffold/app/frontend/src/components/ui/form.tsx +152 -0
- package/templates/scaffold/app/frontend/src/components/ui/input.tsx +21 -0
- package/templates/scaffold/app/frontend/src/components/ui/label.tsx +21 -0
- package/templates/scaffold/app/frontend/src/components/ui/spinner.tsx +16 -0
- package/templates/scaffold/app/frontend/src/components/ui/table.tsx +90 -0
- package/templates/scaffold/app/frontend/src/graphql/generated/graphql-env.d.ts +103 -0
- package/templates/scaffold/app/frontend/src/graphql/generated/schema.graphql +1235 -0
- package/templates/scaffold/app/frontend/src/graphql/index.ts +15 -0
- package/templates/scaffold/app/frontend/src/index.css +5 -0
- package/templates/scaffold/app/frontend/src/lib/auth-client.ts +17 -0
- package/templates/scaffold/app/frontend/src/lib/utils.ts +6 -0
- package/templates/scaffold/app/frontend/src/main.tsx +10 -0
- package/templates/scaffold/app/frontend/src/pages/page.tsx +20 -0
- package/templates/scaffold/app/frontend/src/pages/user-management/page.tsx +19 -0
- package/templates/scaffold/app/frontend/src/pages/user-management/profile/page.tsx +97 -0
- package/templates/scaffold/app/frontend/src/pages/user-management/user/[id]/components/user-detail.tsx +58 -0
- package/templates/scaffold/app/frontend/src/pages/user-management/user/[id]/page.tsx +51 -0
- package/templates/scaffold/app/frontend/src/pages/user-management/user/components/users-table.tsx +101 -0
- package/templates/scaffold/app/frontend/src/pages/user-management/user/create/components/create-user-form.tsx +99 -0
- package/templates/scaffold/app/frontend/src/pages/user-management/user/create/page.tsx +19 -0
- package/templates/scaffold/app/frontend/src/pages/user-management/user/page.tsx +61 -0
- package/templates/scaffold/app/frontend/src/providers/graphql-provider.tsx +21 -0
- package/templates/scaffold/app/frontend/tsconfig.app.json +35 -0
- package/templates/scaffold/app/frontend/tsconfig.json +16 -0
- package/templates/scaffold/app/frontend/tsconfig.node.json +23 -0
- package/templates/scaffold/app/frontend/vite.config.ts +23 -0
- package/templates/scaffold/module/command/.gitkeep +0 -0
- package/templates/scaffold/module/db/.gitkeep +0 -0
- package/templates/scaffold/module/executor/.gitkeep +0 -0
- package/templates/scaffold/module/generated/.gitkeep +0 -0
- package/templates/scaffold/module/index.ts +2 -0
- package/templates/scaffold/module/lib/errors.ts +1 -0
- package/templates/scaffold/module/lib/types.ts +4 -0
- package/templates/scaffold/module/module.ts +7 -0
- package/templates/scaffold/module/permissions.ts +3 -0
- package/templates/scaffold/module/query/.gitkeep +0 -0
- package/templates/scaffold/module/tailor.config.ts +13 -0
- package/templates/scaffold/module/testing/fixtures.ts +1 -0
- package/templates/workflows/erp-kit-check.yml +37 -0
- package/dist/cli.js +0 -1654
- package/skills/erp-kit-app-1-requirements/references/structure.md +0 -27
- package/skills/erp-kit-app-2-breakdown/SKILL.md +0 -95
- package/skills/erp-kit-app-2-breakdown/references/screen-detailview.md +0 -106
- package/skills/erp-kit-app-2-breakdown/references/screen-form.md +0 -139
- package/skills/erp-kit-app-2-breakdown/references/screen-listview.md +0 -153
- package/skills/erp-kit-app-2-breakdown/references/structure.md +0 -27
- package/skills/erp-kit-app-3-doc-review/SKILL.md +0 -116
- package/skills/erp-kit-app-3-doc-review/references/structure.md +0 -27
- package/skills/erp-kit-app-4-design/SKILL.md +0 -256
- package/skills/erp-kit-app-4-design/references/component.md +0 -50
- package/skills/erp-kit-app-4-design/references/screen-detailview.md +0 -106
- package/skills/erp-kit-app-4-design/references/screen-form.md +0 -139
- package/skills/erp-kit-app-4-design/references/screen-listview.md +0 -153
- package/skills/erp-kit-app-4-design/references/structure.md +0 -27
- package/skills/erp-kit-app-5-design-review/SKILL.md +0 -290
- package/skills/erp-kit-app-5-design-review/references/component.md +0 -50
- package/skills/erp-kit-app-5-design-review/references/screen-detailview.md +0 -106
- package/skills/erp-kit-app-5-design-review/references/screen-form.md +0 -139
- package/skills/erp-kit-app-5-design-review/references/screen-listview.md +0 -153
- package/skills/erp-kit-app-6-impl-spec/SKILL.md +0 -127
- package/skills/erp-kit-app-6-impl-spec/references/auth.md +0 -72
- package/skills/erp-kit-app-6-impl-spec/references/structure.md +0 -27
- package/skills/erp-kit-module-1-docs/SKILL.md +0 -111
- package/skills/erp-kit-module-2-feature-breakdown/SKILL.md +0 -76
- package/skills/erp-kit-module-3-doc-review/SKILL.md +0 -294
- package/skills/erp-kit-module-4-tdd/SKILL.md +0 -94
- package/skills/erp-kit-module-4-tdd/references/exports.md +0 -8
- package/skills/erp-kit-module-5-impl-review/SKILL.md +0 -410
- package/src/commands/scaffold-templates.ts +0 -65
- package/src/modules/shared/index.ts +0 -1
- package/src/modules/user-management/command/logAuditEvent.generated.ts +0 -6
- package/src/modules/user-management/command/logAuditEvent.test.ts +0 -187
- package/src/modules/user-management/command/logAuditEvent.ts +0 -56
- package/src/modules/user-management/db/auditEvent.ts +0 -47
- package/src/modules/user-management/docs/commands/LogAuditEvent.md +0 -37
- package/src/modules/user-management/docs/features/audit-trail.md +0 -80
- package/src/modules/user-management/docs/models/AuditEvent.md +0 -36
- /package/skills/{erp-kit-module-2-feature-breakdown → erp-kit-module-3-plan}/references/naming.md +0 -0
- /package/skills/{erp-kit-module-4-tdd → erp-kit-module-5-impl}/references/cross-module-dependency.md +0 -0
- /package/skills/{erp-kit-module-4-tdd → erp-kit-module-5-impl}/references/db-relations.md +0 -0
- /package/skills/{erp-kit-module-4-tdd → erp-kit-module-5-impl}/references/generated-code.md +0 -0
- /package/skills/{erp-kit-module-4-tdd → erp-kit-module-5-impl}/references/models.md +0 -0
- /package/skills/{erp-kit-module-5-impl-review → erp-kit-module-6-impl-review}/references/commands.md +0 -0
- /package/skills/{erp-kit-module-5-impl-review → erp-kit-module-6-impl-review}/references/testing.md +0 -0
- /package/src/modules/{product-management → audit}/.gitkeep +0 -0
- /package/src/{modules/shared → shared}/createContext.test.ts +0 -0
- /package/src/{modules/shared → shared}/createContext.ts +0 -0
- /package/src/{modules/shared → shared}/definePermissions.test.ts +0 -0
- /package/src/{modules/shared → shared}/definePermissions.ts +0 -0
- /package/src/{modules/shared → shared}/defineQuery.test.ts +0 -0
- /package/src/{modules/shared → shared}/defineQuery.ts +0 -0
- /package/src/{modules/shared → shared}/entityTypes.ts +0 -0
- /package/src/{modules/shared → shared}/errors.ts +0 -0
- /package/src/{modules/shared → shared}/requirePermission.test.ts +0 -0
- /package/src/{modules/shared → shared}/requirePermission.ts +0 -0
- /package/src/{modules/shared → shared}/result.ts +0 -0
|
@@ -1,153 +0,0 @@
|
|
|
1
|
-
# ListView Screen Implementation
|
|
2
|
-
|
|
3
|
-
Implementation pattern for screens with `Screen Type: ListView`.
|
|
4
|
-
Assumes `page.md` and `component.md` rules.
|
|
5
|
-
|
|
6
|
-
## File Structure
|
|
7
|
-
|
|
8
|
-
```
|
|
9
|
-
{screen-path}/
|
|
10
|
-
├── components/
|
|
11
|
-
│ └── {screen-name}-table.tsx # Table component with fragments
|
|
12
|
-
└── page.tsx
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## Page Component (page.tsx)
|
|
16
|
-
|
|
17
|
-
Data fetching and `Layout` must be co-located in the same page component.
|
|
18
|
-
Do NOT split into an inner Content component — `Layout` requires `Layout.Column` as direct children.
|
|
19
|
-
|
|
20
|
-
```tsx
|
|
21
|
-
const ResourcesQuery = graphql(
|
|
22
|
-
`
|
|
23
|
-
query Resources {
|
|
24
|
-
resources {
|
|
25
|
-
...ResourceTable
|
|
26
|
-
}
|
|
27
|
-
}
|
|
28
|
-
`,
|
|
29
|
-
[ResourceTableFragment],
|
|
30
|
-
);
|
|
31
|
-
|
|
32
|
-
const ResourcesPage = () => {
|
|
33
|
-
const [{ data, error, fetching }, reexecuteQuery] = useQuery({
|
|
34
|
-
query: ResourcesQuery,
|
|
35
|
-
});
|
|
36
|
-
|
|
37
|
-
if (fetching) return <Loading />;
|
|
38
|
-
|
|
39
|
-
if (error || !data) {
|
|
40
|
-
return (
|
|
41
|
-
<ErrorFallback
|
|
42
|
-
title="Failed to load resources"
|
|
43
|
-
message="An error occurred while fetching the list."
|
|
44
|
-
onReset={() => reexecuteQuery({ requestPolicy: "network-only" })}
|
|
45
|
-
/>
|
|
46
|
-
);
|
|
47
|
-
}
|
|
48
|
-
|
|
49
|
-
return (
|
|
50
|
-
<Layout
|
|
51
|
-
columns={1}
|
|
52
|
-
title="Resources"
|
|
53
|
-
actions={[
|
|
54
|
-
<Button key="create" asChild>
|
|
55
|
-
<Link to="create">Create</Link>
|
|
56
|
-
</Button>,
|
|
57
|
-
]}
|
|
58
|
-
>
|
|
59
|
-
<Layout.Column>
|
|
60
|
-
<ResourceTable data={data.resources} />
|
|
61
|
-
</Layout.Column>
|
|
62
|
-
</Layout>
|
|
63
|
-
);
|
|
64
|
-
};
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
## Table Component (components/{screen-name}-table.tsx)
|
|
68
|
-
|
|
69
|
-
### Fragment Collocation
|
|
70
|
-
|
|
71
|
-
Define a row fragment and a table fragment wrapping the Connection type.
|
|
72
|
-
|
|
73
|
-
```tsx
|
|
74
|
-
const ResourceRowFragment = graphql(`
|
|
75
|
-
fragment ResourceRow on Resource {
|
|
76
|
-
id
|
|
77
|
-
title
|
|
78
|
-
status
|
|
79
|
-
createdAt
|
|
80
|
-
}
|
|
81
|
-
`);
|
|
82
|
-
|
|
83
|
-
export const ResourceTableFragment = graphql(
|
|
84
|
-
`
|
|
85
|
-
fragment ResourceTable on ResourceConnection {
|
|
86
|
-
edges {
|
|
87
|
-
node {
|
|
88
|
-
...ResourceRow
|
|
89
|
-
}
|
|
90
|
-
}
|
|
91
|
-
}
|
|
92
|
-
`,
|
|
93
|
-
[ResourceRowFragment],
|
|
94
|
-
);
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
### Row Component
|
|
98
|
-
|
|
99
|
-
```tsx
|
|
100
|
-
const ResourceRow = ({ resource: resourceFragment }: ResourceRowProps) => {
|
|
101
|
-
const resource = readFragment(ResourceRowFragment, resourceFragment);
|
|
102
|
-
return (
|
|
103
|
-
<TableRow>
|
|
104
|
-
<TableCell>{resource.title}</TableCell>
|
|
105
|
-
<TableCell>
|
|
106
|
-
<Badge variant={resource.status === "ACTIVE" ? "default" : "secondary"}>
|
|
107
|
-
{resource.status}
|
|
108
|
-
</Badge>
|
|
109
|
-
</TableCell>
|
|
110
|
-
<TableCell>
|
|
111
|
-
<Button variant="ghost" size="sm" asChild>
|
|
112
|
-
<Link to={resource.id}>View</Link>
|
|
113
|
-
</Button>
|
|
114
|
-
</TableCell>
|
|
115
|
-
</TableRow>
|
|
116
|
-
);
|
|
117
|
-
};
|
|
118
|
-
```
|
|
119
|
-
|
|
120
|
-
### Empty State
|
|
121
|
-
|
|
122
|
-
```tsx
|
|
123
|
-
if (connection.edges.length === 0) {
|
|
124
|
-
return (
|
|
125
|
-
<EmptyState
|
|
126
|
-
title="No resources"
|
|
127
|
-
message="Get started by creating a new resource."
|
|
128
|
-
action={
|
|
129
|
-
<Button asChild>
|
|
130
|
-
<Link to="create">Create</Link>
|
|
131
|
-
</Button>
|
|
132
|
-
}
|
|
133
|
-
/>
|
|
134
|
-
);
|
|
135
|
-
}
|
|
136
|
-
```
|
|
137
|
-
|
|
138
|
-
## Column Property Mapping
|
|
139
|
-
|
|
140
|
-
| Property | Implementation |
|
|
141
|
-
| --------------- | ----------------------------------------------------------- |
|
|
142
|
-
| Hideable: Yes | Column visibility state to toggle show/hide |
|
|
143
|
-
| Sortable: Yes | Sort icon on `<TableHead>` + onClick to toggle query vars |
|
|
144
|
-
| Filterable: Yes | Filter UI above table (`<Select />`) |
|
|
145
|
-
| Searchable: Yes | Search input above table (`<Input placeholder="Search" />`) |
|
|
146
|
-
|
|
147
|
-
## Key Points
|
|
148
|
-
|
|
149
|
-
- Use `<Badge />` for status columns
|
|
150
|
-
- Format dates with `toLocaleDateString()`
|
|
151
|
-
- Use `<EmptyState />` with Create action for empty lists
|
|
152
|
-
- Add a View button per row to navigate to the detail page
|
|
153
|
-
- Iterate data using Connection type `edges.node` pattern
|
|
@@ -1,127 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: erp-kit-app-6-impl-spec
|
|
3
|
-
description: Create Tier 4 documentation (resolvers) for GraphQL operations. Use after completing design review with erp-kit-app-5-design-review.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Implementation Spec Workflow
|
|
7
|
-
|
|
8
|
-
Create Tier 4 documentation: GraphQL Resolvers (mutations and queries).
|
|
9
|
-
|
|
10
|
-
## Prerequisites
|
|
11
|
-
|
|
12
|
-
Tier 1-3 documentation and design mockups must exist:
|
|
13
|
-
|
|
14
|
-
- `README.md` (requirements)
|
|
15
|
-
- `docs/actors/*.md` (actors)
|
|
16
|
-
- `docs/business-flow/*/README.md` (flows)
|
|
17
|
-
- `docs/business-flow/*/story/*.md` (stories)
|
|
18
|
-
- `docs/screen/*.md` (screens)
|
|
19
|
-
- `docs/design.pen` (UI mockups)
|
|
20
|
-
|
|
21
|
-
## Workflow Phases
|
|
22
|
-
|
|
23
|
-
```
|
|
24
|
-
ANALYZE → IDENTIFY → CHECK MODULES → CREATE → VALIDATE
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
### Phase 1: Analyze
|
|
28
|
-
|
|
29
|
-
Read all story files and identify:
|
|
30
|
-
|
|
31
|
-
1. **Operations** that modify data → mutations
|
|
32
|
-
2. **Operations** that retrieve data → queries
|
|
33
|
-
3. **Error scenarios** for each operation
|
|
34
|
-
|
|
35
|
-
### Phase 2: Identify
|
|
36
|
-
|
|
37
|
-
Map stories to resolvers:
|
|
38
|
-
|
|
39
|
-
| Story Element | Resolver Type |
|
|
40
|
-
| -------------------- | ------------- |
|
|
41
|
-
| Create/Update/Delete | Mutation |
|
|
42
|
-
| View/List/Search | Query |
|
|
43
|
-
| Real-time updates | Subscription |
|
|
44
|
-
|
|
45
|
-
**Naming:** Use action-verb names: `create-`, `update-`, `delete-`, `submit-`, `approve-`
|
|
46
|
-
|
|
47
|
-
### Phase 3: Check Module Dependencies
|
|
48
|
-
|
|
49
|
-
Resolvers reference module commands. Before creating resolver docs, verify required modules exist.
|
|
50
|
-
|
|
51
|
-
**Check existing modules:**
|
|
52
|
-
|
|
53
|
-
```bash
|
|
54
|
-
ls modules/
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
**Check module commands:**
|
|
58
|
-
|
|
59
|
-
```bash
|
|
60
|
-
ls modules/<module-name>/docs/commands/
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
**Map resolvers to modules:**
|
|
64
|
-
|
|
65
|
-
| Resolver Operation | Typical Module |
|
|
66
|
-
| ------------------ | --------------------- |
|
|
67
|
-
| User invite/roles | `user-management` |
|
|
68
|
-
| Supplier CRUD | `supplier-management` |
|
|
69
|
-
| Document handling | `document-management` |
|
|
70
|
-
| Task workflows | `task-management` |
|
|
71
|
-
|
|
72
|
-
**If modules don't exist:**
|
|
73
|
-
|
|
74
|
-
1. **Identify needed modules** - Group resolver operations by domain
|
|
75
|
-
2. **Create module docs first** - Use `erp-kit-module-1-docs` skill
|
|
76
|
-
3. **Return to Tier 4** - After modules have documented commands
|
|
77
|
-
|
|
78
|
-
```
|
|
79
|
-
Tier 4 blocked → Create modules → Return to Tier 4
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
**Only reference existing module commands** in resolver documentation. Never reference modules or commands that don't exist.
|
|
83
|
-
|
|
84
|
-
### Phase 4: Create
|
|
85
|
-
|
|
86
|
-
Generate documentation using `erp-kit` CLI:
|
|
87
|
-
|
|
88
|
-
```bash
|
|
89
|
-
erp-kit scaffold --app-root examples resolver <app> <resolver-name>
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
**Naming conventions:**
|
|
93
|
-
|
|
94
|
-
- Filename must match H1 heading exactly (kebab-case)
|
|
95
|
-
- Action-focused names: `create-supplier-invitation.md`
|
|
96
|
-
|
|
97
|
-
### Phase 5: Validate
|
|
98
|
-
|
|
99
|
-
```bash
|
|
100
|
-
pnpm run app:doc:check
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
## Schema Reference
|
|
104
|
-
|
|
105
|
-
| Schema | Tier | Output Path |
|
|
106
|
-
| -------------- | ---- | ------------------------- |
|
|
107
|
-
| `resolver.yml` | 4 | `docs/resolver/<name>.md` |
|
|
108
|
-
|
|
109
|
-
## Tips
|
|
110
|
-
|
|
111
|
-
- One story may require 1-3 resolvers
|
|
112
|
-
- Group related operations logically
|
|
113
|
-
- Document all error scenarios
|
|
114
|
-
|
|
115
|
-
## Completion
|
|
116
|
-
|
|
117
|
-
After Tier 4, the application specification is complete:
|
|
118
|
-
|
|
119
|
-
- **Tier 1**: Application overview
|
|
120
|
-
- **Tier 2**: Actors and business workflows
|
|
121
|
-
- **Tier 3**: User stories and screens
|
|
122
|
-
- **Tier 4**: Implementation specifications
|
|
123
|
-
|
|
124
|
-
## References
|
|
125
|
-
|
|
126
|
-
- [Application structure](references/structure.md)
|
|
127
|
-
- [Backend auth](references/auth.md)
|
|
@@ -1,72 +0,0 @@
|
|
|
1
|
-
# Backend Auth Configuration
|
|
2
|
-
|
|
3
|
-
Use Tailor SDK auth resources as the default pattern for backend authentication setup.
|
|
4
|
-
|
|
5
|
-
## Standard Auth Shape
|
|
6
|
-
|
|
7
|
-
In `tailor.config.ts`:
|
|
8
|
-
|
|
9
|
-
- Define IdP with `defineIdp(...)`
|
|
10
|
-
- Define Auth with `defineAuth(...)`
|
|
11
|
-
- Define static website with `defineStaticWebSite(...)` when frontend is deployed as static hosting
|
|
12
|
-
- Wire `idProvider` via `idp.provider(...)`
|
|
13
|
-
- Set exactly one OAuth2 client for frontend login (default client name: `default`)
|
|
14
|
-
- Export config with `auth: auth` and `idp: [idp]`
|
|
15
|
-
- Include static website URL in CORS when using deployed frontend (for example, `cors: ["http://localhost:5173", website.url]`)
|
|
16
|
-
|
|
17
|
-
Prefer this stable naming unless there is a clear reason to change:
|
|
18
|
-
|
|
19
|
-
- Auth name: `default`
|
|
20
|
-
- IdP name: `default`
|
|
21
|
-
- OAuth2 client name: `default`
|
|
22
|
-
|
|
23
|
-
## User Mapping
|
|
24
|
-
|
|
25
|
-
Use `userProfile` to map authenticated identities to the application user type.
|
|
26
|
-
|
|
27
|
-
- `type`: module-provided user type
|
|
28
|
-
- `usernameField`: stable unique field (for example, `email`)
|
|
29
|
-
- `attributes`: explicitly list required attributes
|
|
30
|
-
|
|
31
|
-
Avoid implicit attribute assumptions.
|
|
32
|
-
|
|
33
|
-
## CORS for Static Website Login
|
|
34
|
-
|
|
35
|
-
When frontend is deployed via `staticWebsites`, OAuth metadata and query calls are cross-origin from `https://<name>-<workspace>.web.erp.dev` to app backend.
|
|
36
|
-
|
|
37
|
-
- Always include the deployed static website origin via `website.url` in backend `cors`
|
|
38
|
-
- Keep local development origin in `cors` as well (for example, `http://localhost:5173`)
|
|
39
|
-
- If your template uses IP allow lists, set `allowedIpAddresses` appropriately for Tailor internal access
|
|
40
|
-
|
|
41
|
-
If `website.url` is missing from `cors`, login may fail with browser CORS errors before authentication starts.
|
|
42
|
-
|
|
43
|
-
## Seed Permission Alignment
|
|
44
|
-
|
|
45
|
-
Seeded login users in `seed/data/User.jsonl` must receive module permissions required by guarded commands/resolvers.
|
|
46
|
-
|
|
47
|
-
- Do not assume `ADMIN` is automatically privileged unless your permission evaluator explicitly supports it
|
|
48
|
-
- Grant concrete permission keys defined by the module (for example, `user-management:createUser`)
|
|
49
|
-
- Keep `User.jsonl` permissions aligned with the module currently wired in `src/modules.ts`
|
|
50
|
-
|
|
51
|
-
## Workspace and CLI Inputs
|
|
52
|
-
|
|
53
|
-
Use `TAILOR_PLATFORM_WORKSPACE_ID` in backend `.env` for CLI operations.
|
|
54
|
-
|
|
55
|
-
Required for non-interactive resource lookup and automation:
|
|
56
|
-
|
|
57
|
-
- `tailor-sdk oauth2client list`
|
|
58
|
-
- `tailor-sdk oauth2client get <name>`
|
|
59
|
-
|
|
60
|
-
Use `--env-file <backend/.env>` for deterministic command execution in local/dev scripts.
|
|
61
|
-
|
|
62
|
-
## OAuth Client ID Source of Truth
|
|
63
|
-
|
|
64
|
-
Frontend `VITE_TAILOR_CLIENT_ID` must come from backend-managed OAuth2 client data.
|
|
65
|
-
|
|
66
|
-
Canonical retrieval flow:
|
|
67
|
-
|
|
68
|
-
1. `tailor-sdk oauth2client get default --json`
|
|
69
|
-
2. Copy `clientId` from command output
|
|
70
|
-
3. Set it in frontend env
|
|
71
|
-
|
|
72
|
-
Do not hardcode OAuth client IDs in source code.
|
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
# Application Directory Structure
|
|
2
|
-
|
|
3
|
-
```
|
|
4
|
-
{app_name}/
|
|
5
|
-
├── backend/
|
|
6
|
-
│ ├── src/
|
|
7
|
-
│ │ ├── modules.ts # Declaring module usage
|
|
8
|
-
│ │ ├── modules/
|
|
9
|
-
│ │ │ └── {module-name}/ # Module-specific directory
|
|
10
|
-
│ │ │ ├── resolvers/ # API Definition to expose graphql apis
|
|
11
|
-
│ │ │ └── executors/ # PubSub Automation (one file per declaration)
|
|
12
|
-
│ │ └── generated/ # Auto-generated code (do not edit)
|
|
13
|
-
│ └── tailor.config.ts # tailor application config
|
|
14
|
-
│
|
|
15
|
-
└── frontend/
|
|
16
|
-
└── src/
|
|
17
|
-
├── pages/ # File-based routing (auto-discovered by Vite plugin)
|
|
18
|
-
│ └── {page-path}/
|
|
19
|
-
│ ├── page.tsx
|
|
20
|
-
│ └── {page-path}/
|
|
21
|
-
│ ├── components/
|
|
22
|
-
│ └── page.tsx
|
|
23
|
-
├── components/
|
|
24
|
-
│ └── ui/ # Generic UI components
|
|
25
|
-
├── graphql/ # gql.tada settings
|
|
26
|
-
└── providers/ # react providers
|
|
27
|
-
```
|
|
@@ -1,111 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: erp-kit-module-1-docs
|
|
3
|
-
description: Create ERP module documentation following framework schemas. Use when starting a new module, documenting an existing module, or when user asks to create module docs, feature docs, or design module features. Guides collaborative research, scoping, and iterative feature breakdown.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Module Documentation Workflow
|
|
7
|
-
|
|
8
|
-
Collaborative workflow for creating ERP module documentation. Human and AI work together through research, scoping, design validation, and iterative refinement.
|
|
9
|
-
|
|
10
|
-
## Workflow Phases
|
|
11
|
-
|
|
12
|
-
```
|
|
13
|
-
RESEARCH → SCOPE → DESIGN → CREATE → REVIEW
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
### Phase 1: Research
|
|
17
|
-
|
|
18
|
-
Study established ERP solutions for the module domain:
|
|
19
|
-
|
|
20
|
-
1. **Web search** Odoo, Oracle ERP Cloud, SAP for the domain (e.g., "Odoo inventory management features")
|
|
21
|
-
2. **Fetch documentation** from official sources when available
|
|
22
|
-
3. **Identify** common features, models, workflows, compliance requirements
|
|
23
|
-
4. **Summarize** findings before proceeding
|
|
24
|
-
|
|
25
|
-
Key ERP references:
|
|
26
|
-
|
|
27
|
-
- Odoo: https://www.odoo.com/documentation/19.0/applications.html
|
|
28
|
-
- Oracle: https://docs.oracle.com/en/cloud/saas/index.html
|
|
29
|
-
- SAP: Search SAP Docs
|
|
30
|
-
|
|
31
|
-
### Phase 2: Scope
|
|
32
|
-
|
|
33
|
-
Present scope options to user. Use AskUserQuestion:
|
|
34
|
-
|
|
35
|
-
| Option | Description |
|
|
36
|
-
| ---------------------- | ----------------------------------------------------------------------- |
|
|
37
|
-
| **Minimal** | Core entities only, basic CRUD, no workflows |
|
|
38
|
-
| **Core (Recommended)** | Essential features for production use, foundational for other modules |
|
|
39
|
-
| **Comprehensive** | Full feature set including advanced workflows, compliance, integrations |
|
|
40
|
-
|
|
41
|
-
Wait for user selection before proceeding.
|
|
42
|
-
|
|
43
|
-
### Phase 3: Design
|
|
44
|
-
|
|
45
|
-
Present features incrementally for validation:
|
|
46
|
-
|
|
47
|
-
1. **List proposed features** as a table (feature name, purpose)
|
|
48
|
-
2. **Wait for user approval** of feature list
|
|
49
|
-
3. For each feature, briefly describe:
|
|
50
|
-
- What it does
|
|
51
|
-
- Key scenarios
|
|
52
|
-
4. **Ask**: "Does this feature breakdown look right?"
|
|
53
|
-
|
|
54
|
-
Keep descriptions concise (~100-200 words per section). Do not present all details at once.
|
|
55
|
-
|
|
56
|
-
### Phase 4: Create
|
|
57
|
-
|
|
58
|
-
Generate documentation following framework schemas.
|
|
59
|
-
|
|
60
|
-
**File structure:**
|
|
61
|
-
|
|
62
|
-
```
|
|
63
|
-
modules/<module-name>/
|
|
64
|
-
├── README.md # module.yml schema
|
|
65
|
-
└── docs/
|
|
66
|
-
└── features/
|
|
67
|
-
└── <feature-name>.md # feature.yml schema
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
**Naming conventions:**
|
|
71
|
-
|
|
72
|
-
- Feature files: kebab-case (e.g., `role-based-access-control.md`)
|
|
73
|
-
- Headings: Title Case
|
|
74
|
-
|
|
75
|
-
Create with `erp-kit` CLI:
|
|
76
|
-
|
|
77
|
-
```bash
|
|
78
|
-
erp-kit scaffold --modules-root modules module <module-name>
|
|
79
|
-
erp-kit scaffold --modules-root modules feature <module-name> <feature-name>
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
### Phase 5: Review
|
|
83
|
-
|
|
84
|
-
After creating docs, user reviews and may request changes:
|
|
85
|
-
|
|
86
|
-
**Split detection**: If a feature covers multiple distinct workflows, split into separate feature files.
|
|
87
|
-
|
|
88
|
-
**Iteration pattern:**
|
|
89
|
-
|
|
90
|
-
1. User identifies issue (e.g., "X is too broad, split it")
|
|
91
|
-
2. Create new feature file for split-out content
|
|
92
|
-
3. Remove split content from original file
|
|
93
|
-
4. Update README.md feature list if needed
|
|
94
|
-
|
|
95
|
-
Continue iterating until user approves.
|
|
96
|
-
|
|
97
|
-
# Framework Schemas Reference
|
|
98
|
-
|
|
99
|
-
Schemas are bundled in `@tailor-platform/erp-kit`.
|
|
100
|
-
|
|
101
|
-
## Validation
|
|
102
|
-
|
|
103
|
-
Always run before completing:
|
|
104
|
-
|
|
105
|
-
```bash
|
|
106
|
-
pnpm run module:doc:check
|
|
107
|
-
```
|
|
108
|
-
|
|
109
|
-
## References
|
|
110
|
-
|
|
111
|
-
- [Module structure](../erp-kit-module-shared/references/structure.md)
|
|
@@ -1,76 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: erp-kit-module-2-feature-breakdown
|
|
3
|
-
description: Use when breaking down a feature spec into model, command, and query documentation. Triggers on feature implementation planning, creating model docs, creating command docs, creating query docs, or when user references model.yml/command.yml schemas.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Feature Breakdown to Model/Command/Query Docs
|
|
7
|
-
|
|
8
|
-
Convert feature specifications into structured model, command, and query documentation following framework schemas.
|
|
9
|
-
|
|
10
|
-
## When to Use
|
|
11
|
-
|
|
12
|
-
- User has a feature spec (e.g., `docs/features/*.md`) and wants implementation docs
|
|
13
|
-
- User asks to create model, command, or query documentation
|
|
14
|
-
- User references `model.yml` or `command.yml` schemas
|
|
15
|
-
|
|
16
|
-
## Workflow
|
|
17
|
-
|
|
18
|
-
```
|
|
19
|
-
ANALYZE → SCAFFOLD → POPULATE → VALIDATE
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
### 1. Analyze
|
|
23
|
-
|
|
24
|
-
Read the feature spec and identify:
|
|
25
|
-
|
|
26
|
-
- **Models**: Entities with state, fields, relationships
|
|
27
|
-
- **Commands**: Operations that change state (look for verbs in state diagrams)
|
|
28
|
-
- **Queries**: Read-only operations for external consumers — lookups, conversions, aggregations. See [CQRS read rule](../erp-kit-module-shared/references/commands.md#command-side-reads-cqrs-separation)
|
|
29
|
-
|
|
30
|
-
### 2. Scaffold
|
|
31
|
-
|
|
32
|
-
For each model, command, and query, scaffold the documentation files using `erp-kit` CLI:
|
|
33
|
-
|
|
34
|
-
```bash
|
|
35
|
-
erp-kit scaffold --modules-root modules model <module-name> <model-name>
|
|
36
|
-
erp-kit scaffold --modules-root modules command <module-name> <command-name>
|
|
37
|
-
erp-kit scaffold --modules-root modules query <module-name> <query-name>
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
### 3. Populate
|
|
41
|
-
|
|
42
|
-
Fill in the scaffolded docs with details analyzed from Step 1.
|
|
43
|
-
|
|
44
|
-
### 4. Validate
|
|
45
|
-
|
|
46
|
-
Run `pnpm run module:doc:check` and fix any violations.
|
|
47
|
-
|
|
48
|
-
## Schema Quick Reference
|
|
49
|
-
|
|
50
|
-
Schemas are bundled in `@tailor-platform/erp-kit` (model.yml, command.yml).
|
|
51
|
-
|
|
52
|
-
## Common Patterns
|
|
53
|
-
|
|
54
|
-
| Feature Element | Documentation Type |
|
|
55
|
-
| --------------------- | -------------------------------- |
|
|
56
|
-
| Entity with fields | Model doc |
|
|
57
|
-
| State machine | Model doc with State Transitions |
|
|
58
|
-
| Verb in state diagram | Command doc |
|
|
59
|
-
| CRUD operation | Command doc |
|
|
60
|
-
| Validation logic | Command doc Business Rules |
|
|
61
|
-
| Data lookup | Query doc |
|
|
62
|
-
| Unit/currency convert | Query doc |
|
|
63
|
-
| Computed aggregation | Query doc |
|
|
64
|
-
|
|
65
|
-
## Validation
|
|
66
|
-
|
|
67
|
-
Always run before completing:
|
|
68
|
-
|
|
69
|
-
```bash
|
|
70
|
-
pnpm run module:doc:check
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
## References
|
|
74
|
-
|
|
75
|
-
- [Command naming convention](references/naming.md)
|
|
76
|
-
- [Module structure](../erp-kit-module-shared/references/structure.md)
|