Modernization & support for migration / items models

lib/cli/actions/items-action.ts

@@ -8,6 +8,8 @@ import {
     deliveryApiKeyOption,
     deliveryBaseUrlOption,
     environmentIdOption,
+    generateObjectsOption,
+    generateTypesOption,
     managementApiKeyOption,
     managementBaseUrlOption,
     moduleFileExtensionOption,
@@ -20,6 +22,8 @@ export async function itemsActionAsync(cliFetcher: CliArgumentsFetcher): Promise
         environmentId: cliFetcher.getRequiredArgumentValue(environmentIdOption.name),
         apiKey: cliFetcher.getRequiredArgumentValue(managementApiKeyOption.name),
         // optional
+        generateTypes: cliFetcher.getBooleanArgumentValue(generateTypesOption.name, false),
+        generateObjects: cliFetcher.getBooleanArgumentValue(generateObjectsOption.name, false),
         deliveryApiKey: cliFetcher.getOptionalArgumentValue(deliveryApiKeyOption.name),
         baseUrl: cliFetcher.getOptionalArgumentValue(managementBaseUrlOption.name),
         deliveryBaseUrl: cliFetcher.getOptionalArgumentValue(deliveryBaseUrlOption.name),

lib/cli/commands.ts

@@ -79,6 +79,20 @@ export const deliveryBaseUrlOption: CommandOption = {
     isRequired: false
 };
 
+export const generateTypesOption: CommandOption = {
+    name: `generateTypes`,
+    description: `Indicates if Typescript types representing data are generated`,
+    type: 'boolean',
+    isRequired: false
+};
+
+export const generateObjectsOption: CommandOption = {
+    name: `generateTypes`,
+    description: `Indicates if objects (const variables) representing data are generated`,
+    type: 'boolean',
+    isRequired: false
+};
+
 export const cliArgs = argumentsSetter()
     .withCommand({
         name: 'delivery-sdk',
@@ -142,7 +156,9 @@ export const cliArgs = argumentsSetter()
             managementBaseUrlOption,
             apiModeOption,
             contentTypesOption,
-            deliveryBaseUrlOption
+            deliveryBaseUrlOption,
+            generateTypesOption,
+            generateObjectsOption
         ]
     })
     .withOption({

lib/core/core.utils.ts

@@ -71,24 +71,28 @@ export function toOutputDirPath(outputDir: string | undefined): string {
     return outputDir ? `${outputDir}/`.replaceAll('//', '/') : `./`;
 }
 
-function removeLineEndings(value: string): string {
-    return value.replace(/(\r\n|\n|\r)/g, '');
-}
-
-function toSafeStringCode(text: string): string {
-    const replaceWith = '';
-    return text.replace(/[\s-]/g, replaceWith).replace(/[^a-zA-Z0-9_]/g, replaceWith);
-}
-
 export function prefixWithUnderscoreWhenStartsWithNonAlpha(text: string): string {
     if (/^[^a-zA-Z]/.test(text)) {
         return `_${text}`;
     }
     return text;
 }
 
+export function singleItemToArray<T>(item: T | undefined): readonly T[] {
+    return item ? [item] : [];
+}
+
 function getPropertyStringHash(text: string): string {
     const hash = createHash('sha256');
     hash.update(text);
     return `_${hash.digest('hex')}`.slice(0, 10);
 }
+
+function removeLineEndings(value: string): string {
+    return value.replace(/(\r\n|\n|\r)/g, '');
+}
+
+function toSafeStringCode(text: string): string {
+    const replaceWith = '';
+    return text.replace(/[\s-]/g, replaceWith).replace(/[^a-zA-Z0-9_]/g, replaceWith);
+}

lib/generators/items/items-func.ts

@@ -2,6 +2,7 @@ import { EnvironmentModels } from '@kontent-ai/management-sdk';
 import chalk from 'chalk';
 import { Options } from 'prettier';
 import { DeliveryApiMode, GeneratedSet, ModuleFileExtension } from '../../core/core.models.js';
+import { singleItemToArray } from '../../core/core.utils.js';
 import { deliveryKontentFetcher as _deliveryKontentFetcher } from '../../fetch/delivery-kontent-fetcher.js';
 import { managementKontentFetcher as _managementKontentFetcher } from '../../fetch/management-kontent-fetcher.js';
 import { fileManager as _fileManager } from '../../files/file-manager.js';
@@ -14,6 +15,8 @@ export interface GenerateItemsModelsConfig {
     readonly moduleFileExtension: ModuleFileExtension;
     readonly apiMode: DeliveryApiMode;
     readonly filterByTypeCodenames: readonly string[];
+    readonly generateTypes: boolean;
+    readonly generateObjects: boolean;
 
     readonly deliveryApiKey?: string;
     readonly outputDir?: string;
@@ -33,14 +36,14 @@ export async function generateItemsAsync(config: GenerateItemsModelsConfig): Pro
         environmentInfo: environmentInfo
     });
 
-    await fileManager.createSetsAsync([itemFiles, codenameFiles]);
+    await fileManager.createSetsAsync([...singleItemToArray(itemFiles), ...singleItemToArray(codenameFiles)]);
 
     console.log(chalk.green(`\nCompleted`));
 }
 
 async function getFilesAsync(config: GenerateItemsModelsConfig): Promise<{
-    readonly itemFiles: GeneratedSet;
-    readonly codenameFiles: GeneratedSet;
+    readonly itemFiles: GeneratedSet | undefined;
+    readonly codenameFiles: GeneratedSet | undefined;
     readonly environmentInfo: Readonly<EnvironmentModels.EnvironmentInformationModel>;
 }> {
     const deliveryKontentFetcher = _deliveryKontentFetcher({
@@ -71,8 +74,8 @@ async function getFilesAsync(config: GenerateItemsModelsConfig): Promise<{
     });
 
     return {
-        itemFiles: itemsGenerator.getItemFiles(),
-        codenameFiles: itemsGenerator.getCodenameFiles(),
+        itemFiles: config.generateObjects ? itemsGenerator.getItemFiles() : undefined,
+        codenameFiles: config.generateTypes ? itemsGenerator.getCodenameFiles() : undefined,
         environmentInfo
     };
 }

scripts/samples/item-models.ts

@@ -34,7 +34,9 @@ try {
         outputDir: outputDir,
         apiMode: 'default',
         deliveryApiKey: deliveryApiKey,
-        filterByTypeCodenames: []
+        filterByTypeCodenames: [],
+        generateObjects: true,
+        generateTypes: true
     });
 } catch (error) {
     logError(error);