@nocobase/data-source-manager 1.2.13-alpha → 1.3.0-alpha.20240710084543

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@nocobase/data-source-manager",
-  "version": "1.2.13-alpha",
+  "version": "1.3.0-alpha.20240710084543",
   "description": "",
   "license": "AGPL-3.0",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "dependencies": {
-    "@nocobase/actions": "1.2.13-alpha",
-    "@nocobase/cache": "1.2.13-alpha",
-    "@nocobase/database": "1.2.13-alpha",
-    "@nocobase/resourcer": "1.2.13-alpha",
-    "@nocobase/utils": "1.2.13-alpha",
+    "@nocobase/actions": "1.3.0-alpha.20240710084543",
+    "@nocobase/cache": "1.3.0-alpha.20240710084543",
+    "@nocobase/database": "1.3.0-alpha.20240710084543",
+    "@nocobase/resourcer": "1.3.0-alpha.20240710084543",
+    "@nocobase/utils": "1.3.0-alpha.20240710084543",
     "@types/jsonwebtoken": "^8.5.8",
     "jsonwebtoken": "^8.5.1"
   },
@@ -19,5 +19,5 @@
     "url": "git+https://github.com/nocobase/nocobase.git",
     "directory": "packages/auth"
   },
-  "gitHead": "b6a1c2ee330b47c2581ea2ce15ee46210e6220f2"
+  "gitHead": "07a8b596fc64a9779a194cb9b0dc2ca7570ed9d4"
 }

package/lib/collection-field.d.ts

@@ -1,15 +0,0 @@
-/**
- * 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 { FieldOptions, IField } from './types';
-export declare class CollectionField implements IField {
-    options: FieldOptions;
-    constructor(options: FieldOptions);
-    updateOptions(options: any): void;
-    isRelationField(): boolean;
-}

package/lib/collection-field.js

@@ -1,53 +0,0 @@
-/**
- * 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 __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-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 collection_field_exports = {};
-__export(collection_field_exports, {
-  CollectionField: () => CollectionField
-});
-module.exports = __toCommonJS(collection_field_exports);
-const _CollectionField = class _CollectionField {
-  options;
-  constructor(options) {
-    this.updateOptions(options);
-  }
-  updateOptions(options) {
-    this.options = {
-      ...this.options,
-      ...options
-    };
-  }
-  isRelationField() {
-    return false;
-  }
-};
-__name(_CollectionField, "CollectionField");
-let CollectionField = _CollectionField;
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  CollectionField
-});

package/lib/collection-manager.d.ts

@@ -1,36 +0,0 @@
-/**
- * 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 { CollectionOptions, ICollection, ICollectionManager, IFieldInterface, IRepository, MergeOptions } from './types';
-export declare class CollectionManager implements ICollectionManager {
-    protected collections: Map<string, ICollection>;
-    protected repositories: Map<string, IRepository>;
-    protected models: Map<string, any>;
-    constructor(options?: {});
-    getRegisteredFieldType(type: any): void;
-    getRegisteredFieldInterface(key: string): void;
-    getRegisteredModel(key: string): any;
-    getRegisteredRepository(key: any): any;
-    registerFieldTypes(): void;
-    registerFieldInterfaces(interfaces: Record<string, new (options: any) => IFieldInterface>): void;
-    registerFieldInterface(name: string, fieldInterface: new (options: any) => IFieldInterface): void;
-    getFieldInterface(name: string): {
-        new (options: any): IFieldInterface | undefined;
-    };
-    registerCollectionTemplates(): void;
-    registerModels(models: Record<string, any>): void;
-    registerRepositories(repositories: Record<string, any>): void;
-    defineCollection(options: CollectionOptions): ICollection;
-    extendCollection(collectionOptions: CollectionOptions, mergeOptions?: MergeOptions): ICollection;
-    hasCollection(name: string): boolean;
-    getCollection(name: string): ICollection;
-    getCollections(): Array<ICollection>;
-    getRepository(name: string, sourceId?: string | number): IRepository;
-    sync(): Promise<void>;
-    protected newCollection(options: any): ICollection;
-}

package/lib/collection-manager.js

@@ -1,116 +0,0 @@
-/**
- * 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 __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-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 collection_manager_exports = {};
-__export(collection_manager_exports, {
-  CollectionManager: () => CollectionManager
-});
-module.exports = __toCommonJS(collection_manager_exports);
-var import_collection = require("./collection");
-const _CollectionManager = class _CollectionManager {
-  collections = /* @__PURE__ */ new Map();
-  repositories = /* @__PURE__ */ new Map();
-  models = /* @__PURE__ */ new Map();
-  constructor(options = {}) {
-  }
-  /* istanbul ignore next -- @preserve */
-  getRegisteredFieldType(type) {
-  }
-  /* istanbul ignore next -- @preserve */
-  getRegisteredFieldInterface(key) {
-  }
-  /* istanbul ignore next -- @preserve */
-  getRegisteredModel(key) {
-    return this.models.get(key);
-  }
-  getRegisteredRepository(key) {
-    if (typeof key !== "string") {
-      return key;
-    }
-    return this.repositories.get(key);
-  }
-  /* istanbul ignore next -- @preserve */
-  registerFieldTypes() {
-  }
-  registerFieldInterfaces(interfaces) {
-    Object.keys(interfaces).forEach((key) => {
-      this.registerFieldInterface(key, interfaces[key]);
-    });
-  }
-  registerFieldInterface(name, fieldInterface) {
-  }
-  getFieldInterface(name) {
-    return;
-  }
-  /* istanbul ignore next -- @preserve */
-  registerCollectionTemplates() {
-  }
-  registerModels(models) {
-    Object.keys(models).forEach((key) => {
-      this.models.set(key, models[key]);
-    });
-  }
-  registerRepositories(repositories) {
-    Object.keys(repositories).forEach((key) => {
-      this.repositories.set(key, repositories[key]);
-    });
-  }
-  defineCollection(options) {
-    const collection = this.newCollection(options);
-    this.collections.set(options.name, collection);
-    return collection;
-  }
-  extendCollection(collectionOptions, mergeOptions) {
-    const collection = this.getCollection(collectionOptions.name);
-    collection.updateOptions(collectionOptions, mergeOptions);
-    return collection;
-  }
-  hasCollection(name) {
-    return !!this.getCollection(name);
-  }
-  getCollection(name) {
-    return this.collections.get(name);
-  }
-  getCollections() {
-    return [...this.collections.values()];
-  }
-  getRepository(name, sourceId) {
-    const collection = this.getCollection(name);
-    return collection.repository;
-  }
-  async sync() {
-  }
-  newCollection(options) {
-    return new import_collection.Collection(options, this);
-  }
-};
-__name(_CollectionManager, "CollectionManager");
-let CollectionManager = _CollectionManager;
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  CollectionManager
-});

package/lib/collection.d.ts

@@ -1,24 +0,0 @@
-/**
- * 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 { CollectionOptions, ICollection, ICollectionManager, IField, IRepository } from './types';
-import { CollectionField } from './collection-field';
-export declare class Collection implements ICollection {
-    protected options: CollectionOptions;
-    protected collectionManager: ICollectionManager;
-    repository: IRepository;
-    fields: Map<string, IField>;
-    constructor(options: CollectionOptions, collectionManager: ICollectionManager);
-    updateOptions(options: CollectionOptions, mergeOptions?: any): this;
-    setFields(fields: any[]): void;
-    setField(name: string, options: any): CollectionField;
-    removeField(name: string): void;
-    getField(name: string): IField;
-    getFields(): IField[];
-    protected setRepository(repository: any): void;
-}

package/lib/collection.js

@@ -1,95 +0,0 @@
-/**
- * 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 __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-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 collection_exports = {};
-__export(collection_exports, {
-  Collection: () => Collection
-});
-module.exports = __toCommonJS(collection_exports);
-var import_lodash = __toESM(require("lodash"));
-var import_deepmerge = __toESM(require("deepmerge"));
-var import_collection_field = require("./collection-field");
-const _Collection = class _Collection {
-  constructor(options, collectionManager) {
-    this.options = options;
-    this.collectionManager = collectionManager;
-    this.setRepository(options.repository);
-    if (options.fields) {
-      this.setFields(options.fields);
-    }
-  }
-  repository;
-  fields = /* @__PURE__ */ new Map();
-  updateOptions(options, mergeOptions) {
-    let newOptions = import_lodash.default.cloneDeep(options);
-    newOptions = (0, import_deepmerge.default)(this.options, newOptions, mergeOptions);
-    this.options = newOptions;
-    this.setFields(newOptions.fields || []);
-    if (options.repository) {
-      this.setRepository(options.repository);
-    }
-    return this;
-  }
-  setFields(fields) {
-    for (const field of fields) {
-      this.setField(field.name, field);
-    }
-  }
-  setField(name, options) {
-    const field = new import_collection_field.CollectionField(options);
-    this.fields.set(name, field);
-    return field;
-  }
-  removeField(name) {
-    this.fields.delete(name);
-  }
-  getField(name) {
-    return this.fields.get(name);
-  }
-  getFields() {
-    return [...this.fields.values()];
-  }
-  setRepository(repository) {
-    this.repository = this.collectionManager.getRegisteredRepository(repository || "Repository");
-  }
-};
-__name(_Collection, "Collection");
-let Collection = _Collection;
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  Collection
-});

package/lib/data-source-factory.d.ts

@@ -1,15 +0,0 @@
-/**
- * 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 { DataSource } from './data-source';
-export declare class DataSourceFactory {
-    collectionTypes: Map<string, typeof DataSource>;
-    register(type: string, dataSourceClass: typeof DataSource): void;
-    getClass(type: string): typeof DataSource;
-    create(type: string, options?: any): DataSource;
-}

package/lib/data-source-factory.js

@@ -1,54 +0,0 @@
-/**
- * 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 __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-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 data_source_factory_exports = {};
-__export(data_source_factory_exports, {
-  DataSourceFactory: () => DataSourceFactory
-});
-module.exports = __toCommonJS(data_source_factory_exports);
-const _DataSourceFactory = class _DataSourceFactory {
-  collectionTypes = /* @__PURE__ */ new Map();
-  register(type, dataSourceClass) {
-    this.collectionTypes.set(type, dataSourceClass);
-  }
-  getClass(type) {
-    return this.collectionTypes.get(type);
-  }
-  create(type, options = {}) {
-    const klass = this.collectionTypes.get(type);
-    if (!klass) {
-      throw new Error(`Data source type "${type}" not found`);
-    }
-    return new klass(options);
-  }
-};
-__name(_DataSourceFactory, "DataSourceFactory");
-let DataSourceFactory = _DataSourceFactory;
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  DataSourceFactory
-});

package/lib/data-source-manager.d.ts

@@ -1,35 +0,0 @@
-/**
- * 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 { ToposortOptions } from '@nocobase/utils';
-import { DataSource } from './data-source';
-import { DataSourceFactory } from './data-source-factory';
-type DataSourceHook = (dataSource: DataSource) => void;
-export declare class DataSourceManager {
-    options: {};
-    dataSources: Map<string, DataSource>;
-    /**
-     * @internal
-     */
-    factory: DataSourceFactory;
-    protected middlewares: any[];
-    private onceHooks;
-    private beforeAddHooks;
-    constructor(options?: {});
-    get(dataSourceKey: string): DataSource;
-    add(dataSource: DataSource, options?: any): Promise<void>;
-    use(fn: any, options?: ToposortOptions): void;
-    middleware(): (ctx: any, next: any) => Promise<any>;
-    registerDataSourceType(type: string, DataSourceClass: typeof DataSource): void;
-    getDataSourceType(type: string): typeof DataSource | undefined;
-    buildDataSourceByType(type: string, options?: any): DataSource;
-    beforeAddDataSource(hook: DataSourceHook): void;
-    afterAddDataSource(hook: DataSourceHook): void;
-    private addHookAndRun;
-}
-export {};

package/lib/data-source-manager.js

@@ -1,105 +0,0 @@
-/**
- * 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 __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-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 data_source_manager_exports = {};
-__export(data_source_manager_exports, {
-  DataSourceManager: () => DataSourceManager
-});
-module.exports = __toCommonJS(data_source_manager_exports);
-var import_data_source_factory = require("./data-source-factory");
-const _DataSourceManager = class _DataSourceManager {
-  constructor(options = {}) {
-    this.options = options;
-    this.dataSources = /* @__PURE__ */ new Map();
-    this.middlewares = [];
-  }
-  dataSources;
-  /**
-   * @internal
-   */
-  factory = new import_data_source_factory.DataSourceFactory();
-  middlewares = [];
-  onceHooks = [];
-  beforeAddHooks = [];
-  get(dataSourceKey) {
-    return this.dataSources.get(dataSourceKey);
-  }
-  async add(dataSource, options = {}) {
-    for (const hook of this.beforeAddHooks) {
-      hook(dataSource);
-    }
-    await dataSource.load(options);
-    this.dataSources.set(dataSource.name, dataSource);
-    for (const hook of this.onceHooks) {
-      hook(dataSource);
-    }
-  }
-  use(fn, options) {
-    this.middlewares.push([fn, options]);
-  }
-  middleware() {
-    return async (ctx, next) => {
-      const name = ctx.get("x-data-source") || "main";
-      if (!this.dataSources.has(name)) {
-        ctx.throw(`data source ${name} does not exist`);
-      }
-      const ds = this.dataSources.get(name);
-      ctx.dataSource = ds;
-      return ds.middleware(this.middlewares)(ctx, next);
-    };
-  }
-  registerDataSourceType(type, DataSourceClass) {
-    this.factory.register(type, DataSourceClass);
-  }
-  getDataSourceType(type) {
-    return this.factory.getClass(type);
-  }
-  buildDataSourceByType(type, options = {}) {
-    return this.factory.create(type, options);
-  }
-  beforeAddDataSource(hook) {
-    this.beforeAddHooks.push(hook);
-    for (const dataSource of this.dataSources.values()) {
-      hook(dataSource);
-    }
-  }
-  afterAddDataSource(hook) {
-    this.addHookAndRun(hook);
-  }
-  addHookAndRun(hook) {
-    this.onceHooks.push(hook);
-    for (const dataSource of this.dataSources.values()) {
-      hook(dataSource);
-    }
-  }
-};
-__name(_DataSourceManager, "DataSourceManager");
-let DataSourceManager = _DataSourceManager;
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  DataSourceManager
-});

package/lib/data-source.d.ts

@@ -1,30 +0,0 @@
-/**
- * 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.
- */
-/// <reference types="node" />
-import { ACL } from '@nocobase/acl';
-import { ResourceManager } from '@nocobase/resourcer';
-import EventEmitter from 'events';
-import { ICollectionManager } from './types';
-export type DataSourceOptions = any;
-export declare abstract class DataSource extends EventEmitter {
-    protected options: DataSourceOptions;
-    collectionManager: ICollectionManager;
-    resourceManager: ResourceManager;
-    acl: ACL;
-    constructor(options: DataSourceOptions);
-    get name(): any;
-    static testConnection(options?: any): Promise<boolean>;
-    init(options?: DataSourceOptions): void;
-    middleware(middlewares?: any): (ctx: any, next: any) => Promise<any>;
-    createACL(): ACL;
-    createResourceManager(options: any): ResourceManager;
-    load(options?: any): Promise<void>;
-    abstract createCollectionManager(options?: any): ICollectionManager;
-    protected collectionToResourceMiddleware(): (ctx: any, next: any) => Promise<any>;
-}