@firela/api-types 0.0.0-canary.d484b9ac → 0.0.0-canary.d7b4245a

package/dist/index.d.mts

@@ -3157,6 +3157,10 @@ type CategoryCatalogEntryDto = {
      * Applicable regions ('*' = all, 'cn' = CN-only)
      */
     regions: Array<string>;
+    /**
+     * Beancount account paths (categoryAccount) of the region-enabled system rules whose categoryKeywords include this slug (#816). System rules only (public endpoint — user rules excluded); one-to-many by design (e.g. 'utilities' → Electricity/Water/Internet/Gas), sorted, [] when no rule maps the slug.
+     */
+    categoryAccounts: Array<string>;
 };
 /**
  * Display scenario group (maps to frontend picker _scenario)
@@ -3789,7 +3793,7 @@ type ClientParsedDataDto = {
      */
     narration?: string;
     /**
-     * Category slug
+     * Category in canonical form (catalog slug or Stage-2 rule keyword token, ADR-0116) — echo back verbatim from parsedData.category. Foreign forms (locale display names, account paths) are rejected with nlp.category.invalid.
      */
     category?: string;
     /**
@@ -3931,7 +3935,7 @@ type NlpParsedDataDto = {
      */
     narration?: string;
     /**
-     * Category
+     * Category in canonical form: a CATEGORY_CATALOG slug (GET /{region}/bean/categories) or a Stage-2 rule categoryKeywords token (ADR-0116 D2). Never a locale display name or a beancount account path. Echo back verbatim on confirm.
      */
     category?: string;
     /**

package/dist/index.d.ts

@@ -3157,6 +3157,10 @@ type CategoryCatalogEntryDto = {
      * Applicable regions ('*' = all, 'cn' = CN-only)
      */
     regions: Array<string>;
+    /**
+     * Beancount account paths (categoryAccount) of the region-enabled system rules whose categoryKeywords include this slug (#816). System rules only (public endpoint — user rules excluded); one-to-many by design (e.g. 'utilities' → Electricity/Water/Internet/Gas), sorted, [] when no rule maps the slug.
+     */
+    categoryAccounts: Array<string>;
 };
 /**
  * Display scenario group (maps to frontend picker _scenario)
@@ -3789,7 +3793,7 @@ type ClientParsedDataDto = {
      */
     narration?: string;
     /**
-     * Category slug
+     * Category in canonical form (catalog slug or Stage-2 rule keyword token, ADR-0116) — echo back verbatim from parsedData.category. Foreign forms (locale display names, account paths) are rejected with nlp.category.invalid.
      */
     category?: string;
     /**
@@ -3931,7 +3935,7 @@ type NlpParsedDataDto = {
      */
     narration?: string;
     /**
-     * Category
+     * Category in canonical form: a CATEGORY_CATALOG slug (GET /{region}/bean/categories) or a Stage-2 rule categoryKeywords token (ADR-0116 D2). Never a locale display name or a beancount account path. Echo back verbatim on confirm.
      */
     category?: string;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firela/api-types",
-  "version": "0.0.0-canary.d484b9ac",
+  "version": "0.0.0-canary.d7b4245a",
   "description": "TypeScript types generated from IGN OpenAPI specification",
   "license": "MIT",
   "author": "FireLa Team",

package/src/generated/schemas.gen.ts

@@ -5230,9 +5230,23 @@ export const $CategoryCatalogEntryDto = {
       items: {
         type: 'string'
       }
+    },
+    categoryAccounts: {
+      description:
+        "Beancount account paths (categoryAccount) of the region-enabled system rules whose categoryKeywords include this slug (#816). System rules only (public endpoint — user rules excluded); one-to-many by design (e.g. 'utilities' → Electricity/Water/Internet/Gas), sorted, [] when no rule maps the slug.",
+      example: [
+        'Expenses:Utilities:Electricity',
+        'Expenses:Utilities:Gas',
+        'Expenses:Utilities:Internet',
+        'Expenses:Utilities:Water'
+      ],
+      type: 'array',
+      items: {
+        type: 'string'
+      }
     }
   },
-  required: ['slug', 'scenario', 'icon', 'regions']
+  required: ['slug', 'scenario', 'icon', 'regions', 'categoryAccounts']
 } as const;
 
 export const $CategoryCatalogListResponseDto = {
@@ -6351,8 +6365,9 @@ export const $ClientParsedDataDto = {
     },
     category: {
       type: 'string',
-      description: 'Category slug',
-      example: 'food_restaurant'
+      description:
+        'Category in canonical form (catalog slug or Stage-2 rule keyword token, ADR-0116) — echo back verbatim from parsedData.category. Foreign forms (locale display names, account paths) are rejected with nlp.category.invalid.',
+      example: 'food'
     },
     incomeType: {
       type: 'string',
@@ -6538,7 +6553,9 @@ export const $NlpParsedDataDto = {
     },
     category: {
       type: 'string',
-      description: 'Category'
+      description:
+        'Category in canonical form: a CATEGORY_CATALOG slug (GET /{region}/bean/categories) or a Stage-2 rule categoryKeywords token (ADR-0116 D2). Never a locale display name or a beancount account path. Echo back verbatim on confirm.',
+      example: 'food'
     },
     incomeType: {
       type: 'string',

package/src/generated/services.gen.ts

@@ -2867,7 +2867,7 @@ export class BeanTransactionRulesService {
 export class BeanCategoryCatalogService {
   /**
    * List category catalog for a region
-   * Returns the region-scoped category slugs (expense/income/investment/banking/transfer/payment) for the NLP result picker. CN-exclusive payment instruments (huabei/baitiao) appear only under /cn.
+   * Returns the region-scoped category slugs (expense/income/investment/banking/transfer/payment) for the NLP result picker, each with the categoryAccount paths the region-enabled system rules map it to (#816). CN-exclusive payment instruments (huabei/baitiao) appear only under /cn.
    * @param data The data for the request.
    * @param data.region Region code for tenant context
    * @param data.scenario Filter by scenario

package/src/generated/types.gen.ts

@@ -3644,6 +3644,10 @@ export type CategoryCatalogEntryDto = {
    * Applicable regions ('*' = all, 'cn' = CN-only)
    */
   regions: Array<string>;
+  /**
+   * Beancount account paths (categoryAccount) of the region-enabled system rules whose categoryKeywords include this slug (#816). System rules only (public endpoint — user rules excluded); one-to-many by design (e.g. 'utilities' → Electricity/Water/Internet/Gas), sorted, [] when no rule maps the slug.
+   */
+  categoryAccounts: Array<string>;
 };
 
 /**
@@ -4379,7 +4383,7 @@ export type ClientParsedDataDto = {
    */
   narration?: string;
   /**
-   * Category slug
+   * Category in canonical form (catalog slug or Stage-2 rule keyword token, ADR-0116) — echo back verbatim from parsedData.category. Foreign forms (locale display names, account paths) are rejected with nlp.category.invalid.
    */
   category?: string;
   /**
@@ -4527,7 +4531,7 @@ export type NlpParsedDataDto = {
    */
   narration?: string;
   /**
-   * Category
+   * Category in canonical form: a CATEGORY_CATALOG slug (GET /{region}/bean/categories) or a Stage-2 rule categoryKeywords token (ADR-0116 D2). Never a locale display name or a beancount account path. Echo back verbatim on confirm.
    */
   category?: string;
   /**