@nocobase/plugin-collection-sql 1.0.0-alpha.15

package/LICENSE.txt

@@ -0,0 +1,122 @@
+Updated Date: March 30, 2024
+
+NocoBase License Agreement
+
+NocoBase Co., Ltd. ("The Company") https://www.nocobase.com/ issues this License Agreement ("Agreement") to you. You, as an individual or a company ("User"), will be deemed to voluntarily accept all terms of this Agreement by using NocoBase (including but not limited to obtaining NocoBase source code or installation package in any form, installing and using NocoBase, purchasing NocoBase commercial license and services, purchasing NocoBase commercial plugins). If the User does not agree to any term of this Agreement, or cannot accurately understand our interpretation of the relevant terms, please stop using it immediately.
+
+This Agreement applies to any use, quotation, contract, invoice, and all software delivered by the Company. The User and the Company or NocoBase's agents can no longer sign a separate license agreement for the sale and delivery of the software.
+
+The Company reserves the right to formulate and modify this Agreement from time to time as needed. If there are changes, the Company will announce them in the form of website announcements, without further individual notification. The changed Agreement will automatically take effect once it is announced, becoming part of this Agreement.
+
+==============
+1. Definitions
+==============
+1.1 "Software" refers to the NocoBase kernel and plugins placed in the same code repository as the kernel, including their source code, installation packages, images, and all their modifications, updates, and upgrades.
+
+1.2 "Plugin Market" refers to the market provided by the Company for selling Software plugins and solutions.
+
+1.3 "Commercial Plugin" refers to the paid plugins provided by the Plugin Market.
+
+1.4 "Root Version" refers to the major version number before the first point in the version number. For example, from 1.0 to 1.x are all the same Root Version 1.
+
+1.5 "Plugin Package" is the unit for batch licensing Commercial Plugins. P5, P10, and P20 Plugin Packages include installation packages for 5, 10, and 20 Commercial Plugins respectively. P5+, P10+, P20+ provide the source code of the Plugins in addition to the installation packages.
+
+1.6 "Upper Layer Application" refers to a specific business use case application serving internal or external customers of the User, developed based on Software and Commercial Plugins, such as ERP/CRM.
+
+1.7 "Third-Party Open Source Software" refers to open source software provided with Software and Commercial Plugins. They are licensed through various published open source software licenses or copyright notices accompanying such software.
+
+===================================
+2. Intellectual Property Protection
+===================================
+
+Except for Third-Party Open Source Software, the Company owns all copyrights, trademark rights, patent rights, trade secrets, and other intellectual property rights of the Software and Commercial Plugins, and has registered and protected them in relevant countries and regions according to the "Paris Convention" or "TRIPS Agreement", ensuring that the intellectual property rights of the Software and Commercial Plugins are internationally recognized and protected.
+
+=============
+3. Disclaimer
+=============
+
+3.1 Users shall not use the Software and Commercial Plugins to engage in activities that violate local laws and regulations, religious beliefs. All legal responsibilities and legal consequences arising from the use of Software and Commercial Plugins shall be borne by the User.
+
+3.2 The Company shall not be liable for any direct, indirect, special, incidental, or consequential damages (including but not limited to loss of profits, business interruption, data loss, or business information disclosure) caused by the User's use of the Software and Commercial Plugins, even if it has been previously informed of the possibility of such damages.
+
+===============
+4. License Type
+===============
+
+4.1 The Software uses a dual license type of AGPL-3.0 Open Source License https://www.gnu.org/licenses/agpl-3..en.htm and Commercial License.
+
+4.2 Commercial Plugins use Commercial License.
+
+================================================
+5. Rights and Obligations of Open Source License
+================================================
+
+5.1 The Software can be used for commercial purposes, such as developing applications for internal use within a company or for clients.
+
+5.2 User can sell plugins developed for the Software in the Plugin Market.
+
+5.3 Outside the Plugin Market, changes and plugins to the Software developed by User or third parties, and third-party software integrated with the Software must all be open sourced under the AGPL-3.0 license.
+
+5.4 It is not allowed to remove or change the brand, name, link, version number, license, and other information about NocoBase on the Software interface, except for the main LOGO in the upper left corner of the page.
+
+5.5 It is not allowed to remove or change all intellectual property statements about NocoBase in the code.
+
+5.6 It is not allowed to provide any form of no-code, zero-code, low-code platform SaaS products to the public using the original or modified Software.
+
+5.7 Comply with all requirements of the AGPL-3.0 agreement.
+
+===============================
+6. Rights of Commercial License
+===============================
+
+6.1 Obtain a permanent commercial license for a Root Version of the Software or Commercial Plugin.
+
+6.2 Get 6 months of exclusive technical support.
+
+6.3 Upgrade to the next Root Version at 50% of the contract price.
+
+6.4 The licensed Software and Commercial Plugins can be used for commercial purposes, such as developing applications for internal use within a company or for clients, with no restrictions on the number of applications and users.
+
+6.5 Changes and plugins to the Software, and applications integrated with the Software do not need to be open sourced.
+
+6.6 Can remove or change the brand, name, link, version number, license, and other information about NocoBase on the Software interface.
+
+6.7 Can sell plugins developed for Software in the Plugin Market or on User’s own website.
+
+6.8 Can sell or provide Upper Layer Applications developed based on Software in the form of SaaS to the public.
+
+6.9 Not restricted by the AGPL-3.0 agreement.
+
+6.10 If there are other agreements in the contract for the above rights, the contract agreement shall prevail.
+
+====================================
+7. Obligations of Commercial License
+====================================
+
+7.1 It is not allowed to remove or change all intellectual property statements about NocoBase in the code.
+
+7.2 It is not allowed to sell, transfer, lease, share, or give away the Commercial License.
+
+7.3 It is not allowed to sell, transfer, lease, share, or give away any form of no-code, zero-code, low-code platform, or developer tools developed based on Software.
+
+7.4 It is not allowed to provide any form of no-code, zero-code, low-code platform SaaS products to the public using the original or modified Software.
+
+7.5 It is not allowed to use reverse engineering, decompilation, and other means to try to discover the source code of Commercial Plugins that have not obtained source code license.
+
+7.6 It is not allowed to disclose the source code of Commercial Plugins to any third party.
+
+7.7 If there is a violation of the above obligations or the terms of this Agreement, the rights owned by the User will be immediately terminated, the paid fees will not be refunded, and the Company reserves the right to pursue the User's legal responsibility.
+
+7.8 If there are other agreements in the contract for the above obligations, the contract agreement shall prevail.
+
+=============================================================
+8. Legal Jurisdiction, Interpretation, and Dispute Resolution
+=============================================================
+
+8.1 Except for Mainland China, the interpretation, application, and all matters related to this agreement are subject to the jurisdiction of Singapore law.
+
+8.2 Any dispute related to this Agreement should first be resolved through friendly negotiation. If the negotiation fails to resolve the dispute, the dispute should be submitted to the International Chamber of Commerce (ICC) for arbitration. The arbitration venue should be Singapore, conducted in English.
+
+8.3 All terms and conditions of this Agreement shall be deemed enforceable to the maximum extent permitted by applicable law. If any term of this Agreement is deemed invalid by any applicable law, the invalidity of that term does not affect the validity of any other term of this Agreement, and it should be deemed that the invalid term has been modified as much as possible to make it valid and enforceable, or if the term cannot be modified, it should be deemed to have been deleted from this Agreement.
+
+8.4 The arbitration award is final, binding on both parties, and can be enforced in any court with jurisdiction.

package/README.md

@@ -0,0 +1 @@
+# @nocobase/plugin-collection-sql

package/client.d.ts

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

package/client.js

@@ -0,0 +1 @@
+module.exports = require('./dist/client/index.js');

package/dist/client/index.d.ts

@@ -0,0 +1,7 @@
+import { Plugin } from '@nocobase/client';
+export declare class PluginCollectionSqlClient extends Plugin {
+    afterAdd(): Promise<void>;
+    beforeLoad(): Promise<void>;
+    load(): Promise<void>;
+}
+export default PluginCollectionSqlClient;

package/dist/client/index.js

@@ -0,0 +1,10 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+(function(e,n){typeof exports=="object"&&typeof module!="undefined"?n(exports,require("@nocobase/client")):typeof define=="function"&&define.amd?define(["exports","@nocobase/client"],n):(e=typeof globalThis!="undefined"?globalThis:e||self,n(e["@nocobase/plugin-collection-sql"]={},e["@nocobase/client"]))})(this,function(e,n){"use strict";var l=(e,n,o)=>new Promise((c,d)=>{var u=i=>{try{t(o.next(i))}catch(s){d(s)}},f=i=>{try{t(o.throw(i))}catch(s){d(s)}},t=i=>i.done?c(i.value):Promise.resolve(i.value).then(u,f);t((o=o.apply(e,n)).next())});class o extends n.Plugin{afterAdd(){return l(this,null,function*(){})}beforeLoad(){return l(this,null,function*(){})}load(){return l(this,null,function*(){console.log(this.app)})}}e.PluginCollectionSqlClient=o,e.default=o,Object.defineProperties(e,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}})});

package/dist/externalVersion.js

@@ -0,0 +1,17 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+module.exports = {
+  "@nocobase/client": "1.0.0-alpha.15",
+  "@nocobase/server": "1.0.0-alpha.15",
+  "@nocobase/database": "1.0.0-alpha.15",
+  "@nocobase/actions": "1.0.0-alpha.15",
+  "sequelize": "6.35.2",
+  "@nocobase/utils": "1.0.0-alpha.15"
+};

package/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,48 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var src_exports = {};
+__export(src_exports, {
+  default: () => import_server.default
+});
+module.exports = __toCommonJS(src_exports);
+__reExport(src_exports, require("./server"), module.exports);
+var import_server = __toESM(require("./server"));
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("./server")
+});

package/dist/server/index.d.ts

@@ -0,0 +1 @@
+export { default } from './plugin';

package/dist/server/index.js

@@ -0,0 +1,42 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var server_exports = {};
+__export(server_exports, {
+  default: () => import_plugin.default
+});
+module.exports = __toCommonJS(server_exports);
+var import_plugin = __toESM(require("./plugin"));

package/dist/server/plugin.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Plugin } from '@nocobase/server';
+export declare class PluginCollectionSQLServer extends Plugin {
+    beforeLoad(): Promise<void>;
+}
+export default PluginCollectionSQLServer;

package/dist/server/plugin.js

@@ -0,0 +1,70 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var plugin_exports = {};
+__export(plugin_exports, {
+  PluginCollectionSQLServer: () => PluginCollectionSQLServer,
+  default: () => plugin_default
+});
+module.exports = __toCommonJS(plugin_exports);
+var import_server = require("@nocobase/server");
+var import_sql_collection = require("./sql-collection");
+var import_sql = __toESM(require("./resources/sql"));
+class PluginCollectionSQLServer extends import_server.Plugin {
+  async beforeLoad() {
+    this.app.db.collectionFactory.registerCollectionType(import_sql_collection.SQLCollection, {
+      condition: (options) => {
+        return options.sql;
+      },
+      async onSync() {
+        return;
+      },
+      async onDump(dumper, collection) {
+        return;
+      }
+    });
+    this.app.resourceManager.define(import_sql.default);
+    this.app.acl.registerSnippet({
+      name: `pm.data-source-manager.collection-sql `,
+      actions: ["sqlCollection:*"]
+    });
+  }
+}
+var plugin_default = PluginCollectionSQLServer;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PluginCollectionSQLServer
+});

package/dist/server/resources/sql.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Context, Next } from '@nocobase/actions';
+declare const _default: {
+    name: string;
+    actions: {
+        execute: (ctx: Context, next: Next) => Promise<void>;
+        setFields: (ctx: Context, next: Next) => Promise<void>;
+        update: (ctx: Context, next: Next) => Promise<void>;
+    };
+};
+export default _default;

package/dist/server/resources/sql.js

@@ -0,0 +1,119 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var sql_exports = {};
+__export(sql_exports, {
+  default: () => sql_default
+});
+module.exports = __toCommonJS(sql_exports);
+var import_sql_collection = require("../sql-collection");
+const updateCollection = async (ctx, transaction) => {
+  const { filterByTk, values } = ctx.action.params;
+  const repo = ctx.db.getRepository("collections");
+  const collection = await repo.findOne({
+    filter: {
+      name: filterByTk
+    },
+    transaction
+  });
+  const existFields = await collection.getFields({ transaction });
+  const deletedFields = existFields.filter((field) => {
+    var _a;
+    return !((_a = values.fields) == null ? void 0 : _a.find((f) => f.name === field.name));
+  });
+  for (const field of deletedFields) {
+    await field.destroy({ transaction });
+  }
+  const upRes = await repo.update({
+    filterByTk,
+    values,
+    updateAssociationValues: ["fields"],
+    transaction
+  });
+  return { collection, upRes };
+};
+var sql_default = {
+  name: "sqlCollection",
+  actions: {
+    execute: async (ctx, next) => {
+      let { sql } = ctx.action.params.values || {};
+      if (!sql) {
+        ctx.throw(400, ctx.t("Please enter a SQL statement"));
+      }
+      sql = sql.trim().split(";").shift();
+      if (!/^select/i.test(sql) && !/^with([\s\S]+)select([\s\S]+)/i.test(sql)) {
+        ctx.throw(400, ctx.t("Only supports SELECT statements or WITH clauses"));
+      }
+      const tmpCollection = new import_sql_collection.SQLCollection({ name: "tmp", sql }, { database: ctx.db });
+      const model = tmpCollection.model;
+      const data = await model.findAll({ attributes: ["*"], limit: 5, raw: true });
+      let fields = {};
+      try {
+        fields = model.inferFields();
+      } catch (err) {
+        ctx.logger.warn(`resource: sql-collection, action: execute, error: ${err}`);
+        fields = {};
+      }
+      const sources = Array.from(
+        new Set(
+          Object.values(fields).map((field) => field.collection).filter((c) => c)
+        )
+      );
+      ctx.body = { data, fields, sources };
+      await next();
+    },
+    setFields: async (ctx, next) => {
+      const transaction = await ctx.app.db.sequelize.transaction();
+      try {
+        const {
+          upRes: [collection]
+        } = await updateCollection(ctx, transaction);
+        await collection.loadFields({
+          transaction
+        });
+        await transaction.commit();
+      } catch (e) {
+        await transaction.rollback();
+        throw e;
+      }
+      await next();
+    },
+    update: async (ctx, next) => {
+      const transaction = await ctx.app.db.sequelize.transaction();
+      try {
+        const { upRes } = await updateCollection(ctx, transaction);
+        const [collection] = upRes;
+        await collection.load({ transaction, resetFields: true });
+        await transaction.commit();
+        ctx.body = upRes;
+      } catch (e) {
+        await transaction.rollback();
+        throw e;
+      }
+      await next();
+    }
+  }
+};

package/dist/server/sql-collection/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+export * from './sql-model';
+export * from './sql-collection';

package/dist/server/sql-collection/index.js

@@ -0,0 +1,32 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var sql_collection_exports = {};
+module.exports = __toCommonJS(sql_collection_exports);
+__reExport(sql_collection_exports, require("./sql-model"), module.exports);
+__reExport(sql_collection_exports, require("./sql-collection"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("./sql-model"),
+  ...require("./sql-collection")
+});

package/dist/server/sql-collection/query-generator.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { GroupOption, Order, ProjectionAlias, WhereOptions } from 'sequelize';
+import { SQLModel } from './sql-model';
+export declare function selectQuery(tableName: string, options: {
+    attributes?: (string | ProjectionAlias)[];
+    where?: WhereOptions;
+    order?: Order;
+    group?: GroupOption;
+    limit?: number;
+    offset?: number;
+}, model: SQLModel): string;

package/dist/server/sql-collection/query-generator.js

@@ -0,0 +1,77 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var query_generator_exports = {};
+__export(query_generator_exports, {
+  selectQuery: () => selectQuery
+});
+module.exports = __toCommonJS(query_generator_exports);
+var import_utils = require("@nocobase/utils");
+function selectQuery(tableName, options, model) {
+  var _a;
+  options = options || {};
+  if (import_utils.lodash.isEmpty(options)) {
+    return `${model.sql};`;
+  }
+  const queryItems = [];
+  let attributes = options.attributes && options.attributes.slice();
+  if (attributes) {
+    const fields = Array.from(((_a = model.collection) == null ? void 0 : _a.fields.keys()) || []);
+    attributes = attributes.filter((attr) => attr === "*" || typeof attr !== "string" || fields.includes(attr));
+  }
+  attributes = this.escapeAttributes(attributes, { model });
+  attributes = attributes || ["*"];
+  if (Object.prototype.hasOwnProperty.call(options, "where")) {
+    options.where = this.getWhereConditions(options.where, tableName, model, options);
+    if (options.where) {
+      queryItems.push(` WHERE ${options.where}`);
+    }
+  }
+  if (options.group) {
+    options.group = Array.isArray(options.group) ? options.group.map((t) => this.aliasGrouping(t, model, tableName, options)).join(", ") : this.aliasGrouping(options.group, model, tableName, options);
+    if (options.group) {
+      queryItems.push(` GROUP BY ${options.group}`);
+    }
+  }
+  if (options.order) {
+    const orders = this.getQueryOrders(options, model, false);
+    if (orders.mainQueryOrder.length) {
+      queryItems.push(` ORDER BY ${orders.mainQueryOrder.join(", ")}`);
+    }
+  }
+  const limitOrder = this.addLimitAndOffset(options, model);
+  if (limitOrder) {
+    queryItems.push(limitOrder);
+  }
+  const query = `SELECT ${attributes.join(", ")} FROM (${model.sql}) ${this.getAliasToken()} ${this.quoteIdentifier(
+    model.name
+  )}${queryItems.join("")}`;
+  return `${query};`;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  selectQuery
+});

package/dist/server/sql-collection/sql-collection.d.ts

@@ -0,0 +1,20 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Collection, CollectionContext, CollectionOptions } from '@nocobase/database';
+import { QueryInterfaceDropTableOptions } from 'sequelize';
+export declare class SQLCollection extends Collection {
+    constructor(options: CollectionOptions, context: CollectionContext);
+    isSql(): boolean;
+    collectionSchema(): any;
+    get filterTargetKey(): string;
+    modelInit(): void;
+    removeFromDb(options?: QueryInterfaceDropTableOptions & {
+        dropCollection?: boolean;
+    }): Promise<Collection<any, any>>;
+}

package/dist/server/sql-collection/sql-collection.js

@@ -0,0 +1,91 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var sql_collection_exports = {};
+__export(sql_collection_exports, {
+  SQLCollection: () => SQLCollection
+});
+module.exports = __toCommonJS(sql_collection_exports);
+var import_database = require("@nocobase/database");
+var import_sql_model = require("./sql-model");
+class SQLCollection extends import_database.Collection {
+  constructor(options, context) {
+    options.autoGenId = false;
+    options.timestamps = false;
+    options.underscored = false;
+    super(options, context);
+  }
+  isSql() {
+    return true;
+  }
+  collectionSchema() {
+    return void 0;
+  }
+  /* istanbul ignore next -- @preserve */
+  get filterTargetKey() {
+    var _a;
+    const targetKey = ((_a = this.options) == null ? void 0 : _a.filterTargetKey) || "id";
+    if (targetKey && this.model.getAttributes()[targetKey]) {
+      return targetKey;
+    }
+    if (this.model.primaryKeyAttributes.length > 1) {
+      return null;
+    }
+    return this.model.primaryKeyAttribute;
+  }
+  modelInit() {
+    const { autoGenId, sql } = this.options;
+    const model = class extends import_sql_model.SQLModel {
+    };
+    model.init(null, {
+      ...this.sequelizeModelOptions(),
+      schema: void 0
+    });
+    if (!autoGenId) {
+      model.removeAttribute("id");
+    }
+    model.sql = (sql == null ? void 0 : sql.endsWith(";")) ? sql.slice(0, -1) : sql;
+    model.database = this.context.database;
+    model.collection = this;
+    this.model = new Proxy(model, {
+      get(target, prop) {
+        if (prop === "_schema") {
+          return void 0;
+        }
+        return Reflect.get(target, prop);
+      }
+    });
+  }
+  async removeFromDb(options) {
+    if ((options == null ? void 0 : options.dropCollection) !== false) {
+      return this.remove();
+    }
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  SQLCollection
+});

package/dist/server/sql-collection/sql-model.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Model } from '@nocobase/database';
+export declare class SQLModel extends Model {
+    static sql: string;
+    static get queryInterface(): import("sequelize").QueryInterface;
+    static sync(): Promise<any>;
+    private static getTableNameWithSchema;
+    private static parseSelectAST;
+    private static parseTablesAndColumns;
+    static inferFields(): {
+        [field: string]: {
+            type: string;
+            source: string;
+            collection: string;
+            interface: string;
+        };
+    };
+}

package/dist/server/sql-collection/sql-model.js

@@ -0,0 +1,178 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var sql_model_exports = {};
+__export(sql_model_exports, {
+  SQLModel: () => SQLModel
+});
+module.exports = __toCommonJS(sql_model_exports);
+var import_database = require("@nocobase/database");
+var import_query_generator = require("./query-generator");
+class SQLModel extends import_database.Model {
+  static sql;
+  static get queryInterface() {
+    const queryInterface = this.sequelize.getQueryInterface();
+    const queryGenerator = queryInterface.queryGenerator;
+    const sqlGenerator = new Proxy(queryGenerator, {
+      get(target, prop) {
+        if (prop === "selectQuery") {
+          return import_query_generator.selectQuery.bind(target);
+        }
+        return Reflect.get(target, prop);
+      }
+    });
+    return new Proxy(queryInterface, {
+      get(target, prop) {
+        if (prop === "queryGenerator") {
+          return sqlGenerator;
+        }
+        return Reflect.get(target, prop);
+      }
+    });
+  }
+  static async sync() {
+  }
+  static getTableNameWithSchema(table) {
+    if (this.database.inDialect("postgres") && !table.includes(".")) {
+      const schema = process.env.DB_SCHEMA || "public";
+      return `${schema}.${table}`;
+    }
+    return table;
+  }
+  static parseSelectAST(ast) {
+    const tablesMap = {};
+    const tableAliases = {};
+    ast.from.forEach((fromItem) => {
+      tablesMap[fromItem.table] = [];
+      if (fromItem.as) {
+        tableAliases[fromItem.as] = fromItem.table;
+      }
+    });
+    ast.columns.forEach((column) => {
+      const expr = column.expr;
+      if (expr.type !== "column_ref") {
+        return;
+      }
+      const table = expr.table;
+      const name = tableAliases[table] || table;
+      const columnAttr = { name: expr.column, as: column.as };
+      if (!name) {
+        Object.keys(tablesMap).forEach((n) => {
+          tablesMap[n].push(columnAttr);
+        });
+      } else if (tablesMap[name]) {
+        tablesMap[name].push(columnAttr);
+      }
+    });
+    return tablesMap;
+  }
+  static parseTablesAndColumns() {
+    let { ast: _ast } = import_database.sqlParser.parse(this.sql);
+    if (Array.isArray(_ast)) {
+      _ast = _ast[0];
+    }
+    const ast = _ast;
+    ast.from = ast.from || [];
+    ast.columns = ast.columns || [];
+    if (ast.with) {
+      const withAST = ast.with;
+      withAST.forEach((withItem) => {
+        const as = withItem.name.value;
+        const withAst = withItem.stmt.ast;
+        ast.from.push(...withAst.from.map((f) => ({ ...f, as })));
+        ast.columns.push(
+          ...withAst.columns.map((c) => ({
+            ...c,
+            expr: {
+              ...c.expr,
+              table: as
+            }
+          }))
+        );
+      });
+    }
+    const tablesMap = this.parseSelectAST(ast);
+    return Object.entries(tablesMap).filter(([_, columns]) => columns).map(([table, columns]) => ({ table, columns }));
+  }
+  static inferFields() {
+    const tables = this.parseTablesAndColumns();
+    return tables.reduce((fields, { table, columns }) => {
+      const tableName = this.getTableNameWithSchema(table);
+      const collection = this.database.tableNameCollectionMap.get(tableName);
+      if (!collection) {
+        const originFields = {};
+        columns.forEach((column) => {
+          if (column.name === "*") {
+            return;
+          }
+          originFields[column.as || column.name] = {};
+        });
+        return { ...fields, ...originFields };
+      }
+      const all = columns.some((column) => column.name === "*");
+      const attributes = collection.model.getAttributes();
+      const sourceFields = {};
+      if (all) {
+        Object.values(attributes).forEach((attribute) => {
+          const field = collection.getField(attribute.fieldName);
+          if (!(field == null ? void 0 : field.options.interface)) {
+            return;
+          }
+          sourceFields[field.name] = {
+            collection: field.collection.name,
+            type: field.type,
+            source: `${field.collection.name}.${field.name}`,
+            interface: field.options.interface,
+            uiSchema: field.options.uiSchema
+          };
+        });
+      } else {
+        columns.forEach((column) => {
+          let options = {};
+          const modelField = Object.values(attributes).find((attribute) => attribute.field === column.name);
+          if (modelField) {
+            const field = collection.getField(modelField.fieldName);
+            if (field == null ? void 0 : field.options.interface) {
+              options = {
+                collection: field.collection.name,
+                type: field.type,
+                source: `${field.collection.name}.${field.name}`,
+                interface: field.options.interface,
+                uiSchema: field.options.uiSchema
+              };
+            }
+          }
+          sourceFields[column.as || column.name] = options;
+        });
+      }
+      return { ...fields, ...sourceFields };
+    }, {});
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  SQLModel
+});

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@nocobase/plugin-collection-sql",
+  "displayName": "Collection: SQL",
+  "displayName.zh-CN": "数据表: SQL",
+  "description": "Provides SQL collection template",
+  "description.zh-CN": "提供 SQL 数据表模板",
+  "version": "1.0.0-alpha.15",
+  "homepage": "https://docs-cn.nocobase.com/handbook/collection-sql",
+  "homepage.zh-CN": "https://docs-cn.nocobase.com/handbook/collection-sql",
+  "main": "dist/server/index.js",
+  "license": "AGPL-3.0",
+  "peerDependencies": {
+    "@nocobase/client": "0.x",
+    "@nocobase/server": "0.x",
+    "@nocobase/test": "0.x"
+  },
+  "keywords": [
+    "Collections"
+  ],
+  "gitHead": "2793d371368e094ea2bba04cfbe9b9b73c44edba"
+}

package/server.d.ts

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

package/server.js

@@ -0,0 +1 @@
+module.exports = require('./dist/server/index.js');