vona-module-a-openapi 5.0.72 → 5.1.2

package/src/types/rest.ts

@@ -0,0 +1,133 @@
+import type { ZodOpenAPIMetadata } from '@cabloy/zod-to-openapi';
+import type { CurrencyOptions } from '@zhennann/currency';
+import type { ILocaleMagic } from 'vona';
+import type { IOpenapiOptions } from 'vona-module-a-openapiutils';
+import type { z } from 'zod';
+
+import type { TypeResourceActionRowRecordRender } from './actions.ts';
+import type { ICaptchaOptions } from './captcha.ts';
+import type { IComponentRecord, ITableCellComponentRecord } from './component.ts';
+import type { TypeDateFormat } from './date.ts';
+import type { IResourcePickerOptions } from './resourcePicker.ts';
+import type { ISelectOptions } from './select.ts';
+import type { ITextareaOptions } from './textarea.ts';
+import type { IToggleOptions } from './toggle.ts';
+import 'openapi3-ts/oas30';
+import 'openapi3-ts/oas31';
+
+export type HTMLInputElementType = 'text' | 'password' | 'number' | 'file' | 'hidden' | 'tel' | 'email';
+
+export type TypeFormFieldOnSetDisplayValue = (value: any) => any;
+export type TypeFormFieldDisplayValueUpdateTiming = 'input' | 'change';
+
+export interface ISchemaObjectExtensionFieldRestProps {
+  customKey?: string;
+  visible?: boolean;
+  order?: number;
+  //
+  classContainer?: any;
+  label?: string | false;
+  inline?: boolean;
+  bordered?: boolean;
+  floating?: boolean;
+  iconPrefix?: string;
+  iconSuffix?: string;
+  header?: TypeRenderComponentJsx | string;
+  footer?: TypeRenderComponentJsx | string;
+  //
+  displayValue?: any;
+  displayValueUpdateTiming?: TypeFormFieldDisplayValueUpdateTiming;
+  onSetDisplayValue?: TypeFormFieldOnSetDisplayValue;
+  disableNotifyChanged?: boolean;
+  class?: any;
+  placeholder?: string;
+  readonly?: boolean;
+  inputType?: HTMLInputElementType;
+  //
+  captcha?: ICaptchaOptions;
+  currency?: CurrencyOptions;
+  dateFormat?: TypeDateFormat;
+  toggle?: IToggleOptions;
+  select?: ISelectOptions;
+  textarea?: ITextareaOptions;
+  resourcePicker?: IResourcePickerOptions;
+}
+
+export interface ISchemaObjectExtensionFieldRest extends ISchemaObjectExtensionFieldRestProps {
+  render?: TypeRenderComponentPreset;
+  table?: ISchemaObjectExtensionFieldRestScene;
+  form?: ISchemaObjectExtensionFieldRestScene;
+  filter?: ISchemaObjectExtensionFieldRestScene;
+}
+
+export interface ISchemaObjectExtensionFieldRestScene extends ISchemaObjectExtensionFieldRestProps {
+  render?: TypeRenderComponent;
+}
+
+export interface ISchemaObjectExtensionField {
+  rest?: ISchemaObjectExtensionFieldRest;
+}
+
+declare module 'openapi3-ts/oas30' {
+  export interface SchemaObject extends ISchemaObjectExtensionField {}
+}
+
+declare module 'openapi3-ts/oas31' {
+  export interface SchemaObject extends ISchemaObjectExtensionField {}
+}
+
+export interface TypeRenderComponentJsxProps {
+  'children': TypeRenderComponentJsx | TypeRenderComponentJsx[];
+  'v-if'?: string | boolean;
+  'v-for'?: string | any[];
+  'v-each'?: string;
+  'v-slot'?: string;
+  'v-slot-scope'?: string;
+}
+
+export interface TypeRenderComponentJsx {
+  type: string;
+  key?: string | null;
+  props?: TypeRenderComponentJsxProps;
+}
+
+export type TypeSchemaScene = 'table' | 'form' | 'filter';
+
+export type TypeRenderComponentPreset =
+  | keyof TypeResourceActionRowRecordRender
+  | 'text'
+  | 'captcha'
+  | 'currency'
+  | 'date'
+  | 'dateRange'
+  | 'textarea'
+  | 'select'
+  | 'checkbox'
+  | 'radio'
+  | 'switch'
+  | 'image'
+  | 'file'
+  | 'color'
+  | 'password'
+  | 'email'
+  | 'url';
+export type TypeRenderComponent = TypeRenderComponentPreset | TypeRenderComponentJsx;
+
+// form
+export type TypeFormFieldRenderComponentProvider = keyof IComponentRecord | 'input' | 'textarea' | 'select';
+
+// table
+export type TypeTableCellRenderComponentProvider = keyof IComponentRecord | keyof ITableCellComponentRecord | 'text';
+
+export type TypeOpenapiMetadata<T extends z.ZodType = z.ZodType> = Omit<Partial<ZodOpenAPIMetadata<z.input<T>>>, 'title' | 'description'> & {
+  title?: string | ILocaleMagic;
+  description?: string | ILocaleMagic;
+};
+
+export type TypeEntityOptionsFields<T extends {}, More extends string | undefined = never> = {
+  [key in keyof T | (More extends string ? More : never)]?: TypeOpenapiMetadata | z.ZodType;
+};
+
+export type TypeControllerOptionsActions<T extends {}> = {
+  [key in keyof T]?: IOpenapiOptions;
+};

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/tableProvider.ts

@@ -0,0 +1,10 @@
+import type { TypeTableCellRenderComponentProvider } from './rest.ts';
+
+export interface ITableProviderComponents {
+  actionView?: TypeTableCellRenderComponentProvider;
+  currency?: TypeTableCellRenderComponentProvider;
+}
+
+export interface ITableProvider {
+  components?: ITableProviderComponents;
+}

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';
+}