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

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

@@ -0,0 +1,57 @@
+import * as ts from 'typescript';
+export declare const NAMESPACES: {
+    Struct: string;
+    Schema: string;
+};
+/**
+ * Shallow representation of a content-type/component attribute definition.
+ * Only the fields read by the generators are typed; the rest is left open.
+ */
+export interface Attribute {
+    type: string;
+    conditions?: {
+        visible?: unknown;
+    };
+    [key: string]: any;
+}
+/**
+ * Shallow representation of a content-type/component schema definition.
+ * Only the fields read by the generators are typed; the rest is left open.
+ */
+export interface Schema {
+    uid: string;
+    modelType?: string;
+    kind?: string;
+    attributes: Record<string, Attribute>;
+    [key: string]: any;
+}
+/**
+ * Extract a valid interface name from a schema uid
+ */
+export declare const getSchemaInterfaceName: (uid: string) => string;
+export declare const getSchemaModelType: (schema: Schema) => string | null | undefined;
+/**
+ * Get the parent type name to extend based on the schema's nature
+ */
+export declare const getSchemaExtendsTypeName: (schema: Schema) => string | null;
+/**
+ * Get a type node based on a type and its params
+ */
+export declare const getTypeNode: (typeName: string, params?: ts.TypeNode[]) => ts.TypeReferenceNode;
+/**
+ * Transform a regular JavaScript object or scalar value into a literal expression
+ */
+export declare const toTypeLiteral: (data: any) => any;
+/**
+ * Get the number of attributes generated for a given schema definition
+ */
+export declare const getDefinitionAttributesCount: (definition: ts.InterfaceDeclaration) => number | null;
+/**
+ * Add the Schema.Attribute namespace before the typename
+ */
+export declare const withAttributeNamespace: (typeName: string) => string;
+/**
+ * Add the schema namespace before the typename
+ */
+export declare const withSchemaNamespace: (typeName: string) => string;
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/generators/common/models/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AAcjC,eAAO,MAAM,UAAU;;;CAGtB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;IACnC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACtC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,eAAO,MAAM,sBAAsB,GAAI,KAAK,MAAM,KAAG,MACJ,CAAC;AAElD,eAAO,MAAM,kBAAkB,GAAI,QAAQ,MAAM,KAAG,MAAM,GAAG,IAAI,GAAG,SAcnE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,wBAAwB,GAAI,QAAQ,MAAM,KAAG,MAAM,GAAG,IAQlE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,GAAI,UAAU,MAAM,EAAE,SAAQ,EAAE,CAAC,QAAQ,EAAO,KAAG,EAAE,CAAC,iBAE7E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa,GAAI,MAAM,GAAG,KAAG,GA2DzC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,4BAA4B,GACvC,YAAY,EAAE,CAAC,oBAAoB,KAClC,MAAM,GAAG,IAUX,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB,GAAI,UAAU,MAAM,KAAG,MACZ,CAAC;AAE/C;;GAEG;AACH,eAAO,MAAM,mBAAmB,GAAI,UAAU,MAAM,KAAG,MACV,CAAC"}

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

@@ -0,0 +1,110 @@
+'use strict';
+
+var ts = require('typescript');
+var _ = require('lodash');
+var compare = require('../compare.js');
+
+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);
+
+const { factory } = ts__namespace;
+const NAMESPACES = {
+    Struct: 'Struct',
+    Schema: 'Schema'
+};
+/**
+ * Extract a valid interface name from a schema uid
+ */ const getSchemaInterfaceName = (uid)=>_.upperFirst(_.camelCase(uid.replace(/(:.)/, ' ')));
+const getSchemaModelType = (schema)=>{
+    const { modelType, kind } = schema;
+    // Components
+    if (modelType === 'component') {
+        return 'component';
+    }
+    // Content-Types
+    if (modelType === 'contentType') {
+        return kind;
+    }
+    return null;
+};
+/**
+ * Get the parent type name to extend based on the schema's nature
+ */ const getSchemaExtendsTypeName = (schema)=>{
+    const base = getSchemaModelType(schema);
+    if (base === null) {
+        return null;
+    }
+    return `${NAMESPACES.Struct}.${_.upperFirst(base)}Schema`;
+};
+/**
+ * Get a type node based on a type and its params
+ */ const getTypeNode = (typeName, params = [])=>{
+    return factory.createTypeReferenceNode(factory.createIdentifier(typeName), params);
+};
+/**
+ * Transform a regular JavaScript object or scalar value into a literal expression
+ */ const toTypeLiteral = (data)=>{
+    if (data === undefined) {
+        return factory.createLiteralTypeNode(ts__namespace.SyntaxKind.UndefinedKeyword);
+    }
+    if (data === null) {
+        return factory.createLiteralTypeNode(ts__namespace.SyntaxKind.NullKeyword);
+    }
+    if (_.isString(data)) {
+        return factory.createStringLiteral(data, true);
+    }
+    if (_.isNumber(data)) {
+        return data < 0 ? factory.createPrefixUnaryExpression(ts__namespace.SyntaxKind.MinusToken, factory.createNumericLiteral(-data)) : factory.createNumericLiteral(data);
+    }
+    if (_.isBoolean(data)) {
+        return data ? factory.createTrue() : factory.createFalse();
+    }
+    if (Array.isArray(data)) {
+        return factory.createTupleTypeNode(data.map((item)=>toTypeLiteral(item)));
+    }
+    if (_.isDate(data)) {
+        return factory.createStringLiteral(data.toISOString());
+    }
+    if (typeof data !== 'object') {
+        throw new Error(`Cannot convert to object literal. Unknown type "${typeof data}"`);
+    }
+    const entries = Object.entries(data).sort((a, b)=>compare.compareEnglish(a[0], b[0]));
+    const props = entries.reduce((acc, [key, value])=>{
+        // Handle keys such as content-type-builder & co.
+        const identifier = key.includes('-') ? factory.createStringLiteral(key, true) : factory.createIdentifier(key);
+        return [
+            ...acc,
+            factory.createPropertyDeclaration(undefined, identifier, undefined, toTypeLiteral(value), undefined)
+        ];
+    }, []);
+    return factory.createTypeLiteralNode(props);
+};
+/**
+ * Add the Schema.Attribute namespace before the typename
+ */ const withAttributeNamespace = (typeName)=>`${NAMESPACES.Schema}.Attribute.${typeName}`;
+
+exports.NAMESPACES = NAMESPACES;
+exports.getSchemaExtendsTypeName = getSchemaExtendsTypeName;
+exports.getSchemaInterfaceName = getSchemaInterfaceName;
+exports.getSchemaModelType = getSchemaModelType;
+exports.getTypeNode = getTypeNode;
+exports.toTypeLiteral = toTypeLiteral;
+exports.withAttributeNamespace = withAttributeNamespace;
+//# sourceMappingURL=utils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sources":["../../../../src/generators/common/models/utils.ts"],"sourcesContent":["import * as ts from 'typescript';\nimport {\n  camelCase,\n  isBoolean,\n  isDate,\n  isNumber,\n  isString,\n  matchesProperty,\n  upperFirst,\n} from 'lodash';\nimport { compareEnglish } from '../compare';\n\nconst { factory } = ts;\n\nexport const NAMESPACES = {\n  Struct: 'Struct',\n  Schema: 'Schema',\n};\n\n/**\n * Shallow representation of a content-type/component attribute definition.\n * Only the fields read by the generators are typed; the rest is left open.\n */\nexport interface Attribute {\n  type: string;\n  conditions?: { visible?: unknown };\n  [key: string]: any;\n}\n\n/**\n * Shallow representation of a content-type/component schema definition.\n * Only the fields read by the generators are typed; the rest is left open.\n */\nexport interface Schema {\n  uid: string;\n  modelType?: string;\n  kind?: string;\n  attributes: Record<string, Attribute>;\n  [key: string]: any;\n}\n\n/**\n * Extract a valid interface name from a schema uid\n */\nexport const getSchemaInterfaceName = (uid: string): string =>\n  upperFirst(camelCase(uid.replace(/(:.)/, ' ')));\n\nexport const getSchemaModelType = (schema: Schema): string | null | undefined => {\n  const { modelType, kind } = schema;\n\n  // Components\n  if (modelType === 'component') {\n    return 'component';\n  }\n\n  // Content-Types\n  if (modelType === 'contentType') {\n    return kind;\n  }\n\n  return null;\n};\n\n/**\n * Get the parent type name to extend based on the schema's nature\n */\nexport const getSchemaExtendsTypeName = (schema: Schema): string | null => {\n  const base = getSchemaModelType(schema);\n\n  if (base === null) {\n    return null;\n  }\n\n  return `${NAMESPACES.Struct}.${upperFirst(base as string)}Schema`;\n};\n\n/**\n * Get a type node based on a type and its params\n */\nexport const getTypeNode = (typeName: string, params: ts.TypeNode[] = []): ts.TypeReferenceNode => {\n  return factory.createTypeReferenceNode(factory.createIdentifier(typeName), params);\n};\n\n/**\n * Transform a regular JavaScript object or scalar value into a literal expression\n */\nexport const toTypeLiteral = (data: any): any => {\n  if (data === undefined) {\n    return factory.createLiteralTypeNode(ts.SyntaxKind.UndefinedKeyword as any);\n  }\n\n  if (data === null) {\n    return factory.createLiteralTypeNode(ts.SyntaxKind.NullKeyword as any);\n  }\n\n  if (isString(data)) {\n    return factory.createStringLiteral(data, true);\n  }\n\n  if (isNumber(data)) {\n    return data < 0\n      ? factory.createPrefixUnaryExpression(\n          ts.SyntaxKind.MinusToken,\n          factory.createNumericLiteral(-data)\n        )\n      : factory.createNumericLiteral(data);\n  }\n\n  if (isBoolean(data)) {\n    return data ? factory.createTrue() : factory.createFalse();\n  }\n\n  if (Array.isArray(data)) {\n    return factory.createTupleTypeNode(data.map((item) => toTypeLiteral(item)));\n  }\n\n  if (isDate(data)) {\n    return factory.createStringLiteral(data.toISOString());\n  }\n\n  if (typeof data !== 'object') {\n    throw new Error(`Cannot convert to object literal. Unknown type \"${typeof data}\"`);\n  }\n\n  const entries = Object.entries(data).sort((a, b) => compareEnglish(a[0], b[0]));\n\n  const props = entries.reduce<any[]>((acc, [key, value]) => {\n    // Handle keys such as content-type-builder & co.\n    const identifier = key.includes('-')\n      ? factory.createStringLiteral(key, true)\n      : factory.createIdentifier(key);\n\n    return [\n      ...acc,\n      factory.createPropertyDeclaration(\n        undefined,\n        identifier,\n        undefined,\n        toTypeLiteral(value),\n        undefined\n      ),\n    ];\n  }, []);\n\n  return factory.createTypeLiteralNode(props);\n};\n\n/**\n * Get the number of attributes generated for a given schema definition\n */\nexport const getDefinitionAttributesCount = (\n  definition: ts.InterfaceDeclaration\n): number | null => {\n  const attributesNode = definition.members.find(\n    matchesProperty('name.escapedText', 'attributes')\n  ) as any;\n\n  if (!attributesNode) {\n    return null;\n  }\n\n  return attributesNode.type.members.length;\n};\n\n/**\n * Add the Schema.Attribute namespace before the typename\n */\nexport const withAttributeNamespace = (typeName: string): string =>\n  `${NAMESPACES.Schema}.Attribute.${typeName}`;\n\n/**\n * Add the schema namespace before the typename\n */\nexport const withSchemaNamespace = (typeName: string): string =>\n  `${(NAMESPACES as any).schema}.${typeName}`;\n"],"names":["factory","ts","NAMESPACES","Struct","Schema","getSchemaInterfaceName","uid","upperFirst","camelCase","replace","getSchemaModelType","schema","modelType","kind","getSchemaExtendsTypeName","base","getTypeNode","typeName","params","createTypeReferenceNode","createIdentifier","toTypeLiteral","data","undefined","createLiteralTypeNode","SyntaxKind","UndefinedKeyword","NullKeyword","isString","createStringLiteral","isNumber","createPrefixUnaryExpression","MinusToken","createNumericLiteral","isBoolean","createTrue","createFalse","Array","isArray","createTupleTypeNode","map","item","isDate","toISOString","Error","entries","Object","sort","a","b","compareEnglish","props","reduce","acc","key","value","identifier","includes","createPropertyDeclaration","createTypeLiteralNode","withAttributeNamespace"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAYA,MAAM,EAAEA,OAAO,EAAE,GAAGC,aAAAA;MAEPC,UAAAA,GAAa;IACxBC,MAAAA,EAAQ,QAAA;IACRC,MAAAA,EAAQ;AACV;AAwBA;;IAGO,MAAMC,sBAAAA,GAAyB,CAACC,GAAAA,GACrCC,YAAAA,CAAWC,WAAAA,CAAUF,GAAAA,CAAIG,OAAO,CAAC,MAAA,EAAQ,GAAA,CAAA,CAAA;AAEpC,MAAMC,qBAAqB,CAACC,MAAAA,GAAAA;AACjC,IAAA,MAAM,EAAEC,SAAS,EAAEC,IAAI,EAAE,GAAGF,MAAAA;;AAG5B,IAAA,IAAIC,cAAc,WAAA,EAAa;QAC7B,OAAO,WAAA;AACT,IAAA;;AAGA,IAAA,IAAIA,cAAc,aAAA,EAAe;QAC/B,OAAOC,IAAAA;AACT,IAAA;IAEA,OAAO,IAAA;AACT;AAEA;;IAGO,MAAMC,wBAAAA,GAA2B,CAACH,MAAAA,GAAAA;AACvC,IAAA,MAAMI,OAAOL,kBAAAA,CAAmBC,MAAAA,CAAAA;AAEhC,IAAA,IAAII,SAAS,IAAA,EAAM;QACjB,OAAO,IAAA;AACT,IAAA;IAEA,OAAO,CAAA,EAAGb,WAAWC,MAAM,CAAC,CAAC,EAAEI,YAAAA,CAAWQ,IAAAA,CAAAA,CAAgB,MAAM,CAAC;AACnE;AAEA;;AAEC,IACM,MAAMC,WAAAA,GAAc,CAACC,QAAAA,EAAkBC,SAAwB,EAAE,GAAA;AACtE,IAAA,OAAOlB,QAAQmB,uBAAuB,CAACnB,OAAAA,CAAQoB,gBAAgB,CAACH,QAAAA,CAAAA,EAAWC,MAAAA,CAAAA;AAC7E;AAEA;;IAGO,MAAMG,aAAAA,GAAgB,CAACC,IAAAA,GAAAA;AAC5B,IAAA,IAAIA,SAASC,SAAAA,EAAW;AACtB,QAAA,OAAOvB,QAAQwB,qBAAqB,CAACvB,aAAAA,CAAGwB,UAAU,CAACC,gBAAgB,CAAA;AACrE,IAAA;AAEA,IAAA,IAAIJ,SAAS,IAAA,EAAM;AACjB,QAAA,OAAOtB,QAAQwB,qBAAqB,CAACvB,aAAAA,CAAGwB,UAAU,CAACE,WAAW,CAAA;AAChE,IAAA;AAEA,IAAA,IAAIC,WAASN,IAAAA,CAAAA,EAAO;QAClB,OAAOtB,OAAAA,CAAQ6B,mBAAmB,CAACP,IAAAA,EAAM,IAAA,CAAA;AAC3C,IAAA;AAEA,IAAA,IAAIQ,WAASR,IAAAA,CAAAA,EAAO;AAClB,QAAA,OAAOA,OAAO,CAAA,GACVtB,OAAAA,CAAQ+B,2BAA2B,CACjC9B,cAAGwB,UAAU,CAACO,UAAU,EACxBhC,QAAQiC,oBAAoB,CAAC,CAACX,IAAAA,CAAAA,CAAAA,GAEhCtB,OAAAA,CAAQiC,oBAAoB,CAACX,IAAAA,CAAAA;AACnC,IAAA;AAEA,IAAA,IAAIY,YAAUZ,IAAAA,CAAAA,EAAO;AACnB,QAAA,OAAOA,IAAAA,GAAOtB,OAAAA,CAAQmC,UAAU,EAAA,GAAKnC,QAAQoC,WAAW,EAAA;AAC1D,IAAA;IAEA,IAAIC,KAAAA,CAAMC,OAAO,CAAChB,IAAAA,CAAAA,EAAO;QACvB,OAAOtB,OAAAA,CAAQuC,mBAAmB,CAACjB,IAAAA,CAAKkB,GAAG,CAAC,CAACC,OAASpB,aAAAA,CAAcoB,IAAAA,CAAAA,CAAAA,CAAAA;AACtE,IAAA;AAEA,IAAA,IAAIC,SAAOpB,IAAAA,CAAAA,EAAO;AAChB,QAAA,OAAOtB,OAAAA,CAAQ6B,mBAAmB,CAACP,IAAAA,CAAKqB,WAAW,EAAA,CAAA;AACrD,IAAA;IAEA,IAAI,OAAOrB,SAAS,QAAA,EAAU;QAC5B,MAAM,IAAIsB,MAAM,CAAC,gDAAgD,EAAE,OAAOtB,IAAAA,CAAK,CAAC,CAAC,CAAA;AACnF,IAAA;AAEA,IAAA,MAAMuB,UAAUC,MAAAA,CAAOD,OAAO,CAACvB,IAAAA,CAAAA,CAAMyB,IAAI,CAAC,CAACC,CAAAA,EAAGC,CAAAA,GAAMC,uBAAeF,CAAC,CAAC,EAAE,EAAEC,CAAC,CAAC,CAAA,CAAE,CAAA,CAAA;IAE7E,MAAME,KAAAA,GAAQN,QAAQO,MAAM,CAAQ,CAACC,GAAAA,EAAK,CAACC,KAAKC,KAAAA,CAAM,GAAA;;AAEpD,QAAA,MAAMC,UAAAA,GAAaF,GAAAA,CAAIG,QAAQ,CAAC,GAAA,CAAA,GAC5BzD,OAAAA,CAAQ6B,mBAAmB,CAACyB,GAAAA,EAAK,IAAA,CAAA,GACjCtD,OAAAA,CAAQoB,gBAAgB,CAACkC,GAAAA,CAAAA;QAE7B,OAAO;AACFD,YAAAA,GAAAA,GAAAA;AACHrD,YAAAA,OAAAA,CAAQ0D,yBAAyB,CAC/BnC,SAAAA,EACAiC,UAAAA,EACAjC,SAAAA,EACAF,cAAckC,KAAAA,CAAAA,EACdhC,SAAAA;AAEH,SAAA;AACH,IAAA,CAAA,EAAG,EAAE,CAAA;IAEL,OAAOvB,OAAAA,CAAQ2D,qBAAqB,CAACR,KAAAA,CAAAA;AACvC;AAmBA;;AAEC,IACM,MAAMS,sBAAAA,GAAyB,CAAC3C,QAAAA,GACrC,CAAA,EAAGf,UAAAA,CAAWE,MAAM,CAAC,WAAW,EAAEa,QAAAA,CAAAA;;;;;;;;;;"}

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

@@ -0,0 +1,82 @@
+import * as ts from 'typescript';
+import { upperFirst, camelCase, isString, isNumber, isBoolean, isDate } from 'lodash';
+import { compareEnglish } from '../compare.mjs';
+
+const { factory } = ts;
+const NAMESPACES = {
+    Struct: 'Struct',
+    Schema: 'Schema'
+};
+/**
+ * Extract a valid interface name from a schema uid
+ */ const getSchemaInterfaceName = (uid)=>upperFirst(camelCase(uid.replace(/(:.)/, ' ')));
+const getSchemaModelType = (schema)=>{
+    const { modelType, kind } = schema;
+    // Components
+    if (modelType === 'component') {
+        return 'component';
+    }
+    // Content-Types
+    if (modelType === 'contentType') {
+        return kind;
+    }
+    return null;
+};
+/**
+ * Get the parent type name to extend based on the schema's nature
+ */ const getSchemaExtendsTypeName = (schema)=>{
+    const base = getSchemaModelType(schema);
+    if (base === null) {
+        return null;
+    }
+    return `${NAMESPACES.Struct}.${upperFirst(base)}Schema`;
+};
+/**
+ * Get a type node based on a type and its params
+ */ const getTypeNode = (typeName, params = [])=>{
+    return factory.createTypeReferenceNode(factory.createIdentifier(typeName), params);
+};
+/**
+ * Transform a regular JavaScript object or scalar value into a literal expression
+ */ const toTypeLiteral = (data)=>{
+    if (data === undefined) {
+        return factory.createLiteralTypeNode(ts.SyntaxKind.UndefinedKeyword);
+    }
+    if (data === null) {
+        return factory.createLiteralTypeNode(ts.SyntaxKind.NullKeyword);
+    }
+    if (isString(data)) {
+        return factory.createStringLiteral(data, true);
+    }
+    if (isNumber(data)) {
+        return data < 0 ? factory.createPrefixUnaryExpression(ts.SyntaxKind.MinusToken, factory.createNumericLiteral(-data)) : factory.createNumericLiteral(data);
+    }
+    if (isBoolean(data)) {
+        return data ? factory.createTrue() : factory.createFalse();
+    }
+    if (Array.isArray(data)) {
+        return factory.createTupleTypeNode(data.map((item)=>toTypeLiteral(item)));
+    }
+    if (isDate(data)) {
+        return factory.createStringLiteral(data.toISOString());
+    }
+    if (typeof data !== 'object') {
+        throw new Error(`Cannot convert to object literal. Unknown type "${typeof data}"`);
+    }
+    const entries = Object.entries(data).sort((a, b)=>compareEnglish(a[0], b[0]));
+    const props = entries.reduce((acc, [key, value])=>{
+        // Handle keys such as content-type-builder & co.
+        const identifier = key.includes('-') ? factory.createStringLiteral(key, true) : factory.createIdentifier(key);
+        return [
+            ...acc,
+            factory.createPropertyDeclaration(undefined, identifier, undefined, toTypeLiteral(value), undefined)
+        ];
+    }, []);
+    return factory.createTypeLiteralNode(props);
+};
+/**
+ * Add the Schema.Attribute namespace before the typename
+ */ const withAttributeNamespace = (typeName)=>`${NAMESPACES.Schema}.Attribute.${typeName}`;
+
+export { NAMESPACES, getSchemaExtendsTypeName, getSchemaInterfaceName, getSchemaModelType, getTypeNode, toTypeLiteral, withAttributeNamespace };
+//# sourceMappingURL=utils.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.mjs","sources":["../../../../src/generators/common/models/utils.ts"],"sourcesContent":["import * as ts from 'typescript';\nimport {\n  camelCase,\n  isBoolean,\n  isDate,\n  isNumber,\n  isString,\n  matchesProperty,\n  upperFirst,\n} from 'lodash';\nimport { compareEnglish } from '../compare';\n\nconst { factory } = ts;\n\nexport const NAMESPACES = {\n  Struct: 'Struct',\n  Schema: 'Schema',\n};\n\n/**\n * Shallow representation of a content-type/component attribute definition.\n * Only the fields read by the generators are typed; the rest is left open.\n */\nexport interface Attribute {\n  type: string;\n  conditions?: { visible?: unknown };\n  [key: string]: any;\n}\n\n/**\n * Shallow representation of a content-type/component schema definition.\n * Only the fields read by the generators are typed; the rest is left open.\n */\nexport interface Schema {\n  uid: string;\n  modelType?: string;\n  kind?: string;\n  attributes: Record<string, Attribute>;\n  [key: string]: any;\n}\n\n/**\n * Extract a valid interface name from a schema uid\n */\nexport const getSchemaInterfaceName = (uid: string): string =>\n  upperFirst(camelCase(uid.replace(/(:.)/, ' ')));\n\nexport const getSchemaModelType = (schema: Schema): string | null | undefined => {\n  const { modelType, kind } = schema;\n\n  // Components\n  if (modelType === 'component') {\n    return 'component';\n  }\n\n  // Content-Types\n  if (modelType === 'contentType') {\n    return kind;\n  }\n\n  return null;\n};\n\n/**\n * Get the parent type name to extend based on the schema's nature\n */\nexport const getSchemaExtendsTypeName = (schema: Schema): string | null => {\n  const base = getSchemaModelType(schema);\n\n  if (base === null) {\n    return null;\n  }\n\n  return `${NAMESPACES.Struct}.${upperFirst(base as string)}Schema`;\n};\n\n/**\n * Get a type node based on a type and its params\n */\nexport const getTypeNode = (typeName: string, params: ts.TypeNode[] = []): ts.TypeReferenceNode => {\n  return factory.createTypeReferenceNode(factory.createIdentifier(typeName), params);\n};\n\n/**\n * Transform a regular JavaScript object or scalar value into a literal expression\n */\nexport const toTypeLiteral = (data: any): any => {\n  if (data === undefined) {\n    return factory.createLiteralTypeNode(ts.SyntaxKind.UndefinedKeyword as any);\n  }\n\n  if (data === null) {\n    return factory.createLiteralTypeNode(ts.SyntaxKind.NullKeyword as any);\n  }\n\n  if (isString(data)) {\n    return factory.createStringLiteral(data, true);\n  }\n\n  if (isNumber(data)) {\n    return data < 0\n      ? factory.createPrefixUnaryExpression(\n          ts.SyntaxKind.MinusToken,\n          factory.createNumericLiteral(-data)\n        )\n      : factory.createNumericLiteral(data);\n  }\n\n  if (isBoolean(data)) {\n    return data ? factory.createTrue() : factory.createFalse();\n  }\n\n  if (Array.isArray(data)) {\n    return factory.createTupleTypeNode(data.map((item) => toTypeLiteral(item)));\n  }\n\n  if (isDate(data)) {\n    return factory.createStringLiteral(data.toISOString());\n  }\n\n  if (typeof data !== 'object') {\n    throw new Error(`Cannot convert to object literal. Unknown type \"${typeof data}\"`);\n  }\n\n  const entries = Object.entries(data).sort((a, b) => compareEnglish(a[0], b[0]));\n\n  const props = entries.reduce<any[]>((acc, [key, value]) => {\n    // Handle keys such as content-type-builder & co.\n    const identifier = key.includes('-')\n      ? factory.createStringLiteral(key, true)\n      : factory.createIdentifier(key);\n\n    return [\n      ...acc,\n      factory.createPropertyDeclaration(\n        undefined,\n        identifier,\n        undefined,\n        toTypeLiteral(value),\n        undefined\n      ),\n    ];\n  }, []);\n\n  return factory.createTypeLiteralNode(props);\n};\n\n/**\n * Get the number of attributes generated for a given schema definition\n */\nexport const getDefinitionAttributesCount = (\n  definition: ts.InterfaceDeclaration\n): number | null => {\n  const attributesNode = definition.members.find(\n    matchesProperty('name.escapedText', 'attributes')\n  ) as any;\n\n  if (!attributesNode) {\n    return null;\n  }\n\n  return attributesNode.type.members.length;\n};\n\n/**\n * Add the Schema.Attribute namespace before the typename\n */\nexport const withAttributeNamespace = (typeName: string): string =>\n  `${NAMESPACES.Schema}.Attribute.${typeName}`;\n\n/**\n * Add the schema namespace before the typename\n */\nexport const withSchemaNamespace = (typeName: string): string =>\n  `${(NAMESPACES as any).schema}.${typeName}`;\n"],"names":["factory","ts","NAMESPACES","Struct","Schema","getSchemaInterfaceName","uid","upperFirst","camelCase","replace","getSchemaModelType","schema","modelType","kind","getSchemaExtendsTypeName","base","getTypeNode","typeName","params","createTypeReferenceNode","createIdentifier","toTypeLiteral","data","undefined","createLiteralTypeNode","SyntaxKind","UndefinedKeyword","NullKeyword","isString","createStringLiteral","isNumber","createPrefixUnaryExpression","MinusToken","createNumericLiteral","isBoolean","createTrue","createFalse","Array","isArray","createTupleTypeNode","map","item","isDate","toISOString","Error","entries","Object","sort","a","b","compareEnglish","props","reduce","acc","key","value","identifier","includes","createPropertyDeclaration","createTypeLiteralNode","withAttributeNamespace"],"mappings":";;;;AAYA,MAAM,EAAEA,OAAO,EAAE,GAAGC,EAAAA;MAEPC,UAAAA,GAAa;IACxBC,MAAAA,EAAQ,QAAA;IACRC,MAAAA,EAAQ;AACV;AAwBA;;IAGO,MAAMC,sBAAAA,GAAyB,CAACC,GAAAA,GACrCC,UAAAA,CAAWC,SAAAA,CAAUF,GAAAA,CAAIG,OAAO,CAAC,MAAA,EAAQ,GAAA,CAAA,CAAA;AAEpC,MAAMC,qBAAqB,CAACC,MAAAA,GAAAA;AACjC,IAAA,MAAM,EAAEC,SAAS,EAAEC,IAAI,EAAE,GAAGF,MAAAA;;AAG5B,IAAA,IAAIC,cAAc,WAAA,EAAa;QAC7B,OAAO,WAAA;AACT,IAAA;;AAGA,IAAA,IAAIA,cAAc,aAAA,EAAe;QAC/B,OAAOC,IAAAA;AACT,IAAA;IAEA,OAAO,IAAA;AACT;AAEA;;IAGO,MAAMC,wBAAAA,GAA2B,CAACH,MAAAA,GAAAA;AACvC,IAAA,MAAMI,OAAOL,kBAAAA,CAAmBC,MAAAA,CAAAA;AAEhC,IAAA,IAAII,SAAS,IAAA,EAAM;QACjB,OAAO,IAAA;AACT,IAAA;IAEA,OAAO,CAAA,EAAGb,WAAWC,MAAM,CAAC,CAAC,EAAEI,UAAAA,CAAWQ,IAAAA,CAAAA,CAAgB,MAAM,CAAC;AACnE;AAEA;;AAEC,IACM,MAAMC,WAAAA,GAAc,CAACC,QAAAA,EAAkBC,SAAwB,EAAE,GAAA;AACtE,IAAA,OAAOlB,QAAQmB,uBAAuB,CAACnB,OAAAA,CAAQoB,gBAAgB,CAACH,QAAAA,CAAAA,EAAWC,MAAAA,CAAAA;AAC7E;AAEA;;IAGO,MAAMG,aAAAA,GAAgB,CAACC,IAAAA,GAAAA;AAC5B,IAAA,IAAIA,SAASC,SAAAA,EAAW;AACtB,QAAA,OAAOvB,QAAQwB,qBAAqB,CAACvB,EAAAA,CAAGwB,UAAU,CAACC,gBAAgB,CAAA;AACrE,IAAA;AAEA,IAAA,IAAIJ,SAAS,IAAA,EAAM;AACjB,QAAA,OAAOtB,QAAQwB,qBAAqB,CAACvB,EAAAA,CAAGwB,UAAU,CAACE,WAAW,CAAA;AAChE,IAAA;AAEA,IAAA,IAAIC,SAASN,IAAAA,CAAAA,EAAO;QAClB,OAAOtB,OAAAA,CAAQ6B,mBAAmB,CAACP,IAAAA,EAAM,IAAA,CAAA;AAC3C,IAAA;AAEA,IAAA,IAAIQ,SAASR,IAAAA,CAAAA,EAAO;AAClB,QAAA,OAAOA,OAAO,CAAA,GACVtB,OAAAA,CAAQ+B,2BAA2B,CACjC9B,GAAGwB,UAAU,CAACO,UAAU,EACxBhC,QAAQiC,oBAAoB,CAAC,CAACX,IAAAA,CAAAA,CAAAA,GAEhCtB,OAAAA,CAAQiC,oBAAoB,CAACX,IAAAA,CAAAA;AACnC,IAAA;AAEA,IAAA,IAAIY,UAAUZ,IAAAA,CAAAA,EAAO;AACnB,QAAA,OAAOA,IAAAA,GAAOtB,OAAAA,CAAQmC,UAAU,EAAA,GAAKnC,QAAQoC,WAAW,EAAA;AAC1D,IAAA;IAEA,IAAIC,KAAAA,CAAMC,OAAO,CAAChB,IAAAA,CAAAA,EAAO;QACvB,OAAOtB,OAAAA,CAAQuC,mBAAmB,CAACjB,IAAAA,CAAKkB,GAAG,CAAC,CAACC,OAASpB,aAAAA,CAAcoB,IAAAA,CAAAA,CAAAA,CAAAA;AACtE,IAAA;AAEA,IAAA,IAAIC,OAAOpB,IAAAA,CAAAA,EAAO;AAChB,QAAA,OAAOtB,OAAAA,CAAQ6B,mBAAmB,CAACP,IAAAA,CAAKqB,WAAW,EAAA,CAAA;AACrD,IAAA;IAEA,IAAI,OAAOrB,SAAS,QAAA,EAAU;QAC5B,MAAM,IAAIsB,MAAM,CAAC,gDAAgD,EAAE,OAAOtB,IAAAA,CAAK,CAAC,CAAC,CAAA;AACnF,IAAA;AAEA,IAAA,MAAMuB,UAAUC,MAAAA,CAAOD,OAAO,CAACvB,IAAAA,CAAAA,CAAMyB,IAAI,CAAC,CAACC,CAAAA,EAAGC,CAAAA,GAAMC,eAAeF,CAAC,CAAC,EAAE,EAAEC,CAAC,CAAC,CAAA,CAAE,CAAA,CAAA;IAE7E,MAAME,KAAAA,GAAQN,QAAQO,MAAM,CAAQ,CAACC,GAAAA,EAAK,CAACC,KAAKC,KAAAA,CAAM,GAAA;;AAEpD,QAAA,MAAMC,UAAAA,GAAaF,GAAAA,CAAIG,QAAQ,CAAC,GAAA,CAAA,GAC5BzD,OAAAA,CAAQ6B,mBAAmB,CAACyB,GAAAA,EAAK,IAAA,CAAA,GACjCtD,OAAAA,CAAQoB,gBAAgB,CAACkC,GAAAA,CAAAA;QAE7B,OAAO;AACFD,YAAAA,GAAAA,GAAAA;AACHrD,YAAAA,OAAAA,CAAQ0D,yBAAyB,CAC/BnC,SAAAA,EACAiC,UAAAA,EACAjC,SAAAA,EACAF,cAAckC,KAAAA,CAAAA,EACdhC,SAAAA;AAEH,SAAA;AACH,IAAA,CAAA,EAAG,EAAE,CAAA;IAEL,OAAOvB,OAAAA,CAAQ2D,qBAAqB,CAACR,KAAAA,CAAAA;AACvC;AAmBA;;AAEC,IACM,MAAMS,sBAAAA,GAAyB,CAAC3C,QAAAA,GACrC,CAAA,EAAGf,UAAAA,CAAWE,MAAM,CAAC,WAAW,EAAEa,QAAAA,CAAAA;;;;"}

package/dist/generators/common/sources.d.ts

@@ -0,0 +1,133 @@
+import * as ts from 'typescript';
+import type { Logger } from '../utils';
+export type AppModuleSource = {
+    uid: string;
+    file: string;
+    specifier: string;
+};
+/**
+ * Directory of each module kind in an API (src/api/<api>/<kind>), and in src/ for the kinds the
+ * loaders also register globally (policies, middlewares)
+ */
+export type AppModuleKind = 'services' | 'controllers' | 'policies' | 'middlewares';
+/**
+ * Collect the global source files of a kind when `dirs.global` is given (src/<kind>/<name>.{ts,js}
+ * → global::<name>), then the ones of every API (src/api/<api>/<kind>/<name>.{ts,js} →
+ * api::<api>.<name>). The first file to resolve to a uid wins.
+ */
+export declare const collectAppSources: (kind: AppModuleKind, dirs: {
+    global?: string;
+    api: string;
+}, outDir: string, logger: Logger) => Promise<AppModuleSource[]>;
+/**
+ * Keep the sources whose uid the running app registered, sorted by uid
+ */
+export declare const filterRegisteredSources: (sources: AppModuleSource[], registered: Record<string, unknown>, logger: Logger) => AppModuleSource[];
+/**
+ * Application tsconfigs do not enable `allowJs`, so the import of a JS source does not resolve and is
+ * an error type. Unlike `any`, conditional types cannot map it to `unknown`.
+ */
+export declare const isTypedSource: (source: AppModuleSource) => boolean;
+/**
+ * The uids of the TypeScript sources whose module exports a type named `name`, such as a service's
+ * `ServiceContract`.
+ *
+ * Each source is parsed on its own, without a program: type generation runs on every `strapi develop`
+ * start, before the compilation, and a program would need the application's tsconfig and its whole
+ * dependency graph. Only top-level declarations and export specifiers are read (see
+ * `exportsTypeNamed`). `export *` is not followed, and a source that cannot be read is skipped with a
+ * warning: both keep the type the source registers without a contract, rather than stopping the
+ * generation.
+ *
+ * JS sources are skipped: their import does not resolve without `allowJs` (see `isTypedSource`).
+ */
+export declare const findTypeExports: (sources: AppModuleSource[], name: string, logger: Logger) => Promise<Set<string>>;
+/**
+ * A type export that replaces the inferred type of the sources that have it, such as a service's
+ * `ServiceContract`.
+ */
+export type AppModuleContract = {
+    exportName: string;
+    helper: string;
+    uids: Set<string>;
+};
+/**
+ * The type a service or controller source registers:
+ * - `<contract helper><import('<source>').<contract export>>` when the module exports the contract;
+ * - `<helper><typeof import('<source>')>` otherwise, which infers it from the default export;
+ * - `unknown` for a JS source, whose import is an error type without `allowJs` (see `isTypedSource`).
+ *
+ * The contract does not depend on the default export, so the factory can be checked against its own
+ * uid (`Core.ServiceFactory<uid>`). The inferred type does: the generators list those uids in a
+ * marker registry (see `isInferredSource`), which the factory types reject.
+ */
+export declare const instanceTypeOf: (helper: string, logger: Logger, contract?: AppModuleContract) => (source: AppModuleSource) => ts.TypeNode;
+/**
+ * Whether a source registers the type its module provides (see `instanceTypeOf`): a TypeScript
+ * source whose module does not export the contract.
+ */
+export declare const isInferredSource: (contract: AppModuleContract) => (source: AppModuleSource) => boolean;
+/**
+ * typeof import('<relative path to the source>')
+ */
+export declare const typeofImport: (source: AppModuleSource) => ts.ImportTypeNode;
+export declare const withDocComment: <TNode extends ts.Node>(node: TNode, comment: string) => TNode;
+/**
+ * type <name><TModule> = TModule extends { default: infer TExport }
+ *   ? 0 extends 1 & TExport
+ *     ? unknown
+ *     : TExport extends (...args: any[]) => infer TInstance ? TInstance : TExport
+ *   : unknown;
+ *
+ * Emitted in each file so that services.ts and controllers.ts stand alone, and only when a source
+ * registers its inferred type.
+ *
+ * Resolves the type registered for a service or a controller from the type of its module: the return
+ * type of the default export when it is a factory, the default export itself otherwise. A module
+ * without a default export registers nothing usable at runtime; with strict types enabled, an
+ * unregistered uid resolves to `unknown`, so the helper does the same rather than claiming a
+ * permissive contract for it. A module typed `any` and a default export typed `any` resolve to
+ * `unknown` too: `any` would match the factory branch and register `any`.
+ *
+ * An import that no longer resolves (the source moved after the generation) is an error type, which
+ * no conditional type maps to `unknown`. The generated file is a `.ts` file, so `tsc` reports the
+ * TS2307 there, `skipLibCheck` or not, until the next generation drops the entry.
+ */
+export declare const generateInstanceHelperDefinition: (name: string, comment: string) => ts.TypeAliasDeclaration;
+/**
+ * type <name><TContract> = 0 extends 1 & TContract ? unknown : TContract;
+ *
+ * Emitted only when at least one source exports a contract: an application without contracts does
+ * not get it.
+ *
+ * A contract typed `any` registers `unknown`, as for an unregistered uid, rather than turning every
+ * lookup of the uid into `any`.
+ *
+ * A contract reference that no longer resolves to a type (the export was renamed after the
+ * generation, or a specifier names a value) is an error type, which no conditional type can map to
+ * `unknown` (an alias instantiated with the error type stays the error type). The generated file is a
+ * `.ts` file, so `tsc` reports the TS2694/TS2749 there, `skipLibCheck` or not. The next generation,
+ * on every `strapi develop` start, registers the source without its contract again.
+ */
+export declare const generateContractHelperDefinition: (name: string, comment: string) => ts.TypeAliasDeclaration;
+/**
+ * A registry that lists uids without typing them, such as the uids registered with their inferred
+ * type. Each uid maps to `true`, which nothing reads: the marker never depends on a source.
+ */
+export type AppModuleMarker = {
+    registry: string;
+    uids: string[];
+};
+/**
+ * export {};
+ *
+ * <helpers>
+ *
+ * declare global { … <registry> … <markers> … }
+ *
+ * The module marker turns the generated file into a module: the global augmentation is only allowed
+ * in one. The helpers come first so that the file stands alone. A marker without uids is not
+ * emitted, so that the output of an application without such uids does not change.
+ */
+export declare const emitRegistryDefinitions: (registry: string, helpers: ts.Node[], sources: AppModuleSource[], toValue: (source: AppModuleSource) => ts.TypeNode, markers?: AppModuleMarker[]) => Promise<string>;
+//# sourceMappingURL=sources.d.ts.map

package/dist/generators/common/sources.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sources.d.ts","sourceRoot":"","sources":["../../../src/generators/common/sources.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AAIjC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAkBvC,MAAM,MAAM,eAAe,GAAG;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IAEb,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,aAAa,GAAG,UAAU,GAAG,aAAa,CAAC;AA2DpF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAC5B,MAAM,aAAa,EACnB,MAAM;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,EACtC,QAAQ,MAAM,EACd,QAAQ,MAAM,KACb,OAAO,CAAC,eAAe,EAAE,CAgC3B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB,GAClC,SAAS,eAAe,EAAE,EAC1B,YAAY,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,QAAQ,MAAM,sBAcf,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,aAAa,GAAI,QAAQ,eAAe,YAAwC,CAAC;AAuD9F;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,eAAe,GAC1B,SAAS,eAAe,EAAE,EAC1B,MAAM,MAAM,EACZ,QAAQ,MAAM,KACb,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAyDrB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAE9B,UAAU,EAAE,MAAM,CAAC;IAEnB,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;CACnB,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc,GACxB,QAAQ,MAAM,EAAE,QAAQ,MAAM,EAAE,WAAW,iBAAiB,MAC5D,QAAQ,eAAe,KAAG,EAAE,CAAC,QAc7B,CAAC;AAEJ;;;GAGG;AACH,eAAO,MAAM,gBAAgB,GAAI,UAAU,iBAAiB,MAAM,QAAQ,eAAe,YACd,CAAC;AAE5E;;GAEG;AACH,eAAO,MAAM,YAAY,GAAI,QAAQ,eAAe,sBAOjD,CAAC;AAcJ,eAAO,MAAM,cAAc,GAAI,KAAK,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,EAAE,SAAS,MAAM,UACQ,CAAC;AAE3F;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,gCAAgC,GAAI,MAAM,MAAM,EAAE,SAAS,MAAM,4BAsD7E,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gCAAgC,GAAI,MAAM,MAAM,EAAE,SAAS,MAAM,4BAiB3E,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB,CAAC;AAwDF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,uBAAuB,GAClC,UAAU,MAAM,EAChB,SAAS,EAAE,CAAC,IAAI,EAAE,EAClB,SAAS,eAAe,EAAE,EAC1B,SAAS,CAAC,MAAM,EAAE,eAAe,KAAK,EAAE,CAAC,QAAQ,EACjD,UAAS,eAAe,EAAO,oBAkChC,CAAC"}