Turn your content types into strongly typed models

/**
 * `CoreContentType` represents the base structure of a content type in Kontent.ai.
 * It provides strongly typed access to system fields such as language, workflow, type, and more.
 *
 * All models are generated by the https://www.npmjs.com/package/@kontent-ai/model-generator
 */
export type Homepage = CoreContentType<
  HomepageElementCodenames,
  {
    /**
     * Headline
     *
     * Type: text
     * Required: false
     * Codename: headline
     * Id: 65abffb4-15c9-9b5e-cb0d-7c36300198fb
     * Guidelines: The main headline of your homepage. It can be different than the name in Kontent. Simple text elements don't allow any formatting.
     */
    readonly headline: Elements.TextElement;
    /**
     * Body text
     *
     * Type: rich_text
     * Required: false
     * Codename: body_text
     * Id: 5dc5b1c4-c3b2-14df-65b5-ff5520110bc3
     * Guidelines: Provide main content for the homepage.
     */
    readonly body_text: Elements.RichTextElement<CoreContentType>;
    /**
     * Picture
     *
     * Type: asset
     * Required: false
     * Codename: picture
     * Id: e1cbc227-f1ee-db9e-1831-de36fa4265ed
     * Guidelines: Choose an image to show above the headline.
     */
    readonly picture: Elements.AssetsElement;
  },
  'homepage'
>;

/**
 * Type representing all available element codenames for Homepage
 */
export type HomepageElementCodenames = 'headline' | 'body_text' | 'picture';

/**
 * Type guard for Homepage
 *
 * Id: 078f37bf-b6ce-4fcb-a1d3-be1966c6b50a
 * Codename: homepage
 */
export function isHomepage(
  item: CoreContentType | undefined | null,
): item is Homepage {
  return item?.system?.type === 'homepage';
}

npx @kontent-ai/model-generator@latest delivery-sdk \
	--environmentId=x \
	--managementApiKey=x

import { createDeliveryClient } from '@kontent-ai/delivery-sdk';

// Initializes the Delivery client with `CoreDeliveryClient` type which improves type safety on system fields
// This type is generated by the https://www.npmjs.com/package/@kontent-ai/model-generator
const deliveryClient = createDeliveryClient<CoreDeliveryClient>({
  environmentId: '8d20758c-d74c-4f59-ae04-ee928c0816b7',
});

// Gets an item by codename from Kontent.ai and treats it as a strongly typed model
const homepageItem = (
  await deliveryClient.item<Homepage>('hello_caas_world').toPromise()
).data.item;

// The example above assumes that the item with the codename `hello_caas_world` is of type `Homepage`.
// However, this may not always be the case. To avoid potential runtime errors, it is recommended to
// use generated type guards, such as:
const item = (await deliveryClient.item(`hello_headless_world`).toPromise())
  .data.item;

if (isHomepage(item)) {
  // At this point, the item's type is known, allowing safe and straightforward access to its properties.
  const headline = item.elements.headline.value;
}