From 3b5b732a1a90df1357fa543eb1fbf0d4f22ecbee Mon Sep 17 00:00:00 2001 From: chenos Date: Fri, 10 Nov 2023 11:32:03 +0800 Subject: [PATCH] feat: plugin-mock-collections (#2988) * feat: plugin-mock-collections * fix: mock bug * feat: field interfaces * fix: field interface * fix: formula * fix: file collection * fix: map * refactor: change api path from :create to :mock * fix: avoid test failed * chore: remove useless code * fix: mock records * fix: association * feat: custom data * fix: mockAttachment * fix: count --------- Co-authored-by: Rain <958414905@qq.com> --- .env.e2e.example | 3 + .../client/src/__tests__/e2e/menu.test.ts | 1 + packages/core/database/src/repository.ts | 25 +- packages/core/test/src/client/e2eUtils.ts | 17 +- .../plugin-mock-collections/.npmignore | 2 + .../@nocobase/plugin-mock-collections/LICENSE | 661 ++++++++++++++++++ .../plugin-mock-collections/README.md | 0 .../plugin-mock-collections/README.zh-CN.md | 0 .../plugin-mock-collections/client.d.ts | 2 + .../plugin-mock-collections/client.js | 1 + .../plugin-mock-collections/package.json | 20 + .../plugin-mock-collections/server.d.ts | 2 + .../plugin-mock-collections/server.js | 1 + .../src/client/index.ts | 5 + .../plugin-mock-collections/src/index.ts | 1 + .../src/server/collection-templates/index.ts | 218 ++++++ .../server/field-interfaces/association.ts | 357 ++++++++++ .../src/server/field-interfaces/attachment.ts | 39 ++ .../src/server/field-interfaces/checkbox.ts | 13 + .../server/field-interfaces/checkboxGroup.ts | 21 + .../server/field-interfaces/chinaRegion.ts | 32 + .../src/server/field-interfaces/circle.ts | 13 + .../src/server/field-interfaces/collection.ts | 9 + .../src/server/field-interfaces/color.ts | 13 + .../src/server/field-interfaces/createdAt.ts | 14 + .../src/server/field-interfaces/createdBy.ts | 20 + .../src/server/field-interfaces/datetime.ts | 18 + .../src/server/field-interfaces/email.ts | 15 + .../src/server/field-interfaces/formula.ts | 18 + .../src/server/field-interfaces/icon.ts | 11 + .../src/server/field-interfaces/id.ts | 15 + .../src/server/field-interfaces/index.ts | 38 + .../src/server/field-interfaces/input.ts | 12 + .../src/server/field-interfaces/integer.ts | 19 + .../src/server/field-interfaces/json.tsx | 18 + .../src/server/field-interfaces/lineString.ts | 13 + .../src/server/field-interfaces/markdown.ts | 14 + .../server/field-interfaces/multipleSelect.ts | 24 + .../src/server/field-interfaces/number.ts | 18 + .../src/server/field-interfaces/password.ts | 12 + .../src/server/field-interfaces/percent.ts | 19 + .../src/server/field-interfaces/phone.ts | 15 + .../src/server/field-interfaces/point.ts | 13 + .../src/server/field-interfaces/polygon.ts | 13 + .../src/server/field-interfaces/radioGroup.ts | 19 + .../src/server/field-interfaces/richText.ts | 14 + .../src/server/field-interfaces/select.ts | 19 + .../src/server/field-interfaces/sequence.ts | 35 + .../src/server/field-interfaces/snapshot.ts | 17 + .../src/server/field-interfaces/tableoid.ts | 15 + .../src/server/field-interfaces/textarea.ts | 14 + .../src/server/field-interfaces/time.ts | 13 + .../src/server/field-interfaces/updatedAt.ts | 14 + .../src/server/field-interfaces/updatedBy.ts | 19 + .../src/server/field-interfaces/url.ts | 10 + .../src/server/index.ts | 293 ++++++++ 56 files changed, 2251 insertions(+), 26 deletions(-) create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/.npmignore create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/LICENSE create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/README.md create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/README.zh-CN.md create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/client.d.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/client.js create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/package.json create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/server.d.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/server.js create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/client/index.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/index.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/collection-templates/index.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/association.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/attachment.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/checkbox.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/checkboxGroup.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/chinaRegion.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/circle.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/collection.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/color.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/createdAt.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/createdBy.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/datetime.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/email.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/formula.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/icon.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/id.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/index.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/input.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/integer.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/json.tsx create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/lineString.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/markdown.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/multipleSelect.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/number.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/password.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/percent.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/phone.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/point.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/polygon.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/radioGroup.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/richText.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/select.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/sequence.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/snapshot.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/tableoid.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/textarea.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/time.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/updatedAt.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/updatedBy.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/url.ts create mode 100644 packages/plugins/@nocobase/plugin-mock-collections/src/server/index.ts diff --git a/.env.e2e.example b/.env.e2e.example index 1c9702e1c..23c975abf 100644 --- a/.env.e2e.example +++ b/.env.e2e.example @@ -17,6 +17,9 @@ APP_KEY=test-key-e2e SOCKET_PATH=storage/gateway-e2e.sock __E2E__=true +# 启用 mock-collections 插件 +APPEND_PRESET_BUILT_IN_PLUGINS=mock-collections + API_BASE_PATH=/api/ API_BASE_URL= diff --git a/packages/core/client/src/__tests__/e2e/menu.test.ts b/packages/core/client/src/__tests__/e2e/menu.test.ts index 1487b7586..f81db165b 100644 --- a/packages/core/client/src/__tests__/e2e/menu.test.ts +++ b/packages/core/client/src/__tests__/e2e/menu.test.ts @@ -50,6 +50,7 @@ test.describe('menu page', () => { await page.getByLabel(pageTitle).hover(); await page.getByLabel(pageTitle).getByLabel('designer-schema-settings').hover(); await page.getByLabel('Edit').click(); + await page.mouse.move(300, 0); await page.getByRole('textbox').click(); await page.getByRole('textbox').fill(newPagetitle); await page.getByRole('button', { name: 'OK' }).click(); diff --git a/packages/core/database/src/repository.ts b/packages/core/database/src/repository.ts index 59c7a2057..5bfc4272a 100644 --- a/packages/core/database/src/repository.ts +++ b/packages/core/database/src/repository.ts @@ -3,16 +3,16 @@ import lodash from 'lodash'; import { Association, BulkCreateOptions, - CountOptions as SequelizeCountOptions, - CreateOptions as SequelizeCreateOptions, - DestroyOptions as SequelizeDestroyOptions, - FindAndCountOptions as SequelizeAndCountOptions, - FindOptions as SequelizeFindOptions, ModelStatic, Op, Sequelize, - Transactionable, + FindAndCountOptions as SequelizeAndCountOptions, + CountOptions as SequelizeCountOptions, + CreateOptions as SequelizeCreateOptions, + DestroyOptions as SequelizeDestroyOptions, + FindOptions as SequelizeFindOptions, UpdateOptions as SequelizeUpdateOptions, + Transactionable, WhereOperators, } from 'sequelize'; import { Collection } from './collection'; @@ -217,6 +217,7 @@ export interface AggregateOptions { interface FirstOrCreateOptions extends Transactionable { filterKeys: string[]; values?: Values; + hooks?: boolean; } export class Repository { @@ -459,7 +460,7 @@ export class Repository = { - // template: 'general', - // logging: true, - // autoGenId: true, - // createdBy: true, - // updatedBy: true, - // createdAt: true, - // updatedAt: true, - // sortable: true, - // view: false, - // }; - collectionSettings = Array.isArray(collectionSettings) ? collectionSettings : [collectionSettings]; - const result = await api.post(`/api/collections:create`, { + const result = await api.post(`/api/collections:mock`, { headers, - // data: collectionSettings.map((item) => Object.assign(defaultCollectionSetting, item)), - data: collectionSettings.filter((item) => !['users', 'roles'].includes(item.name)), + data: collectionSettings, }); if (!result.ok()) { diff --git a/packages/plugins/@nocobase/plugin-mock-collections/.npmignore b/packages/plugins/@nocobase/plugin-mock-collections/.npmignore new file mode 100644 index 000000000..c593fe9df --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/.npmignore @@ -0,0 +1,2 @@ +/node_modules +/src \ No newline at end of file diff --git a/packages/plugins/@nocobase/plugin-mock-collections/LICENSE b/packages/plugins/@nocobase/plugin-mock-collections/LICENSE new file mode 100644 index 000000000..0ad25db4b --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/packages/plugins/@nocobase/plugin-mock-collections/README.md b/packages/plugins/@nocobase/plugin-mock-collections/README.md new file mode 100644 index 000000000..e69de29bb diff --git a/packages/plugins/@nocobase/plugin-mock-collections/README.zh-CN.md b/packages/plugins/@nocobase/plugin-mock-collections/README.zh-CN.md new file mode 100644 index 000000000..e69de29bb diff --git a/packages/plugins/@nocobase/plugin-mock-collections/client.d.ts b/packages/plugins/@nocobase/plugin-mock-collections/client.d.ts new file mode 100644 index 000000000..6c459cbac --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/client.d.ts @@ -0,0 +1,2 @@ +export * from './dist/client'; +export { default } from './dist/client'; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/client.js b/packages/plugins/@nocobase/plugin-mock-collections/client.js new file mode 100644 index 000000000..b6e3be70e --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/client.js @@ -0,0 +1 @@ +module.exports = require('./dist/client/index.js'); diff --git a/packages/plugins/@nocobase/plugin-mock-collections/package.json b/packages/plugins/@nocobase/plugin-mock-collections/package.json new file mode 100644 index 000000000..3724e55d0 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/package.json @@ -0,0 +1,20 @@ +{ + "name": "@nocobase/plugin-mock-collections", + "displayName": "mock-collections", + "description": "mock-collections", + "version": "0.14.0-alpha.8", + "main": "./dist/server/index.js", + "license": "AGPL-3.0", + "devDependencies": { + + }, + "peerDependencies": { + "@nocobase/client": "0.x", + "@nocobase/database": "0.x", + "@nocobase/plugin-error-handler": "0.x", + "@nocobase/server": "0.x", + "@nocobase/test": "0.x", + "@nocobase/utils": "0.x" + }, + "gitHead": "ce588eefb0bfc50f7d5bbee575e0b5e843bf6644" +} diff --git a/packages/plugins/@nocobase/plugin-mock-collections/server.d.ts b/packages/plugins/@nocobase/plugin-mock-collections/server.d.ts new file mode 100644 index 000000000..c41081ddc --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/server.d.ts @@ -0,0 +1,2 @@ +export * from './dist/server'; +export { default } from './dist/server'; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/server.js b/packages/plugins/@nocobase/plugin-mock-collections/server.js new file mode 100644 index 000000000..972842039 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/server.js @@ -0,0 +1 @@ +module.exports = require('./dist/server/index.js'); diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/client/index.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/client/index.ts new file mode 100644 index 000000000..68b95abd4 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/client/index.ts @@ -0,0 +1,5 @@ +import { Plugin } from '@nocobase/client'; + +export default class PluginMockCollectionsClient extends Plugin { + async load() {} +} diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/index.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/index.ts new file mode 100644 index 000000000..7ddad5814 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/index.ts @@ -0,0 +1 @@ +export { default } from './server'; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/collection-templates/index.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/collection-templates/index.ts new file mode 100644 index 000000000..f76b6a935 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/collection-templates/index.ts @@ -0,0 +1,218 @@ +export default { + calendar: (options) => { + return { + fields: [ + { name: 'exclude', type: 'json' }, + { name: 'title', type: 'string', interface: 'input' }, + { name: 'startAt', type: 'date', interface: 'datetime' }, + { + name: 'cron', + type: 'string', + uiSchema: { + type: 'string', + title: '{{t("Repeats")}}', + 'x-component': 'CronSet', + 'x-component-props': 'allowClear', + enum: [ + { label: '{{t("Daily")}}', value: '0 0 0 * * ?' }, + { label: '{{t("Weekly")}}', value: 'every_week' }, + { label: '{{t("Monthly")}}', value: 'every_month' }, + { label: '{{t("Yearly")}}', value: 'every_year' }, + ], + }, + interface: 'select', + }, + ], + }; + }, + tree: (options) => { + return { + tree: 'adjacencyList', + fields: [ + { + interface: 'integer', + name: 'parentId', + type: 'bigInt', + isForeignKey: true, + uiSchema: { + type: 'number', + title: '{{t("Parent ID")}}', + 'x-component': 'InputNumber', + 'x-read-pretty': true, + }, + }, + { + interface: 'm2o', + type: 'belongsTo', + name: 'parent', + foreignKey: 'parentId', + treeParent: true, + onDelete: 'CASCADE', + target: options.name, + uiSchema: { + title: '{{t("Parent")}}', + 'x-component': 'AssociationField', + 'x-component-props': { multiple: false, fieldNames: { label: 'id', value: 'id' } }, + }, + }, + { + interface: 'o2m', + type: 'hasMany', + name: 'children', + foreignKey: 'parentId', + treeChildren: true, + onDelete: 'CASCADE', + target: options.name, + uiSchema: { + title: '{{t("Children")}}', + 'x-component': 'AssociationField', + 'x-component-props': { multiple: true, fieldNames: { label: 'id', value: 'id' } }, + }, + }, + ], + }; + }, + general: () => ({}), + file: (options) => { + return { + template: 'file', + fields: [ + { + interface: 'input', + type: 'string', + name: 'title', + deletable: false, + uiSchema: { type: 'string', title: '{{t("Title")}}', 'x-component': 'Input' }, + }, + { + interface: 'input', + type: 'string', + name: 'filename', + deletable: false, + uiSchema: { + type: 'string', + title: '{{t("File name", { ns: "file-manager" })}}', + 'x-component': 'Input', + 'x-read-pretty': true, + }, + }, + { + interface: 'input', + type: 'string', + name: 'extname', + deletable: false, + uiSchema: { + type: 'string', + title: '{{t("Extension name", { ns: "file-manager" })}}', + 'x-component': 'Input', + 'x-read-pretty': true, + }, + }, + { + interface: 'integer', + type: 'integer', + name: 'size', + deletable: false, + uiSchema: { + type: 'number', + title: '{{t("Size", { ns: "file-manager" })}}', + 'x-component': 'InputNumber', + 'x-read-pretty': true, + 'x-component-props': { stringMode: true, step: '0' }, + }, + }, + { + interface: 'input', + type: 'string', + name: 'mimetype', + deletable: false, + uiSchema: { + type: 'string', + title: '{{t("MIME type", { ns: "file-manager" })}}', + 'x-component': 'Input', + 'x-read-pretty': true, + }, + }, + { + interface: 'input', + type: 'string', + name: 'path', + deletable: false, + uiSchema: { type: 'string', title: '{{t("Path")}}', 'x-component': 'Input', 'x-read-pretty': true }, + }, + { + interface: 'input', + type: 'string', + name: 'url', + deletable: false, + uiSchema: { type: 'string', title: '{{t("URL")}}', 'x-component': 'Input.URL', 'x-read-pretty': true }, + }, + { + interface: 'url', + type: 'string', + name: 'preview', + field: 'url', + deletable: false, + uiSchema: { type: 'string', title: '{{t("Preview")}}', 'x-component': 'Preview', 'x-read-pretty': true }, + }, + { + comment: '存储引擎', + type: 'belongsTo', + name: 'storage', + target: 'storages', + foreignKey: 'storageId', + deletable: false, + }, + { type: 'jsonb', name: 'meta', deletable: false, defaultValue: {} }, + ], + }; + }, + expression: () => ({ + template: 'expression', + fields: [ + { + name: 'engine', + type: 'string', + interface: 'radioGroup', + uiSchema: { + type: 'string', + title: '{{t("Calculation engine")}}', + 'x-component': 'Radio.Group', + enum: [ + { + value: 'math.js', + label: 'Math.js', + tooltip: + "{{t('Math.js comes with a large set of built-in functions and constants, and offers an integrated solution to work with different data types')}}", + link: 'https://mathjs.org/', + }, + { + value: 'formula.js', + label: 'Formula.js', + tooltip: '{{t("Formula.js supports most Microsoft Excel formula functions.")}}', + link: 'https://formulajs.info/functions/', + }, + ], + default: 'formula.js', + }, + }, + { + name: 'sourceCollection', + type: 'string', + interface: 'select', + uiSchema: { + type: 'string', + title: '{{t("Collection")}}', + 'x-component': 'CollectionSelect', + 'x-component-props': {}, + }, + }, + { + name: 'expression', + type: 'text', + interface: 'expression', + uiSchema: { type: 'string', title: '{{t("Expression")}}', 'x-component': 'DynamicExpression' }, + }, + ], + }), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/association.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/association.ts new file mode 100644 index 000000000..680ca8146 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/association.ts @@ -0,0 +1,357 @@ +import { faker } from '@faker-js/faker'; +import { uid } from '@nocobase/utils'; + +function reverseFieldHandle(defaults, { target, reverseField }) { + if (!reverseField) { + delete defaults.reverseField; + } else { + Object.assign(defaults.reverseField, reverseField); + if (!defaults.reverseField.name) { + defaults.reverseField.name = `f_${uid()}`; + } + if (reverseField.title && defaults.reverseField.uiSchema) { + defaults.reverseField.uiSchema['title'] = reverseField.title; + } + if (!defaults.reverseField.uiSchema['title']) { + defaults.reverseField.uiSchema['title'] = defaults.reverseField.name; + } + if (!defaults.key) { + defaults.key = uid(); + } + if (!defaults.reverseField.key) { + defaults.reverseField.key = uid(); + } + defaults['reverseKey'] = defaults.reverseField.key; + defaults.reverseField.reverseKey = defaults.key; + defaults.reverseField.collectionName = target; + } + return defaults; +} + +function generateForeignKeyField(options) { + return options.type === 'bigInt' + ? { + key: uid(), + ...options, + interface: 'integer', + isForeignKey: true, + sort: 1, + uiSchema: { + type: 'number', + title: options.name, + 'x-component': 'InputNumber', + 'x-read-pretty': true, + }, + } + : { + key: uid(), + ...options, + interface: 'input', + isForeignKey: true, + sort: 1, + uiSchema: { + type: 'string', + title: options.name, + 'x-component': 'Input', + 'x-read-pretty': true, + }, + }; +} + +export const oho = { + options: (options) => { + const { foreignKey = `f_${uid()}`, targetKey = 'id', sourceKey = 'id', reverseField } = options; + const defaults = { + type: 'hasOne', + foreignKey, + sourceKey, + // name, + uiSchema: { + // title, + 'x-component': 'AssociationField', + 'x-component-props': { + // mode: 'tags', + multiple: false, + fieldNames: { + label: targetKey, + value: targetKey, + }, + }, + }, + reverseField: { + interface: 'obo', + type: 'belongsTo', + foreignKey, + targetKey: sourceKey, + uiSchema: { + // title, + 'x-component': 'AssociationField', + 'x-component-props': { + // mode: 'tags', + multiple: false, + fieldNames: { + label: sourceKey, + value: sourceKey, + }, + }, + }, + }, + }; + defaults['foreignKeyFields'] = [ + generateForeignKeyField({ + type: sourceKey === 'id' ? 'bigInt' : 'string', + name: foreignKey, + collectionName: options.target, + }), + ]; + return reverseFieldHandle(defaults, options); + }, + mock: async (options, { mockCollectionData }) => { + return mockCollectionData(options.target, 1, true); + }, +}; + +export const obo = { + options: (options) => { + const { foreignKey = `f_${uid()}`, targetKey = 'id', sourceKey = 'id', reverseField } = options; + const key = uid(); + const defaults = { + type: 'belongsTo', + foreignKey, + targetKey, + // name, + uiSchema: { + // title, + 'x-component': 'AssociationField', + 'x-component-props': { + // mode: 'tags', + multiple: false, + fieldNames: { + label: targetKey, + value: targetKey, + }, + }, + }, + reverseField: { + interface: 'oho', + type: 'hasOne', + foreignKey, + sourceKey: targetKey, + uiSchema: { + // title, + 'x-component': 'AssociationField', + 'x-component-props': { + multiple: false, + fieldNames: { + label: sourceKey, + value: sourceKey, + }, + }, + }, + }, + }; + defaults['foreignKeyFields'] = [ + generateForeignKeyField({ + type: targetKey === 'id' ? 'bigInt' : 'string', + name: foreignKey, + collectionName: options.collectionName, + }), + ]; + return reverseFieldHandle(defaults, options); + }, + mock: async (options, { mockCollectionData }) => { + return mockCollectionData(options.target, 1, true); + }, +}; + +export const o2m = { + options: (options) => { + const { foreignKey = `f_${uid()}`, targetKey = 'id', sourceKey = 'id', reverseField } = options; + const defaults = { + type: 'hasMany', + foreignKey, + targetKey, + sourceKey, + // name, + uiSchema: { + // title, + 'x-component': 'AssociationField', + 'x-component-props': { + // mode: 'tags', + multiple: true, + fieldNames: { + label: targetKey, + value: targetKey, + }, + }, + }, + reverseField: { + interface: 'm2o', + type: 'belongsTo', + foreignKey, + targetKey: sourceKey, + uiSchema: { + // title: `T-${uid()}`, + 'x-component': 'AssociationField', + 'x-component-props': { + // mode: 'tags', + multiple: false, + fieldNames: { + label: sourceKey, + value: sourceKey, + }, + }, + }, + }, + }; + defaults['foreignKeyFields'] = [ + generateForeignKeyField({ + type: sourceKey === 'id' ? 'bigInt' : 'string', + name: foreignKey, + collectionName: options.target, + }), + ]; + return reverseFieldHandle(defaults, options); + }, + mock: async (options, { mockCollectionData }) => { + return mockCollectionData(options.target, faker.number.int({ min: 2, max: 5 }), true); + }, +}; + +export const m2o = { + options: (options) => { + const { foreignKey = `f_${uid()}`, targetKey = 'id', sourceKey = 'id', reverseField } = options; + const defaults = { + type: 'belongsTo', + foreignKey, + targetKey, + // name, + uiSchema: { + // title, + 'x-component': 'AssociationField', + 'x-component-props': { + // mode: 'tags', + multiple: false, + fieldNames: { + label: targetKey, + value: targetKey, + }, + }, + }, + reverseField: { + interface: 'o2m', + type: 'hasMany', + foreignKey, + targetKey: sourceKey, + sourceKey: targetKey, + // name, + uiSchema: { + // title, + 'x-component': 'AssociationField', + 'x-component-props': { + // mode: 'tags', + multiple: true, + fieldNames: { + label: sourceKey, + value: sourceKey, + }, + }, + }, + }, + }; + defaults['foreignKeyFields'] = [ + generateForeignKeyField({ + type: targetKey === 'id' ? 'bigInt' : 'string', + name: foreignKey, + collectionName: options.collectionName, + }), + ]; + return reverseFieldHandle(defaults, options); + }, + mock: async (options, { mockCollectionData }) => { + return mockCollectionData(options.target, 1, true); + }, +}; + +export const m2m = { + options: (options) => { + const { + through = `t_${uid()}`, + foreignKey = `f_${uid()}`, + otherKey = `f_${uid()}`, + targetKey = 'id', + sourceKey = 'id', + reverseField, + } = options; + const defaults = { + type: 'belongsToMany', + through, + foreignKey, + otherKey, + targetKey, + sourceKey, + // name, + uiSchema: { + // title, + 'x-component': 'AssociationField', + 'x-component-props': { + // mode: 'tags', + multiple: true, + fieldNames: { + label: targetKey, + value: targetKey, + }, + }, + }, + reverseField: { + interface: 'm2m', + type: 'belongsToMany', + through, + foreignKey: otherKey, + otherKey: foreignKey, + targetKey: sourceKey, + sourceKey: targetKey, + // name, + uiSchema: { + // title, + 'x-component': 'AssociationField', + 'x-component-props': { + // mode: 'tags', + multiple: true, + fieldNames: { + label: sourceKey, + value: sourceKey, + }, + }, + }, + }, + }; + defaults['foreignKeyFields'] = [ + generateForeignKeyField({ + type: sourceKey === 'id' ? 'bigInt' : 'string', + name: foreignKey, + collectionName: through, + }), + generateForeignKeyField({ + type: targetKey === 'id' ? 'bigInt' : 'string', + name: otherKey, + collectionName: through, + }), + ]; + defaults['throughCollection'] = { + key: uid(), + name: through, + title: through, + timestamps: true, + autoGenId: false, + hidden: true, + autoCreate: true, + isThrough: true, + sortable: false, + }; + return reverseFieldHandle(defaults, options); + }, + mock: async (options, { mockCollectionData }) => { + return mockCollectionData(options.target, faker.number.int({ min: 2, max: 5 }), true); + }, +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/attachment.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/attachment.ts new file mode 100644 index 000000000..6f23d0fb1 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/attachment.ts @@ -0,0 +1,39 @@ +import { faker } from '@faker-js/faker'; +import { uid } from '@nocobase/utils'; +import _ from 'lodash'; + +export function mockAttachment() { + return { + title: faker.word.words(), + filename: `${faker.word.words()}.png`, + extname: '.png', + path: '', + size: 3938, + url: faker.image.url(), + mimetype: 'image/png', + meta: {}, + storageId: 1, + }; +} + +export const attachment = { + options: (options) => ({ + type: 'belongsToMany', + target: 'attachments', + through: options.through || `t_${uid()}`, + foreignKey: options.foreignKey || `f_${uid()}`, + otherKey: options.otherKey || `f_${uid()}`, + targetKey: options.targetKey || 'id', + sourceKey: options.sourceKey || 'id', + // name, + uiSchema: { + type: 'array', + // title, + 'x-component': 'Upload.Attachment', + }, + }), + mock: (options) => + options?.uiSchema?.['x-component-props']?.multiple + ? _.range(faker.number.int({ min: 1, max: 5 })).map(() => mockAttachment()) + : mockAttachment(), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/checkbox.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/checkbox.ts new file mode 100644 index 000000000..4dde2f9c4 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/checkbox.ts @@ -0,0 +1,13 @@ +import { faker } from '@faker-js/faker'; + +export const checkbox = { + options: () => ({ + type: 'boolean', + // name, + uiSchema: { + type: 'boolean', + 'x-component': 'Checkbox', + }, + }), + mock: () => faker.datatype.boolean(), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/checkboxGroup.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/checkboxGroup.ts new file mode 100644 index 000000000..b9a07aea7 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/checkboxGroup.ts @@ -0,0 +1,21 @@ +import { faker } from '@faker-js/faker'; +import _ from 'lodash'; + +export const checkboxGroup = { + options: (options) => ({ + interface: 'checkboxGroup', + type: 'array', + defaultValue: [], + // name, + uiSchema: { + type: 'array', + 'x-component': 'Checkbox.Group', + enum: options?.uiSchema?.enum || [ + { value: 'option1', label: 'Option1' }, + { value: 'option2', label: 'Option2' }, + { value: 'option3', label: 'Option3' }, + ], + }, + }), + mock: (options) => faker.helpers.arrayElements(_.map(options?.uiSchema?.enum, _.property('value'))), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/chinaRegion.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/chinaRegion.ts new file mode 100644 index 000000000..85ac97324 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/chinaRegion.ts @@ -0,0 +1,32 @@ +import { uid } from '@nocobase/utils'; + +export const chinaRegion = { + options: (options) => ({ + type: 'belongsToMany', + target: 'chinaRegions', + targetKey: 'code', + sortBy: 'level', + through: options.through || `t_${uid()}`, + foreignKey: options.foreignKey || `f_${uid()}`, + otherKey: options.otherKey || `f_${uid()}`, + sourceKey: options.sourceKey || 'id', + // name, + uiSchema: { + type: 'array', + // title, + 'x-component': 'Cascader', + 'x-component-props': { + useDataSource: '{{ useChinaRegionDataSource }}', + useLoadData: '{{ useChinaRegionLoadData }}', + changeOnSelectLast: options?.uiSchema?.['x-component-props']?.changeOnSelectLast || false, + labelInValue: true, + maxLevel: options?.uiSchema?.['x-component-props']?.maxLevel || 3, + fieldNames: { + label: 'name', + value: 'code', + children: 'children', + }, + }, + }, + }), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/circle.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/circle.ts new file mode 100644 index 000000000..146d1019f --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/circle.ts @@ -0,0 +1,13 @@ +export const circle = { + options: () => ({ + type: 'circle', + uiSchema: { + type: 'void', + 'x-component': 'Map', + 'x-component-designer': 'Map.Designer', + 'x-component-props': { + mapType: 'amap', + }, + }, + }), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/collection.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/collection.ts new file mode 100644 index 000000000..975dbb46e --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/collection.ts @@ -0,0 +1,9 @@ +export const collection = { + options: (options) => ({ + type: 'string', + uiSchema: { + type: 'string', + 'x-component': 'CollectionSelect', + }, + }), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/color.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/color.ts new file mode 100644 index 000000000..21624e25e --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/color.ts @@ -0,0 +1,13 @@ +import { faker } from '@faker-js/faker'; + +export const color = { + options: (options) => ({ + type: 'string', + uiSchema: { + type: 'string', + 'x-component': 'ColorPicker', + default: '#1677FF', + }, + }), + mock: () => faker.color.rgb(), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/createdAt.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/createdAt.ts new file mode 100644 index 000000000..1e4dc8670 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/createdAt.ts @@ -0,0 +1,14 @@ +export const createdAt = { + options: (options) => ({ + type: 'date', + field: 'createdAt', + // name, + uiSchema: { + type: 'datetime', + title: '{{t("Created at")}}', + 'x-component': 'DatePicker', + 'x-component-props': {}, + 'x-read-pretty': true, + }, + }), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/createdBy.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/createdBy.ts new file mode 100644 index 000000000..14d08ea1f --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/createdBy.ts @@ -0,0 +1,20 @@ +export const createdBy = { + options: (options) => ({ + type: 'belongsTo', + target: 'users', + foreignKey: 'createdById', + // name, + uiSchema: { + type: 'object', + title: '{{t("Created by")}}', + 'x-component': 'AssociationField', + 'x-component-props': { + fieldNames: { + value: 'id', + label: 'nickname', + }, + }, + 'x-read-pretty': true, + }, + }), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/datetime.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/datetime.ts new file mode 100644 index 000000000..f8f213b32 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/datetime.ts @@ -0,0 +1,18 @@ +import { faker } from '@faker-js/faker'; + +export const datetime = { + options: () => ({ + type: 'date', + // name, + uiSchema: { + type: 'string', + // title, + 'x-component': 'DatePicker', + 'x-component-props': { + dateFormat: 'YYYY-MM-DD', + showTime: false, + }, + }, + }), + mock: () => faker.date.anytime(), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/email.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/email.ts new file mode 100644 index 000000000..628cfbeba --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/email.ts @@ -0,0 +1,15 @@ +import { faker } from '@faker-js/faker'; + +export const email = { + options: () => ({ + type: 'string', + // name, + uiSchema: { + type: 'string', + // title, + 'x-component': 'Input', + 'x-validator': 'email', + }, + }), + mock: () => faker.internet.email(), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/formula.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/formula.ts new file mode 100644 index 000000000..e8f65120b --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/formula.ts @@ -0,0 +1,18 @@ +export const formula = { + options: () => ({ + type: 'formula', + dataType: 'double', + engine: 'math.js', + // name, + uiSchema: { + type: 'string', + // title, + 'x-component': 'Formula.Result', + 'x-component-props': { + stringMode: true, + step: '1', + }, + 'x-read-pretty': true, + }, + }), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/icon.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/icon.ts new file mode 100644 index 000000000..abe683de2 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/icon.ts @@ -0,0 +1,11 @@ +export const icon = { + options: () => ({ + type: 'string', + // name, + uiSchema: { + type: 'string', + // title, + 'x-component': 'IconPicker', + }, + }), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/id.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/id.ts new file mode 100644 index 000000000..36b65b299 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/id.ts @@ -0,0 +1,15 @@ +export const id = { + options: () => ({ + name: 'id', + type: 'bigInt', + autoIncrement: true, + primaryKey: true, + allowNull: false, + uiSchema: { + type: 'number', + title: '{{t("ID")}}', + 'x-component': 'InputNumber', + 'x-read-pretty': true, + }, + }), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/index.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/index.ts new file mode 100644 index 000000000..1983b2e8c --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/index.ts @@ -0,0 +1,38 @@ +export * from './association'; +export * from './attachment'; +export * from './checkbox'; +export * from './checkboxGroup'; +export * from './chinaRegion'; +export * from './circle'; +export * from './collection'; +export * from './color'; +export * from './createdAt'; +export * from './createdBy'; +export * from './datetime'; +export * from './email'; +export * from './formula'; +export * from './icon'; +export * from './id'; +export * from './input'; +export * from './integer'; +export * from './json'; +export * from './lineString'; +export * from './markdown'; +export * from './multipleSelect'; +export * from './number'; +export * from './password'; +export * from './percent'; +export * from './phone'; +export * from './point'; +export * from './polygon'; +export * from './radioGroup'; +export * from './richText'; +export * from './select'; +export * from './sequence'; +export * from './snapshot'; +export * from './tableoid'; +export * from './textarea'; +export * from './time'; +export * from './updatedAt'; +export * from './updatedBy'; +export * from './url'; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/input.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/input.ts new file mode 100644 index 000000000..ae4f44e1b --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/input.ts @@ -0,0 +1,12 @@ +import { faker } from '@faker-js/faker'; + +export const input = { + options: () => ({ + type: 'string', + uiSchema: { + type: 'string', + 'x-component': 'Input', + }, + }), + mock: () => faker.word.words({ count: { min: 5, max: 10 } }), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/integer.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/integer.ts new file mode 100644 index 000000000..bb2df396b --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/integer.ts @@ -0,0 +1,19 @@ +import { faker } from '@faker-js/faker'; + +export const integer = { + options: () => ({ + type: 'bigInt', + // name, + uiSchema: { + type: 'number', + // title, + 'x-component': 'InputNumber', + 'x-component-props': { + stringMode: true, + step: '1', + }, + 'x-validator': 'integer', + }, + }), + mock: () => faker.number.int({ max: 10000 }), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/json.tsx b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/json.tsx new file mode 100644 index 000000000..d61c43267 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/json.tsx @@ -0,0 +1,18 @@ +export const json = { + options: () => ({ + type: 'json', + // name, + uiSchema: { + type: 'object', + // title, + 'x-component': 'Input.JSON', + 'x-component-props': { + autoSize: { + minRows: 5, + // maxRows: 20, + }, + }, + default: null, + }, + }), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/lineString.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/lineString.ts new file mode 100644 index 000000000..a48f42f2f --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/lineString.ts @@ -0,0 +1,13 @@ +export const lineString = { + options: () => ({ + type: 'lineString', + uiSchema: { + type: 'void', + 'x-component': 'Map', + 'x-component-designer': 'Map.Designer', + 'x-component-props': { + mapType: 'amap', + }, + }, + }), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/markdown.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/markdown.ts new file mode 100644 index 000000000..0834512a9 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/markdown.ts @@ -0,0 +1,14 @@ +import { faker } from '@faker-js/faker'; + +export const markdown = { + options: () => ({ + type: 'text', + // name, + uiSchema: { + type: 'string', + // title, + 'x-component': 'Markdown', + }, + }), + mock: () => faker.lorem.paragraphs(), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/multipleSelect.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/multipleSelect.ts new file mode 100644 index 000000000..2e52f4557 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/multipleSelect.ts @@ -0,0 +1,24 @@ +import { faker } from '@faker-js/faker'; +import _ from 'lodash'; + +export const multipleSelect = { + options: (options) => ({ + interface: 'multipleSelect', + type: 'array', + defaultValue: [], + // name, + uiSchema: { + type: 'array', + 'x-component': 'Select', + 'x-component-props': { + mode: 'multiple', + }, + enum: options?.uiSchema?.enum || [ + { value: 'option1', label: 'Option1' }, + { value: 'option2', label: 'Option2' }, + { value: 'option3', label: 'Option3' }, + ], + }, + }), + mock: (options) => faker.helpers.arrayElements(_.map(options?.uiSchema?.enum, _.property('value'))), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/number.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/number.ts new file mode 100644 index 000000000..2f8758d2e --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/number.ts @@ -0,0 +1,18 @@ +import { faker } from '@faker-js/faker'; + +export const number = { + options: () => ({ + type: 'double', + // name, + uiSchema: { + type: 'number', + // title, + 'x-component': 'InputNumber', + 'x-component-props': { + stringMode: true, + step: '1', + }, + }, + }), + mock: () => faker.number.float({ max: 1000 }), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/password.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/password.ts new file mode 100644 index 000000000..3596faa7f --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/password.ts @@ -0,0 +1,12 @@ +export const password = { + options: () => ({ + type: 'password', + hidden: true, + // name, + uiSchema: { + type: 'string', + // title, + 'x-component': 'Password', + }, + }), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/percent.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/percent.ts new file mode 100644 index 000000000..efbb4acb2 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/percent.ts @@ -0,0 +1,19 @@ +import { faker } from '@faker-js/faker'; + +export const percent = { + options: () => ({ + type: 'float', + // name, + uiSchema: { + type: 'string', + // title, + 'x-component': 'Percent', + 'x-component-props': { + stringMode: true, + step: '1', + addonAfter: '%', + }, + }, + }), + mock: () => faker.number.float({ max: 1000 }), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/phone.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/phone.ts new file mode 100644 index 000000000..4597160d9 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/phone.ts @@ -0,0 +1,15 @@ +export const phone = { + options: () => ({ + type: 'string', + // name, + uiSchema: { + type: 'string', + // title, + 'x-component': 'Input', + 'x-component-props': { + type: 'tel', + }, + // 'x-validator': 'phone', + }, + }), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/point.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/point.ts new file mode 100644 index 000000000..81dee0e4b --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/point.ts @@ -0,0 +1,13 @@ +export const point = { + options: () => ({ + type: 'point', + uiSchema: { + type: 'void', + 'x-component': 'Map', + 'x-component-designer': 'Map.Designer', + 'x-component-props': { + mapType: 'amap', + }, + }, + }), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/polygon.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/polygon.ts new file mode 100644 index 000000000..a83d9d428 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/polygon.ts @@ -0,0 +1,13 @@ +export const polygon = { + options: () => ({ + type: 'polygon', + uiSchema: { + type: 'void', + 'x-component': 'Map', + 'x-component-designer': 'Map.Designer', + 'x-component-props': { + mapType: 'amap', + }, + }, + }), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/radioGroup.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/radioGroup.ts new file mode 100644 index 000000000..8dad73e8c --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/radioGroup.ts @@ -0,0 +1,19 @@ +import { faker } from '@faker-js/faker'; +import _ from 'lodash'; + +export const radioGroup = { + options: (options) => ({ + type: 'string', + // name, + uiSchema: { + type: 'string', + 'x-component': 'Radio.Group', + enum: options?.uiSchema?.enum || [ + { value: 'option1', label: 'Option1' }, + { value: 'option2', label: 'Option2' }, + { value: 'option3', label: 'Option3' }, + ], + }, + }), + mock: (options) => faker.helpers.arrayElement(_.map(options?.uiSchema?.enum, _.property('value'))), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/richText.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/richText.ts new file mode 100644 index 000000000..8da3f83e4 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/richText.ts @@ -0,0 +1,14 @@ +import { faker } from '@faker-js/faker'; + +export const richText = { + options: () => ({ + interface: 'richText', + type: 'text', + // name, + uiSchema: { + type: 'string', + 'x-component': 'RichText', + }, + }), + mock: () => faker.lorem.paragraphs(), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/select.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/select.ts new file mode 100644 index 000000000..91e9faf70 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/select.ts @@ -0,0 +1,19 @@ +import { faker } from '@faker-js/faker'; +import _ from 'lodash'; + +export const select = { + options: (options) => ({ + type: 'string', + // name, + uiSchema: { + type: 'string', + 'x-component': 'Select', + enum: options?.uiSchema?.enum || [ + { value: 'option1', label: 'Option1' }, + { value: 'option2', label: 'Option2' }, + { value: 'option3', label: 'Option3' }, + ], + }, + }), + mock: (options) => faker.helpers.arrayElement(_.map(options?.uiSchema?.enum, _.property('value'))), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/sequence.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/sequence.ts new file mode 100644 index 000000000..7b8a7a302 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/sequence.ts @@ -0,0 +1,35 @@ +import { randomInt } from 'crypto'; + +export const sequence = { + options: (options) => { + const defaults = { + type: 'sequence', + uiSchema: { + type: 'string', + 'x-component': 'Input', + 'x-component-props': {}, + }, + patterns: [ + { + type: 'integer', + options: { + digits: 1, + start: 0, + key: randomInt(1 << 16), + cycle: '0 0 * * *', + }, + }, + ], + }; + if (options.patterns) { + defaults.patterns = options.patterns.map((p) => { + if (p.type === 'integer') { + p.options.key = randomInt(1 << 16); + } + return p; + }); + delete options.patterns; + } + return defaults; + }, +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/snapshot.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/snapshot.ts new file mode 100644 index 000000000..0aa059a22 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/snapshot.ts @@ -0,0 +1,17 @@ +export const snapshot = { + options: () => ({ + type: 'snapshot', + // name, + uiSchema: { + // title, + 'x-component': 'SnapshotRecordPicker', + 'x-component-props': { + multiple: true, + fieldNames: { + label: 'id', + value: 'id', + }, + }, + }, + }), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/tableoid.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/tableoid.ts new file mode 100644 index 000000000..e8ff5cb74 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/tableoid.ts @@ -0,0 +1,15 @@ +export const tableoid = { + options: () => ({ + name: '__collection', + type: 'virtual', + uiSchema: { + type: 'string', + title: '{{t("Table OID")}}', + 'x-component': 'CollectionSelect', + 'x-component-props': { + isTableOid: true, + }, + 'x-read-pretty': true, + }, + }), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/textarea.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/textarea.ts new file mode 100644 index 000000000..35cdfee43 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/textarea.ts @@ -0,0 +1,14 @@ +import { faker } from '@faker-js/faker'; + +export const textarea = { + options: () => ({ + interface: 'textarea', + type: 'text', + // name, + uiSchema: { + type: 'string', + 'x-component': 'Input.TextArea', + }, + }), + mock: () => faker.lorem.lines(), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/time.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/time.ts new file mode 100644 index 000000000..2a8f13d63 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/time.ts @@ -0,0 +1,13 @@ +export const time = { + options: () => ({ + type: 'time', + // name, + uiSchema: { + type: 'string', + 'x-component': 'TimePicker', + 'x-component-props': { + format: 'HH:mm:ss', + }, + }, + }), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/updatedAt.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/updatedAt.ts new file mode 100644 index 000000000..80ab694ec --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/updatedAt.ts @@ -0,0 +1,14 @@ +export const updatedAt = { + options: () => ({ + type: 'date', + field: 'updatedAt', + // name, + uiSchema: { + type: 'string', + title: '{{t("Last updated at")}}', + 'x-component': 'DatePicker', + 'x-component-props': {}, + 'x-read-pretty': true, + }, + }), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/updatedBy.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/updatedBy.ts new file mode 100644 index 000000000..2b9215324 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/updatedBy.ts @@ -0,0 +1,19 @@ +export const updatedBy = { + options: () => ({ + type: 'belongsTo', + target: 'users', + foreignKey: 'updatedById', + uiSchema: { + type: 'object', + title: '{{t("Last updated by")}}', + 'x-component': 'AssociationField', + 'x-component-props': { + fieldNames: { + value: 'id', + label: 'nickname', + }, + }, + 'x-read-pretty': true, + }, + }), +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/url.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/url.ts new file mode 100644 index 000000000..ec0ff42e3 --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/field-interfaces/url.ts @@ -0,0 +1,10 @@ +export const url = { + options: () => ({ + type: 'string', + uiSchema: { + type: 'string', + 'x-component': 'Input.URL', + }, + }), + mock: () => null, +}; diff --git a/packages/plugins/@nocobase/plugin-mock-collections/src/server/index.ts b/packages/plugins/@nocobase/plugin-mock-collections/src/server/index.ts new file mode 100644 index 000000000..5dd0a79ba --- /dev/null +++ b/packages/plugins/@nocobase/plugin-mock-collections/src/server/index.ts @@ -0,0 +1,293 @@ +import Database, { Collection, Repository } from '@nocobase/database'; +import { CollectionRepository } from '@nocobase/plugin-collection-manager'; +import { Plugin } from '@nocobase/server'; +import { merge, uid } from '@nocobase/utils'; +import _ from 'lodash'; +import collectionTemplates from './collection-templates'; +import * as fieldInterfaces from './field-interfaces'; +import { mockAttachment } from './field-interfaces'; + +export class PluginMockCollectionsServer extends Plugin { + async load() { + const templates = collectionTemplates; + + const defaultFields = { + id: () => ({ + name: 'id', + type: 'bigInt', + autoIncrement: true, + primaryKey: true, + allowNull: false, + uiSchema: { type: 'number', title: '{{t("ID")}}', 'x-component': 'InputNumber', 'x-read-pretty': true }, + interface: 'id', + }), + createdAt: () => ({ + name: 'createdAt', + interface: 'createdAt', + type: 'date', + field: 'createdAt', + uiSchema: { + type: 'datetime', + title: '{{t("Created at")}}', + 'x-component': 'DatePicker', + 'x-component-props': {}, + 'x-read-pretty': true, + }, + }), + createdBy: () => ({ + name: 'createdBy', + interface: 'createdBy', + type: 'belongsTo', + target: 'users', + foreignKey: 'createdById', + uiSchema: { + type: 'object', + title: '{{t("Created by")}}', + 'x-component': 'AssociationField', + 'x-component-props': { fieldNames: { value: 'id', label: 'nickname' } }, + 'x-read-pretty': true, + }, + }), + updatedAt: () => ({ + type: 'date', + field: 'updatedAt', + name: 'updatedAt', + interface: 'updatedAt', + uiSchema: { + type: 'string', + title: '{{t("Last updated at")}}', + 'x-component': 'DatePicker', + 'x-component-props': {}, + 'x-read-pretty': true, + }, + }), + updatedBy: () => ({ + type: 'belongsTo', + target: 'users', + foreignKey: 'updatedById', + name: 'updatedBy', + interface: 'updatedBy', + uiSchema: { + type: 'object', + title: '{{t("Last updated by")}}', + 'x-component': 'AssociationField', + 'x-component-props': { fieldNames: { value: 'id', label: 'nickname' } }, + 'x-read-pretty': true, + }, + }), + }; + + const mockCollection = (values) => { + if (values.autoCreate || values.view) { + if (!values.key) { + values.key = uid(); + } + if (Array.isArray(values.fields)) { + values.fields = values.fields.map((f) => { + if (!f.key) { + f.key = uid(); + } + return f; + }); + } + return values; + } + const defaults = { + logging: true, + autoGenId: true, + createdBy: true, + updatedBy: true, + createdAt: true, + updatedAt: true, + sortable: true, + template: 'general', + view: false, + sort: 1, + name: `t_${uid()}`, + ...values, + }; + defaults.key = uid(); + if (!defaults.title) { + defaults.title = defaults.name; + } + if (!defaults.fields?.length) { + defaults.fields = []; + } + const fieldNames = defaults.fields.map((f) => f.name); + const fn = templates[defaults.template] || templates.general; + const { fields = [], ...others } = fn(defaults); + Object.assign(defaults, others); + for (const field of fields) { + if (!fieldNames.includes(field.name)) { + defaults.fields.push(field); + } + } + if (['general', 'file', 'tree', 'calendar', 'expression'].includes(defaults.template)) { + if (defaults.autoGenId && !fieldNames.includes('id')) { + defaults.fields.push(defaultFields.id()); + } + if (defaults.createdAt && !fieldNames.includes('createdAt')) { + defaults.fields.push(defaultFields.createdAt()); + } + if (defaults.updatedAt && !fieldNames.includes('updatedAt')) { + defaults.fields.push(defaultFields.updatedAt()); + } + if (defaults.createdBy && !fieldNames.includes('createdBy')) { + defaults.fields.push(defaultFields.createdBy()); + } + if (defaults.updatedBy && !fieldNames.includes('updatedBy')) { + defaults.fields.push(defaultFields.updatedBy()); + } + const foreignKeyFields = []; + defaults.fields = defaults.fields.map((field) => { + field.collectionName = defaults.name; + const f = mockCollectionField(field); + if (f.foreignKeyFields) { + foreignKeyFields.push(...f.foreignKeyFields); + } + if (f.reverseField) { + foreignKeyFields.push(f.reverseField); + } + if (f.throughCollection) { + defaults['throughCollection'] = f.throughCollection; + } + f.collectionName = defaults.name; + return _.omit(f, ['reverseField', 'throughCollection', 'foreignKeyFields']); + }); + defaults.fields.push(...foreignKeyFields); + } + return defaults; + }; + + const mockCollectionField = (opts) => { + let options = opts; + options.sort = 1; + if (options.interface) { + const fn = fieldInterfaces[options.interface]; + if (fn) { + const defaultValue = fn.options(options); + options = merge(defaultValue, options); + } + } + if (!options.key) { + options.key = uid(); + } + if (!options.name) { + options.name = `f_${uid()}`; + } + if (options.title && options.uiSchema) { + options.uiSchema.title = options.title; + } + if (options.uiSchema && !options.uiSchema.title) { + options.uiSchema.title = options.name; + } + return options; + }; + + this.app.resourcer.registerActions({ + mock: async (ctx, next) => { + const { resourceName } = ctx.action; + const { values, count = 10 } = ctx.action.params; + const mockCollectionData = async (collectionName, count = 1, skipAssoc = false) => { + const collection = ctx.db.getCollection(collectionName) as Collection; + const items = await Promise.all( + _.range(count).map(async (i) => { + if (collection.options.template === 'file') { + return mockAttachment(); + } + const values = {}; + if (collection.options.sortable) { + values['sort'] = i + 1; + } + for (const field of collection.fields.values()) { + if (!field.options.interface) { + continue; + } + if (skipAssoc && ['m2o', 'm2m', 'o2m', 'obo', 'oho'].includes(field.options.interface)) { + continue; + } + const fn = fieldInterfaces[field.options.interface]; + if (fn?.mock) { + values[field.name] = await fn.mock(field.options, { mockCollectionData }); + } + } + return values; + }), + ); + return count == 1 ? items[0] : items; + }; + const repository = ctx.db.getRepository(resourceName); + const data = await mockCollectionData(resourceName, count); + // ctx.body = data; + ctx.body = await repository.create({ + values: (Array.isArray(data) ? data : [data]).map((item) => ({ ...item, ...values })), + }); + await next(); + }, + 'collections:mock': async (ctx, next) => { + const { values } = ctx.action.params; + const items = Array.isArray(values) ? values : [values || {}]; + const collections = []; + const collectionFields = []; + for (const item of items) { + const { fields = [], throughCollection, ...opts } = mockCollection(item); + collections.push(opts); + if (throughCollection) { + collections.push(throughCollection); + } + collectionFields.push(...fields); + } + // ctx.body = { + // collections, + // collectionFields, + // }; + // await next(); + // return; + const db = ctx.db as Database; + const collectionsRepository = db.getRepository('collections') as CollectionRepository; + const fieldsRepository = db.getRepository('fields') as Repository; + await db.sequelize.transaction(async (transaction) => { + for (const collection of collections) { + try { + await collectionsRepository.firstOrCreate({ + values: collection, + filterKeys: ['name'], + hooks: false, + transaction, + }); + } catch (error) { + this.app.log.error(error.message, { collection }); + throw error; + } + } + for (const collectionField of collectionFields) { + try { + await fieldsRepository.firstOrCreate({ + values: collectionField, + filterKeys: ['name', 'collectionName'], + hooks: false, + transaction, + }); + } catch (error) { + this.app.log.error(error.message, { collectionField }); + throw error; + } + } + }); + + await collectionsRepository.load(); + await db.sync(); + const records = await collectionsRepository.find({ + filter: { + name: collections.map((c) => c.name), + }, + appends: ['fields'], + }); + ctx.body = Array.isArray(values) ? records : records[0]; + await next(); + }, + }); + } +} + +export default PluginMockCollectionsServer;