@tachybase/module-ui-schema 0.23.8

package/dist/swagger/index.d.ts

@@ -0,0 +1,326 @@
+declare const _default: {
+    openapi: string;
+    info: {
+        title: string;
+    };
+    tags: any[];
+    paths: {
+        '/uiSchemas:getJsonSchema/{uid}': {
+            get: {
+                tags: string[];
+                description: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/uiSchemas:getProperties/{uid}': {
+            get: {
+                tags: string[];
+                description: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: string;
+                                    properties: {
+                                        type: {
+                                            type: string;
+                                        };
+                                        properties: {
+                                            type: string;
+                                            additionalProperties: {
+                                                $ref: string;
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/uiSchemas:insert': {
+            post: {
+                tags: string[];
+                description: string;
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/uiSchemas:remove/{uid}': {
+            post: {
+                tags: string[];
+                description: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                responses: {
+                    '200': {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/uiSchemas:patch': {
+            post: {
+                tags: string[];
+                description: string;
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    '200': {
+                        description: string;
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        '/uiSchemas:batchPatch': {
+            post: {
+                tags: string[];
+                description: string;
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: string;
+                                items: {
+                                    $ref: string;
+                                };
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    '200': {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/uiSchemas:clearAncestor/{uid}': {
+            post: {
+                tags: string[];
+                description: string;
+                parameters: {
+                    $ref: string;
+                }[];
+                responses: {
+                    '200': {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/uiSchemas:insertAdjacent/{uid}': {
+            post: {
+                tags: string[];
+                description: string;
+                parameters: ({
+                    $ref: string;
+                    name?: undefined;
+                    in?: undefined;
+                    required?: undefined;
+                    description?: undefined;
+                    schema?: undefined;
+                } | {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    description: string;
+                    schema: {
+                        type: string;
+                        enum: string[];
+                    };
+                    $ref?: undefined;
+                })[];
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: string;
+                                properties: {
+                                    schema: {
+                                        $ref: string;
+                                    };
+                                    wrap: {
+                                        $ref: string;
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    '200': {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/uiSchemas:saveAsTemplate': {
+            post: {
+                tags: string[];
+                description: string;
+                parameters: {
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    description: string;
+                    schema: {
+                        type: string;
+                    };
+                }[];
+                requestBody: {
+                    required: boolean;
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: string;
+                                properties: {
+                                    key: {
+                                        type: string;
+                                    };
+                                    collectionName: {
+                                        type: string;
+                                    };
+                                    componentName: {
+                                        type: string;
+                                    };
+                                    name: {
+                                        type: string;
+                                        description: string;
+                                    };
+                                    resourceName: {
+                                        type: string;
+                                        description: string;
+                                    };
+                                    uid: {
+                                        type: string;
+                                        description: string;
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    '200': {
+                        description: string;
+                    };
+                };
+            };
+        };
+    };
+    components: {
+        parameters: {
+            uid: {
+                name: string;
+                in: string;
+                required: boolean;
+                description: string;
+                schema: {
+                    type: string;
+                };
+            };
+        };
+        schemas: {
+            uiSchema: {
+                type: string;
+                properties: {
+                    type: {
+                        type: string;
+                        example: string;
+                    };
+                    title: {
+                        type: string;
+                        example: string;
+                        description: string;
+                    };
+                    'x-uid': {
+                        type: string;
+                        example: string;
+                        description: string;
+                    };
+                    'x-index': {
+                        type: string;
+                        exmaple: number;
+                        description: string;
+                    };
+                    'x-async': {
+                        type: string;
+                        example: boolean;
+                        description: string;
+                    };
+                    name: {
+                        type: string;
+                        name: string;
+                        description: string;
+                    };
+                    properties: {
+                        type: string;
+                        additionalProperties: {
+                            $ref: string;
+                        };
+                    };
+                };
+            };
+        };
+    };
+};
+export default _default;

package/dist/swagger/index.js

@@ -0,0 +1,354 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var swagger_exports = {};
+__export(swagger_exports, {
+  default: () => swagger_default
+});
+module.exports = __toCommonJS(swagger_exports);
+var swagger_default = {
+  openapi: "3.0.2",
+  info: {
+    title: "TachyBase API - UI schema storage plugin"
+  },
+  tags: [],
+  paths: {
+    "/uiSchemas:getJsonSchema/{uid}": {
+      get: {
+        tags: ["uiSchemas"],
+        description: "",
+        parameters: [
+          {
+            $ref: "#/components/parameters/uid"
+          }
+        ],
+        responses: {
+          "200": {
+            description: "OK",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/uiSchema"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/uiSchemas:getProperties/{uid}": {
+      get: {
+        tags: ["uiSchemas"],
+        description: "\u83B7\u53D6ui schema\u7684properties\u5C5E\u6027",
+        parameters: [
+          {
+            $ref: "#/components/parameters/uid"
+          }
+        ],
+        responses: {
+          "200": {
+            description: "OK",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "object",
+                  properties: {
+                    type: {
+                      type: "string"
+                    },
+                    properties: {
+                      type: "object",
+                      additionalProperties: {
+                        $ref: "#/components/schemas/uiSchema"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/uiSchemas:insert": {
+      post: {
+        tags: ["uiSchemas"],
+        description: "insert ui schema as root node",
+        requestBody: {
+          required: true,
+          content: {
+            "application/json": {
+              schema: {
+                $ref: "#/components/schemas/uiSchema"
+              }
+            }
+          }
+        },
+        responses: {
+          "200": {
+            description: "OK",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/uiSchema"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/uiSchemas:remove/{uid}": {
+      post: {
+        tags: ["uiSchemas"],
+        description: "remove an ui schema node by uid",
+        parameters: [
+          {
+            $ref: "#/components/parameters/uid"
+          }
+        ],
+        responses: {
+          "200": {
+            description: "OK"
+          }
+        }
+      }
+    },
+    "/uiSchemas:patch": {
+      post: {
+        tags: ["uiSchemas"],
+        description: "update an ui schema node by an new ui schema",
+        requestBody: {
+          required: true,
+          content: {
+            "application/json": {
+              schema: {
+                $ref: "#/components/schemas/uiSchema"
+              }
+            }
+          }
+        },
+        responses: {
+          "200": {
+            description: "OK",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/uiSchema"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/uiSchemas:batchPatch": {
+      post: {
+        tags: ["uiSchemas"],
+        description: "batch update ui schema nodes by an new ui schema item",
+        requestBody: {
+          required: true,
+          content: {
+            "application/json": {
+              schema: {
+                type: "array",
+                items: {
+                  $ref: "#/components/schemas/uiSchema"
+                }
+              }
+            }
+          }
+        },
+        responses: {
+          "200": {
+            description: "OK"
+          }
+        }
+      }
+    },
+    "/uiSchemas:clearAncestor/{uid}": {
+      post: {
+        tags: ["uiSchemas"],
+        description: "Removes all ancestors of a given node",
+        parameters: [
+          {
+            $ref: "#/components/parameters/uid"
+          }
+        ],
+        responses: {
+          "200": {
+            description: "OK"
+          }
+        }
+      }
+    },
+    "/uiSchemas:insertAdjacent/{uid}": {
+      post: {
+        tags: ["uiSchemas"],
+        description: "insert a node adjacent to another node",
+        parameters: [
+          {
+            $ref: "#/components/parameters/uid"
+          },
+          {
+            name: "position",
+            in: "query",
+            required: true,
+            description: "position",
+            schema: {
+              type: "string",
+              enum: ["beforeBegin", "afterBegin", "beforeEnd", "afterEnd"]
+            }
+          }
+        ],
+        requestBody: {
+          required: true,
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                properties: {
+                  schema: {
+                    $ref: "#/components/schemas/uiSchema"
+                  },
+                  wrap: {
+                    $ref: "#/components/schemas/uiSchema"
+                  }
+                }
+              }
+            }
+          }
+        },
+        responses: {
+          "200": {
+            description: "OK"
+          }
+        }
+      }
+    },
+    "/uiSchemas:saveAsTemplate": {
+      post: {
+        tags: ["uiSchemas"],
+        description: "save an ui schema as template",
+        parameters: [
+          {
+            name: "filterByTk",
+            in: "query",
+            required: true,
+            description: "filterByTk",
+            schema: {
+              type: "string"
+            }
+          }
+        ],
+        requestBody: {
+          required: true,
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                properties: {
+                  key: {
+                    type: "string"
+                  },
+                  collectionName: {
+                    type: "string"
+                  },
+                  componentName: {
+                    type: "string"
+                  },
+                  name: {
+                    type: "string",
+                    description: "template's name"
+                  },
+                  resourceName: {
+                    type: "string",
+                    description: "template's resourceName"
+                  },
+                  uid: {
+                    type: "string",
+                    description: "ui schema id"
+                  }
+                }
+              }
+            }
+          }
+        },
+        responses: {
+          "200": {
+            description: "OK"
+          }
+        }
+      }
+    }
+  },
+  components: {
+    parameters: {
+      uid: {
+        name: "uid",
+        in: "path",
+        required: true,
+        description: "x-uid",
+        schema: {
+          type: "string"
+        }
+      }
+    },
+    schemas: {
+      uiSchema: {
+        type: "object",
+        properties: {
+          type: {
+            type: "string",
+            example: "void"
+          },
+          title: {
+            type: "string",
+            example: '{{ t("Actions") }}',
+            description: "ui schema's title"
+          },
+          "x-uid": {
+            type: "string",
+            example: "ygdvvfnw3h8",
+            description: "unique id of ui schema node"
+          },
+          "x-index": {
+            type: "integer",
+            exmaple: 1,
+            description: "ui schema's order index"
+          },
+          "x-async": {
+            type: "boolean",
+            example: false,
+            description: "async or not"
+          },
+          name: {
+            type: "string",
+            name: "2qakvs173rs",
+            description: "ui schema's name"
+          },
+          properties: {
+            type: "object",
+            additionalProperties: {
+              $ref: "#/components/schemas/uiSchema"
+            }
+          }
+        }
+      }
+    }
+  }
+};

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@tachybase/module-ui-schema",
+  "displayName": "UI schema storage",
+  "version": "0.23.8",
+  "description": "Provides centralized UI schema storage service.",
+  "keywords": [
+    "System & security"
+  ],
+  "license": "Apache-2.0",
+  "main": "./dist/server/index.js",
+  "devDependencies": {
+    "lodash": "4.17.21",
+    "sequelize": "6.37.5"
+  },
+  "peerDependencies": {
+    "@tachybase/actions": "0.23.8",
+    "@tachybase/database": "0.23.8",
+    "@tachybase/client": "0.23.8",
+    "@tachybase/cache": "0.23.8",
+    "@tachybase/server": "0.23.8",
+    "@tachybase/test": "0.23.8",
+    "@tachybase/resourcer": "0.23.8",
+    "@tachybase/utils": "0.23.8",
+    "@tachybase/module-user": "0.23.8",
+    "@tachybase/module-error-handler": "0.23.8"
+  },
+  "description.zh-CN": "提供中心化的 UI schema 存储服务。",
+  "displayName.zh-CN": "UI schema 存储服务",
+  "scripts": {
+    "build": "tachybase-build --no-dts @tachybase/module-ui-schema"
+  }
+}

package/server.d.ts

@@ -0,0 +1,2 @@
+export * from './dist/server';
+export { default } from './dist/server';