@ruiapp/rapid-core 0.1.63 → 0.1.66

package/dist/plugins/setting/SettingPlugin.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Setting plugin
+ */
+import { RpdApplicationConfig } from "../../types";
+import { IRpdServer, RapidPlugin, RpdConfigurationItemOptions, RpdServerPluginConfigurableTargetOptions, RpdServerPluginExtendingAbilities } from "../../core/server";
+import SettingService from "./SettingService";
+declare class SettingPlugin implements RapidPlugin {
+    #private;
+    get settingService(): SettingService;
+    get code(): string;
+    get description(): string;
+    get extendingAbilities(): RpdServerPluginExtendingAbilities[];
+    get configurableTargets(): RpdServerPluginConfigurableTargetOptions[];
+    get configurations(): RpdConfigurationItemOptions[];
+    registerActionHandlers(server: IRpdServer): Promise<any>;
+    configureModels(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any>;
+    configureServices(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any>;
+    configureRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any>;
+    onApplicationLoaded(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<void>;
+}
+export default SettingPlugin;

package/dist/plugins/setting/SettingPluginTypes.d.ts

@@ -0,0 +1,33 @@
+export type SettingGroupSetting = {
+    code: string;
+    name: string;
+    description?: string;
+    permissionAssignments?: PermissionAssignment[];
+};
+export type SettingItemSetting = {
+    group: SettingGroupSetting;
+    orderNum: number;
+    type: string;
+    code: string;
+    name: string;
+    description?: string;
+    config?: any;
+};
+export type SystemSettingItem = {
+    id: number;
+    groupCode: string;
+    itemCode: string;
+    value: any;
+};
+export type UserSettingItem = {
+    id: number;
+    ownerId: number;
+    groupCode: string;
+    itemCode: string;
+    value: any;
+};
+export type PermissionAssignment = {
+    assigneeType: string;
+    assigneeId: number;
+    actions: string[];
+};

package/dist/plugins/setting/SettingService.d.ts

@@ -0,0 +1,22 @@
+import { IRpdServer } from "../../core/server";
+import { SystemSettingItem, UserSettingItem } from "./SettingPluginTypes";
+export interface GetSystemSettingValuesInput {
+    groupCode: string;
+}
+export interface GetUserSettingValuesInput {
+    groupCode: string;
+}
+export default class SettingService {
+    #private;
+    constructor(server: IRpdServer);
+    getSystemSettingItems(groupCode: string): Promise<SystemSettingItem[]>;
+    getSystemSettingValues(groupCode: string): Promise<Record<string, any>>;
+    getSystemSettingValue(groupCode: string, itemCode: string): Promise<any>;
+    setSystemSettingValue(groupCode: string, itemCode: string, value: any): Promise<void>;
+    setSystemSettingValues(groupCode: string, settingValues: Record<string, any>): Promise<void>;
+    getUserSettingItems(ownerId: number, groupCode: string): Promise<UserSettingItem[]>;
+    getUserSettingValues(ownerId: number, groupCode: string): Promise<Record<string, any>>;
+    getUserSettingValue(ownerId: number, groupCode: string, itemCode: string): Promise<any>;
+    setUserSettingValue(ownerId: number, groupCode: string, itemCode: string, value: any): Promise<void>;
+    setUserSettingValues(ownerId: number, groupCode: string, settingValues: Record<string, any>): Promise<void>;
+}

package/dist/plugins/setting/actionHandlers/getSystemSettingValues.d.ts

@@ -0,0 +1,7 @@
+import { ActionHandlerContext } from "../../../core/actionHandler";
+import { RapidPlugin } from "../../../core/server";
+export interface GetSystemSettingValuesOptions {
+    groupCode: string;
+}
+export declare const code = "getSystemSettingValues";
+export declare function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: GetSystemSettingValuesOptions): Promise<void>;

package/dist/plugins/setting/actionHandlers/getUserSettingValues.d.ts

@@ -0,0 +1,7 @@
+import { ActionHandlerContext } from "../../../core/actionHandler";
+import { RapidPlugin } from "../../../core/server";
+export interface GetUserSettingValuesOptions {
+    groupCode: string;
+}
+export declare const code = "getUserSettingValues";
+export declare function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: GetUserSettingValuesOptions): Promise<void>;

package/dist/plugins/setting/actionHandlers/index.d.ts

@@ -0,0 +1,4 @@
+import * as getUserSettingValues from "./getUserSettingValues";
+import * as getSystemSettingValues from "./getSystemSettingValues";
+declare const _default: (typeof getUserSettingValues | typeof getSystemSettingValues)[];
+export default _default;

package/dist/plugins/setting/models/SystemSettingGroupSetting.d.ts

@@ -0,0 +1,3 @@
+import { RpdDataModel } from "../../../types";
+declare const _default: RpdDataModel;
+export default _default;

package/dist/plugins/setting/models/SystemSettingItem.d.ts

@@ -0,0 +1,3 @@
+import { RpdDataModel } from "../../../types";
+declare const _default: RpdDataModel;
+export default _default;

package/dist/plugins/setting/models/SystemSettingItemSetting.d.ts

@@ -0,0 +1,3 @@
+import { RpdDataModel } from "../../../types";
+declare const _default: RpdDataModel;
+export default _default;

package/dist/plugins/setting/models/UserSettingGroupSetting.d.ts

@@ -0,0 +1,3 @@
+import { RpdDataModel } from "../../../types";
+declare const _default: RpdDataModel;
+export default _default;

package/dist/plugins/setting/models/UserSettingItem.d.ts

@@ -0,0 +1,3 @@
+import { RpdDataModel } from "../../../types";
+declare const _default: RpdDataModel;
+export default _default;

package/dist/plugins/setting/models/UserSettingItemSetting.d.ts

@@ -0,0 +1,3 @@
+import { RpdDataModel } from "../../../types";
+declare const _default: RpdDataModel;
+export default _default;

package/dist/plugins/setting/models/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("../../..").RpdDataModel[];
+export default _default;

package/dist/plugins/setting/routes/getSystemSettingValues.d.ts

@@ -0,0 +1,12 @@
+declare const _default: {
+    namespace: string;
+    name: string;
+    code: string;
+    type: "RESTful";
+    method: "GET";
+    endpoint: string;
+    actions: {
+        code: string;
+    }[];
+};
+export default _default;

package/dist/plugins/setting/routes/getUserSettingValues.d.ts

@@ -0,0 +1,12 @@
+declare const _default: {
+    namespace: string;
+    name: string;
+    code: string;
+    type: "RESTful";
+    method: "GET";
+    endpoint: string;
+    actions: {
+        code: string;
+    }[];
+};
+export default _default;

package/dist/plugins/setting/routes/index.d.ts

@@ -0,0 +1,12 @@
+declare const _default: {
+    namespace: string;
+    name: string;
+    code: string;
+    type: "RESTful";
+    method: "POST";
+    endpoint: string;
+    actions: {
+        code: string;
+    }[];
+}[];
+export default _default;

package/dist/types.d.ts

@@ -175,6 +175,10 @@ export interface RpdDataModel {
      * Configure the property code to save derived type for base entity.
      */
     derivedTypePropertyCode?: string;
+    /**
+     * Configure the property code used to display the entity.
+     */
+    displayPropertyCode?: string;
     properties: RpdDataModelProperty[];
     extensions?: RpdDataModelExtension[];
     permissionPolicies?: RpdDataModelPermissionPolicies;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruiapp/rapid-core",
-  "version": "0.1.63",
+  "version": "0.1.66",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/rollup.config.js

@@ -1,16 +1,16 @@
-import typescript from "rollup-plugin-typescript2";
-import tscAlias from "rollup-plugin-tsc-alias";
-
-export default {
-  input: ["src/index.ts"],
-  output: [
-    {
-      dir: "dist",
-      entryFileNames: "[name].js",
-      format: "cjs",
-      exports: "named",
-    },
-  ],
-  plugins: [typescript(), tscAlias()],
-  external: [],
-};
+import typescript from "rollup-plugin-typescript2";
+import tscAlias from "rollup-plugin-tsc-alias";
+
+export default {
+  input: ["src/index.ts"],
+  output: [
+    {
+      dir: "dist",
+      entryFileNames: "[name].js",
+      format: "cjs",
+      exports: "named",
+    },
+  ],
+  plugins: [typescript(), tscAlias()],
+  external: [],
+};