zova-module-a-openapi 5.0.0 → 5.1.1

package/src/monkey.ts

@@ -0,0 +1,52 @@
+import type { IModule } from '@cabloy/module-info';
+import type { Ref } from 'vue';
+import type { BeanBase, BeanContainer, IMonkeyBeanInit, IMonkeyModule } from 'zova';
+
+import { ref, watch } from 'vue';
+import { BeanSimple } from 'zova';
+
+import type { ModelSdk } from './model/sdk.js';
+
+export class Monkey extends BeanSimple implements IMonkeyModule, IMonkeyBeanInit {
+  private _moduleSelf: IModule;
+  private _modelSdk: Ref<ModelSdk | undefined> = ref();
+
+  constructor(moduleSelf: IModule) {
+    super();
+    this._moduleSelf = moduleSelf;
+  }
+
+  async moduleLoading(_module: IModule) {}
+  async moduleLoaded(module: IModule) {
+    // self
+    if (this._moduleSelf === module) {
+      await this._loadSdk();
+      this.ctx.util.instanceScope(() => {
+        return watch(
+          () => {
+            return this.app.meta.locale.current;
+          },
+          async () => {
+            await this._loadSdk();
+          },
+        );
+      });
+    }
+  }
+
+  async beanInit(bean: BeanContainer, beanInstance: BeanBase) {
+    const self = this;
+    // $sdk
+    bean.defineProperty(beanInstance, '$sdk', {
+      enumerable: false,
+      configurable: true,
+      get() {
+        return self._modelSdk;
+      },
+    });
+  }
+
+  private async _loadSdk() {
+    this._modelSdk.value = await this.app.bean._getBeanSelector('a-openapi.model.sdk', true, this.app.meta.locale.current);
+  }
+}

package/src/types/action.ts

@@ -0,0 +1,26 @@
+import type { BeanBase, ZovaApplication, ZovaContext } from 'zova';
+import type { ZovaJsx } from 'zova-jsx';
+import type { IActionRecord } from 'zova-module-a-action';
+
+export interface IJsxRenderContextBase {
+  app: ZovaApplication;
+  ctx: ZovaContext;
+  $scene?: keyof IJsxRenderSceneRecord;
+  $host: BeanBase;
+  $celScope?: unknown;
+  $jsx: ZovaJsx;
+}
+
+export interface IJsxRenderSceneRecord {
+  pageWrapper: never;
+  page: never;
+  pageEntryWrapper: never;
+  pageEntry: never;
+  // table: never;
+  tableColumn: never;
+  tableCell: never;
+  // form: never;
+  formField: never;
+}
+
+export type TypeActionProvider = keyof IActionRecord;

package/src/types/actions.ts

@@ -0,0 +1,18 @@
+export interface IResourceActionTableOptions {}
+export interface IResourceActionRowOptions {}
+
+export interface TypeResourceActionTableRecord {
+  create: IResourceActionTableOptions;
+  operationsTable: IResourceActionTableOptions;
+}
+
+export interface TypeResourceActionRowRecord {
+  view: IResourceActionRowOptions;
+  update: IResourceActionRowOptions;
+  delete: IResourceActionRowOptions;
+  operationsRow: IResourceActionRowOptions;
+}
+
+export type TypeResourceActionRowRecordRender = {
+  [key in keyof TypeResourceActionRowRecord as `action${Capitalize<key>}`]: TypeResourceActionRowRecord[key];
+};

package/src/types/captcha.ts

@@ -0,0 +1,16 @@
+export interface ICaptchaSceneRecord {
+  'captcha-simple:simple': never;
+}
+
+export interface ICaptchaProviderRecord {}
+
+export interface ICaptchaOptions {
+  scene?: keyof ICaptchaSceneRecord;
+}
+
+export interface ICaptchaData {
+  id: string;
+  provider: keyof ICaptchaProviderRecord | string;
+  token?: unknown;
+  payload?: unknown;
+}

package/src/types/database.ts

@@ -0,0 +1,4 @@
+export const OrderCoreBase = 100;
+export const OrderBusinessBase = 1000;
+export const OrderUnknownBase = 10000;
+export const OrderMaxBase = 100000;

package/src/types/date.ts

@@ -0,0 +1,25 @@
+export type TypeDateFormatPreset =
+  | 'DATE_SHORT'
+  | 'DATE_MED'
+  | 'DATE_MED_WITH_WEEKDAY'
+  | 'DATE_FULL'
+  | 'DATE_HUGE'
+  | 'TIME_SIMPLE'
+  | 'TIME_WITH_SECONDS'
+  | 'TIME_WITH_SHORT_OFFSET'
+  | 'TIME_WITH_LONG_OFFSET'
+  | 'TIME_24_SIMPLE'
+  | 'TIME_24_WITH_SECONDS'
+  | 'TIME_24_WITH_SHORT_OFFSET'
+  | 'TIME_24_WITH_LONG_OFFSET'
+  | 'DATETIME_SHORT'
+  | 'DATETIME_MED'
+  | 'DATETIME_MED_WITH_WEEKDAY'
+  | 'DATETIME_FULL'
+  | 'DATETIME_HUGE'
+  | 'DATETIME_SHORT_WITH_SECONDS'
+  | 'DATETIME_MED_WITH_SECONDS'
+  | 'DATETIME_FULL_WITH_SECONDS'
+  | 'DATETIME_HUGE_WITH_SECONDS';
+
+export type TypeDateFormat = { preset: TypeDateFormatPreset } | string;

package/src/types/index.ts

@@ -0,0 +1,16 @@
+export * from './action.js';
+export * from './actions.js';
+export * from './captcha.js';
+export * from './database.js';
+export * from './date.js';
+export * from './jsx.js';
+export * from './permissions.js';
+export * from './resourceMeta.js';
+export * from './resourcePicker.js';
+export * from './rest.js';
+export * from './schema.js';
+export * from './sdk.js';
+export * from './select.js';
+export * from './table.js';
+export * from './textarea.js';
+export * from './toggle.js';

package/src/types/jsx.ts

@@ -0,0 +1,10 @@
+import type { IActionsRecord } from 'zova-module-a-action';
+
+import type { TypeActionProvider } from './action.js';
+import 'zova-jsx';
+
+declare module 'zova-jsx' {
+  export interface ZovaJsx {
+    normalizeAction(type: keyof IActionsRecord): TypeActionProvider;
+  }
+}

package/src/types/permissions.ts

@@ -0,0 +1,18 @@
+import type { TableIdentity } from 'table-identity';
+
+export interface IOpenapiActionRecord {
+  create: boolean;
+  view: boolean;
+  update: boolean;
+  delete: boolean;
+}
+
+export type IOpenapiPermissionModeActionActions = {
+  [K in keyof IOpenapiActionRecord]?: IOpenapiActionRecord[K];
+};
+
+export interface IOpenapiPermissions {
+  roleIds?: TableIdentity[];
+  roleNames?: string[];
+  actions?: IOpenapiPermissionModeActionActions;
+}

package/src/types/resourceMeta.ts

@@ -0,0 +1,37 @@
+import type { TypeComponentRecordSelectorKeysStrict } from 'zova';
+import type { IActionsRecord } from 'zova-module-a-action';
+
+import type { IOpenapiPermissions } from './permissions.js';
+
+export type TypeOpenApiRestResourceScene = 'table' | 'row';
+
+export type TypeOpenapiPermissions = IOpenapiPermissions | boolean;
+
+export interface IOpenapiOptionsResourceMeta {
+  /**
+   * false: disallow
+   * true: public
+   * undefined: by api
+   * IOpenapiPermissions: specific
+   */
+  permissions?: TypeOpenapiPermissions;
+  provider?: IOpenapiOptionsResourceMetaProvider;
+  form?: IOpenapiOptionsResourceMetaForm;
+  table?: IOpenapiOptionsResourceMetaTable;
+}
+
+export interface IOpenapiOptionsResourceMetaForm {}
+
+export interface IOpenapiOptionsResourceMetaTable {}
+
+export interface IOpenapiOptionsResourceMetaProvider {
+  components?: IOpenapiOptionsResourceMetaProviderComponents;
+  actions?: IActionsRecord;
+}
+
+export interface IOpenapiOptionsResourceMetaProviderComponents {
+  restPage?: TypeComponentRecordSelectorKeysStrict<'restPage'>;
+  restPageEntry?: TypeComponentRecordSelectorKeysStrict<'restPageEntry'>;
+  table?: TypeComponentRecordSelectorKeysStrict<'table'>;
+  form?: TypeComponentRecordSelectorKeysStrict<'form'>;
+}

package/src/types/resourcePicker.ts

@@ -0,0 +1,10 @@
+import type { ISelectOptions } from './select.js';
+import type { ITableQuery } from './table.js';
+
+export interface IResourcePickerOptions {
+  resource?: string;
+  actionPath?: string;
+  query?: ITableQuery;
+  selectOptions?: ISelectOptions;
+  relation?: string;
+}

package/src/types/rest.ts

@@ -0,0 +1,107 @@
+import type { CurrencyOptions } from '@zhennann/currency';
+import type { ComponentPublicInstance } from 'vue';
+import type { Constructable, IComponentRecord, TypeBeanRecordGeneralSelector } from 'zova';
+import type { TypeRenderComponentJsx } from 'zova-jsx';
+
+import type { TypeResourceActionRowRecordRender } from './actions.js';
+import type { ICaptchaOptions } from './captcha.js';
+import type { TypeDateFormat } from './date.js';
+import type { IResourcePickerOptions } from './resourcePicker.js';
+import type { ISelectOptions } from './select.js';
+import type { ITextareaOptions } from './textarea.js';
+import type { IToggleOptions } from './toggle.js';
+import 'openapi3-ts/oas30';
+import 'openapi3-ts/oas31';
+
+export interface ISchemaObjectExtensionFieldRest {
+  render?: TypeFormFieldRenderComponentNormal | TypeTableCellRenderComponentNormal;
+  captcha?: ICaptchaOptions;
+  currency?: CurrencyOptions;
+  dateFormat?: TypeDateFormat;
+  toggle?: IToggleOptions;
+  select?: ISelectOptions;
+  textarea?: ITextareaOptions;
+  resourcePicker?: IResourcePickerOptions;
+  customKey?: string;
+  visible?: boolean;
+  displayValue?: any;
+  order?: number;
+  table?: Omit<ISchemaObjectExtensionFieldRest, TypeSchemaScene>;
+  form?: Omit<ISchemaObjectExtensionFieldRest, TypeSchemaScene>;
+  filter?: Omit<ISchemaObjectExtensionFieldRest, TypeSchemaScene>;
+}
+
+export interface ISchemaObjectExtensionFieldFilterCapabilities {
+  where?: boolean;
+  // filter?: boolean;
+  order?: boolean;
+  // group?: boolean;
+}
+
+export interface ISchemaObjectExtensionFieldFilter {
+  capabilities?: ISchemaObjectExtensionFieldFilterCapabilities;
+}
+
+export interface ISchemaObjectExtensionField {
+  key?: string;
+  rest?: ISchemaObjectExtensionFieldRest;
+  filter?: ISchemaObjectExtensionFieldFilter;
+}
+
+declare module 'openapi3-ts/oas30' {
+  export interface SchemaObject extends ISchemaObjectExtensionField {}
+}
+
+declare module 'openapi3-ts/oas31' {
+  export interface SchemaObject extends ISchemaObjectExtensionField {}
+}
+
+export type TypeSchemaScene = 'table' | 'form' | 'filter';
+export type TypeFormSchemaScene = 'form' | 'filter';
+
+export const renderFormFieldTopPropsSystem = ['order', 'table', 'form', 'filter'];
+export const renderTableColumnTopPropsSystem = ['order', 'table', 'form', 'filter', 'displayValue'];
+
+export type TypeRenderComponentPreset =
+  | keyof TypeResourceActionRowRecordRender
+  | 'text'
+  | 'captcha'
+  | 'currency'
+  | 'date'
+  | 'dateRange'
+  | 'textarea'
+  | 'select'
+  | 'checkbox'
+  | 'radio'
+  | 'switch'
+  | 'image'
+  | 'file'
+  | 'color'
+  | 'password'
+  | 'email'
+  | 'url';
+
+// form
+export type TypeFormFieldRenderComponentNormal = Constructable<ComponentPublicInstance> | keyof IComponentRecord | TypeRenderComponentPreset;
+export type TypeFormFieldRenderComponent = TypeFormFieldRenderComponentNormal | TypeRenderComponentJsx;
+export type TypeFormFieldRenderComponentProvider =
+  | Constructable
+  | Constructable<ComponentPublicInstance>
+  | keyof IComponentRecord
+  | 'input'
+  | 'textarea'
+  | 'select';
+
+// table
+export type TypeTableCellRenderComponentNormal =
+  | Constructable<ComponentPublicInstance>
+  | keyof IComponentRecord
+  | keyof TypeBeanRecordGeneralSelector<'tableCell'>
+  | TypeRenderComponentPreset;
+export type TypeTableCellRenderComponent = TypeTableCellRenderComponentNormal | TypeRenderComponentJsx;
+export type TypeTableCellRenderComponentProvider =
+  | Constructable<ComponentPublicInstance>
+  | keyof IComponentRecord
+  | keyof TypeBeanRecordGeneralSelector<'tableCell'>
+  | 'text';
+export type TypeTableRenderComponentProvider = Constructable<ComponentPublicInstance> | keyof IComponentRecord | TypeRenderComponentJsx;

package/src/types/schema.ts

@@ -0,0 +1,24 @@
+import type { DefaultError, UseQueryReturnType } from '@tanstack/vue-query';
+import type { OpenAPIObject, SchemaObject } from 'openapi3-ts/oas31';
+import type { UnwrapNestedRefs } from 'vue';
+
+import type { IOpenapiSdkItem } from './sdk.js';
+
+export interface IOpenapiSchema {
+  doc: OpenAPIObject;
+  meta?: IOpenapiSchemaMeta;
+}
+
+export interface IOpenapiSchemaMeta {}
+
+export type TypeOpenapiSchemasSdk = UnwrapNestedRefs<UseQueryReturnType<IOpenapiSdkItem, DefaultError>>;
+
+export interface IOpenapiSchemas {
+  sdk: TypeOpenapiSchemasSdk;
+  query?: SchemaObject;
+  filter?: SchemaObject;
+  requestBody?: SchemaObject;
+  responseBody?: SchemaObject;
+  paged?: SchemaObject;
+  row?: SchemaObject;
+}

package/src/types/sdk.ts

@@ -0,0 +1,26 @@
+import type { OperationObject } from 'openapi3-ts/oas31';
+
+import type { ModelSdk } from '../model/sdk.js';
+import type { IOpenapiOptionsResourceMeta } from './resourceMeta.js';
+import type { IOpenapiSchemaMeta } from './schema.js';
+
+export const SymbolOpenapiSchemaName = '__schemaName__';
+
+export interface IOpenapiSdkBootstrap {
+  apiPath: string;
+  resourceMeta: IOpenapiOptionsResourceMeta;
+}
+
+export interface IOpenapiSdkItem {
+  schemas: string[];
+  operationObject: OperationObject;
+  meta?: IOpenapiSchemaMeta;
+}
+
+export type TypeRequestMethod = 'get' | 'post' | 'put' | 'delete' | 'patch' | 'options' | 'head';
+
+declare module 'zova' {
+  export interface BeanBase {
+    $sdk: ModelSdk;
+  }
+}

package/src/types/select.ts

@@ -0,0 +1,16 @@
+export interface ISelectChipsOptions {
+  column?: boolean;
+  filter?: boolean;
+  selectedClass?: string;
+}
+
+export interface ISelectOptions {
+  mode?: 'default' | 'chips';
+  chipsOptions?: ISelectChipsOptions;
+  multiple?: boolean;
+  chips?: boolean;
+  items?: any[];
+  itemTitle?: string;
+  itemValue?: string;
+  itemProps?: string;
+}

package/src/types/table.ts

@@ -0,0 +1,27 @@
+export interface ITablePaged {
+  pageNo: number;
+  pageSize?: number;
+}
+
+export interface ITableQuery {
+  columns?: string[] | undefined;
+  where?:
+    | {
+        [key: string]: unknown;
+      }
+    | undefined;
+  orders?: string | string[][] | undefined;
+  pageNo?: number;
+  pageSize?: number;
+}
+
+export interface ITableRes<Entity = any> extends ITableResPaged {
+  list: Entity[];
+}
+
+export interface ITableResPaged {
+  total: string;
+  pageCount: number;
+  pageSize: number;
+  pageNo: number;
+}

package/src/types/textarea.ts

@@ -0,0 +1,10 @@
+export interface ITextareaOptions {
+  autoGrow?: boolean;
+  maxRows?: number;
+  maxHeight?: number;
+  noResize?: boolean;
+  rows?: number;
+  color?: string;
+  bgColor?: string;
+  counter?: string | number | true;
+}

package/src/types/toggle.ts

@@ -0,0 +1,3 @@
+export interface IToggleOptions {
+  color?: 'primary' | 'secondary' | 'success' | 'info' | 'warning' | 'error';
+}

package/README.md

@@ -1 +0,0 @@
-# @cabloy/set