@strapi/typescript-utils 0.0.0-experimental.6340da17068c3bed7fb006e7bcc554c71129e282 → 0.0.0-experimental.63624e21eb5b0713345a0cf2f68f1c40eab427bc

package/dist/generators/common/models/attributes.js

@@ -0,0 +1,205 @@
+'use strict';
+
+var ts = require('typescript');
+var _ = require('lodash');
+var imports = require('../imports.js');
+var utils = require('./utils.js');
+var mappers = require('./mappers.js');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+function _interopNamespace(e) {
+  if (e && e.__esModule) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+
+var ts__namespace = /*#__PURE__*/_interopNamespace(ts);
+var ___default = /*#__PURE__*/_interopDefault(_);
+
+const { factory } = ts__namespace;
+/**
+ * Create the base type node for a given attribute
+ */ const getAttributeType = (attributeName, attribute, uid)=>{
+    if (!Object.keys(mappers.mappers).includes(attribute.type)) {
+        console.warn(`"${attributeName}" attribute from "${uid}" has an invalid type: "${attribute.type}"`);
+        return null;
+    }
+    const [attributeType, typeParams] = mappers.mappers[attribute.type]({
+        uid,
+        attribute,
+        attributeName
+    });
+    // Make sure the schema namespace is imported
+    imports.addImport(utils.NAMESPACES.Schema);
+    return utils.getTypeNode(attributeType, typeParams);
+};
+/**
+ * Collect every modifier node from an attribute
+ */ const getAttributeModifiers = (attribute, { strict = false } = {})=>{
+    const modifiers = [];
+    // Required
+    if (attribute.required) {
+        modifiers.push(factory.createTypeReferenceNode(factory.createIdentifier(utils.withAttributeNamespace('Required'))));
+    }
+    // Private
+    if (attribute.private) {
+        modifiers.push(factory.createTypeReferenceNode(factory.createIdentifier(utils.withAttributeNamespace('Private'))));
+    }
+    // Unique
+    if (attribute.unique) {
+        modifiers.push(factory.createTypeReferenceNode(factory.createIdentifier(utils.withAttributeNamespace('Unique'))));
+    }
+    // Configurable
+    if (attribute.configurable) {
+        modifiers.push(factory.createTypeReferenceNode(factory.createIdentifier(utils.withAttributeNamespace('Configurable'))));
+    }
+    // Custom field
+    if (attribute.customField) {
+        const customFieldUid = factory.createStringLiteral(attribute.customField);
+        const typeArguments = [
+            customFieldUid
+        ];
+        if (attribute.options) {
+            typeArguments.push(utils.toTypeLiteral(attribute.options));
+        }
+        modifiers.push(factory.createTypeReferenceNode(factory.createIdentifier(utils.withAttributeNamespace('CustomField')), typeArguments));
+    }
+    // Plugin Options
+    if (!___default.default.isEmpty(attribute.pluginOptions)) {
+        modifiers.push(factory.createTypeReferenceNode(factory.createIdentifier(utils.withAttributeNamespace('SetPluginOptions')), // Transform the pluginOptions object into an object literal expression
+        [
+            utils.toTypeLiteral(attribute.pluginOptions)
+        ]));
+    }
+    // Min / Max
+    if (attribute.min != null || attribute.max != null) {
+        const minMaxProperties = ___default.default.pick(attribute, [
+            'min',
+            'max'
+        ]);
+        const { min, max } = minMaxProperties;
+        const typeofMin = typeof min;
+        const typeofMax = typeof max;
+        // Throws error if min/max exist but have different types to prevent unexpected behavior
+        if (min !== undefined && max !== undefined && typeofMin !== typeofMax) {
+            throw new Error('typeof min/max values mismatch');
+        }
+        let typeKeyword;
+        // use 'string'
+        if (typeofMin === 'string' || typeofMax === 'string') {
+            typeKeyword = ts__namespace.SyntaxKind.StringKeyword;
+        } else if (typeofMin === 'number' || typeofMax === 'number') {
+            typeKeyword = ts__namespace.SyntaxKind.NumberKeyword;
+        } else {
+            throw new Error(`Invalid data type for min/max options. Must be string, number or undefined, but found { min: ${min} (${typeofMin}), max: ${max} (${typeofMax}) }`);
+        }
+        modifiers.push(factory.createTypeReferenceNode(factory.createIdentifier(utils.withAttributeNamespace('SetMinMax')), [
+            utils.toTypeLiteral(minMaxProperties),
+            factory.createKeywordTypeNode(typeKeyword)
+        ]));
+    }
+    // Min length / Max length
+    if (attribute.minLength != null || attribute.maxLength != null) {
+        const minMaxProperties = ___default.default.pick(attribute, [
+            'minLength',
+            'maxLength'
+        ]);
+        modifiers.push(factory.createTypeReferenceNode(factory.createIdentifier(utils.withAttributeNamespace('SetMinMaxLength')), [
+            utils.toTypeLiteral(minMaxProperties)
+        ]));
+    }
+    // Conditional (strict types only): a field hidden by its `conditions.visible` rule skips
+    // validation, so the strict write inputs make it optional and nullable
+    if (strict === true && attribute.conditions?.visible !== undefined) {
+        modifiers.push(factory.createTypeReferenceNode(factory.createIdentifier(utils.withAttributeNamespace('Conditional'))));
+    }
+    // Default (ignore if default is a function)
+    if (attribute.default != null && typeof attribute.default !== 'function') {
+        const defaultLiteral = utils.toTypeLiteral(attribute.default);
+        modifiers.push(factory.createTypeReferenceNode(factory.createIdentifier(utils.withAttributeNamespace('DefaultTo')), [
+            defaultLiteral
+        ]));
+    }
+    return modifiers;
+};
+/**
+ * Whether the attribute is a list of components: a repeatable component or a dynamic zone.
+ */ const isComponentList = (attribute)=>attribute.type === 'dynamiczone' || attribute.type === 'component' && attribute.repeatable === true;
+/**
+ * The write rule of an attribute, as one sentence for its JSDoc, or `undefined` when the attribute
+ * has none to tell. It mirrors the strict write inputs of `@strapi/types`
+ * (`modules/documents/params/write.ts`), which follow the entity validator of `@strapi/core`.
+ *
+ * `draftAndPublish` is `undefined` for a component: its fields follow the mode of the parent entry.
+ */ const getAttributeWriteRule = (attribute, { draftAndPublish } = {})=>{
+    // The validator skips attributes that are not writable
+    if (attribute.writable === false) {
+        return undefined;
+    }
+    const hasDefault = attribute.default !== undefined && attribute.default !== null && typeof attribute.default !== 'function';
+    // `*/` in a default value would end the comment
+    const defaultRule = hasDefault === true ? `Default: ${JSON.stringify(attribute.default).replaceAll('*/', '*\\/')}.` : '';
+    if (attribute.required !== true) {
+        if (isComponentList(attribute) === true) {
+            return 'Never `null`.';
+        }
+        return hasDefault === true ? defaultRule : undefined;
+    }
+    if (attribute.conditions?.visible !== undefined) {
+        return 'Required only when its condition shows it.';
+    }
+    if (isComponentList(attribute) === true) {
+        return 'Required on every create, drafts included (`[]` is enough). Never `null`.';
+    }
+    if (attribute.type === 'relation' || attribute.type === 'media') {
+        return 'Required when published, only with `api.documents.strictRelations`.';
+    }
+    if (draftAndPublish === false) {
+        return hasDefault === true ? `${defaultRule} Never \`null\`.` : 'Required. Never `null`.';
+    }
+    return hasDefault === true ? `${defaultRule} \`null\` only in drafts.` : 'Required when published. `null` only in drafts.';
+};
+/**
+ * Generate a property signature node for a given attribute
+ */ const attributeToPropertySignature = (schema, attributeName, attribute, options = {})=>{
+    const baseType = getAttributeType(attributeName, attribute, schema.uid);
+    if (baseType === null) {
+        return null;
+    }
+    const modifiers = getAttributeModifiers(attribute, options);
+    const nodes = [
+        baseType,
+        ...modifiers
+    ];
+    const signature = factory.createPropertySignature(undefined, factory.createIdentifier(attributeName), undefined, factory.createIntersectionTypeNode(nodes));
+    // Strict types only: editors show the write rule on the attribute and on the input keys
+    if (options.strict === true) {
+        const rule = getAttributeWriteRule(attribute, {
+            draftAndPublish: schema.modelType === 'contentType' ? schema.options?.draftAndPublish === true : undefined
+        });
+        if (rule !== undefined) {
+            ts__namespace.addSyntheticLeadingComment(signature, ts__namespace.SyntaxKind.MultiLineCommentTrivia, `* ${rule} `, true);
+        }
+    }
+    return signature;
+};
+
+exports.mappers = mappers.mappers;
+exports.attributeToPropertySignature = attributeToPropertySignature;
+exports.getAttributeModifiers = getAttributeModifiers;
+exports.getAttributeType = getAttributeType;
+exports.getAttributeWriteRule = getAttributeWriteRule;
+//# sourceMappingURL=attributes.js.map

package/dist/generators/common/models/attributes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"attributes.js","sources":["../../../../src/generators/common/models/attributes.ts"],"sourcesContent":["import * as ts from 'typescript';\nimport _ from 'lodash';\n\nimport { addImport } from '../imports';\nimport { getTypeNode, toTypeLiteral, withAttributeNamespace, NAMESPACES } from './utils';\nimport type { Attribute, Schema } from './utils';\nimport { mappers } from './mappers';\n\nconst { factory } = ts;\n\n/**\n * Create the base type node for a given attribute\n */\nexport const getAttributeType = (\n  attributeName: string,\n  attribute: Attribute,\n  uid?: string\n): ts.TypeReferenceNode | null => {\n  if (!Object.keys(mappers).includes(attribute.type)) {\n    console.warn(\n      `\"${attributeName}\" attribute from \"${uid}\" has an invalid type: \"${attribute.type}\"`\n    );\n\n    return null;\n  }\n\n  const [attributeType, typeParams] = mappers[attribute.type]({ uid, attribute, attributeName });\n\n  // Make sure the schema namespace is imported\n  addImport(NAMESPACES.Schema);\n\n  return getTypeNode(attributeType, typeParams);\n};\n\n/**\n * Options of the attribute generators.\n */\nexport type AttributeOptions = {\n  /**\n   * Whether the application enables `typescript.strictTypes`. Strict-only modifiers, such as\n   * `Schema.Attribute.Conditional`, are emitted only then, so generated files without strict types\n   * stay as in previous releases.\n   */\n  strict?: boolean;\n};\n\n/**\n * Collect every modifier node from an attribute\n */\nexport const getAttributeModifiers = (\n  attribute: Attribute,\n  { strict = false }: AttributeOptions = {}\n): ts.TypeNode[] => {\n  const modifiers: ts.TypeNode[] = [];\n\n  // Required\n  if (attribute.required) {\n    modifiers.push(\n      factory.createTypeReferenceNode(factory.createIdentifier(withAttributeNamespace('Required')))\n    );\n  }\n\n  // Private\n  if (attribute.private) {\n    modifiers.push(\n      factory.createTypeReferenceNode(factory.createIdentifier(withAttributeNamespace('Private')))\n    );\n  }\n\n  // Unique\n  if (attribute.unique) {\n    modifiers.push(\n      factory.createTypeReferenceNode(factory.createIdentifier(withAttributeNamespace('Unique')))\n    );\n  }\n\n  // Configurable\n  if (attribute.configurable) {\n    modifiers.push(\n      factory.createTypeReferenceNode(\n        factory.createIdentifier(withAttributeNamespace('Configurable'))\n      )\n    );\n  }\n\n  // Custom field\n  if (attribute.customField) {\n    const customFieldUid = factory.createStringLiteral(attribute.customField);\n    const typeArguments: any[] = [customFieldUid];\n\n    if (attribute.options) {\n      typeArguments.push(toTypeLiteral(attribute.options));\n    }\n\n    modifiers.push(\n      factory.createTypeReferenceNode(\n        factory.createIdentifier(withAttributeNamespace('CustomField')),\n        typeArguments\n      )\n    );\n  }\n\n  // Plugin Options\n  if (!_.isEmpty(attribute.pluginOptions)) {\n    modifiers.push(\n      factory.createTypeReferenceNode(\n        factory.createIdentifier(withAttributeNamespace('SetPluginOptions')),\n        // Transform the pluginOptions object into an object literal expression\n        [toTypeLiteral(attribute.pluginOptions)]\n      )\n    );\n  }\n\n  // Min / Max\n  if (attribute.min != null || attribute.max != null) {\n    const minMaxProperties = _.pick(attribute, ['min', 'max']);\n    const { min, max } = minMaxProperties;\n\n    const typeofMin = typeof min;\n    const typeofMax = typeof max;\n\n    // Throws error if min/max exist but have different types to prevent unexpected behavior\n    if (min !== undefined && max !== undefined && typeofMin !== typeofMax) {\n      throw new Error('typeof min/max values mismatch');\n    }\n\n    let typeKeyword: any;\n\n    // use 'string'\n    if (typeofMin === 'string' || typeofMax === 'string') {\n      typeKeyword = ts.SyntaxKind.StringKeyword;\n    }\n    // use 'number'\n    else if (typeofMin === 'number' || typeofMax === 'number') {\n      typeKeyword = ts.SyntaxKind.NumberKeyword;\n    }\n    // invalid type\n    else {\n      throw new Error(\n        `Invalid data type for min/max options. Must be string, number or undefined, but found { min: ${min} (${typeofMin}), max: ${max} (${typeofMax}) }`\n      );\n    }\n\n    modifiers.push(\n      factory.createTypeReferenceNode(\n        factory.createIdentifier(withAttributeNamespace('SetMinMax')),\n        [toTypeLiteral(minMaxProperties), factory.createKeywordTypeNode(typeKeyword)]\n      )\n    );\n  }\n\n  // Min length / Max length\n  if (attribute.minLength != null || attribute.maxLength != null) {\n    const minMaxProperties = _.pick(attribute, ['minLength', 'maxLength']);\n\n    modifiers.push(\n      factory.createTypeReferenceNode(\n        factory.createIdentifier(withAttributeNamespace('SetMinMaxLength')),\n        [toTypeLiteral(minMaxProperties)]\n      )\n    );\n  }\n\n  // Conditional (strict types only): a field hidden by its `conditions.visible` rule skips\n  // validation, so the strict write inputs make it optional and nullable\n  if (strict === true && attribute.conditions?.visible !== undefined) {\n    modifiers.push(\n      factory.createTypeReferenceNode(\n        factory.createIdentifier(withAttributeNamespace('Conditional'))\n      )\n    );\n  }\n\n  // Default (ignore if default is a function)\n  if (attribute.default != null && typeof attribute.default !== 'function') {\n    const defaultLiteral = toTypeLiteral(attribute.default);\n\n    modifiers.push(\n      factory.createTypeReferenceNode(\n        factory.createIdentifier(withAttributeNamespace('DefaultTo')),\n        [defaultLiteral]\n      )\n    );\n  }\n\n  return modifiers;\n};\n\n/**\n * Whether the attribute is a list of components: a repeatable component or a dynamic zone.\n */\nconst isComponentList = (attribute: Attribute) =>\n  attribute.type === 'dynamiczone' ||\n  (attribute.type === 'component' && attribute.repeatable === true);\n\n/**\n * The write rule of an attribute, as one sentence for its JSDoc, or `undefined` when the attribute\n * has none to tell. It mirrors the strict write inputs of `@strapi/types`\n * (`modules/documents/params/write.ts`), which follow the entity validator of `@strapi/core`.\n *\n * `draftAndPublish` is `undefined` for a component: its fields follow the mode of the parent entry.\n */\nexport const getAttributeWriteRule = (\n  attribute: Attribute,\n  { draftAndPublish }: { draftAndPublish?: boolean } = {}\n): string | undefined => {\n  // The validator skips attributes that are not writable\n  if (attribute.writable === false) {\n    return undefined;\n  }\n\n  const hasDefault =\n    attribute.default !== undefined &&\n    attribute.default !== null &&\n    typeof attribute.default !== 'function';\n  // `*/` in a default value would end the comment\n  const defaultRule =\n    hasDefault === true\n      ? `Default: ${JSON.stringify(attribute.default).replaceAll('*/', '*\\\\/')}.`\n      : '';\n\n  if (attribute.required !== true) {\n    if (isComponentList(attribute) === true) {\n      return 'Never `null`.';\n    }\n\n    return hasDefault === true ? defaultRule : undefined;\n  }\n\n  if (attribute.conditions?.visible !== undefined) {\n    return 'Required only when its condition shows it.';\n  }\n\n  if (isComponentList(attribute) === true) {\n    return 'Required on every create, drafts included (`[]` is enough). Never `null`.';\n  }\n\n  if (attribute.type === 'relation' || attribute.type === 'media') {\n    return 'Required when published, only with `api.documents.strictRelations`.';\n  }\n\n  if (draftAndPublish === false) {\n    return hasDefault === true ? `${defaultRule} Never \\`null\\`.` : 'Required. Never `null`.';\n  }\n\n  return hasDefault === true\n    ? `${defaultRule} \\`null\\` only in drafts.`\n    : 'Required when published. `null` only in drafts.';\n};\n\n/**\n * Generate a property signature node for a given attribute\n */\nexport const attributeToPropertySignature = (\n  schema: Schema,\n  attributeName: string,\n  attribute: Attribute,\n  options: AttributeOptions = {}\n): ts.PropertySignature | null => {\n  const baseType = getAttributeType(attributeName, attribute, schema.uid);\n\n  if (baseType === null) {\n    return null;\n  }\n\n  const modifiers = getAttributeModifiers(attribute, options);\n\n  const nodes = [baseType, ...modifiers];\n\n  const signature = factory.createPropertySignature(\n    undefined,\n    factory.createIdentifier(attributeName),\n    undefined,\n    factory.createIntersectionTypeNode(nodes)\n  );\n\n  // Strict types only: editors show the write rule on the attribute and on the input keys\n  if (options.strict === true) {\n    const rule = getAttributeWriteRule(attribute, {\n      draftAndPublish:\n        schema.modelType === 'contentType' ? schema.options?.draftAndPublish === true : undefined,\n    });\n\n    if (rule !== undefined) {\n      ts.addSyntheticLeadingComment(\n        signature,\n        ts.SyntaxKind.MultiLineCommentTrivia,\n        `* ${rule} `,\n        true\n      );\n    }\n  }\n\n  return signature;\n};\n\nexport { mappers };\n"],"names":["factory","ts","getAttributeType","attributeName","attribute","uid","Object","keys","mappers","includes","type","console","warn","attributeType","typeParams","addImport","NAMESPACES","Schema","getTypeNode","getAttributeModifiers","strict","modifiers","required","push","createTypeReferenceNode","createIdentifier","withAttributeNamespace","private","unique","configurable","customField","customFieldUid","createStringLiteral","typeArguments","options","toTypeLiteral","_","isEmpty","pluginOptions","min","max","minMaxProperties","pick","typeofMin","typeofMax","undefined","Error","typeKeyword","SyntaxKind","StringKeyword","NumberKeyword","createKeywordTypeNode","minLength","maxLength","conditions","visible","default","defaultLiteral","isComponentList","repeatable","getAttributeWriteRule","draftAndPublish","writable","hasDefault","defaultRule","JSON","stringify","replaceAll","attributeToPropertySignature","schema","baseType","nodes","signature","createPropertySignature","createIntersectionTypeNode","rule","modelType","addSyntheticLeadingComment","MultiLineCommentTrivia"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAQA,MAAM,EAAEA,OAAO,EAAE,GAAGC,aAAAA;AAEpB;;AAEC,IACM,MAAMC,gBAAAA,GAAmB,CAC9BC,eACAC,SAAAA,EACAC,GAAAA,GAAAA;IAEA,IAAI,CAACC,OAAOC,IAAI,CAACC,iBAASC,QAAQ,CAACL,SAAAA,CAAUM,IAAI,CAAA,EAAG;AAClDC,QAAAA,OAAAA,CAAQC,IAAI,CACV,CAAC,CAAC,EAAET,aAAAA,CAAc,kBAAkB,EAAEE,GAAAA,CAAI,wBAAwB,EAAED,SAAAA,CAAUM,IAAI,CAAC,CAAC,CAAC,CAAA;QAGvF,OAAO,IAAA;AACT,IAAA;IAEA,MAAM,CAACG,eAAeC,UAAAA,CAAW,GAAGN,eAAO,CAACJ,SAAAA,CAAUM,IAAI,CAAC,CAAC;AAAEL,QAAAA,GAAAA;AAAKD,QAAAA,SAAAA;AAAWD,QAAAA;AAAc,KAAA,CAAA;;AAG5FY,IAAAA,iBAAAA,CAAUC,iBAAWC,MAAM,CAAA;AAE3B,IAAA,OAAOC,kBAAYL,aAAAA,EAAeC,UAAAA,CAAAA;AACpC;AAcA;;IAGO,MAAMK,qBAAAA,GAAwB,CACnCf,SAAAA,EACA,EAAEgB,MAAAA,GAAS,KAAK,EAAoB,GAAG,EAAE,GAAA;AAEzC,IAAA,MAAMC,YAA2B,EAAE;;IAGnC,IAAIjB,SAAAA,CAAUkB,QAAQ,EAAE;QACtBD,SAAAA,CAAUE,IAAI,CACZvB,OAAAA,CAAQwB,uBAAuB,CAACxB,OAAAA,CAAQyB,gBAAgB,CAACC,4BAAAA,CAAuB,UAAA,CAAA,CAAA,CAAA,CAAA;AAEpF,IAAA;;IAGA,IAAItB,SAAAA,CAAUuB,OAAO,EAAE;QACrBN,SAAAA,CAAUE,IAAI,CACZvB,OAAAA,CAAQwB,uBAAuB,CAACxB,OAAAA,CAAQyB,gBAAgB,CAACC,4BAAAA,CAAuB,SAAA,CAAA,CAAA,CAAA,CAAA;AAEpF,IAAA;;IAGA,IAAItB,SAAAA,CAAUwB,MAAM,EAAE;QACpBP,SAAAA,CAAUE,IAAI,CACZvB,OAAAA,CAAQwB,uBAAuB,CAACxB,OAAAA,CAAQyB,gBAAgB,CAACC,4BAAAA,CAAuB,QAAA,CAAA,CAAA,CAAA,CAAA;AAEpF,IAAA;;IAGA,IAAItB,SAAAA,CAAUyB,YAAY,EAAE;QAC1BR,SAAAA,CAAUE,IAAI,CACZvB,OAAAA,CAAQwB,uBAAuB,CAC7BxB,OAAAA,CAAQyB,gBAAgB,CAACC,4BAAAA,CAAuB,cAAA,CAAA,CAAA,CAAA,CAAA;AAGtD,IAAA;;IAGA,IAAItB,SAAAA,CAAU0B,WAAW,EAAE;AACzB,QAAA,MAAMC,cAAAA,GAAiB/B,OAAAA,CAAQgC,mBAAmB,CAAC5B,UAAU0B,WAAW,CAAA;AACxE,QAAA,MAAMG,aAAAA,GAAuB;AAACF,YAAAA;AAAe,SAAA;QAE7C,IAAI3B,SAAAA,CAAU8B,OAAO,EAAE;AACrBD,YAAAA,aAAAA,CAAcV,IAAI,CAACY,mBAAAA,CAAc/B,SAAAA,CAAU8B,OAAO,CAAA,CAAA;AACpD,QAAA;QAEAb,SAAAA,CAAUE,IAAI,CACZvB,OAAAA,CAAQwB,uBAAuB,CAC7BxB,OAAAA,CAAQyB,gBAAgB,CAACC,4BAAAA,CAAuB,aAAA,CAAA,CAAA,EAChDO,aAAAA,CAAAA,CAAAA;AAGN,IAAA;;AAGA,IAAA,IAAI,CAACG,kBAAAA,CAAEC,OAAO,CAACjC,SAAAA,CAAUkC,aAAa,CAAA,EAAG;QACvCjB,SAAAA,CAAUE,IAAI,CACZvB,OAAAA,CAAQwB,uBAAuB,CAC7BxB,QAAQyB,gBAAgB,CAACC,4BAAAA,CAAuB,kBAAA,CAAA,CAAA;AAEhD,QAAA;AAACS,YAAAA,mBAAAA,CAAc/B,UAAUkC,aAAa;AAAE,SAAA,CAAA,CAAA;AAG9C,IAAA;;AAGA,IAAA,IAAIlC,UAAUmC,GAAG,IAAI,QAAQnC,SAAAA,CAAUoC,GAAG,IAAI,IAAA,EAAM;AAClD,QAAA,MAAMC,gBAAAA,GAAmBL,kBAAAA,CAAEM,IAAI,CAACtC,SAAAA,EAAW;AAAC,YAAA,KAAA;AAAO,YAAA;AAAM,SAAA,CAAA;AACzD,QAAA,MAAM,EAAEmC,GAAG,EAAEC,GAAG,EAAE,GAAGC,gBAAAA;AAErB,QAAA,MAAME,YAAY,OAAOJ,GAAAA;AACzB,QAAA,MAAMK,YAAY,OAAOJ,GAAAA;;AAGzB,QAAA,IAAID,GAAAA,KAAQM,SAAAA,IAAaL,GAAAA,KAAQK,SAAAA,IAAaF,cAAcC,SAAAA,EAAW;AACrE,YAAA,MAAM,IAAIE,KAAAA,CAAM,gCAAA,CAAA;AAClB,QAAA;QAEA,IAAIC,WAAAA;;QAGJ,IAAIJ,SAAAA,KAAc,QAAA,IAAYC,SAAAA,KAAc,QAAA,EAAU;YACpDG,WAAAA,GAAc9C,aAAAA,CAAG+C,UAAU,CAACC,aAAa;AAC3C,QAAA,CAAA,MAEK,IAAIN,SAAAA,KAAc,QAAA,IAAYC,SAAAA,KAAc,QAAA,EAAU;YACzDG,WAAAA,GAAc9C,aAAAA,CAAG+C,UAAU,CAACE,aAAa;QAC3C,CAAA,MAEK;AACH,YAAA,MAAM,IAAIJ,KAAAA,CACR,CAAC,6FAA6F,EAAEP,IAAI,EAAE,EAAEI,SAAAA,CAAU,QAAQ,EAAEH,GAAAA,CAAI,EAAE,EAAEI,SAAAA,CAAU,GAAG,CAAC,CAAA;AAEtJ,QAAA;QAEAvB,SAAAA,CAAUE,IAAI,CACZvB,OAAAA,CAAQwB,uBAAuB,CAC7BxB,OAAAA,CAAQyB,gBAAgB,CAACC,4BAAAA,CAAuB,WAAA,CAAA,CAAA,EAChD;YAACS,mBAAAA,CAAcM,gBAAAA,CAAAA;AAAmBzC,YAAAA,OAAAA,CAAQmD,qBAAqB,CAACJ,WAAAA;AAAa,SAAA,CAAA,CAAA;AAGnF,IAAA;;AAGA,IAAA,IAAI3C,UAAUgD,SAAS,IAAI,QAAQhD,SAAAA,CAAUiD,SAAS,IAAI,IAAA,EAAM;AAC9D,QAAA,MAAMZ,gBAAAA,GAAmBL,kBAAAA,CAAEM,IAAI,CAACtC,SAAAA,EAAW;AAAC,YAAA,WAAA;AAAa,YAAA;AAAY,SAAA,CAAA;QAErEiB,SAAAA,CAAUE,IAAI,CACZvB,OAAAA,CAAQwB,uBAAuB,CAC7BxB,OAAAA,CAAQyB,gBAAgB,CAACC,4BAAAA,CAAuB,iBAAA,CAAA,CAAA,EAChD;YAACS,mBAAAA,CAAcM,gBAAAA;AAAkB,SAAA,CAAA,CAAA;AAGvC,IAAA;;;AAIA,IAAA,IAAIrB,WAAW,IAAA,IAAQhB,SAAAA,CAAUkD,UAAU,EAAEC,YAAYV,SAAAA,EAAW;QAClExB,SAAAA,CAAUE,IAAI,CACZvB,OAAAA,CAAQwB,uBAAuB,CAC7BxB,OAAAA,CAAQyB,gBAAgB,CAACC,4BAAAA,CAAuB,aAAA,CAAA,CAAA,CAAA,CAAA;AAGtD,IAAA;;IAGA,IAAItB,SAAAA,CAAUoD,OAAO,IAAI,IAAA,IAAQ,OAAOpD,SAAAA,CAAUoD,OAAO,KAAK,UAAA,EAAY;QACxE,MAAMC,cAAAA,GAAiBtB,mBAAAA,CAAc/B,SAAAA,CAAUoD,OAAO,CAAA;QAEtDnC,SAAAA,CAAUE,IAAI,CACZvB,OAAAA,CAAQwB,uBAAuB,CAC7BxB,OAAAA,CAAQyB,gBAAgB,CAACC,4BAAAA,CAAuB,WAAA,CAAA,CAAA,EAChD;AAAC+B,YAAAA;AAAe,SAAA,CAAA,CAAA;AAGtB,IAAA;IAEA,OAAOpC,SAAAA;AACT;AAEA;;AAEC,IACD,MAAMqC,eAAAA,GAAkB,CAACtD,SAAAA,GACvBA,UAAUM,IAAI,KAAK,aAAA,IAClBN,SAAAA,CAAUM,IAAI,KAAK,WAAA,IAAeN,SAAAA,CAAUuD,UAAU,KAAK,IAAA;AAE9D;;;;;;IAOO,MAAMC,qBAAAA,GAAwB,CACnCxD,SAAAA,EACA,EAAEyD,eAAe,EAAiC,GAAG,EAAE,GAAA;;IAGvD,IAAIzD,SAAAA,CAAU0D,QAAQ,KAAK,KAAA,EAAO;QAChC,OAAOjB,SAAAA;AACT,IAAA;AAEA,IAAA,MAAMkB,UAAAA,GACJ3D,SAAAA,CAAUoD,OAAO,KAAKX,SAAAA,IACtBzC,SAAAA,CAAUoD,OAAO,KAAK,IAAA,IACtB,OAAOpD,SAAAA,CAAUoD,OAAO,KAAK,UAAA;;AAE/B,IAAA,MAAMQ,cACJD,UAAAA,KAAe,IAAA,GACX,CAAC,SAAS,EAAEE,KAAKC,SAAS,CAAC9D,SAAAA,CAAUoD,OAAO,EAAEW,UAAU,CAAC,MAAM,MAAA,CAAA,CAAQ,CAAC,CAAC,GACzE,EAAA;IAEN,IAAI/D,SAAAA,CAAUkB,QAAQ,KAAK,IAAA,EAAM;QAC/B,IAAIoC,eAAAA,CAAgBtD,eAAe,IAAA,EAAM;YACvC,OAAO,eAAA;AACT,QAAA;QAEA,OAAO2D,UAAAA,KAAe,OAAOC,WAAAA,GAAcnB,SAAAA;AAC7C,IAAA;AAEA,IAAA,IAAIzC,SAAAA,CAAUkD,UAAU,EAAEC,OAAAA,KAAYV,SAAAA,EAAW;QAC/C,OAAO,4CAAA;AACT,IAAA;IAEA,IAAIa,eAAAA,CAAgBtD,eAAe,IAAA,EAAM;QACvC,OAAO,2EAAA;AACT,IAAA;AAEA,IAAA,IAAIA,UAAUM,IAAI,KAAK,cAAcN,SAAAA,CAAUM,IAAI,KAAK,OAAA,EAAS;QAC/D,OAAO,qEAAA;AACT,IAAA;AAEA,IAAA,IAAImD,oBAAoB,KAAA,EAAO;AAC7B,QAAA,OAAOE,eAAe,IAAA,GAAO,CAAA,EAAGC,WAAAA,CAAY,gBAAgB,CAAC,GAAG,yBAAA;AAClE,IAAA;AAEA,IAAA,OAAOD,eAAe,IAAA,GAClB,CAAA,EAAGC,WAAAA,CAAY,yBAAyB,CAAC,GACzC,iDAAA;AACN;AAEA;;UAGaI,4BAAAA,GAA+B,CAC1CC,QACAlE,aAAAA,EACAC,SAAAA,EACA8B,OAAAA,GAA4B,EAAE,GAAA;AAE9B,IAAA,MAAMoC,QAAAA,GAAWpE,gBAAAA,CAAiBC,aAAAA,EAAeC,SAAAA,EAAWiE,OAAOhE,GAAG,CAAA;AAEtE,IAAA,IAAIiE,aAAa,IAAA,EAAM;QACrB,OAAO,IAAA;AACT,IAAA;IAEA,MAAMjD,SAAAA,GAAYF,sBAAsBf,SAAAA,EAAW8B,OAAAA,CAAAA;AAEnD,IAAA,MAAMqC,KAAAA,GAAQ;AAACD,QAAAA,QAAAA;AAAajD,QAAAA,GAAAA;AAAU,KAAA;AAEtC,IAAA,MAAMmD,SAAAA,GAAYxE,OAAAA,CAAQyE,uBAAuB,CAC/C5B,SAAAA,EACA7C,OAAAA,CAAQyB,gBAAgB,CAACtB,aAAAA,CAAAA,EACzB0C,SAAAA,EACA7C,OAAAA,CAAQ0E,0BAA0B,CAACH,KAAAA,CAAAA,CAAAA;;IAIrC,IAAIrC,OAAAA,CAAQd,MAAM,KAAK,IAAA,EAAM;QAC3B,MAAMuD,IAAAA,GAAOf,sBAAsBxD,SAAAA,EAAW;YAC5CyD,eAAAA,EACEQ,MAAAA,CAAOO,SAAS,KAAK,aAAA,GAAgBP,OAAOnC,OAAO,EAAE2B,oBAAoB,IAAA,GAAOhB;AACpF,SAAA,CAAA;AAEA,QAAA,IAAI8B,SAAS9B,SAAAA,EAAW;AACtB5C,YAAAA,aAAAA,CAAG4E,0BAA0B,CAC3BL,SAAAA,EACAvE,aAAAA,CAAG+C,UAAU,CAAC8B,sBAAsB,EACpC,CAAC,EAAE,EAAEH,IAAAA,CAAK,CAAC,CAAC,EACZ,IAAA,CAAA;AAEJ,QAAA;AACF,IAAA;IAEA,OAAOH,SAAAA;AACT;;;;;;;;"}

package/dist/generators/common/models/attributes.mjs

@@ -0,0 +1,176 @@
+import * as ts from 'typescript';
+import _ from 'lodash';
+import { addImport } from '../imports.mjs';
+import { getTypeNode, withAttributeNamespace, toTypeLiteral, NAMESPACES } from './utils.mjs';
+import { mappers } from './mappers.mjs';
+
+const { factory } = ts;
+/**
+ * Create the base type node for a given attribute
+ */ const getAttributeType = (attributeName, attribute, uid)=>{
+    if (!Object.keys(mappers).includes(attribute.type)) {
+        console.warn(`"${attributeName}" attribute from "${uid}" has an invalid type: "${attribute.type}"`);
+        return null;
+    }
+    const [attributeType, typeParams] = mappers[attribute.type]({
+        uid,
+        attribute,
+        attributeName
+    });
+    // Make sure the schema namespace is imported
+    addImport(NAMESPACES.Schema);
+    return getTypeNode(attributeType, typeParams);
+};
+/**
+ * Collect every modifier node from an attribute
+ */ const getAttributeModifiers = (attribute, { strict = false } = {})=>{
+    const modifiers = [];
+    // Required
+    if (attribute.required) {
+        modifiers.push(factory.createTypeReferenceNode(factory.createIdentifier(withAttributeNamespace('Required'))));
+    }
+    // Private
+    if (attribute.private) {
+        modifiers.push(factory.createTypeReferenceNode(factory.createIdentifier(withAttributeNamespace('Private'))));
+    }
+    // Unique
+    if (attribute.unique) {
+        modifiers.push(factory.createTypeReferenceNode(factory.createIdentifier(withAttributeNamespace('Unique'))));
+    }
+    // Configurable
+    if (attribute.configurable) {
+        modifiers.push(factory.createTypeReferenceNode(factory.createIdentifier(withAttributeNamespace('Configurable'))));
+    }
+    // Custom field
+    if (attribute.customField) {
+        const customFieldUid = factory.createStringLiteral(attribute.customField);
+        const typeArguments = [
+            customFieldUid
+        ];
+        if (attribute.options) {
+            typeArguments.push(toTypeLiteral(attribute.options));
+        }
+        modifiers.push(factory.createTypeReferenceNode(factory.createIdentifier(withAttributeNamespace('CustomField')), typeArguments));
+    }
+    // Plugin Options
+    if (!_.isEmpty(attribute.pluginOptions)) {
+        modifiers.push(factory.createTypeReferenceNode(factory.createIdentifier(withAttributeNamespace('SetPluginOptions')), // Transform the pluginOptions object into an object literal expression
+        [
+            toTypeLiteral(attribute.pluginOptions)
+        ]));
+    }
+    // Min / Max
+    if (attribute.min != null || attribute.max != null) {
+        const minMaxProperties = _.pick(attribute, [
+            'min',
+            'max'
+        ]);
+        const { min, max } = minMaxProperties;
+        const typeofMin = typeof min;
+        const typeofMax = typeof max;
+        // Throws error if min/max exist but have different types to prevent unexpected behavior
+        if (min !== undefined && max !== undefined && typeofMin !== typeofMax) {
+            throw new Error('typeof min/max values mismatch');
+        }
+        let typeKeyword;
+        // use 'string'
+        if (typeofMin === 'string' || typeofMax === 'string') {
+            typeKeyword = ts.SyntaxKind.StringKeyword;
+        } else if (typeofMin === 'number' || typeofMax === 'number') {
+            typeKeyword = ts.SyntaxKind.NumberKeyword;
+        } else {
+            throw new Error(`Invalid data type for min/max options. Must be string, number or undefined, but found { min: ${min} (${typeofMin}), max: ${max} (${typeofMax}) }`);
+        }
+        modifiers.push(factory.createTypeReferenceNode(factory.createIdentifier(withAttributeNamespace('SetMinMax')), [
+            toTypeLiteral(minMaxProperties),
+            factory.createKeywordTypeNode(typeKeyword)
+        ]));
+    }
+    // Min length / Max length
+    if (attribute.minLength != null || attribute.maxLength != null) {
+        const minMaxProperties = _.pick(attribute, [
+            'minLength',
+            'maxLength'
+        ]);
+        modifiers.push(factory.createTypeReferenceNode(factory.createIdentifier(withAttributeNamespace('SetMinMaxLength')), [
+            toTypeLiteral(minMaxProperties)
+        ]));
+    }
+    // Conditional (strict types only): a field hidden by its `conditions.visible` rule skips
+    // validation, so the strict write inputs make it optional and nullable
+    if (strict === true && attribute.conditions?.visible !== undefined) {
+        modifiers.push(factory.createTypeReferenceNode(factory.createIdentifier(withAttributeNamespace('Conditional'))));
+    }
+    // Default (ignore if default is a function)
+    if (attribute.default != null && typeof attribute.default !== 'function') {
+        const defaultLiteral = toTypeLiteral(attribute.default);
+        modifiers.push(factory.createTypeReferenceNode(factory.createIdentifier(withAttributeNamespace('DefaultTo')), [
+            defaultLiteral
+        ]));
+    }
+    return modifiers;
+};
+/**
+ * Whether the attribute is a list of components: a repeatable component or a dynamic zone.
+ */ const isComponentList = (attribute)=>attribute.type === 'dynamiczone' || attribute.type === 'component' && attribute.repeatable === true;
+/**
+ * The write rule of an attribute, as one sentence for its JSDoc, or `undefined` when the attribute
+ * has none to tell. It mirrors the strict write inputs of `@strapi/types`
+ * (`modules/documents/params/write.ts`), which follow the entity validator of `@strapi/core`.
+ *
+ * `draftAndPublish` is `undefined` for a component: its fields follow the mode of the parent entry.
+ */ const getAttributeWriteRule = (attribute, { draftAndPublish } = {})=>{
+    // The validator skips attributes that are not writable
+    if (attribute.writable === false) {
+        return undefined;
+    }
+    const hasDefault = attribute.default !== undefined && attribute.default !== null && typeof attribute.default !== 'function';
+    // `*/` in a default value would end the comment
+    const defaultRule = hasDefault === true ? `Default: ${JSON.stringify(attribute.default).replaceAll('*/', '*\\/')}.` : '';
+    if (attribute.required !== true) {
+        if (isComponentList(attribute) === true) {
+            return 'Never `null`.';
+        }
+        return hasDefault === true ? defaultRule : undefined;
+    }
+    if (attribute.conditions?.visible !== undefined) {
+        return 'Required only when its condition shows it.';
+    }
+    if (isComponentList(attribute) === true) {
+        return 'Required on every create, drafts included (`[]` is enough). Never `null`.';
+    }
+    if (attribute.type === 'relation' || attribute.type === 'media') {
+        return 'Required when published, only with `api.documents.strictRelations`.';
+    }
+    if (draftAndPublish === false) {
+        return hasDefault === true ? `${defaultRule} Never \`null\`.` : 'Required. Never `null`.';
+    }
+    return hasDefault === true ? `${defaultRule} \`null\` only in drafts.` : 'Required when published. `null` only in drafts.';
+};
+/**
+ * Generate a property signature node for a given attribute
+ */ const attributeToPropertySignature = (schema, attributeName, attribute, options = {})=>{
+    const baseType = getAttributeType(attributeName, attribute, schema.uid);
+    if (baseType === null) {
+        return null;
+    }
+    const modifiers = getAttributeModifiers(attribute, options);
+    const nodes = [
+        baseType,
+        ...modifiers
+    ];
+    const signature = factory.createPropertySignature(undefined, factory.createIdentifier(attributeName), undefined, factory.createIntersectionTypeNode(nodes));
+    // Strict types only: editors show the write rule on the attribute and on the input keys
+    if (options.strict === true) {
+        const rule = getAttributeWriteRule(attribute, {
+            draftAndPublish: schema.modelType === 'contentType' ? schema.options?.draftAndPublish === true : undefined
+        });
+        if (rule !== undefined) {
+            ts.addSyntheticLeadingComment(signature, ts.SyntaxKind.MultiLineCommentTrivia, `* ${rule} `, true);
+        }
+    }
+    return signature;
+};
+
+export { attributeToPropertySignature, getAttributeModifiers, getAttributeType, getAttributeWriteRule, mappers };
+//# sourceMappingURL=attributes.mjs.map

package/dist/generators/common/models/attributes.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"attributes.mjs","sources":["../../../../src/generators/common/models/attributes.ts"],"sourcesContent":["import * as ts from 'typescript';\nimport _ from 'lodash';\n\nimport { addImport } from '../imports';\nimport { getTypeNode, toTypeLiteral, withAttributeNamespace, NAMESPACES } from './utils';\nimport type { Attribute, Schema } from './utils';\nimport { mappers } from './mappers';\n\nconst { factory } = ts;\n\n/**\n * Create the base type node for a given attribute\n */\nexport const getAttributeType = (\n  attributeName: string,\n  attribute: Attribute,\n  uid?: string\n): ts.TypeReferenceNode | null => {\n  if (!Object.keys(mappers).includes(attribute.type)) {\n    console.warn(\n      `\"${attributeName}\" attribute from \"${uid}\" has an invalid type: \"${attribute.type}\"`\n    );\n\n    return null;\n  }\n\n  const [attributeType, typeParams] = mappers[attribute.type]({ uid, attribute, attributeName });\n\n  // Make sure the schema namespace is imported\n  addImport(NAMESPACES.Schema);\n\n  return getTypeNode(attributeType, typeParams);\n};\n\n/**\n * Options of the attribute generators.\n */\nexport type AttributeOptions = {\n  /**\n   * Whether the application enables `typescript.strictTypes`. Strict-only modifiers, such as\n   * `Schema.Attribute.Conditional`, are emitted only then, so generated files without strict types\n   * stay as in previous releases.\n   */\n  strict?: boolean;\n};\n\n/**\n * Collect every modifier node from an attribute\n */\nexport const getAttributeModifiers = (\n  attribute: Attribute,\n  { strict = false }: AttributeOptions = {}\n): ts.TypeNode[] => {\n  const modifiers: ts.TypeNode[] = [];\n\n  // Required\n  if (attribute.required) {\n    modifiers.push(\n      factory.createTypeReferenceNode(factory.createIdentifier(withAttributeNamespace('Required')))\n    );\n  }\n\n  // Private\n  if (attribute.private) {\n    modifiers.push(\n      factory.createTypeReferenceNode(factory.createIdentifier(withAttributeNamespace('Private')))\n    );\n  }\n\n  // Unique\n  if (attribute.unique) {\n    modifiers.push(\n      factory.createTypeReferenceNode(factory.createIdentifier(withAttributeNamespace('Unique')))\n    );\n  }\n\n  // Configurable\n  if (attribute.configurable) {\n    modifiers.push(\n      factory.createTypeReferenceNode(\n        factory.createIdentifier(withAttributeNamespace('Configurable'))\n      )\n    );\n  }\n\n  // Custom field\n  if (attribute.customField) {\n    const customFieldUid = factory.createStringLiteral(attribute.customField);\n    const typeArguments: any[] = [customFieldUid];\n\n    if (attribute.options) {\n      typeArguments.push(toTypeLiteral(attribute.options));\n    }\n\n    modifiers.push(\n      factory.createTypeReferenceNode(\n        factory.createIdentifier(withAttributeNamespace('CustomField')),\n        typeArguments\n      )\n    );\n  }\n\n  // Plugin Options\n  if (!_.isEmpty(attribute.pluginOptions)) {\n    modifiers.push(\n      factory.createTypeReferenceNode(\n        factory.createIdentifier(withAttributeNamespace('SetPluginOptions')),\n        // Transform the pluginOptions object into an object literal expression\n        [toTypeLiteral(attribute.pluginOptions)]\n      )\n    );\n  }\n\n  // Min / Max\n  if (attribute.min != null || attribute.max != null) {\n    const minMaxProperties = _.pick(attribute, ['min', 'max']);\n    const { min, max } = minMaxProperties;\n\n    const typeofMin = typeof min;\n    const typeofMax = typeof max;\n\n    // Throws error if min/max exist but have different types to prevent unexpected behavior\n    if (min !== undefined && max !== undefined && typeofMin !== typeofMax) {\n      throw new Error('typeof min/max values mismatch');\n    }\n\n    let typeKeyword: any;\n\n    // use 'string'\n    if (typeofMin === 'string' || typeofMax === 'string') {\n      typeKeyword = ts.SyntaxKind.StringKeyword;\n    }\n    // use 'number'\n    else if (typeofMin === 'number' || typeofMax === 'number') {\n      typeKeyword = ts.SyntaxKind.NumberKeyword;\n    }\n    // invalid type\n    else {\n      throw new Error(\n        `Invalid data type for min/max options. Must be string, number or undefined, but found { min: ${min} (${typeofMin}), max: ${max} (${typeofMax}) }`\n      );\n    }\n\n    modifiers.push(\n      factory.createTypeReferenceNode(\n        factory.createIdentifier(withAttributeNamespace('SetMinMax')),\n        [toTypeLiteral(minMaxProperties), factory.createKeywordTypeNode(typeKeyword)]\n      )\n    );\n  }\n\n  // Min length / Max length\n  if (attribute.minLength != null || attribute.maxLength != null) {\n    const minMaxProperties = _.pick(attribute, ['minLength', 'maxLength']);\n\n    modifiers.push(\n      factory.createTypeReferenceNode(\n        factory.createIdentifier(withAttributeNamespace('SetMinMaxLength')),\n        [toTypeLiteral(minMaxProperties)]\n      )\n    );\n  }\n\n  // Conditional (strict types only): a field hidden by its `conditions.visible` rule skips\n  // validation, so the strict write inputs make it optional and nullable\n  if (strict === true && attribute.conditions?.visible !== undefined) {\n    modifiers.push(\n      factory.createTypeReferenceNode(\n        factory.createIdentifier(withAttributeNamespace('Conditional'))\n      )\n    );\n  }\n\n  // Default (ignore if default is a function)\n  if (attribute.default != null && typeof attribute.default !== 'function') {\n    const defaultLiteral = toTypeLiteral(attribute.default);\n\n    modifiers.push(\n      factory.createTypeReferenceNode(\n        factory.createIdentifier(withAttributeNamespace('DefaultTo')),\n        [defaultLiteral]\n      )\n    );\n  }\n\n  return modifiers;\n};\n\n/**\n * Whether the attribute is a list of components: a repeatable component or a dynamic zone.\n */\nconst isComponentList = (attribute: Attribute) =>\n  attribute.type === 'dynamiczone' ||\n  (attribute.type === 'component' && attribute.repeatable === true);\n\n/**\n * The write rule of an attribute, as one sentence for its JSDoc, or `undefined` when the attribute\n * has none to tell. It mirrors the strict write inputs of `@strapi/types`\n * (`modules/documents/params/write.ts`), which follow the entity validator of `@strapi/core`.\n *\n * `draftAndPublish` is `undefined` for a component: its fields follow the mode of the parent entry.\n */\nexport const getAttributeWriteRule = (\n  attribute: Attribute,\n  { draftAndPublish }: { draftAndPublish?: boolean } = {}\n): string | undefined => {\n  // The validator skips attributes that are not writable\n  if (attribute.writable === false) {\n    return undefined;\n  }\n\n  const hasDefault =\n    attribute.default !== undefined &&\n    attribute.default !== null &&\n    typeof attribute.default !== 'function';\n  // `*/` in a default value would end the comment\n  const defaultRule =\n    hasDefault === true\n      ? `Default: ${JSON.stringify(attribute.default).replaceAll('*/', '*\\\\/')}.`\n      : '';\n\n  if (attribute.required !== true) {\n    if (isComponentList(attribute) === true) {\n      return 'Never `null`.';\n    }\n\n    return hasDefault === true ? defaultRule : undefined;\n  }\n\n  if (attribute.conditions?.visible !== undefined) {\n    return 'Required only when its condition shows it.';\n  }\n\n  if (isComponentList(attribute) === true) {\n    return 'Required on every create, drafts included (`[]` is enough). Never `null`.';\n  }\n\n  if (attribute.type === 'relation' || attribute.type === 'media') {\n    return 'Required when published, only with `api.documents.strictRelations`.';\n  }\n\n  if (draftAndPublish === false) {\n    return hasDefault === true ? `${defaultRule} Never \\`null\\`.` : 'Required. Never `null`.';\n  }\n\n  return hasDefault === true\n    ? `${defaultRule} \\`null\\` only in drafts.`\n    : 'Required when published. `null` only in drafts.';\n};\n\n/**\n * Generate a property signature node for a given attribute\n */\nexport const attributeToPropertySignature = (\n  schema: Schema,\n  attributeName: string,\n  attribute: Attribute,\n  options: AttributeOptions = {}\n): ts.PropertySignature | null => {\n  const baseType = getAttributeType(attributeName, attribute, schema.uid);\n\n  if (baseType === null) {\n    return null;\n  }\n\n  const modifiers = getAttributeModifiers(attribute, options);\n\n  const nodes = [baseType, ...modifiers];\n\n  const signature = factory.createPropertySignature(\n    undefined,\n    factory.createIdentifier(attributeName),\n    undefined,\n    factory.createIntersectionTypeNode(nodes)\n  );\n\n  // Strict types only: editors show the write rule on the attribute and on the input keys\n  if (options.strict === true) {\n    const rule = getAttributeWriteRule(attribute, {\n      draftAndPublish:\n        schema.modelType === 'contentType' ? schema.options?.draftAndPublish === true : undefined,\n    });\n\n    if (rule !== undefined) {\n      ts.addSyntheticLeadingComment(\n        signature,\n        ts.SyntaxKind.MultiLineCommentTrivia,\n        `* ${rule} `,\n        true\n      );\n    }\n  }\n\n  return signature;\n};\n\nexport { mappers };\n"],"names":["factory","ts","getAttributeType","attributeName","attribute","uid","Object","keys","mappers","includes","type","console","warn","attributeType","typeParams","addImport","NAMESPACES","Schema","getTypeNode","getAttributeModifiers","strict","modifiers","required","push","createTypeReferenceNode","createIdentifier","withAttributeNamespace","private","unique","configurable","customField","customFieldUid","createStringLiteral","typeArguments","options","toTypeLiteral","_","isEmpty","pluginOptions","min","max","minMaxProperties","pick","typeofMin","typeofMax","undefined","Error","typeKeyword","SyntaxKind","StringKeyword","NumberKeyword","createKeywordTypeNode","minLength","maxLength","conditions","visible","default","defaultLiteral","isComponentList","repeatable","getAttributeWriteRule","draftAndPublish","writable","hasDefault","defaultRule","JSON","stringify","replaceAll","attributeToPropertySignature","schema","baseType","nodes","signature","createPropertySignature","createIntersectionTypeNode","rule","modelType","addSyntheticLeadingComment","MultiLineCommentTrivia"],"mappings":";;;;;;AAQA,MAAM,EAAEA,OAAO,EAAE,GAAGC,EAAAA;AAEpB;;AAEC,IACM,MAAMC,gBAAAA,GAAmB,CAC9BC,eACAC,SAAAA,EACAC,GAAAA,GAAAA;IAEA,IAAI,CAACC,OAAOC,IAAI,CAACC,SAASC,QAAQ,CAACL,SAAAA,CAAUM,IAAI,CAAA,EAAG;AAClDC,QAAAA,OAAAA,CAAQC,IAAI,CACV,CAAC,CAAC,EAAET,aAAAA,CAAc,kBAAkB,EAAEE,GAAAA,CAAI,wBAAwB,EAAED,SAAAA,CAAUM,IAAI,CAAC,CAAC,CAAC,CAAA;QAGvF,OAAO,IAAA;AACT,IAAA;IAEA,MAAM,CAACG,eAAeC,UAAAA,CAAW,GAAGN,OAAO,CAACJ,SAAAA,CAAUM,IAAI,CAAC,CAAC;AAAEL,QAAAA,GAAAA;AAAKD,QAAAA,SAAAA;AAAWD,QAAAA;AAAc,KAAA,CAAA;;AAG5FY,IAAAA,SAAAA,CAAUC,WAAWC,MAAM,CAAA;AAE3B,IAAA,OAAOC,YAAYL,aAAAA,EAAeC,UAAAA,CAAAA;AACpC;AAcA;;IAGO,MAAMK,qBAAAA,GAAwB,CACnCf,SAAAA,EACA,EAAEgB,MAAAA,GAAS,KAAK,EAAoB,GAAG,EAAE,GAAA;AAEzC,IAAA,MAAMC,YAA2B,EAAE;;IAGnC,IAAIjB,SAAAA,CAAUkB,QAAQ,EAAE;QACtBD,SAAAA,CAAUE,IAAI,CACZvB,OAAAA,CAAQwB,uBAAuB,CAACxB,OAAAA,CAAQyB,gBAAgB,CAACC,sBAAAA,CAAuB,UAAA,CAAA,CAAA,CAAA,CAAA;AAEpF,IAAA;;IAGA,IAAItB,SAAAA,CAAUuB,OAAO,EAAE;QACrBN,SAAAA,CAAUE,IAAI,CACZvB,OAAAA,CAAQwB,uBAAuB,CAACxB,OAAAA,CAAQyB,gBAAgB,CAACC,sBAAAA,CAAuB,SAAA,CAAA,CAAA,CAAA,CAAA;AAEpF,IAAA;;IAGA,IAAItB,SAAAA,CAAUwB,MAAM,EAAE;QACpBP,SAAAA,CAAUE,IAAI,CACZvB,OAAAA,CAAQwB,uBAAuB,CAACxB,OAAAA,CAAQyB,gBAAgB,CAACC,sBAAAA,CAAuB,QAAA,CAAA,CAAA,CAAA,CAAA;AAEpF,IAAA;;IAGA,IAAItB,SAAAA,CAAUyB,YAAY,EAAE;QAC1BR,SAAAA,CAAUE,IAAI,CACZvB,OAAAA,CAAQwB,uBAAuB,CAC7BxB,OAAAA,CAAQyB,gBAAgB,CAACC,sBAAAA,CAAuB,cAAA,CAAA,CAAA,CAAA,CAAA;AAGtD,IAAA;;IAGA,IAAItB,SAAAA,CAAU0B,WAAW,EAAE;AACzB,QAAA,MAAMC,cAAAA,GAAiB/B,OAAAA,CAAQgC,mBAAmB,CAAC5B,UAAU0B,WAAW,CAAA;AACxE,QAAA,MAAMG,aAAAA,GAAuB;AAACF,YAAAA;AAAe,SAAA;QAE7C,IAAI3B,SAAAA,CAAU8B,OAAO,EAAE;AACrBD,YAAAA,aAAAA,CAAcV,IAAI,CAACY,aAAAA,CAAc/B,SAAAA,CAAU8B,OAAO,CAAA,CAAA;AACpD,QAAA;QAEAb,SAAAA,CAAUE,IAAI,CACZvB,OAAAA,CAAQwB,uBAAuB,CAC7BxB,OAAAA,CAAQyB,gBAAgB,CAACC,sBAAAA,CAAuB,aAAA,CAAA,CAAA,EAChDO,aAAAA,CAAAA,CAAAA;AAGN,IAAA;;AAGA,IAAA,IAAI,CAACG,CAAAA,CAAEC,OAAO,CAACjC,SAAAA,CAAUkC,aAAa,CAAA,EAAG;QACvCjB,SAAAA,CAAUE,IAAI,CACZvB,OAAAA,CAAQwB,uBAAuB,CAC7BxB,QAAQyB,gBAAgB,CAACC,sBAAAA,CAAuB,kBAAA,CAAA,CAAA;AAEhD,QAAA;AAACS,YAAAA,aAAAA,CAAc/B,UAAUkC,aAAa;AAAE,SAAA,CAAA,CAAA;AAG9C,IAAA;;AAGA,IAAA,IAAIlC,UAAUmC,GAAG,IAAI,QAAQnC,SAAAA,CAAUoC,GAAG,IAAI,IAAA,EAAM;AAClD,QAAA,MAAMC,gBAAAA,GAAmBL,CAAAA,CAAEM,IAAI,CAACtC,SAAAA,EAAW;AAAC,YAAA,KAAA;AAAO,YAAA;AAAM,SAAA,CAAA;AACzD,QAAA,MAAM,EAAEmC,GAAG,EAAEC,GAAG,EAAE,GAAGC,gBAAAA;AAErB,QAAA,MAAME,YAAY,OAAOJ,GAAAA;AACzB,QAAA,MAAMK,YAAY,OAAOJ,GAAAA;;AAGzB,QAAA,IAAID,GAAAA,KAAQM,SAAAA,IAAaL,GAAAA,KAAQK,SAAAA,IAAaF,cAAcC,SAAAA,EAAW;AACrE,YAAA,MAAM,IAAIE,KAAAA,CAAM,gCAAA,CAAA;AAClB,QAAA;QAEA,IAAIC,WAAAA;;QAGJ,IAAIJ,SAAAA,KAAc,QAAA,IAAYC,SAAAA,KAAc,QAAA,EAAU;YACpDG,WAAAA,GAAc9C,EAAAA,CAAG+C,UAAU,CAACC,aAAa;AAC3C,QAAA,CAAA,MAEK,IAAIN,SAAAA,KAAc,QAAA,IAAYC,SAAAA,KAAc,QAAA,EAAU;YACzDG,WAAAA,GAAc9C,EAAAA,CAAG+C,UAAU,CAACE,aAAa;QAC3C,CAAA,MAEK;AACH,YAAA,MAAM,IAAIJ,KAAAA,CACR,CAAC,6FAA6F,EAAEP,IAAI,EAAE,EAAEI,SAAAA,CAAU,QAAQ,EAAEH,GAAAA,CAAI,EAAE,EAAEI,SAAAA,CAAU,GAAG,CAAC,CAAA;AAEtJ,QAAA;QAEAvB,SAAAA,CAAUE,IAAI,CACZvB,OAAAA,CAAQwB,uBAAuB,CAC7BxB,OAAAA,CAAQyB,gBAAgB,CAACC,sBAAAA,CAAuB,WAAA,CAAA,CAAA,EAChD;YAACS,aAAAA,CAAcM,gBAAAA,CAAAA;AAAmBzC,YAAAA,OAAAA,CAAQmD,qBAAqB,CAACJ,WAAAA;AAAa,SAAA,CAAA,CAAA;AAGnF,IAAA;;AAGA,IAAA,IAAI3C,UAAUgD,SAAS,IAAI,QAAQhD,SAAAA,CAAUiD,SAAS,IAAI,IAAA,EAAM;AAC9D,QAAA,MAAMZ,gBAAAA,GAAmBL,CAAAA,CAAEM,IAAI,CAACtC,SAAAA,EAAW;AAAC,YAAA,WAAA;AAAa,YAAA;AAAY,SAAA,CAAA;QAErEiB,SAAAA,CAAUE,IAAI,CACZvB,OAAAA,CAAQwB,uBAAuB,CAC7BxB,OAAAA,CAAQyB,gBAAgB,CAACC,sBAAAA,CAAuB,iBAAA,CAAA,CAAA,EAChD;YAACS,aAAAA,CAAcM,gBAAAA;AAAkB,SAAA,CAAA,CAAA;AAGvC,IAAA;;;AAIA,IAAA,IAAIrB,WAAW,IAAA,IAAQhB,SAAAA,CAAUkD,UAAU,EAAEC,YAAYV,SAAAA,EAAW;QAClExB,SAAAA,CAAUE,IAAI,CACZvB,OAAAA,CAAQwB,uBAAuB,CAC7BxB,OAAAA,CAAQyB,gBAAgB,CAACC,sBAAAA,CAAuB,aAAA,CAAA,CAAA,CAAA,CAAA;AAGtD,IAAA;;IAGA,IAAItB,SAAAA,CAAUoD,OAAO,IAAI,IAAA,IAAQ,OAAOpD,SAAAA,CAAUoD,OAAO,KAAK,UAAA,EAAY;QACxE,MAAMC,cAAAA,GAAiBtB,aAAAA,CAAc/B,SAAAA,CAAUoD,OAAO,CAAA;QAEtDnC,SAAAA,CAAUE,IAAI,CACZvB,OAAAA,CAAQwB,uBAAuB,CAC7BxB,OAAAA,CAAQyB,gBAAgB,CAACC,sBAAAA,CAAuB,WAAA,CAAA,CAAA,EAChD;AAAC+B,YAAAA;AAAe,SAAA,CAAA,CAAA;AAGtB,IAAA;IAEA,OAAOpC,SAAAA;AACT;AAEA;;AAEC,IACD,MAAMqC,eAAAA,GAAkB,CAACtD,SAAAA,GACvBA,UAAUM,IAAI,KAAK,aAAA,IAClBN,SAAAA,CAAUM,IAAI,KAAK,WAAA,IAAeN,SAAAA,CAAUuD,UAAU,KAAK,IAAA;AAE9D;;;;;;IAOO,MAAMC,qBAAAA,GAAwB,CACnCxD,SAAAA,EACA,EAAEyD,eAAe,EAAiC,GAAG,EAAE,GAAA;;IAGvD,IAAIzD,SAAAA,CAAU0D,QAAQ,KAAK,KAAA,EAAO;QAChC,OAAOjB,SAAAA;AACT,IAAA;AAEA,IAAA,MAAMkB,UAAAA,GACJ3D,SAAAA,CAAUoD,OAAO,KAAKX,SAAAA,IACtBzC,SAAAA,CAAUoD,OAAO,KAAK,IAAA,IACtB,OAAOpD,SAAAA,CAAUoD,OAAO,KAAK,UAAA;;AAE/B,IAAA,MAAMQ,cACJD,UAAAA,KAAe,IAAA,GACX,CAAC,SAAS,EAAEE,KAAKC,SAAS,CAAC9D,SAAAA,CAAUoD,OAAO,EAAEW,UAAU,CAAC,MAAM,MAAA,CAAA,CAAQ,CAAC,CAAC,GACzE,EAAA;IAEN,IAAI/D,SAAAA,CAAUkB,QAAQ,KAAK,IAAA,EAAM;QAC/B,IAAIoC,eAAAA,CAAgBtD,eAAe,IAAA,EAAM;YACvC,OAAO,eAAA;AACT,QAAA;QAEA,OAAO2D,UAAAA,KAAe,OAAOC,WAAAA,GAAcnB,SAAAA;AAC7C,IAAA;AAEA,IAAA,IAAIzC,SAAAA,CAAUkD,UAAU,EAAEC,OAAAA,KAAYV,SAAAA,EAAW;QAC/C,OAAO,4CAAA;AACT,IAAA;IAEA,IAAIa,eAAAA,CAAgBtD,eAAe,IAAA,EAAM;QACvC,OAAO,2EAAA;AACT,IAAA;AAEA,IAAA,IAAIA,UAAUM,IAAI,KAAK,cAAcN,SAAAA,CAAUM,IAAI,KAAK,OAAA,EAAS;QAC/D,OAAO,qEAAA;AACT,IAAA;AAEA,IAAA,IAAImD,oBAAoB,KAAA,EAAO;AAC7B,QAAA,OAAOE,eAAe,IAAA,GAAO,CAAA,EAAGC,WAAAA,CAAY,gBAAgB,CAAC,GAAG,yBAAA;AAClE,IAAA;AAEA,IAAA,OAAOD,eAAe,IAAA,GAClB,CAAA,EAAGC,WAAAA,CAAY,yBAAyB,CAAC,GACzC,iDAAA;AACN;AAEA;;UAGaI,4BAAAA,GAA+B,CAC1CC,QACAlE,aAAAA,EACAC,SAAAA,EACA8B,OAAAA,GAA4B,EAAE,GAAA;AAE9B,IAAA,MAAMoC,QAAAA,GAAWpE,gBAAAA,CAAiBC,aAAAA,EAAeC,SAAAA,EAAWiE,OAAOhE,GAAG,CAAA;AAEtE,IAAA,IAAIiE,aAAa,IAAA,EAAM;QACrB,OAAO,IAAA;AACT,IAAA;IAEA,MAAMjD,SAAAA,GAAYF,sBAAsBf,SAAAA,EAAW8B,OAAAA,CAAAA;AAEnD,IAAA,MAAMqC,KAAAA,GAAQ;AAACD,QAAAA,QAAAA;AAAajD,QAAAA,GAAAA;AAAU,KAAA;AAEtC,IAAA,MAAMmD,SAAAA,GAAYxE,OAAAA,CAAQyE,uBAAuB,CAC/C5B,SAAAA,EACA7C,OAAAA,CAAQyB,gBAAgB,CAACtB,aAAAA,CAAAA,EACzB0C,SAAAA,EACA7C,OAAAA,CAAQ0E,0BAA0B,CAACH,KAAAA,CAAAA,CAAAA;;IAIrC,IAAIrC,OAAAA,CAAQd,MAAM,KAAK,IAAA,EAAM;QAC3B,MAAMuD,IAAAA,GAAOf,sBAAsBxD,SAAAA,EAAW;YAC5CyD,eAAAA,EACEQ,MAAAA,CAAOO,SAAS,KAAK,aAAA,GAAgBP,OAAOnC,OAAO,EAAE2B,oBAAoB,IAAA,GAAOhB;AACpF,SAAA,CAAA;AAEA,QAAA,IAAI8B,SAAS9B,SAAAA,EAAW;AACtB5C,YAAAA,EAAAA,CAAG4E,0BAA0B,CAC3BL,SAAAA,EACAvE,EAAAA,CAAG+C,UAAU,CAAC8B,sBAAsB,EACpC,CAAC,EAAE,EAAEH,IAAAA,CAAK,CAAC,CAAC,EACZ,IAAA,CAAA;AAEJ,QAAA;AACF,IAAA;IAEA,OAAOH,SAAAA;AACT;;;;"}

package/dist/generators/common/models/index.d.ts

@@ -0,0 +1,7 @@
+import * as schema from './schema';
+import * as attributes from './attributes';
+import { mappers } from './mappers';
+import * as utils from './utils';
+import * as imports from '../imports';
+export { schema, attributes, mappers, utils, imports };
+//# sourceMappingURL=index.d.ts.map

package/dist/generators/common/models/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/generators/common/models/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,OAAO,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC"}

package/dist/generators/common/models/mappers.d.ts

@@ -0,0 +1,9 @@
+import type { Attribute } from './utils';
+export interface MapperContext {
+    uid?: string;
+    attribute: Attribute;
+    attributeName?: string;
+}
+export type Mapper = (context: MapperContext) => [string] | [string, any[]];
+export declare const mappers: Record<string, Mapper>;
+//# sourceMappingURL=mappers.d.ts.map

package/dist/generators/common/models/mappers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mappers.d.ts","sourceRoot":"","sources":["../../../../src/generators/common/models/mappers.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAIzC,MAAM,WAAW,aAAa;IAC5B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,SAAS,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,EAAE,aAAa,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;AA8J5E,eAAO,MAAM,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAuB1C,CAAC"}