Merge branch 'beta' into milestone/v2.0.0

.github/workflows/semantic-release.yml

@@ -1,7 +1,7 @@
 name: Release
 on:
   push:
-    branches: [ main, beta ]
+    branches: [ main, beta, prerelease ]
   pull_request:
     branches: [ main ]
 jobs:

.releaserc

@@ -4,7 +4,8 @@
 	"branches": [
 		{ "name": "main", "channel": "latest" },
 		"+([0-9])?(.{+([0-9]),x}).x",
-		{ "name": "beta", "prerelease": true }
+		{ "name": "beta", "prerelease": true },
+		{ "name": "prerelease", "prerelease": "rc" }
 	],
 	"plugins": [
 		"@semantic-release/commit-analyzer",

gen/generator.ts

@@ -696,7 +696,7 @@ const generateResource = (type: string, name: string, resource: Resource): strin
 	res = res.replace(/##__IMPORT_RESOURCE_COMMON__##/, Array.from(declaredImportsCommon).join(', '))
 	res = res.replace(/##__MODEL_SORTABLE_INTERFACE__##/, (resModelType === 'ApiSingleton') ? '' : `, ${resModelInterface}Sort`)
 
-	const importQueryModels = (qryMod.size > 0)? `import type { ${Array.from(qryMod).sort().reverse().join(', ')} } from '../query'` : ''
+	const importQueryModels = (qryMod.size > 0) ? `import type { ${Array.from(qryMod).sort().reverse().join(', ')} } from '../query'` : ''
 	res = res.replace(/##__IMPORT_QUERY_MODELS__##/, importQueryModels)
 
 
@@ -720,6 +720,7 @@ const generateResource = (type: string, name: string, resource: Resource): strin
 	const relationshipTypes: Set<string> = new Set()
 	const sortableFields: string[] = []
 	const filterableFields: string[] = []
+	let nullables = false
 
 	typesArray.forEach(t => {
 		const cudSuffix = getCUDSuffix(t)
@@ -733,6 +734,7 @@ const generateResource = (type: string, name: string, resource: Resource): strin
 			sortableFields.push('id', ...Object.values(component.attributes).filter(f => (f.sortable && !RESOURCE_COMMON_FIELDS.includes(f.name))).map(f => f.name))
 			filterableFields.push('id', ...Object.values(component.attributes).filter(f => (f.filterable && !RESOURCE_COMMON_FIELDS.includes(f.name))).map(f => f.name))
 		}
+		nullables ||= tplCmp.nullables
 	})
 	res = res.replace(/##__MODEL_INTERFACES__##/g, modelInterfaces.join('\n\n\n'))
 	res = res.replace(/##__IMPORT_RESOURCE_INTERFACES__##/g, resourceInterfaces.join(', '))
@@ -757,6 +759,10 @@ const generateResource = (type: string, name: string, resource: Resource): strin
 
 	// Enum types definitions
 
+	// Nullable type import
+	console.log(type + ' - ' + nullables)
+	if (!nullables) res = res.replace(/import type { Nullable/, '// import type { Nullable')
+
 
 	return res
 
@@ -876,7 +882,7 @@ const nullable = (type: string): string => {
 
 type ComponentEnums = { [key: string]: string }
 
-const templatedComponent = (res: string, name: string, cmp: Component): { component: string, models: string[], enums: ComponentEnums } => {
+const templatedComponent = (res: string, name: string, cmp: Component): { component: string, models: string[], enums: ComponentEnums, nullables: boolean } => {
 
 	const cudModel = isCUDModel(name)
 
@@ -886,13 +892,15 @@ const templatedComponent = (res: string, name: string, cmp: Component): { compon
 	// Attributes
 	const attributes = Object.values(cmp.attributes)
 	const fields: string[] = []
+	let nullables = false
 	attributes.forEach(a => {
 		if (!RESOURCE_COMMON_FIELDS.includes(a.name)) {
 			if (cudModel || a.fetchable) {
 				let attrType = fixAttributeType(a)
 				if (a.enum) enums[a.name] = attrType
-				// fields.push('/**\n* Unique identifier for the resource (hash).\n* @example ```"XAyRWNUzyN"```\n*/')
+				if (a.description || a.example) fields.push(`/** ${a.description? `\n\t * ${a.description}.` : ''}${a.example? `\n\t * @example \`\`\`"${(typeof a.example === 'object')? JSON.stringify(a.example) : a.example}"\`\`\``: ''}\n\t */`)
 				fields.push(`${a.name}${a.required ? '' : '?'}: ${a.required ? attrType : nullable(attrType)}`)
+				nullables ||= (!a.required && !RESOURCE_COMMON_FIELDS.includes(a.name))
 			}
 		}
 	})
@@ -931,6 +939,7 @@ const templatedComponent = (res: string, name: string, cmp: Component): { compon
 			}
 
 			rels.push(`${r.name}${r.required ? '' : '?'}: ${r.required ? resName : nullable(resName)}`)
+			nullables ||= !r.required
 
 		}
 	})
@@ -946,8 +955,7 @@ const templatedComponent = (res: string, name: string, cmp: Component): { compon
 	component = component.replace(/##__RESOURCE_MODEL_FIELDS__##/g, fieldsStr)
 	component = component.replace(/##__RESOURCE_MODEL_RELATIONSHIPS__##/g, relsStr)
 
-
-	return { component, models, enums }
+	return { component, models, enums, nullables }
 
 }