cabloy 5.1.111 → 5.1.113

package/vona/src/suite/a-commerce/modules/commerce-siteadmin/src/.metadata/index.ts

@@ -1,4 +1,147 @@
 // eslint-disable
+import type { TypeSymbolKeyFieldsMore } from 'vona-module-a-orm';
+import type { TypeEntityOptionsFields,TypeControllerOptionsActions } from 'vona-module-a-openapi';
+/** service: begin */
+export * from '../service/operator.ts';
+
+import 'vona-module-a-bean';
+declare module 'vona-module-a-bean' {
+  
+    export interface IServiceRecord {
+      'commerce-siteadmin:operator': never;
+    }
+
+  
+}
+declare module 'vona-module-commerce-siteadmin' {
+  
+        export interface ServiceOperator {
+          /** @internal */
+          get scope(): ScopeModuleCommerceSiteadmin;
+        }
+
+          export interface ServiceOperator {
+            get $beanFullName(): 'commerce-siteadmin.service.operator';
+            get $onionName(): 'commerce-siteadmin:operator';
+            
+          } 
+}
+/** service: end */
+/** service: begin */
+import type { ServiceOperator } from '../service/operator.ts';
+export interface IModuleService {
+  'operator': ServiceOperator;
+}
+/** service: end */
+/** service: begin */
+
+import 'vona';
+declare module 'vona' {
+  export interface IBeanRecordGeneral {
+    'commerce-siteadmin.service.operator': ServiceOperator;
+  }
+}
+/** service: end */
+/** meta: begin */
+export * from '../bean/meta.version.ts';
+
+import 'vona-module-a-meta';
+declare module 'vona-module-a-meta' {
+  
+    export interface IMetaRecord {
+      'commerce-siteadmin:version': never;
+    }
+
+  
+}
+declare module 'vona-module-commerce-siteadmin' {
+  
+        export interface MetaVersion {
+          /** @internal */
+          get scope(): ScopeModuleCommerceSiteadmin;
+        }
+
+          export interface MetaVersion {
+            get $beanFullName(): 'commerce-siteadmin.meta.version';
+            get $onionName(): 'commerce-siteadmin:version';
+            
+          } 
+}
+/** meta: end */
+/** dto: begin */
+export * from '../dto/operatorContext.ts';
+import type { IDtoOptionsOperatorContext } from '../dto/operatorContext.ts';
+import 'vona-module-a-web';
+declare module 'vona-module-a-web' {
+  
+    export interface IDtoRecord {
+      'commerce-siteadmin:operatorContext': IDtoOptionsOperatorContext;
+    }
+
+  
+}
+declare module 'vona-module-commerce-siteadmin' {
+   
+}
+/** dto: end */
+/** dto: begin */
+import type { DtoOperatorContext } from '../dto/operatorContext.ts';
+declare module 'vona-module-commerce-siteadmin' {
+  
+    export interface IDtoOptionsOperatorContext {
+      fields?: TypeEntityOptionsFields<DtoOperatorContext, IDtoOptionsOperatorContext[TypeSymbolKeyFieldsMore]>;
+    }
+}
+/** dto: end */
+/** controller: begin */
+export * from '../controller/operator.ts';
+import type { IControllerOptionsOperator } from '../controller/operator.ts';
+import 'vona-module-a-web';
+declare module 'vona-module-a-web' {
+  
+    export interface IControllerRecord {
+      'commerce-siteadmin:operator': IControllerOptionsOperator;
+    }
+
+  
+}
+declare module 'vona-module-commerce-siteadmin' {
+  
+        export interface ControllerOperator {
+          /** @internal */
+          get scope(): ScopeModuleCommerceSiteadmin;
+        }
+
+          export interface ControllerOperator {
+            get $beanFullName(): 'commerce-siteadmin.controller.operator';
+            get $onionName(): 'commerce-siteadmin:operator';
+            get $onionOptions(): IControllerOptionsOperator;
+          } 
+}
+/** controller: end */
+/** controller: begin */
+// @ts-ignore ignore
+import type { ControllerOperator } from '../controller/operator.ts';
+declare module 'vona-module-commerce-siteadmin' {
+  
+    export interface IControllerOptionsOperator {
+      actions?: TypeControllerOptionsActions<ControllerOperator>;
+    }
+}
+declare module 'vona-module-a-web' {
+  export interface IApiPathGetRecord{
+        '/commerce/siteadmin/operator/context': undefined;
+    }
+
+}
+import 'vona-module-a-openapi';
+  declare module 'vona-module-a-openapi' {
+    export interface IResourceRecord {
+      'commerce-siteadmin:operator': never;
+    }
+  }
+  
+/** controller: end */
 /** ssrSite: begin */
 export * from '../bean/ssrSite.commerceAdmin.ts';
 import type { ISsrSiteOptionsCommerceAdmin } from '../bean/ssrSite.commerceAdmin.ts';
@@ -51,8 +194,51 @@ declare module 'vona-module-commerce-siteadmin' {
           } 
 }
 /** ssrMenu: end */
+/** ssrMenuGroup: begin */
+export * from '../bean/ssrMenuGroup.catalog.ts';
+export * from '../bean/ssrMenuGroup.inventory.ts';
+import type { ISsrMenuGroupOptionsCatalog } from '../bean/ssrMenuGroup.catalog.ts';
+import type { ISsrMenuGroupOptionsInventory } from '../bean/ssrMenuGroup.inventory.ts';
+import 'vona-module-a-ssr';
+declare module 'vona-module-a-ssr' {
+  
+    export interface ISsrMenuGroupRecord {
+      'commerce-siteadmin:catalog': ISsrMenuGroupOptionsCatalog;
+'commerce-siteadmin:inventory': ISsrMenuGroupOptionsInventory;
+    }
+
+  
+}
+declare module 'vona-module-commerce-siteadmin' {
+  
+        export interface SsrMenuGroupCatalog {
+          /** @internal */
+          get scope(): ScopeModuleCommerceSiteadmin;
+        }
+
+          export interface SsrMenuGroupCatalog {
+            get $beanFullName(): 'commerce-siteadmin.ssrMenuGroup.catalog';
+            get $onionName(): 'commerce-siteadmin:catalog';
+            get $onionOptions(): ISsrMenuGroupOptionsCatalog;
+          }
+
+        export interface SsrMenuGroupInventory {
+          /** @internal */
+          get scope(): ScopeModuleCommerceSiteadmin;
+        }
+
+          export interface SsrMenuGroupInventory {
+            get $beanFullName(): 'commerce-siteadmin.ssrMenuGroup.inventory';
+            get $onionName(): 'commerce-siteadmin:inventory';
+            get $onionOptions(): ISsrMenuGroupOptionsInventory;
+          } 
+}
+/** ssrMenuGroup: end */
+/** locale: begin */
+import { locales } from './locales.ts';
+/** locale: end */
 /** scope: begin */
-import { BeanScopeBase, type BeanScopeUtil } from 'vona';
+import { BeanScopeBase, type BeanScopeUtil, type TypeModuleLocales, type TypeLocaleBase } from 'vona';
 import { Scope } from 'vona-module-a-bean';
 
 @Scope()
@@ -60,6 +246,8 @@ export class ScopeModuleCommerceSiteadmin extends BeanScopeBase {}
 
 export interface ScopeModuleCommerceSiteadmin {
   util: BeanScopeUtil;
+locale: TypeModuleLocales<(typeof locales)[TypeLocaleBase]>;
+service: IModuleService;
 }
 
 import 'vona';
@@ -74,7 +262,9 @@ declare module 'vona' {
   
   
 
-  
+  export interface IBeanScopeLocale {
+    'commerce-siteadmin': (typeof locales)[TypeLocaleBase];
+  }
 
   
 }

package/vona/src/suite/a-commerce/modules/commerce-siteadmin/src/.metadata/locales.ts

@@ -0,0 +1,18 @@
+import type { TypeLocaleBase } from 'vona';
+
+import { $makeLocaleMagic } from 'vona';
+
+import locale_en_us from '../config/locale/en-us.ts';
+import locale_zh_cn from '../config/locale/zh-cn.ts';
+
+export const locales = {
+  'en-us': locale_en_us,
+  'zh-cn': locale_zh_cn,
+};
+
+export function $locale<K extends keyof (typeof locales)[TypeLocaleBase]>(
+  key: K,
+  ...args: any[]
+): any {
+  return $makeLocaleMagic(`commerce-siteadmin::${key}`, ...args);
+}

package/vona/src/suite/a-commerce/modules/commerce-siteadmin/src/bean/meta.version.ts

@@ -0,0 +1,32 @@
+import type {
+  IMetaVersionInit,
+  IMetaVersionInitOptions,
+  IMetaVersionUpdate,
+  IMetaVersionUpdateOptions,
+} from 'vona-module-a-version';
+
+import { BeanBase } from 'vona';
+import { Meta } from 'vona-module-a-meta';
+
+const roleSiteIds = {
+  registeredUser: ['commerce'],
+  systemAdmin: ['commerce', 'commerceAdmin'],
+};
+
+@Meta()
+export class MetaVersion extends BeanBase implements IMetaVersionUpdate, IMetaVersionInit {
+  async update(_options: IMetaVersionUpdateOptions) {}
+
+  async init(options: IMetaVersionInitOptions) {
+    if (options.version !== 1) return;
+    const modelRole = this.app.scope('home-user').model.role;
+    for (const [roleName, requiredSiteIds] of Object.entries(roleSiteIds)) {
+      const role = await modelRole.getByName(roleName);
+      if (!role) continue;
+
+      const siteIds = [...new Set([...role.siteIds, ...requiredSiteIds])];
+      if (siteIds.length === role.siteIds.length) continue;
+      await modelRole.updateById(role.id, { siteIds });
+    }
+  }
+}

package/vona/src/suite/a-commerce/modules/commerce-siteadmin/src/bean/ssrMenu.home.ts

@@ -6,11 +6,13 @@ import { SsrMenu } from 'vona-module-a-ssr';
 
 import type { ISsrSiteOptionsCommerceAdmin } from './ssrSite.commerceAdmin.ts';
 
+import { $locale } from '../.metadata/locales.ts';
+
 export interface ISsrMenuOptionsHome extends IDecoratorSsrMenuOptions<ISsrSiteOptionsCommerceAdmin> {}
 
 @SsrMenu<ISsrMenuOptionsHome>({
   item: {
-    title: 'Commerce Administration',
+    title: $locale('CommerceAdministration'),
     order: $order(1),
     icon: undefined,
     link: '/',

package/vona/src/suite/a-commerce/modules/commerce-siteadmin/src/bean/ssrMenuGroup.catalog.ts

@@ -0,0 +1,21 @@
+import type { IDecoratorSsrMenuGroupOptions } from 'vona-module-a-ssr';
+
+import { BeanBase } from 'vona';
+import { $order } from 'vona-module-a-openapiutils';
+import { SsrMenuGroup } from 'vona-module-a-ssr';
+
+import type { ISsrSiteOptionsCommerceAdmin } from './ssrSite.commerceAdmin.ts';
+
+import { $locale } from '../.metadata/locales.ts';
+
+export interface ISsrMenuGroupOptionsCatalog extends IDecoratorSsrMenuGroupOptions<ISsrSiteOptionsCommerceAdmin> {}
+
+@SsrMenuGroup<ISsrMenuGroupOptionsCatalog>({
+  item: {
+    title: $locale('Catalog'),
+    order: $order(2),
+    icon: undefined,
+  },
+  site: ['commerce-siteadmin:commerceAdmin'],
+})
+export class SsrMenuGroupCatalog extends BeanBase {}

package/vona/src/suite/a-commerce/modules/commerce-siteadmin/src/bean/ssrMenuGroup.inventory.ts

@@ -0,0 +1,21 @@
+import type { IDecoratorSsrMenuGroupOptions } from 'vona-module-a-ssr';
+
+import { BeanBase } from 'vona';
+import { $order } from 'vona-module-a-openapiutils';
+import { SsrMenuGroup } from 'vona-module-a-ssr';
+
+import type { ISsrSiteOptionsCommerceAdmin } from './ssrSite.commerceAdmin.ts';
+
+import { $locale } from '../.metadata/locales.ts';
+
+export interface ISsrMenuGroupOptionsInventory extends IDecoratorSsrMenuGroupOptions<ISsrSiteOptionsCommerceAdmin> {}
+
+@SsrMenuGroup<ISsrMenuGroupOptionsInventory>({
+  item: {
+    title: $locale('Inventory'),
+    order: $order(3),
+    icon: undefined,
+  },
+  site: ['commerce-siteadmin:commerceAdmin'],
+})
+export class SsrMenuGroupInventory extends BeanBase {}

package/vona/src/suite/a-commerce/modules/commerce-siteadmin/src/config/locale/en-us.ts

@@ -0,0 +1,5 @@
+export default {
+  Catalog: 'Catalog',
+  CommerceAdministration: 'Commerce Administration',
+  Inventory: 'Inventory',
+};

package/vona/src/suite/a-commerce/modules/commerce-siteadmin/src/config/locale/zh-cn.ts

@@ -0,0 +1,5 @@
+export default {
+  Catalog: '商品目录',
+  CommerceAdministration: '商业管理',
+  Inventory: '库存',
+};

package/vona/src/suite/a-commerce/modules/commerce-siteadmin/src/controller/operator.ts

@@ -0,0 +1,21 @@
+import type { IDecoratorControllerOptions } from 'vona-module-a-web';
+
+import { BeanBase } from 'vona';
+import { Api, Resource, v } from 'vona-module-a-openapiutils';
+import { Passport } from 'vona-module-a-user';
+import { Controller, Web } from 'vona-module-a-web';
+
+import { DtoOperatorContext } from '../dto/operatorContext.ts';
+
+export interface IControllerOptionsOperator extends IDecoratorControllerOptions {}
+
+@Controller<IControllerOptionsOperator>('operator')
+@Resource()
+export class ControllerOperator extends BeanBase {
+  @Web.get('context')
+  @Api.body(v.object(DtoOperatorContext))
+  @Passport.systemAdmin()
+  async context(): Promise<DtoOperatorContext> {
+    return this.scope.service.operator.context();
+  }
+}

package/vona/src/suite/a-commerce/modules/commerce-siteadmin/src/dto/operatorContext.ts

@@ -0,0 +1,21 @@
+import type { IDecoratorDtoOptions } from 'vona-module-a-web';
+
+import { Api } from 'vona-module-a-openapiutils';
+import { Dto } from 'vona-module-a-web';
+
+export interface IDtoOptionsOperatorContext extends IDecoratorDtoOptions {}
+
+@Dto<IDtoOptionsOperatorContext>()
+export class DtoOperatorContext {
+  @Api.field()
+  instanceId: string;
+
+  @Api.field()
+  instanceName: string;
+
+  @Api.field()
+  userId: string;
+
+  @Api.field()
+  userName: string;
+}

package/vona/src/suite/a-commerce/modules/commerce-siteadmin/src/index.ts

@@ -1 +1,2 @@
+export * from './.metadata/locales.ts';
 export * from './.metadata/index.ts';

package/vona/src/suite/a-commerce/modules/commerce-siteadmin/src/service/operator.ts

@@ -0,0 +1,18 @@
+import { BeanBase } from 'vona';
+import { Service } from 'vona-module-a-bean';
+
+import type { DtoOperatorContext } from '../dto/operatorContext.ts';
+
+@Service()
+export class ServiceOperator extends BeanBase {
+  context(): DtoOperatorContext {
+    const { instance, instanceName } = this.ctx;
+    const user = this.bean.passport.current!.user!;
+    return {
+      instanceId: instance.id.toString(),
+      instanceName: instanceName ?? '',
+      userId: user.id.toString(),
+      userName: user.name,
+    };
+  }
+}

package/vona/src/suite/a-commerce/modules/commerce-siteadmin/test/meta.version.test.ts

@@ -0,0 +1,44 @@
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
+import { app } from 'vona-mock';
+
+describe('meta.version.test.ts', () => {
+  it('init:version:1 preserves existing grants and appends Commerce site access once', async () => {
+    await app.bean.executor.mockCtx(async () => {
+      const modelRole = app.scope('home-user').model.role;
+      const roleRegisteredUser = await modelRole.getByName('registeredUser');
+      const roleSystemAdmin = await modelRole.getByName('systemAdmin');
+      assert.ok(roleRegisteredUser);
+      assert.ok(roleSystemAdmin);
+      const registeredUserSiteIdsOriginal = roleRegisteredUser.siteIds;
+      const systemAdminSiteIdsOriginal = roleSystemAdmin.siteIds;
+      try {
+        await modelRole.updateById(roleRegisteredUser.id, { siteIds: ['web', 'customSite'] });
+        await modelRole.updateById(roleSystemAdmin.id, {
+          siteIds: ['web', 'admin', 'customSite', 'commerce'],
+        });
+
+        const metaVersion = app.scope('commerce-siteadmin').meta.version;
+        await metaVersion.init({ version: 1 });
+        await metaVersion.init({ version: 1 });
+
+        const registeredUser = await modelRole.getByName('registeredUser');
+        assert.deepEqual(registeredUser?.siteIds, ['web', 'customSite', 'commerce']);
+
+        const systemAdmin = await modelRole.getByName('systemAdmin');
+        assert.deepEqual(systemAdmin?.siteIds, [
+          'web',
+          'admin',
+          'customSite',
+          'commerce',
+          'commerceAdmin',
+        ]);
+      } finally {
+        await modelRole.updateById(roleRegisteredUser.id, {
+          siteIds: registeredUserSiteIdsOriginal,
+        });
+        await modelRole.updateById(roleSystemAdmin.id, { siteIds: systemAdminSiteIdsOriginal });
+      }
+    });
+  });
+});

package/vona/src/suite/a-commerce/modules/commerce-siteadmin/test/operatorAccess.test.ts

@@ -0,0 +1,55 @@
+import { catchError } from '@cabloy/utils';
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
+import { app } from 'vona-mock';
+
+const resourceName = 'commerce-siteadmin:operator';
+const actionName = 'context';
+const actionPath = '/commerce/siteadmin/operator/context';
+
+describe('operatorAccess.test.ts', () => {
+  it('action:operator:context:denies anonymous callers', async () => {
+    await app.bean.executor.mockCtx(async () => {
+      const [_, err] = await catchError(() =>
+        app.bean.executor.performAction('get', actionPath, { innerAccess: false }),
+      );
+      assert.equal(err?.code, 401);
+    });
+  });
+
+  it('action:operator:context:denies non-system administrators', async () => {
+    await app.bean.executor.mockCtx(async () => {
+      await app.bean.passport.signinMock();
+      try {
+        app.bean.passport.current!.roles = [];
+        const [_, err] = await catchError(() =>
+          app.bean.executor.performAction('get', actionPath, { innerAccess: false }),
+        );
+        assert.equal(err?.code, 403);
+        assert.equal(
+          await app.bean.permission.retrievePermissionAction(resourceName, actionName),
+          false,
+        );
+      } finally {
+        await app.bean.passport.signout();
+      }
+    });
+  });
+
+  it('action:operator:context:returns server-derived context to system administrators', async () => {
+    await app.bean.executor.mockCtx(async () => {
+      await app.bean.passport.signinMock();
+      try {
+        const result = await app.bean.executor.performAction('get', actionPath, {
+          innerAccess: false,
+        });
+        assert.equal(result.instanceId, app.ctx.instance.id.toString());
+        assert.equal(result.instanceName, app.ctx.instanceName);
+        assert.equal(result.userId, app.bean.passport.current!.user!.id.toString());
+        assert.equal(result.userName, app.bean.passport.current!.user!.name);
+      } finally {
+        await app.bean.passport.signout();
+      }
+    });
+  });
+});

package/vona/src/suite/a-commerce/modules/commerce-siteadmin/test/ssrMenu.test.ts

@@ -0,0 +1,77 @@
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
+import { app } from 'vona-mock';
+
+const menuNames = [
+  'commerce-catalog:category#category',
+  'commerce-catalog:product#product',
+  'commerce-catalog:sku#sku',
+  'commerce-trade:stockBalance#stockBalance',
+  'commerce-trade:stockAudit#stockAudit',
+];
+
+async function retrieveMenus() {
+  const menus = await app.bean.ssr.retrieveMenus('commerce-admin');
+  assert.ok(menus);
+  return menus;
+}
+
+describe('ssrMenu.test.ts', () => {
+  it('exposes Catalog resource menus only to system administrators', async () => {
+    await app.bean.executor.mockCtx(async () => {
+      const menusAnonymous = await retrieveMenus();
+      for (const menuName of menuNames) {
+        assert.equal(
+          menusAnonymous.menus?.some(menu => menu.name === menuName),
+          false,
+        );
+      }
+
+      try {
+        await app.bean.passport.signinMock('admin');
+        const menusSystemAdmin = await retrieveMenus();
+        const catalog = menusSystemAdmin.groups?.find(
+          group => group.name === 'commerce-siteadmin:catalog',
+        );
+        assert.ok(catalog);
+
+        const menuCategory = menusSystemAdmin.menus?.find(
+          menu => menu.name === 'commerce-catalog:category#category',
+        );
+        assert.equal(menuCategory?.group, catalog.name);
+        assert.equal(menuCategory?.meta?.params?.resource, 'commerce-catalog:category');
+
+        const menuProduct = menusSystemAdmin.menus?.find(
+          menu => menu.name === 'commerce-catalog:product#product',
+        );
+        assert.equal(menuProduct?.group, catalog.name);
+        assert.equal(menuProduct?.meta?.params?.resource, 'commerce-catalog:product');
+
+        const menuSku = menusSystemAdmin.menus?.find(
+          menu => menu.name === 'commerce-catalog:sku#sku',
+        );
+        assert.equal(menuSku?.group, catalog.name);
+        assert.equal(menuSku?.meta?.params?.resource, 'commerce-catalog:sku');
+
+        const inventory = menusSystemAdmin.groups?.find(
+          group => group.name === 'commerce-siteadmin:inventory',
+        );
+        assert.ok(inventory);
+
+        const menuStockBalance = menusSystemAdmin.menus?.find(
+          menu => menu.name === 'commerce-trade:stockBalance#stockBalance',
+        );
+        assert.equal(menuStockBalance?.group, inventory.name);
+        assert.equal(menuStockBalance?.meta?.params?.resource, 'commerce-trade:stockBalance');
+
+        const menuStockAudit = menusSystemAdmin.menus?.find(
+          menu => menu.name === 'commerce-trade:stockAudit#stockAudit',
+        );
+        assert.equal(menuStockAudit?.group, inventory.name);
+        assert.equal(menuStockAudit?.meta?.params?.resource, 'commerce-trade:stockAudit');
+      } finally {
+        await app.bean.passport.signout();
+      }
+    });
+  });
+});

package/vona/src/suite/a-commerce/modules/commerce-trade/package.json

@@ -47,6 +47,7 @@
   "vonaModule": {
     "dependencies": {
       "a-vona": "5.0.0"
-    }
+    },
+    "fileVersion": 1
   }
 }