@strapi/database 4.12.7 → 4.13.0-alpha.0

package/dist/metadata/index.js

@@ -0,0 +1,236 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMetadata = void 0;
+const fp_1 = __importDefault(require("lodash/fp"));
+const utils_1 = require("@strapi/utils");
+const types = __importStar(require("../types"));
+const relations_1 = require("./relations");
+const types_1 = require("./types");
+// TODO: check if there isn't an attribute with an id already
+/**
+ * Create Metadata from models configurations
+ */
+const createMetadata = (models = []) => {
+    const metadata = new types_1.Metadata();
+    // init pass
+    for (const model of fp_1.default.cloneDeep(models)) {
+        if ('id' in model.attributes) {
+            throw new Error('The attribute "id" is reserved and cannot be used in a model');
+        }
+        metadata.add({
+            singularName: model.singularName,
+            uid: model.uid,
+            tableName: model.tableName,
+            attributes: {
+                id: {
+                    type: 'increments',
+                },
+                ...model.attributes,
+            },
+            lifecycles: model.lifecycles || {},
+            indexes: model.indexes || [],
+        });
+    }
+    // build compos / relations
+    for (const meta of metadata.values()) {
+        if (hasComponentsOrDz(meta)) {
+            const compoLinkModelMeta = createCompoLinkModelMeta(meta);
+            meta.componentLink = compoLinkModelMeta;
+            metadata.add(compoLinkModelMeta);
+        }
+        for (const [attributeName, attribute] of Object.entries(meta.attributes)) {
+            try {
+                if (types.isComponent(attribute.type) && hasComponentsOrDz(meta)) {
+                    createComponent(attributeName, attribute, meta);
+                    continue;
+                }
+                if (types.isDynamicZone(attribute.type) && hasComponentsOrDz(meta)) {
+                    createDynamicZone(attributeName, attribute, meta);
+                    continue;
+                }
+                if (types.isRelation(attribute.type)) {
+                    (0, relations_1.createRelation)(attributeName, attribute, meta, metadata);
+                    continue;
+                }
+                createAttribute(attributeName, attribute);
+            }
+            catch (error) {
+                console.log(error);
+                if (utils_1.errors.isError(error)) {
+                    throw new Error(`Error on attribute ${attributeName} in model ${meta.singularName}(${meta.uid}): ${error.message}`);
+                }
+            }
+        }
+    }
+    for (const meta of metadata.values()) {
+        const columnToAttribute = Object.keys(meta.attributes).reduce((acc, key) => {
+            const attribute = meta.attributes[key];
+            return Object.assign(acc, { [attribute.columnName || key]: key });
+        }, {});
+        meta.columnToAttribute = columnToAttribute;
+    }
+    metadata.validate();
+    return metadata;
+};
+exports.createMetadata = createMetadata;
+const hasComponentsOrDz = (model) => {
+    return Object.values(model.attributes).some(({ type }) => types.isComponent(type) || types.isDynamicZone(type));
+};
+// NOTE: we might just move the compo logic outside this layer too at some point
+const createCompoLinkModelMeta = (baseModelMeta) => {
+    return {
+        // TODO: make sure there can't be any conflicts with a prefix
+        // singularName: 'compo',
+        uid: `${baseModelMeta.tableName}_components`,
+        tableName: `${baseModelMeta.tableName}_components`,
+        attributes: {
+            id: {
+                type: 'increments',
+            },
+            entity_id: {
+                type: 'integer',
+                column: {
+                    unsigned: true,
+                },
+            },
+            component_id: {
+                type: 'integer',
+                column: {
+                    unsigned: true,
+                },
+            },
+            component_type: {
+                type: 'string',
+            },
+            field: {
+                type: 'string',
+            },
+            order: {
+                type: 'float',
+                column: {
+                    unsigned: true,
+                    defaultTo: null,
+                },
+            },
+        },
+        indexes: [
+            {
+                name: `${baseModelMeta.tableName}_field_index`,
+                columns: ['field'],
+                type: null,
+            },
+            {
+                name: `${baseModelMeta.tableName}_component_type_index`,
+                columns: ['component_type'],
+                type: null,
+            },
+            {
+                name: `${baseModelMeta.tableName}_entity_fk`,
+                columns: ['entity_id'],
+            },
+            {
+                name: `${baseModelMeta.tableName}_unique`,
+                columns: ['entity_id', 'component_id', 'field', 'component_type'],
+                type: 'unique',
+            },
+        ],
+        foreignKeys: [
+            {
+                name: `${baseModelMeta.tableName}_entity_fk`,
+                columns: ['entity_id'],
+                referencedColumns: ['id'],
+                referencedTable: baseModelMeta.tableName,
+                onDelete: 'CASCADE',
+            },
+        ],
+    };
+};
+const createDynamicZone = (attributeName, attribute, meta) => {
+    Object.assign(attribute, {
+        type: 'relation',
+        relation: 'morphToMany',
+        // TODO: handle restrictions at some point
+        // target: attribute.components,
+        joinTable: {
+            name: meta.componentLink.tableName,
+            joinColumn: {
+                name: 'entity_id',
+                referencedColumn: 'id',
+            },
+            morphColumn: {
+                idColumn: {
+                    name: 'component_id',
+                    referencedColumn: 'id',
+                },
+                typeColumn: {
+                    name: 'component_type',
+                },
+                typeField: '__component',
+            },
+            on: {
+                field: attributeName,
+            },
+            orderBy: {
+                order: 'asc',
+            },
+            pivotColumns: ['entity_id', 'component_id', 'field', 'component_type'],
+        },
+    });
+};
+const createComponent = (attributeName, attribute, meta) => {
+    Object.assign(attribute, {
+        type: 'relation',
+        relation: attribute.repeatable === true ? 'oneToMany' : 'oneToOne',
+        target: attribute.component,
+        joinTable: {
+            name: meta.componentLink.tableName,
+            joinColumn: {
+                name: 'entity_id',
+                referencedColumn: 'id',
+            },
+            inverseJoinColumn: {
+                name: 'component_id',
+                referencedColumn: 'id',
+            },
+            on: {
+                field: attributeName,
+            },
+            orderColumnName: 'order',
+            orderBy: {
+                order: 'asc',
+            },
+            pivotColumns: ['entity_id', 'component_id', 'field', 'component_type'],
+        },
+    });
+};
+const createAttribute = (attributeName, attribute) => {
+    const columnName = fp_1.default.snakeCase(attributeName);
+    Object.assign(attribute, { columnName });
+};
+//# sourceMappingURL=index.js.map

package/dist/metadata/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/metadata/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mDAA0B;AAC1B,yCAAuC;AAEvC,gDAAkC;AAClC,2CAA6C;AAC7C,mCAAmC;AAGnC,6DAA6D;AAC7D;;GAEG;AACI,MAAM,cAAc,GAAG,CAAC,SAAkB,EAAE,EAAY,EAAE;IAC/D,MAAM,QAAQ,GAAG,IAAI,gBAAQ,EAAE,CAAC;IAEhC,YAAY;IACZ,KAAK,MAAM,KAAK,IAAI,YAAC,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE;QACvC,IAAI,IAAI,IAAI,KAAK,CAAC,UAAU,EAAE;YAC5B,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAC;SACjF;QAED,QAAQ,CAAC,GAAG,CAAC;YACX,YAAY,EAAE,KAAK,CAAC,YAAY;YAChC,GAAG,EAAE,KAAK,CAAC,GAAG;YACd,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,UAAU,EAAE;gBACV,EAAE,EAAE;oBACF,IAAI,EAAE,YAAY;iBACnB;gBACD,GAAG,KAAK,CAAC,UAAU;aACpB;YACD,UAAU,EAAE,KAAK,CAAC,UAAU,IAAI,EAAE;YAClC,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,EAAE;SAC7B,CAAC,CAAC;KACJ;IAED,2BAA2B;IAC3B,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,MAAM,EAAE,EAAE;QACpC,IAAI,iBAAiB,CAAC,IAAI,CAAC,EAAE;YAC3B,MAAM,kBAAkB,GAAG,wBAAwB,CAAC,IAAI,CAAC,CAAC;YAC1D,IAAI,CAAC,aAAa,GAAG,kBAAkB,CAAC;YACxC,QAAQ,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;SAClC;QAED,KAAK,MAAM,CAAC,aAAa,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YACxE,IAAI;gBACF,IAAI,KAAK,CAAC,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,iBAAiB,CAAC,IAAI,CAAC,EAAE;oBAChE,eAAe,CAAC,aAAa,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;oBAChD,SAAS;iBACV;gBAED,IAAI,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,iBAAiB,CAAC,IAAI,CAAC,EAAE;oBAClE,iBAAiB,CAAC,aAAa,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;oBAClD,SAAS;iBACV;gBAED,IAAI,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE;oBACpC,IAAA,0BAAc,EAAC,aAAa,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;oBACzD,SAAS;iBACV;gBAED,eAAe,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;aAC3C;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBACnB,IAAI,cAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;oBACzB,MAAM,IAAI,KAAK,CACb,sBAAsB,aAAa,aAAa,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,GAAG,MAAM,KAAK,CAAC,OAAO,EAAE,CACnG,CAAC;iBACH;aACF;SACF;KACF;IAED,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,MAAM,EAAE,EAAE;QACpC,MAAM,iBAAiB,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACzE,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YACvC,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,UAAU,IAAI,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;QACpE,CAAC,EAAE,EAAE,CAAC,CAAC;QAEP,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;KAC5C;IAED,QAAQ,CAAC,QAAQ,EAAE,CAAC;IACpB,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAxEW,QAAA,cAAc,kBAwEzB;AAEF,MAAM,iBAAiB,GAAG,CAAC,KAAW,EAA8B,EAAE;IACpE,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI,CACzC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CACnE,CAAC;AACJ,CAAC,CAAC;AAEF,gFAAgF;AAChF,MAAM,wBAAwB,GAAG,CAAC,aAAmB,EAAQ,EAAE;IAC7D,OAAO;QACL,6DAA6D;QAC7D,yBAAyB;QACzB,GAAG,EAAE,GAAG,aAAa,CAAC,SAAS,aAAa;QAC5C,SAAS,EAAE,GAAG,aAAa,CAAC,SAAS,aAAa;QAClD,UAAU,EAAE;YACV,EAAE,EAAE;gBACF,IAAI,EAAE,YAAY;aACnB;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,SAAS;gBACf,MAAM,EAAE;oBACN,QAAQ,EAAE,IAAI;iBACf;aACF;YACD,YAAY,EAAE;gBACZ,IAAI,EAAE,SAAS;gBACf,MAAM,EAAE;oBACN,QAAQ,EAAE,IAAI;iBACf;aACF;YACD,cAAc,EAAE;gBACd,IAAI,EAAE,QAAQ;aACf;YACD,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;aACf;YACD,KAAK,EAAE;gBACL,IAAI,EAAE,OAAO;gBACb,MAAM,EAAE;oBACN,QAAQ,EAAE,IAAI;oBACd,SAAS,EAAE,IAAI;iBAChB;aACF;SACF;QACD,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,GAAG,aAAa,CAAC,SAAS,cAAc;gBAC9C,OAAO,EAAE,CAAC,OAAO,CAAC;gBAClB,IAAI,EAAE,IAAI;aACX;YACD;gBACE,IAAI,EAAE,GAAG,aAAa,CAAC,SAAS,uBAAuB;gBACvD,OAAO,EAAE,CAAC,gBAAgB,CAAC;gBAC3B,IAAI,EAAE,IAAI;aACX;YACD;gBACE,IAAI,EAAE,GAAG,aAAa,CAAC,SAAS,YAAY;gBAC5C,OAAO,EAAE,CAAC,WAAW,CAAC;aACvB;YACD;gBACE,IAAI,EAAE,GAAG,aAAa,CAAC,SAAS,SAAS;gBACzC,OAAO,EAAE,CAAC,WAAW,EAAE,cAAc,EAAE,OAAO,EAAE,gBAAgB,CAAC;gBACjE,IAAI,EAAE,QAAQ;aACf;SACF;QACD,WAAW,EAAE;YACX;gBACE,IAAI,EAAE,GAAG,aAAa,CAAC,SAAS,YAAY;gBAC5C,OAAO,EAAE,CAAC,WAAW,CAAC;gBACtB,iBAAiB,EAAE,CAAC,IAAI,CAAC;gBACzB,eAAe,EAAE,aAAa,CAAC,SAAS;gBACxC,QAAQ,EAAE,SAAS;aACpB;SACF;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CACxB,aAAqB,EACrB,SAAoB,EACpB,IAAuB,EACvB,EAAE;IACF,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE;QACvB,IAAI,EAAE,UAAU;QAChB,QAAQ,EAAE,aAAa;QACvB,0CAA0C;QAC1C,gCAAgC;QAChC,SAAS,EAAE;YACT,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS;YAClC,UAAU,EAAE;gBACV,IAAI,EAAE,WAAW;gBACjB,gBAAgB,EAAE,IAAI;aACvB;YACD,WAAW,EAAE;gBACX,QAAQ,EAAE;oBACR,IAAI,EAAE,cAAc;oBACpB,gBAAgB,EAAE,IAAI;iBACvB;gBACD,UAAU,EAAE;oBACV,IAAI,EAAE,gBAAgB;iBACvB;gBACD,SAAS,EAAE,aAAa;aACzB;YACD,EAAE,EAAE;gBACF,KAAK,EAAE,aAAa;aACrB;YACD,OAAO,EAAE;gBACP,KAAK,EAAE,KAAK;aACb;YACD,YAAY,EAAE,CAAC,WAAW,EAAE,cAAc,EAAE,OAAO,EAAE,gBAAgB,CAAC;SACvE;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,aAAqB,EAAE,SAAoB,EAAE,IAAuB,EAAE,EAAE;IAC/F,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE;QACvB,IAAI,EAAE,UAAU;QAChB,QAAQ,EAAE,SAAS,CAAC,UAAU,KAAK,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,UAAU;QAClE,MAAM,EAAE,SAAS,CAAC,SAAS;QAC3B,SAAS,EAAE;YACT,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS;YAClC,UAAU,EAAE;gBACV,IAAI,EAAE,WAAW;gBACjB,gBAAgB,EAAE,IAAI;aACvB;YACD,iBAAiB,EAAE;gBACjB,IAAI,EAAE,cAAc;gBACpB,gBAAgB,EAAE,IAAI;aACvB;YACD,EAAE,EAAE;gBACF,KAAK,EAAE,aAAa;aACrB;YACD,eAAe,EAAE,OAAO;YACxB,OAAO,EAAE;gBACP,KAAK,EAAE,KAAK;aACb;YACD,YAAY,EAAE,CAAC,WAAW,EAAE,cAAc,EAAE,OAAO,EAAE,gBAAgB,CAAC;SACvE;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,aAAqB,EAAE,SAAoB,EAAE,EAAE;IACtE,MAAM,UAAU,GAAG,YAAC,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IAC9C,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;AAC3C,CAAC,CAAC"}

package/dist/metadata/relations.d.ts

@@ -0,0 +1,20 @@
+import type { Attribute } from './types';
+declare const isPolymorphic: (attribute: Attribute) => boolean;
+declare const isOneToAny: (attribute: Attribute) => boolean;
+declare const isManyToAny: (attribute: Attribute) => boolean;
+declare const isAnyToOne: (attribute: Attribute) => boolean;
+declare const isAnyToMany: (attribute: Attribute) => boolean;
+declare const isBidirectional: (attribute: Attribute) => boolean;
+declare const getJoinTableName: (tableName: string, attributeName: string) => string;
+/**
+ * Creates a relation metadata
+ *
+ * @param {string} attributeName
+ * @param {Attribute} attribute
+ * @param {ModelMetadata} meta
+ * @param {Metadata} metadata
+ */
+declare const createRelation: (attributeName: any, attribute: any, meta: any, metadata: any) => void;
+declare const hasOrderColumn: (attribute: Attribute) => boolean;
+declare const hasInverseOrderColumn: (attribute: Attribute) => boolean;
+export { createRelation, isPolymorphic, isBidirectional, isOneToAny, isManyToAny, isAnyToOne, isAnyToMany, hasOrderColumn, hasInverseOrderColumn, getJoinTableName, };