@se-studio/core-data-types 0.1.0 → 0.1.1

package/dist/index.d.ts

@@ -1,27 +1,5 @@
 import { VideoTypeData } from '@extractus/oembed-extractor';
 
-interface IPage<TConfig extends BaseCmsConfig> extends IBaseModel<TConfig> {
-    type: 'Page';
-    isHomePage: boolean;
-    structuredData?: ReadonlyArray<unknown>;
-    contents?: ReadonlyArray<PageContent<TConfig>>;
-    tags?: ReadonlyArray<IInternalLink<TConfig>>;
-}
-type PageLink<TConfig extends BaseCmsConfig> = Omit<IPage<TConfig>, BaseModelLinkOmissions | 'structuredData' | 'contents'>;
-declare function isPage<TConfig extends BaseCmsConfig>(content: IBaseModel<TConfig>): content is IPage<TConfig>;
-
-interface ITag<TConfig extends BaseCmsConfig> extends IBaseModel<TConfig> {
-    type: 'Tag';
-    tagType?: string | null;
-    contents?: ReadonlyArray<PageContent<TConfig>>;
-}
-type TagLink<TConfig extends BaseCmsConfig> = Omit<ITag<TConfig>, BaseModelLinkOmissions | 'contents'>;
-declare function isTag<TConfig extends BaseCmsConfig>(content: IBaseModel<TConfig>): content is ITag<TConfig>;
-interface ITags<TConfig extends BaseCmsConfig> extends IBaseModel<TConfig> {
-    type: 'Tags';
-}
-declare function isTags<TConfig extends BaseCmsConfig>(content: IBaseModel<TConfig>): content is ITags<TConfig>;
-
 type Vertical = 'Top' | 'Middle' | 'Bottom';
 type Horizontal = 'Left' | 'Middle' | 'Right';
 interface IInternalBreakpoint {
@@ -104,11 +82,13 @@ interface IVideoCommon extends IVisualCommon {
 interface ILocalVideo extends IVideoCommon {
     type: 'Local video';
     preview: IVideoDetails;
+    videoPrefix: string;
 }
 interface IFullVideo extends IVideoCommon {
     type: 'Full video';
     preview?: IVideoDetails;
     full: IVideoDetails;
+    videoPrefix: string;
 }
 interface IExternalVideo extends IVideoCommon {
     type: 'External video';
@@ -148,34 +128,24 @@ interface IResponsiveVisual {
     visualCustomSize?: number | null;
 }
 
-type BaseModelType = 'Page' | 'Article' | 'Tag' | 'Article type' | 'Tags' | 'Person' | 'People' | 'Custom type';
 type BaseContentType = 'Component' | 'Collection' | 'Internal link' | 'Visual' | 'External component';
-type Brand<T, U> = T & {
-    __brand: U;
-};
-type ColourName<T extends string = string> = Brand<T, 'ColourName'>;
-type GradientName<T extends string = string> = Brand<T, 'GradientName'>;
-type ModelType<T extends string = string> = Brand<T, 'ModelType'>;
-type ContentType<T extends string = string> = Brand<T, 'ContentType'>;
-type IconName<T extends string = string> = Brand<T, 'IconName'>;
-type ButtonVariant<T extends string = string> = Brand<T, 'ButtonVariant'>;
-type ButtonSize<T extends string = string> = Brand<T, 'ButtonSize'>;
-type ComponentType<T extends string = string> = Brand<T, 'ComponentType'>;
-type CollectionType<T extends string = string> = Brand<T, 'CollectionType'>;
-type ExternalComponentType<T extends string = string> = Brand<T, 'ExternalComponentType'>;
-interface IPageContext<TConfig extends BaseCmsConfig> {
-    articleLink?: ArticleLink<TConfig>;
-    articleTypeLink?: ArticleTypeLink<TConfig>;
-    personLink?: PersonLink<TConfig>;
-    pageLink?: PageLink<TConfig>;
-    tagLink?: TagLink<TConfig>;
-}
-interface IContentContext<TConfig extends BaseCmsConfig> {
+interface ITyped {
+    type: string;
+    id: string;
+}
+interface IPageContext {
+    articleLink?: ITyped;
+    articleTypeLink?: ITyped;
+    personLink?: ITyped;
+    pageLink?: ITyped;
+    tagLink?: ITyped;
+}
+interface IContentContext {
     analyticsContext?: IAnalyticsContext;
-    pageContext: IPageContext<TConfig>;
-    current: PageContent<TConfig>;
-    previousContent?: PageContent<TConfig>;
-    nextContent?: PageContent<TConfig>;
+    pageContext: IPageContext;
+    current: ITyped;
+    previousContent?: ITyped;
+    nextContent?: ITyped;
 }
 interface IAnalyticsContext {
     slug: string;
@@ -189,25 +159,7 @@ interface IRichTextOptions {
     parentId: string;
     parentIndex: number;
 }
-type BaseCmsConfig = {
-    RichText: unknown;
-    ColourName: ColourName<string>;
-    GradientName: GradientName<string>;
-    ModelType: ModelType<string>;
-    ContentType: ContentType<string>;
-    CollectionType: CollectionType<string>;
-    ComponentType: ComponentType<string>;
-    ExternalComponentType: ExternalComponentType<string>;
-    ButtonVariant: ButtonVariant<string>;
-    ButtonSize: ButtonSize<string>;
-    PageContext: IPageContext<BaseCmsConfig>;
-    Component: IBaseComponent<BaseCmsConfig>;
-    Collection: IBaseCollection<BaseCmsConfig>;
-    ExternalComponent: IBaseExternalComponent<BaseCmsConfig>;
-    RichTextOptions: IRichTextOptions;
-    PageContent: PageContent<BaseCmsConfig>;
-};
-interface ILinkProps<TConfig extends BaseCmsConfig> {
+interface ILinkProps {
     parentId?: string;
     parentFieldId?: string;
     id: string;
@@ -219,42 +171,41 @@ interface ILinkProps<TConfig extends BaseCmsConfig> {
     href?: string | null;
     click?: () => void;
     type: 'Blank link' | 'External link' | 'Internal link' | 'Download link';
-    backgroundColour?: TConfig['ColourName'] | TConfig['GradientName'] | null;
-    textColour?: TConfig['ColourName'] | null;
-    variant?: TConfig['ButtonVariant'];
-    size?: TConfig['ButtonSize'];
+    backgroundColour?: string | null;
+    textColour?: string | null;
+    variant?: string;
+    size?: string;
 }
-interface IBLankLink<TConfig extends BaseCmsConfig> extends ILinkProps<TConfig> {
+interface IBlankLink extends ILinkProps {
     type: 'Blank link';
 }
-interface IExternalLink<TConfig extends BaseCmsConfig> extends ILinkProps<TConfig> {
+interface IExternalLink extends ILinkProps {
     type: 'External link';
 }
-interface IInternalLink<TConfig extends BaseCmsConfig> extends ILinkProps<TConfig> {
+interface IInternalLink extends ILinkProps {
     type: 'Internal link';
     slug: string;
     indexed?: boolean | null;
     hidden?: boolean | null;
-    tags?: ReadonlyArray<IInternalLink<TConfig>>;
+    tags?: ReadonlyArray<IInternalLink>;
 }
-interface IDownloadLink<TConfig extends BaseCmsConfig> extends ILinkProps<TConfig> {
+interface IDownloadLink extends ILinkProps {
     type: 'Download link';
 }
-interface INavigation<TConfig extends BaseCmsConfig> {
+interface INavigation {
     id: string;
     name: string;
-    entries: ReadonlyArray<INavigationItem<TConfig>>;
-    textColour?: TConfig['ColourName'];
-    backgroundColour?: TConfig['ColourName'] | TConfig['GradientName'];
+    entries: ReadonlyArray<INavigationItem>;
+    textColour?: string;
+    backgroundColour?: string;
 }
-interface INavigationItem<TConfig extends BaseCmsConfig> {
+interface INavigationItem {
     id: string;
-    link?: ILinkProps<TConfig>;
-    entries?: ReadonlyArray<INavigationItem<TConfig>>;
-    longText: TConfig['RichText'] | string | null;
+    link?: ILinkProps;
+    entries?: ReadonlyArray<INavigationItem>;
 }
-interface IBaseModel<TConfig extends BaseCmsConfig> {
-    type: BaseModelType | TConfig['ModelType'];
+interface IBaseModel {
+    type: string;
     id: string;
     slug: string;
     title: string;
@@ -264,14 +215,14 @@ interface IBaseModel<TConfig extends BaseCmsConfig> {
     indexed?: boolean | null;
     hidden?: boolean | null;
     lastUpdated?: string | Date;
-    textColour?: TConfig['ColourName'];
-    backgroundColour?: TConfig['ColourName'] | TConfig['GradientName'];
-    menu?: INavigation<TConfig>;
-    footer?: INavigation<TConfig>;
+    textColour?: string;
+    backgroundColour?: string;
+    menu?: INavigation;
+    footer?: INavigation;
 }
 type BaseModelLinkOmissions = 'menu' | 'footer';
-interface IBaseContent<TConfig extends BaseCmsConfig> {
-    type: BaseContentType | TConfig['ContentType'];
+interface IBaseContent {
+    type: string;
     index: number;
     isFirst: boolean;
     isLast: boolean;
@@ -280,8 +231,8 @@ interface IBaseContent<TConfig extends BaseCmsConfig> {
     name: string;
     anchor?: string | null;
     cmsLabel: string | null;
-    backgroundColour?: TConfig['ColourName'] | TConfig['GradientName'];
-    textColour?: TConfig['ColourName'];
+    backgroundColour?: string;
+    textColour?: string;
     hexColor?: string | null;
     backgroundVisual?: IResponsiveVisual;
     backgroundOverlayOpacity?: number | null;
@@ -289,69 +240,85 @@ interface IBaseContent<TConfig extends BaseCmsConfig> {
     parentId?: string;
     parentFieldId?: string;
 }
-interface IBaseComponent<TConfig extends BaseCmsConfig> extends IBaseContent<TConfig> {
+interface IBaseComponent extends IBaseContent {
     type: 'Component';
-    componentType: TConfig['ComponentType'];
+    componentType: string;
     preHeading?: string | null;
     heading?: string | null;
     postHeading?: string | null;
-    body?: TConfig['RichText'] | string;
+    body?: unknown;
     icon?: IVisual;
-    links?: ReadonlyArray<ILinkProps<TConfig>>;
-    additionalCopy?: TConfig['RichText'] | string;
+    links?: ReadonlyArray<ILinkProps>;
+    additionalCopy?: unknown;
 }
-declare function isComponent<TConfig extends BaseCmsConfig>(obj: unknown): obj is TConfig['Component'];
-type CollectionContent<TConfig extends BaseCmsConfig> = IBaseComponent<TConfig> | IBaseCollection<TConfig>;
-interface IBaseCollection<TConfig extends BaseCmsConfig> extends IBaseContent<TConfig> {
+declare function isComponent(obj: unknown): obj is IBaseComponent;
+type CollectionContent = IBaseComponent | IBaseCollection;
+interface IBaseCollection extends IBaseContent {
     type: 'Collection';
-    collectionType: TConfig['CollectionType'];
+    collectionType: string;
     anchor?: string | null;
     preHeading?: string | null;
     heading?: string | null;
     postHeading?: string | null;
-    body?: TConfig['RichText'] | string;
+    body?: unknown;
     icon?: IVisual;
-    links?: ReadonlyArray<ILinkProps<TConfig>>;
-    additionalCopy?: TConfig['RichText'] | string;
-    contents?: ReadonlyArray<CollectionContent<TConfig>>;
+    links?: ReadonlyArray<ILinkProps>;
+    additionalCopy?: unknown;
+    contents?: ReadonlyArray<CollectionContent>;
 }
-declare function isCollection<TConfig extends BaseCmsConfig>(obj: unknown): obj is TConfig['Collection'];
-interface IBaseExternalComponent<TConfig extends BaseCmsConfig> extends IBaseContent<TConfig> {
+declare function isCollection(obj: unknown): obj is IBaseCollection;
+interface IBaseExternalComponent extends IBaseContent {
     type: 'External component';
-    externalType: TConfig['ExternalComponentType'];
+    externalType: string;
     data: unknown | null;
 }
-interface IPerson<TConfig extends BaseCmsConfig> extends IBaseModel<TConfig> {
+interface IPerson extends IBaseModel {
     type: 'Person';
     jobTitle?: string | null;
     phoneNumber: string | null;
     emailAddress: string | null;
     location: string | null;
     linkedIn: string | null;
-    bio: TConfig['RichText'] | null | undefined;
+    bio: unknown;
     href: string | undefined;
     structuredData?: ReadonlyArray<unknown>;
-    contents?: ReadonlyArray<PageContent<TConfig>>;
+    contents?: ReadonlyArray<unknown>;
 }
-type PersonLink<TConfig extends BaseCmsConfig> = Omit<IPerson<TConfig>, BaseModelLinkOmissions | 'structuredData' | 'contents'>;
-type PageContent<TConfig extends BaseCmsConfig> = IBaseComponent<TConfig> | IBaseCollection<TConfig> | IBaseExternalComponent<TConfig> | IVisual | IInternalLink<TConfig>;
+type PersonLink = Omit<IPerson, BaseModelLinkOmissions | 'structuredData' | 'contents'>;
 
-interface IArticle<TConfig extends BaseCmsConfig> extends IBaseModel<TConfig> {
+interface IBaseTag extends IBaseModel {
+    type: 'Tag';
+    tagType?: string | null;
+    contents?: ReadonlyArray<ITyped>;
+}
+declare function isTag(content: IBaseModel): content is IBaseTag;
+interface IBaseTags extends IBaseModel {
+    type: 'Tags';
+}
+declare function isTags(content: IBaseModel): content is IBaseTags;
+
+interface IBaseArticle extends IBaseModel {
     type: 'Article';
-    articleType?: IInternalLink<TConfig>;
+    articleType?: IInternalLink;
     structuredData?: ReadonlyArray<unknown>;
-    contents?: ReadonlyArray<PageContent<TConfig>>;
-    tags?: ReadonlyArray<IInternalLink<TConfig>>;
+    contents?: ReadonlyArray<ITyped>;
+    tags?: ReadonlyArray<IInternalLink>;
 }
-type ArticleLink<TConfig extends BaseCmsConfig> = Omit<IArticle<TConfig>, BaseModelLinkOmissions | 'structuredData' | 'contents' | 'tags'> & {
-    tags?: ReadonlyArray<TagLink<TConfig>>;
-};
-declare function isArticle<TConfig extends BaseCmsConfig>(content: IBaseModel<TConfig>): content is IArticle<TConfig>;
-interface IArticleType<TConfig extends BaseCmsConfig> extends IBaseModel<TConfig> {
+declare function isArticle(content: IBaseModel): content is IBaseArticle;
+interface IBaseArticleType extends IBaseModel {
     type: 'Article type';
-    indexPageContent?: ReadonlyArray<PageContent<TConfig>>;
-    searchPageContent?: ReadonlyArray<PageContent<TConfig>>;
+    indexPageContent?: ReadonlyArray<ITyped>;
+    searchPageContent?: ReadonlyArray<ITyped>;
+}
+declare function isArticleType(content: IBaseModel): content is IBaseArticleType;
+
+interface IBasePage extends IBaseModel {
+    type: 'Page';
+    isHomePage: boolean;
+    structuredData?: ReadonlyArray<unknown>;
+    contents?: ReadonlyArray<ITyped>;
+    tags?: ReadonlyArray<IInternalLink>;
 }
-type ArticleTypeLink<TConfig extends BaseCmsConfig> = Omit<IArticleType<TConfig>, BaseModelLinkOmissions | 'indexPageContent' | 'searchPageContent'>;
+declare function isPage(content: IBaseModel): content is IBasePage;
 
-export { type BaseCmsConfig, type BaseContentType, type BaseModelType, type ButtonSize, type ButtonVariant, type CollectionContent, type CollectionType, type ColourName, type ComponentType, type ContentType, type ExternalComponentType, type GradientName, type Horizontal, type IAnalyticsContext, type IAnimation, type IArticle, type IBLankLink, type IBaseCollection, type IBaseComponent, type IBaseContent, type IBaseExternalComponent, type IBaseModel, type IContentContext, type IDownloadLink, type IExternalLink, type IExternalVideo, type IFullVideo, type IImage, type IInternalLink, type ILinkProps, type ILocalVideo, type INavigation, type INavigationItem, type IPage, type IPageContext, type IPerson, type IPicture, type IResponsiveVisual, type ISvgData, type ISvgImage, type ITag, type ITags, type IVideo, type IVideoDetails, type IVisual, type IVisualCommon, type IVisualSizes, type IconName, type ModelType, type PageContent, type PersonLink, type Vertical, isAnimation, isArticle, isCollection, isComponent, isExternalVideo, isFullVideo, isImage, isLocalVideo, isPage, isPicture, isSvgData, isSvgImage, isTag, isTags, isVideo, isVisualAnimation, isVisualImage, isVisualVideo, processSizes };
+export { type BaseContentType, type CollectionContent, type Horizontal, type IAnalyticsContext, type IAnimation, type IBaseArticle, type IBaseArticleType, type IBaseCollection, type IBaseComponent, type IBaseContent, type IBaseExternalComponent, type IBaseModel, type IBasePage, type IBaseTag, type IBaseTags, type IBlankLink, type IContentContext, type IDownloadLink, type IExternalLink, type IExternalVideo, type IFullVideo, type IImage, type IInternalLink, type ILinkProps, type ILocalVideo, type INavigation, type INavigationItem, type IPageContext, type IPerson, type IPicture, type IResponsiveVisual, type IRichTextOptions, type ISvgData, type ISvgImage, type ITyped, type IVideo, type IVideoDetails, type IVisual, type IVisualCommon, type IVisualSizes, type PersonLink, type Vertical, isAnimation, isArticle, isArticleType, isCollection, isComponent, isExternalVideo, isFullVideo, isImage, isLocalVideo, isPage, isPicture, isSvgData, isSvgImage, isTag, isTags, isVideo, isVisualAnimation, isVisualImage, isVisualVideo, processSizes };

package/dist/index.js

@@ -2,6 +2,9 @@
 function isArticle(content) {
   return content.type === "Article";
 }
+function isArticleType(content) {
+  return content.type === "Article type";
+}
 
 // src/types/common.ts
 function isComponent(obj) {
@@ -103,6 +106,6 @@ function isVisualAnimation(visual) {
   return visual?.animation !== void 0;
 }
 
-export { isAnimation, isArticle, isCollection, isComponent, isExternalVideo, isFullVideo, isImage, isLocalVideo, isPage, isPicture, isSvgData, isSvgImage, isTag, isTags, isVideo, isVisualAnimation, isVisualImage, isVisualVideo, processSizes };
+export { isAnimation, isArticle, isArticleType, isCollection, isComponent, isExternalVideo, isFullVideo, isImage, isLocalVideo, isPage, isPicture, isSvgData, isSvgImage, isTag, isTags, isVideo, isVisualAnimation, isVisualImage, isVisualVideo, processSizes };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/types/article.ts","../src/types/common.ts","../src/types/page.ts","../src/types/tag.ts","../src/types/visual.ts"],"names":["proportion"],"mappings":";AAwBO,SAAS,UACd,OAAA,EAC8B;AAC9B,EAAA,OAAO,QAAQ,IAAA,KAAS,SAAA;AAC1B;;;ACqMO,SAAS,YACd,GAAA,EAC6B;AAC7B,EAAA,IAAI,OAAO,GAAA,KAAQ,QAAA,IAAY,GAAA,KAAQ,IAAA,EAAM;AAC3C,IAAA,OAAO,KAAA;AAAA,EACT;AACA,EAAA,IAAK,GAAA,CAA6B,SAAS,WAAA,EAAa;AACtD,IAAA,OAAO,KAAA;AAAA,EACT;AACA,EAAA,OAAO,IAAA;AACT;AAoBO,SAAS,aACd,GAAA,EAC8B;AAC9B,EAAA,IAAI,OAAO,GAAA,KAAQ,QAAA,IAAY,GAAA,KAAQ,IAAA,EAAM;AAC3C,IAAA,OAAO,KAAA;AAAA,EACT;AACA,EAAA,IAAK,GAAA,CAA8B,SAAS,YAAA,EAAc;AACxD,IAAA,OAAO,KAAA;AAAA,EACT;AACA,EAAA,OAAO,IAAA;AACT;;;ACpPO,SAAS,OACd,OAAA,EAC2B;AAC3B,EAAA,OAAO,QAAQ,IAAA,KAAS,MAAA;AAC1B;;;ACZO,SAAS,MACd,OAAA,EAC0B;AAC1B,EAAA,OAAO,QAAQ,IAAA,KAAS,KAAA;AAC1B;AAMO,SAAS,OACd,OAAA,EAC2B;AAC3B,EAAA,OAAO,QAAQ,IAAA,KAAS,MAAA;AAC1B;;;ACRA,SAAS,kBAAkB,WAAA,EAAgE;AACzF,EAAA,OAAO,WAAA,EAAa,IAAI,CAAC,EAAE,UAAU,UAAA,EAAY,MAAA,EAAQ,MAAK,KAAM;AAClE,IAAA,IAAI,UAAA,EAAY;AACd,MAAA,OAAO;AAAA,QACL,QAAA;AAAA,QACA,UAAA;AAAA,QACA,MAAA,EAAQ,IAAA,CAAK,KAAA,CAAM,QAAA,GAAW,UAAU,CAAA;AAAA,QACxC,MAAM,CAAA,EAAG,IAAA,CAAK,KAAA,CAAM,GAAA,GAAM,UAAU,CAAC,CAAA,EAAA;AAAA,OACvC;AAAA,IACF;AACA,IAAA,IAAI,MAAA,EAAQ;AACV,MAAA,MAAMA,WAAAA,GAAa,IAAA,CAAK,KAAA,CAAM,QAAA,GAAW,MAAM,CAAA;AAC/C,MAAA,OAAO;AAAA,QACL,QAAA;AAAA,QACA,UAAA,EAAAA,WAAAA;AAAA,QACA,MAAA;AAAA,QACA,MAAM,IAAA,IAAQ,CAAA,EAAG,KAAK,KAAA,CAAM,GAAA,GAAMA,WAAU,CAAC,CAAA,EAAA;AAAA,OAC/C;AAAA,IACF;AAEA,IAAA,OAAO,EAAE,UAAU,UAAA,EAAY,CAAA,EAAG,QAAQ,QAAA,EAAU,IAAA,EAAM,QAAQ,CAAA,KAAA,CAAA,EAAQ;AAAA,EAC5E,CAAC,CAAA;AACH;AACO,SAAS,YAAA,CAAa,EAAE,WAAA,EAAa,aAAA,EAAe,aAAY,EAAiB;AACtF,EAAA,OAAO;AAAA,IACL,WAAA;AAAA,IACA,aAAA;AAAA,IACA,WAAA,EAAa,kBAAkB,WAAW;AAAA,GAC5C;AACF;AAiDO,SAAS,UAAU,GAAA,EAAwD;AAChF,EAAA,OAAO,KAAK,IAAA,KAAS,SAAA;AACvB;AAEO,SAAS,WAAW,GAAA,EAAyD;AAClF,EAAA,OAAO,KAAK,IAAA,KAAS,WAAA;AACvB;AAEO,SAAS,UAAU,GAAA,EAAwD;AAChF,EAAA,OAAO,KAAK,IAAA,KAAS,UAAA;AACvB;AAEO,SAAS,QAAQ,GAAA,EAAsD;AAC5E,EAAA,OAAO,UAAU,GAAG,CAAA,IAAK,WAAW,GAAG,CAAA,IAAK,UAAU,GAAG,CAAA;AAC3D;AAuCO,SAAS,aAAa,GAAA,EAA2D;AACtF,EAAA,OAAO,KAAK,IAAA,KAAS,aAAA;AACvB;AAEO,SAAS,YAAY,GAAA,EAA0D;AACpF,EAAA,OAAO,KAAK,IAAA,KAAS,YAAA;AACvB;AAEO,SAAS,gBAAgB,GAAA,EAA8D;AAC5F,EAAA,OAAO,KAAK,IAAA,KAAS,gBAAA;AACvB;AAEO,SAAS,QAAQ,GAAA,EAAsD;AAC5E,EAAA,OAAO,aAAa,GAAG,CAAA,IAAK,YAAY,GAAG,CAAA,IAAK,gBAAgB,GAAG,CAAA;AACrE;AAWO,SAAS,YAAY,GAAA,EAAuC;AACjE,EAAA,OAAO,KAAK,IAAA,KAAS,WAAA;AACvB;AAUO,SAAS,cAAc,MAAA,EAAoC;AAChE,EAAA,OAAO,QAAQ,KAAA,KAAU,MAAA;AAC3B;AACO,SAAS,cAAc,MAAA,EAAoC;AAChE,EAAA,OAAO,QAAQ,KAAA,KAAU,MAAA;AAC3B;AACO,SAAS,kBAAkB,MAAA,EAAoC;AACpE,EAAA,OAAO,QAAQ,SAAA,KAAc,MAAA;AAC/B","file":"index.js","sourcesContent":["import type {\n  BaseCmsConfig,\n  BaseModelLinkOmissions,\n  IBaseModel,\n  IInternalLink,\n  PageContent,\n} from './common';\nimport type { TagLink } from './tag';\n\nexport interface IArticle<TConfig extends BaseCmsConfig> extends IBaseModel<TConfig> {\n  type: 'Article';\n  articleType?: IInternalLink<TConfig>;\n  structuredData?: ReadonlyArray<unknown>;\n  contents?: ReadonlyArray<PageContent<TConfig>>;\n  tags?: ReadonlyArray<IInternalLink<TConfig>>;\n}\n\nexport type ArticleLink<TConfig extends BaseCmsConfig> = Omit<\n  IArticle<TConfig>,\n  BaseModelLinkOmissions | 'structuredData' | 'contents' | 'tags'\n> & {\n  tags?: ReadonlyArray<TagLink<TConfig>>;\n};\n\nexport function isArticle<TConfig extends BaseCmsConfig>(\n  content: IBaseModel<TConfig>,\n): content is IArticle<TConfig> {\n  return content.type === 'Article';\n}\n\nexport interface IArticleType<TConfig extends BaseCmsConfig> extends IBaseModel<TConfig> {\n  type: 'Article type';\n  indexPageContent?: ReadonlyArray<PageContent<TConfig>>;\n  searchPageContent?: ReadonlyArray<PageContent<TConfig>>;\n}\n\nexport type ArticleTypeLink<TConfig extends BaseCmsConfig> = Omit<\n  IArticleType<TConfig>,\n  BaseModelLinkOmissions | 'indexPageContent' | 'searchPageContent'\n>;\n\nexport function isArticleType<TConfig extends BaseCmsConfig>(\n  content: IBaseModel<TConfig>,\n): content is IArticleType<TConfig> {\n  return content.type === 'Article type';\n}\n","import type { ArticleLink, ArticleTypeLink } from './article';\nimport type { PageLink } from './page';\nimport type { TagLink } from './tag';\nimport type { IResponsiveVisual, IVisual } from './visual';\n\n/**\n * Utility type to make all nested properties of a type optional\n */\nexport type DeepPartial<T> = {\n  [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];\n};\n\n/**\n * Utility type to make TypeScript's complex types more readable in IDE tooltips\n */\nexport type Prettify<T> = {\n  [K in keyof T]: T[K];\n} & {};\n\nexport type BaseModelType =\n  | 'Page'\n  | 'Article'\n  | 'Tag'\n  | 'Article type'\n  | 'Tags'\n  | 'Person'\n  | 'People'\n  | 'Custom type';\n\nexport type BaseContentType =\n  | 'Component'\n  | 'Collection'\n  | 'Internal link'\n  | 'Visual'\n  | 'External component';\n\nexport type Brand<T, U> = T & { __brand: U }; // Nominal typing helper\n\nexport type ColourName<T extends string = string> = Brand<T, 'ColourName'>;\nexport type GradientName<T extends string = string> = Brand<T, 'GradientName'>;\nexport type ModelType<T extends string = string> = Brand<T, 'ModelType'>;\nexport type ContentType<T extends string = string> = Brand<T, 'ContentType'>;\nexport type IconName<T extends string = string> = Brand<T, 'IconName'>;\nexport type ButtonVariant<T extends string = string> = Brand<T, 'ButtonVariant'>;\nexport type ButtonSize<T extends string = string> = Brand<T, 'ButtonSize'>;\nexport type ComponentType<T extends string = string> = Brand<T, 'ComponentType'>;\nexport type CollectionType<T extends string = string> = Brand<T, 'CollectionType'>;\nexport type ExternalComponentType<T extends string = string> = Brand<T, 'ExternalComponentType'>;\n\nexport interface IPageContext<TConfig extends BaseCmsConfig> {\n  articleLink?: ArticleLink<TConfig>;\n  articleTypeLink?: ArticleTypeLink<TConfig>;\n  personLink?: PersonLink<TConfig>;\n  pageLink?: PageLink<TConfig>;\n  tagLink?: TagLink<TConfig>;\n}\n\nexport interface IContentContext<TConfig extends BaseCmsConfig> {\n  analyticsContext?: IAnalyticsContext;\n  pageContext: IPageContext<TConfig>;\n  current: PageContent<TConfig>;\n  previousContent?: PageContent<TConfig>;\n  nextContent?: PageContent<TConfig>;\n}\n\nexport interface IAnalyticsContext {\n  slug: string;\n  title?: string;\n  type?: string;\n}\n\nexport interface IRichTextOptions {\n  cmsLabel?: string | null;\n  analytics?: IAnalyticsContext;\n  embedded?: boolean;\n  parentId: string;\n  parentIndex: number;\n}\n\nexport type BaseCmsConfig = {\n  RichText: unknown; // Or whatever your default rich text type is\n  ColourName: ColourName<string>;\n  GradientName: GradientName<string>;\n  ModelType: ModelType<string>;\n  ContentType: ContentType<string>;\n  CollectionType: CollectionType<string>;\n  ComponentType: ComponentType<string>;\n  ExternalComponentType: ExternalComponentType<string>;\n  ButtonVariant: ButtonVariant<string>;\n  ButtonSize: ButtonSize<string>;\n  PageContext: IPageContext<BaseCmsConfig>;\n  Component: IBaseComponent<BaseCmsConfig>;\n  Collection: IBaseCollection<BaseCmsConfig>;\n  ExternalComponent: IBaseExternalComponent<BaseCmsConfig>;\n  RichTextOptions: IRichTextOptions;\n  PageContent: PageContent<BaseCmsConfig>;\n};\n\nexport interface ILinkProps<TConfig extends BaseCmsConfig> {\n  parentId?: string;\n  parentFieldId?: string;\n  id: string;\n  useName?: boolean | null;\n  name: string;\n  text?: string | null;\n  icon?: IVisual;\n  visual?: IVisual;\n  href?: string | null;\n  click?: () => void;\n  type: 'Blank link' | 'External link' | 'Internal link' | 'Download link';\n  backgroundColour?: TConfig['ColourName'] | TConfig['GradientName'] | null;\n  textColour?: TConfig['ColourName'] | null;\n  variant?: TConfig['ButtonVariant'];\n  size?: TConfig['ButtonSize'];\n}\n\nexport interface IBLankLink<TConfig extends BaseCmsConfig> extends ILinkProps<TConfig> {\n  type: 'Blank link';\n}\n\nexport interface IExternalLink<TConfig extends BaseCmsConfig> extends ILinkProps<TConfig> {\n  type: 'External link';\n}\n\nexport interface IInternalLink<TConfig extends BaseCmsConfig> extends ILinkProps<TConfig> {\n  type: 'Internal link';\n  slug: string;\n  indexed?: boolean | null;\n  hidden?: boolean | null;\n  tags?: ReadonlyArray<IInternalLink<TConfig>>;\n}\n\nexport interface IDownloadLink<TConfig extends BaseCmsConfig> extends ILinkProps<TConfig> {\n  type: 'Download link';\n}\n\nexport function isBlankLink<TConfig extends BaseCmsConfig>(\n  link: ILinkProps<TConfig>,\n): link is IBLankLink<TConfig> {\n  return link.type === 'Blank link';\n}\n\nexport function isExternalLink<TConfig extends BaseCmsConfig>(\n  link: ILinkProps<TConfig>,\n): link is IExternalLink<TConfig> {\n  return link.type === 'External link';\n}\n\nexport function isInternalLink<TConfig extends BaseCmsConfig>(\n  link: ILinkProps<TConfig>,\n): link is IInternalLink<TConfig> {\n  return link.type === 'Internal link';\n}\n\nexport function isDownloadLink<TConfig extends BaseCmsConfig>(\n  link: ILinkProps<TConfig>,\n): link is IDownloadLink<TConfig> {\n  return link.type === 'Download link';\n}\n\nexport interface INavigation<TConfig extends BaseCmsConfig> {\n  id: string;\n  name: string;\n  entries: ReadonlyArray<INavigationItem<TConfig>>;\n  textColour?: TConfig['ColourName'];\n  backgroundColour?: TConfig['ColourName'] | TConfig['GradientName'];\n}\n\nexport interface INavigationItem<TConfig extends BaseCmsConfig> {\n  id: string;\n  link?: ILinkProps<TConfig>;\n  entries?: ReadonlyArray<INavigationItem<TConfig>>;\n  longText: TConfig['RichText'] | string | null;\n}\n\nexport interface IBaseModel<TConfig extends BaseCmsConfig> {\n  type: BaseModelType | TConfig['ModelType'];\n  id: string;\n  slug: string;\n  title: string;\n  description: string;\n  featuredImage?: IVisual;\n  link?: string;\n  indexed?: boolean | null;\n  hidden?: boolean | null;\n  lastUpdated?: string | Date;\n  textColour?: TConfig['ColourName'];\n  backgroundColour?: TConfig['ColourName'] | TConfig['GradientName'];\n  menu?: INavigation<TConfig>;\n  footer?: INavigation<TConfig>;\n}\nexport type BaseModelLinkOmissions = 'menu' | 'footer';\n\nexport interface IBaseContent<TConfig extends BaseCmsConfig> {\n  type: BaseContentType | TConfig['ContentType'];\n  index: number;\n  isFirst: boolean;\n  isLast: boolean;\n  indexOfType: number;\n  id: string;\n  name: string;\n  anchor?: string | null;\n  cmsLabel: string | null; // Original CMS label for tracking purposes\n  backgroundColour?: TConfig['ColourName'] | TConfig['GradientName'];\n  textColour?: TConfig['ColourName'];\n  hexColor?: string | null;\n  backgroundVisual?: IResponsiveVisual;\n  backgroundOverlayOpacity?: number | null;\n  visual?: IResponsiveVisual;\n  parentId?: string;\n  parentFieldId?: string;\n}\n\nexport interface IBaseComponent<TConfig extends BaseCmsConfig> extends IBaseContent<TConfig> {\n  type: 'Component';\n  componentType: TConfig['ComponentType'];\n  preHeading?: string | null;\n  heading?: string | null;\n  postHeading?: string | null;\n  body?: TConfig['RichText'] | string;\n  icon?: IVisual;\n  links?: ReadonlyArray<ILinkProps<TConfig>>;\n  additionalCopy?: TConfig['RichText'] | string;\n}\n\nexport function isComponent<TConfig extends BaseCmsConfig>(\n  obj: unknown,\n): obj is TConfig['Component'] {\n  if (typeof obj !== 'object' || obj === null) {\n    return false;\n  }\n  if ((obj as TConfig['Component']).type !== 'Component') {\n    return false;\n  }\n  return true;\n}\n\nexport type CollectionContent<TConfig extends BaseCmsConfig> =\n  | IBaseComponent<TConfig>\n  | IBaseCollection<TConfig>;\n\nexport interface IBaseCollection<TConfig extends BaseCmsConfig> extends IBaseContent<TConfig> {\n  type: 'Collection';\n  collectionType: TConfig['CollectionType'];\n  anchor?: string | null;\n  preHeading?: string | null;\n  heading?: string | null;\n  postHeading?: string | null;\n  body?: TConfig['RichText'] | string;\n  icon?: IVisual;\n  links?: ReadonlyArray<ILinkProps<TConfig>>;\n  additionalCopy?: TConfig['RichText'] | string;\n  contents?: ReadonlyArray<CollectionContent<TConfig>>;\n}\n\nexport function isCollection<TConfig extends BaseCmsConfig>(\n  obj: unknown,\n): obj is TConfig['Collection'] {\n  if (typeof obj !== 'object' || obj === null) {\n    return false;\n  }\n  if ((obj as TConfig['Collection']).type !== 'Collection') {\n    return false;\n  }\n  return true;\n}\n\nexport interface IBaseExternalComponent<TConfig extends BaseCmsConfig>\n  extends IBaseContent<TConfig> {\n  type: 'External component';\n  externalType: TConfig['ExternalComponentType'];\n  data: unknown | null;\n}\n\nexport function isExternalComponent<TConfig extends BaseCmsConfig>(\n  obj: unknown,\n): obj is TConfig['ExternalComponent'] {\n  if (typeof obj !== 'object' || obj === null) {\n    return false;\n  }\n  if ((obj as TConfig['ExternalComponent']).type !== 'External component') {\n    return false;\n  }\n  return true;\n}\n\nexport interface IPerson<TConfig extends BaseCmsConfig> extends IBaseModel<TConfig> {\n  type: 'Person';\n  jobTitle?: string | null;\n  phoneNumber: string | null;\n  emailAddress: string | null;\n  location: string | null;\n  linkedIn: string | null;\n  bio: TConfig['RichText'] | null | undefined;\n  href: string | undefined;\n  structuredData?: ReadonlyArray<unknown>;\n  contents?: ReadonlyArray<PageContent<TConfig>>;\n}\n\nexport type PersonLink<TConfig extends BaseCmsConfig> = Omit<\n  IPerson<TConfig>,\n  BaseModelLinkOmissions | 'structuredData' | 'contents'\n>;\n\nexport function isPerson<TConfig extends BaseCmsConfig>(\n  content: IBaseModel<TConfig>,\n): content is IPerson<TConfig> {\n  return content.type === 'Person';\n}\n\nexport type PageContent<TConfig extends BaseCmsConfig> =\n  | IBaseComponent<TConfig>\n  | IBaseCollection<TConfig>\n  | IBaseExternalComponent<TConfig>\n  | IVisual\n  | IInternalLink<TConfig>;\n","import type {\n  BaseCmsConfig,\n  BaseModelLinkOmissions,\n  IBaseModel,\n  IInternalLink,\n  PageContent,\n} from './common';\n\nexport interface IPage<TConfig extends BaseCmsConfig> extends IBaseModel<TConfig> {\n  type: 'Page';\n  isHomePage: boolean;\n  structuredData?: ReadonlyArray<unknown>;\n  contents?: ReadonlyArray<PageContent<TConfig>>;\n  tags?: ReadonlyArray<IInternalLink<TConfig>>;\n}\n\nexport type PageLink<TConfig extends BaseCmsConfig> = Omit<\n  IPage<TConfig>,\n  BaseModelLinkOmissions | 'structuredData' | 'contents'\n>;\n\nexport function isPage<TConfig extends BaseCmsConfig>(\n  content: IBaseModel<TConfig>,\n): content is IPage<TConfig> {\n  return content.type === 'Page';\n}\n","import type { BaseCmsConfig, BaseModelLinkOmissions, IBaseModel, PageContent } from './common';\n\nexport interface ITag<TConfig extends BaseCmsConfig> extends IBaseModel<TConfig> {\n  type: 'Tag';\n  tagType?: string | null;\n  contents?: ReadonlyArray<PageContent<TConfig>>;\n}\n\nexport type TagLink<TConfig extends BaseCmsConfig> = Omit<\n  ITag<TConfig>,\n  BaseModelLinkOmissions | 'contents'\n>;\n\nexport function isTag<TConfig extends BaseCmsConfig>(\n  content: IBaseModel<TConfig>,\n): content is ITag<TConfig> {\n  return content.type === 'Tag';\n}\n\nexport interface ITags<TConfig extends BaseCmsConfig> extends IBaseModel<TConfig> {\n  type: 'Tags';\n}\n\nexport function isTags<TConfig extends BaseCmsConfig>(\n  content: IBaseModel<TConfig>,\n): content is ITags<TConfig> {\n  return content.type === 'Tags';\n}\n","import type { VideoTypeData } from '@extractus/oembed-extractor';\n\nexport type Vertical = 'Top' | 'Middle' | 'Bottom';\nexport type Horizontal = 'Left' | 'Middle' | 'Right';\n\ninterface IInternalBreakpoint {\n  maxWidth: number;\n  proportion: number;\n  pixels: number;\n  size: string;\n}\ntype IBreakpoint = Pick<IInternalBreakpoint, 'maxWidth'> &\n  Partial<Omit<IInternalBreakpoint, 'maxWidth'>>;\nexport interface IVisualSizes {\n  defaultSize?: string;\n  defaultPixels?: number;\n  breakpoints?: IBreakpoint[];\n}\n\nfunction fillInBreakpoints(breakpoints?: IBreakpoint[]): IInternalBreakpoint[] | undefined {\n  return breakpoints?.map(({ maxWidth, proportion, pixels, size }) => {\n    if (proportion) {\n      return {\n        maxWidth,\n        proportion,\n        pixels: Math.round(maxWidth * proportion),\n        size: `${Math.round(100 * proportion)}vw`,\n      };\n    }\n    if (pixels) {\n      const proportion = Math.round(maxWidth / pixels);\n      return {\n        maxWidth,\n        proportion,\n        pixels,\n        size: size ?? `${Math.round(100 * proportion)}vw`,\n      };\n    }\n\n    return { maxWidth, proportion: 1, pixels: maxWidth, size: size ?? `100vw` };\n  });\n}\nexport function processSizes({ defaultSize, defaultPixels, breakpoints }: IVisualSizes) {\n  return {\n    defaultSize,\n    defaultPixels,\n    breakpoints: fillInBreakpoints(breakpoints),\n  };\n}\n\nexport interface IVisualCommon {\n  type: string;\n  id: string;\n  name: string;\n  description?: string | null;\n  nameAsCaption?: boolean | null;\n  dontCrop?: boolean | null;\n  horizontalCropPosition?: Horizontal | null;\n  verticalCropPosition?: Vertical | null;\n  horizontalPosition?: Horizontal | null;\n  widthPercent?: number | null;\n}\n\nexport interface IOptimisedSvg {\n  data: string;\n  width: number;\n  height: number;\n}\n\ninterface IImageCommon extends IVisualCommon {\n  mimeType: string;\n}\nexport interface IPicture extends IImageCommon {\n  type: 'Picture';\n  src: string;\n  width: number;\n  height: number;\n  size: number;\n}\n\nexport interface ISvgImage extends IImageCommon {\n  type: 'Svg image';\n  size: number;\n  svgSrc: string;\n  width: number;\n  height: number;\n}\n\nexport interface ISvgData extends IImageCommon {\n  type: 'Svg data';\n  data: string;\n  width: number;\n  height: number;\n}\n\nexport type IImage = IPicture | ISvgImage | ISvgData;\n\nexport function isPicture(obj: IVisualCommon | undefined | null): obj is IPicture {\n  return obj?.type === 'Picture';\n}\n\nexport function isSvgImage(obj: IVisualCommon | undefined | null): obj is ISvgImage {\n  return obj?.type === 'Svg image';\n}\n\nexport function isSvgData(obj: IVisualCommon | undefined | null): obj is ISvgData {\n  return obj?.type === 'Svg data';\n}\n\nexport function isImage(obj: IVisualCommon | undefined | null): obj is IImage {\n  return isPicture(obj) || isSvgImage(obj) || isSvgData(obj);\n}\n\nexport interface IVideoDetails {\n  id: string;\n  videoUrl: string;\n  mimeType: string;\n  fileName: string;\n  size: number;\n}\n\nexport interface IVideoCommon extends IVisualCommon {\n  poster?: string;\n  loop?: boolean | null;\n  autoPlay?: boolean | null;\n  width?: number;\n  height?: number;\n  hideControls?: boolean | null;\n}\n\nexport interface ILocalVideo extends IVideoCommon {\n  type: 'Local video';\n  preview: IVideoDetails;\n}\n\nexport interface IFullVideo extends IVideoCommon {\n  type: 'Full video';\n  preview?: IVideoDetails;\n  full: IVideoDetails;\n}\n\nexport interface IExternalVideo extends IVideoCommon {\n  type: 'External video';\n  preview?: IVideoDetails;\n  external: string;\n  embed?: VideoTypeData;\n}\n\nexport type IVideo = ILocalVideo | IFullVideo | IExternalVideo;\n\nexport function isLocalVideo(obj: IVisualCommon | undefined | null): obj is ILocalVideo {\n  return obj?.type === 'Local video';\n}\n\nexport function isFullVideo(obj: IVisualCommon | undefined | null): obj is IFullVideo {\n  return obj?.type === 'Full video';\n}\n\nexport function isExternalVideo(obj: IVisualCommon | undefined | null): obj is IExternalVideo {\n  return obj?.type === 'External video';\n}\n\nexport function isVideo(obj: IVisualCommon | undefined | null): obj is IVideo {\n  return isLocalVideo(obj) || isFullVideo(obj) || isExternalVideo(obj);\n}\n\nexport interface IAnimation extends IVisualCommon {\n  type: 'Animation';\n  optimised?: IOptimisedSvg;\n  animationSrc: string;\n  loop?: boolean | null;\n  loopDelay?: number | null;\n  autoPlay?: boolean | null;\n}\n\nexport function isAnimation(obj: IVisualCommon | undefined | null) {\n  return obj?.type === 'Animation';\n}\n\nexport interface IVisual {\n  type: 'Visual';\n  id: string;\n  image?: IImage;\n  video?: IVideo;\n  animation?: IAnimation;\n}\n\nexport function isVisualVideo(visual: IVisual | undefined | null) {\n  return visual?.video !== undefined;\n}\nexport function isVisualImage(visual: IVisual | undefined | null) {\n  return visual?.image !== undefined;\n}\nexport function isVisualAnimation(visual: IVisual | undefined | null) {\n  return visual?.animation !== undefined;\n}\n\nexport interface IResponsiveVisual {\n  visual: IVisual;\n  hideVisual?: boolean;\n  mobileVisual?: IVisual;\n  hideMobileVisual?: boolean;\n  visualCustomSize?: number | null;\n}\n"]}
+{"version":3,"sources":["../src/types/article.ts","../src/types/common.ts","../src/types/page.ts","../src/types/tag.ts","../src/types/visual.ts"],"names":["proportion"],"mappings":";AAkBO,SAAS,UAAU,OAAA,EAA8C;AACtE,EAAA,OAAO,QAAQ,IAAA,KAAS,SAAA;AAC1B;AAaO,SAAS,cAAc,OAAA,EAAkD;AAC9E,EAAA,OAAO,QAAQ,IAAA,KAAS,cAAA;AAC1B;;;AC6IO,SAAS,YAAY,GAAA,EAAqC;AAC/D,EAAA,IAAI,OAAO,GAAA,KAAQ,QAAA,IAAY,GAAA,KAAQ,IAAA,EAAM;AAC3C,IAAA,OAAO,KAAA;AAAA,EACT;AACA,EAAA,IAAK,GAAA,CAAuB,SAAS,WAAA,EAAa;AAChD,IAAA,OAAO,KAAA;AAAA,EACT;AACA,EAAA,OAAO,IAAA;AACT;AAkBO,SAAS,aAAa,GAAA,EAAsC;AACjE,EAAA,IAAI,OAAO,GAAA,KAAQ,QAAA,IAAY,GAAA,KAAQ,IAAA,EAAM;AAC3C,IAAA,OAAO,KAAA;AAAA,EACT;AACA,EAAA,IAAK,GAAA,CAAwB,SAAS,YAAA,EAAc;AAClD,IAAA,OAAO,KAAA;AAAA,EACT;AACA,EAAA,OAAO,IAAA;AACT;;;ACtMO,SAAS,OAAO,OAAA,EAA2C;AAChE,EAAA,OAAO,QAAQ,IAAA,KAAS,MAAA;AAC1B;;;ACJO,SAAS,MAAM,OAAA,EAA0C;AAC9D,EAAA,OAAO,QAAQ,IAAA,KAAS,KAAA;AAC1B;AAMO,SAAS,OAAO,OAAA,EAA2C;AAChE,EAAA,OAAO,QAAQ,IAAA,KAAS,MAAA;AAC1B;;;ACDA,SAAS,kBAAkB,WAAA,EAAgE;AACzF,EAAA,OAAO,WAAA,EAAa,IAAI,CAAC,EAAE,UAAU,UAAA,EAAY,MAAA,EAAQ,MAAK,KAAM;AAClE,IAAA,IAAI,UAAA,EAAY;AACd,MAAA,OAAO;AAAA,QACL,QAAA;AAAA,QACA,UAAA;AAAA,QACA,MAAA,EAAQ,IAAA,CAAK,KAAA,CAAM,QAAA,GAAW,UAAU,CAAA;AAAA,QACxC,MAAM,CAAA,EAAG,IAAA,CAAK,KAAA,CAAM,GAAA,GAAM,UAAU,CAAC,CAAA,EAAA;AAAA,OACvC;AAAA,IACF;AACA,IAAA,IAAI,MAAA,EAAQ;AACV,MAAA,MAAMA,WAAAA,GAAa,IAAA,CAAK,KAAA,CAAM,QAAA,GAAW,MAAM,CAAA;AAC/C,MAAA,OAAO;AAAA,QACL,QAAA;AAAA,QACA,UAAA,EAAAA,WAAAA;AAAA,QACA,MAAA;AAAA,QACA,MAAM,IAAA,IAAQ,CAAA,EAAG,KAAK,KAAA,CAAM,GAAA,GAAMA,WAAU,CAAC,CAAA,EAAA;AAAA,OAC/C;AAAA,IACF;AAEA,IAAA,OAAO,EAAE,UAAU,UAAA,EAAY,CAAA,EAAG,QAAQ,QAAA,EAAU,IAAA,EAAM,QAAQ,CAAA,KAAA,CAAA,EAAQ;AAAA,EAC5E,CAAC,CAAA;AACH;AACO,SAAS,YAAA,CAAa,EAAE,WAAA,EAAa,aAAA,EAAe,aAAY,EAAiB;AACtF,EAAA,OAAO;AAAA,IACL,WAAA;AAAA,IACA,aAAA;AAAA,IACA,WAAA,EAAa,kBAAkB,WAAW;AAAA,GAC5C;AACF;AAiDO,SAAS,UAAU,GAAA,EAAwD;AAChF,EAAA,OAAO,KAAK,IAAA,KAAS,SAAA;AACvB;AAEO,SAAS,WAAW,GAAA,EAAyD;AAClF,EAAA,OAAO,KAAK,IAAA,KAAS,WAAA;AACvB;AAEO,SAAS,UAAU,GAAA,EAAwD;AAChF,EAAA,OAAO,KAAK,IAAA,KAAS,UAAA;AACvB;AAEO,SAAS,QAAQ,GAAA,EAAsD;AAC5E,EAAA,OAAO,UAAU,GAAG,CAAA,IAAK,WAAW,GAAG,CAAA,IAAK,UAAU,GAAG,CAAA;AAC3D;AAyCO,SAAS,aAAa,GAAA,EAA2D;AACtF,EAAA,OAAO,KAAK,IAAA,KAAS,aAAA;AACvB;AAEO,SAAS,YAAY,GAAA,EAA0D;AACpF,EAAA,OAAO,KAAK,IAAA,KAAS,YAAA;AACvB;AAEO,SAAS,gBAAgB,GAAA,EAA8D;AAC5F,EAAA,OAAO,KAAK,IAAA,KAAS,gBAAA;AACvB;AAEO,SAAS,QAAQ,GAAA,EAAsD;AAC5E,EAAA,OAAO,aAAa,GAAG,CAAA,IAAK,YAAY,GAAG,CAAA,IAAK,gBAAgB,GAAG,CAAA;AACrE;AAWO,SAAS,YAAY,GAAA,EAAuC;AACjE,EAAA,OAAO,KAAK,IAAA,KAAS,WAAA;AACvB;AAUO,SAAS,cAAc,MAAA,EAAoC;AAChE,EAAA,OAAO,QAAQ,KAAA,KAAU,MAAA;AAC3B;AACO,SAAS,cAAc,MAAA,EAAoC;AAChE,EAAA,OAAO,QAAQ,KAAA,KAAU,MAAA;AAC3B;AACO,SAAS,kBAAkB,MAAA,EAAoC;AACpE,EAAA,OAAO,QAAQ,SAAA,KAAc,MAAA;AAC/B","file":"index.js","sourcesContent":["import type { BaseModelLinkOmissions, IBaseModel, IInternalLink, ITyped } from './common';\nimport type { TagLink } from './tag';\n\nexport interface IBaseArticle extends IBaseModel {\n  type: 'Article';\n  articleType?: IInternalLink;\n  structuredData?: ReadonlyArray<unknown>;\n  contents?: ReadonlyArray<ITyped>; // PageContent - will be narrowed at project level\n  tags?: ReadonlyArray<IInternalLink>;\n}\n\nexport type ArticleLink = Omit<\n  IBaseArticle,\n  BaseModelLinkOmissions | 'structuredData' | 'contents' | 'tags'\n> & {\n  tags?: ReadonlyArray<TagLink>;\n};\n\nexport function isArticle(content: IBaseModel): content is IBaseArticle {\n  return content.type === 'Article';\n}\n\nexport interface IBaseArticleType extends IBaseModel {\n  type: 'Article type';\n  indexPageContent?: ReadonlyArray<ITyped>; // PageContent - will be narrowed at project level\n  searchPageContent?: ReadonlyArray<ITyped>; // PageContent - will be narrowed at project level\n}\n\nexport type ArticleTypeLink = Omit<\n  IBaseArticleType,\n  BaseModelLinkOmissions | 'indexPageContent' | 'searchPageContent'\n>;\n\nexport function isArticleType(content: IBaseModel): content is IBaseArticleType {\n  return content.type === 'Article type';\n}\n","import type { IResponsiveVisual, IVisual } from './visual';\n\n/**\n * Utility type to make all nested properties of a type optional\n */\nexport type DeepPartial<T> = {\n  [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];\n};\n\n/**\n * Utility type to make TypeScript's complex types more readable in IDE tooltips\n */\nexport type Prettify<T> = {\n  [K in keyof T]: T[K];\n} & {};\n\nexport type BaseContentType =\n  | 'Component'\n  | 'Collection'\n  | 'Internal link'\n  | 'Visual'\n  | 'External component';\n\nexport interface ITyped {\n  type: string;\n  id: string;\n}\n\nexport interface IPageContext {\n  articleLink?: ITyped; // ArticleLink - will be narrowed at project level\n  articleTypeLink?: ITyped; // ArticleTypeLink - will be narrowed at project level\n  personLink?: ITyped; // PersonLink - will be narrowed at project level\n  pageLink?: ITyped; // PageLink - will be narrowed at project level\n  tagLink?: ITyped; // TagLink - will be narrowed at project level\n}\n\nexport interface IContentContext {\n  analyticsContext?: IAnalyticsContext;\n  pageContext: IPageContext;\n  current: ITyped; // PageContent - will be narrowed at project level\n  previousContent?: ITyped; // PageContent - will be narrowed at project level\n  nextContent?: ITyped; // PageContent - will be narrowed at project level\n}\n\nexport interface IAnalyticsContext {\n  slug: string;\n  title?: string;\n  type?: string;\n}\n\nexport interface IRichTextOptions {\n  cmsLabel?: string | null;\n  analytics?: IAnalyticsContext;\n  embedded?: boolean;\n  parentId: string;\n  parentIndex: number;\n}\n\nexport interface ILinkProps {\n  parentId?: string;\n  parentFieldId?: string;\n  id: string;\n  useName?: boolean | null;\n  name: string;\n  text?: string | null;\n  icon?: IVisual;\n  visual?: IVisual;\n  href?: string | null;\n  click?: () => void;\n  type: 'Blank link' | 'External link' | 'Internal link' | 'Download link';\n  backgroundColour?: string | null;\n  textColour?: string | null;\n  variant?: string;\n  size?: string;\n}\n\nexport interface IBlankLink extends ILinkProps {\n  type: 'Blank link';\n}\n\nexport interface IExternalLink extends ILinkProps {\n  type: 'External link';\n}\n\nexport interface IInternalLink extends ILinkProps {\n  type: 'Internal link';\n  slug: string;\n  indexed?: boolean | null;\n  hidden?: boolean | null;\n  tags?: ReadonlyArray<IInternalLink>;\n}\n\nexport interface IDownloadLink extends ILinkProps {\n  type: 'Download link';\n}\n\nexport function isBlankLink(link: ILinkProps): link is IBlankLink {\n  return link.type === 'Blank link';\n}\n\nexport function isExternalLink(link: ILinkProps): link is IExternalLink {\n  return link.type === 'External link';\n}\n\nexport function isInternalLink(link: ILinkProps): link is IInternalLink {\n  return link.type === 'Internal link';\n}\n\nexport function isDownloadLink(link: ILinkProps): link is IDownloadLink {\n  return link.type === 'Download link';\n}\n\nexport interface INavigation {\n  id: string;\n  name: string;\n  entries: ReadonlyArray<INavigationItem>;\n  textColour?: string;\n  backgroundColour?: string;\n}\n\nexport interface INavigationItem {\n  id: string;\n  link?: ILinkProps;\n  entries?: ReadonlyArray<INavigationItem>;\n}\n\nexport interface IBaseModel {\n  type: string;\n  id: string;\n  slug: string;\n  title: string;\n  description: string;\n  featuredImage?: IVisual;\n  link?: string;\n  indexed?: boolean | null;\n  hidden?: boolean | null;\n  lastUpdated?: string | Date;\n  textColour?: string;\n  backgroundColour?: string;\n  menu?: INavigation;\n  footer?: INavigation;\n}\nexport type BaseModelLinkOmissions = 'menu' | 'footer';\n\nexport interface IBaseContent {\n  type: string;\n  index: number;\n  isFirst: boolean;\n  isLast: boolean;\n  indexOfType: number;\n  id: string;\n  name: string;\n  anchor?: string | null;\n  cmsLabel: string | null; // Original CMS label for tracking purposes\n  backgroundColour?: string;\n  textColour?: string;\n  hexColor?: string | null;\n  backgroundVisual?: IResponsiveVisual;\n  backgroundOverlayOpacity?: number | null;\n  visual?: IResponsiveVisual;\n  parentId?: string;\n  parentFieldId?: string;\n}\n\nexport interface IBaseComponent extends IBaseContent {\n  type: 'Component';\n  componentType: string;\n  preHeading?: string | null;\n  heading?: string | null;\n  postHeading?: string | null;\n  body?: unknown;\n  icon?: IVisual;\n  links?: ReadonlyArray<ILinkProps>;\n  additionalCopy?: unknown;\n}\n\nexport function isComponent(obj: unknown): obj is IBaseComponent {\n  if (typeof obj !== 'object' || obj === null) {\n    return false;\n  }\n  if ((obj as IBaseComponent).type !== 'Component') {\n    return false;\n  }\n  return true;\n}\n\nexport type CollectionContent = IBaseComponent | IBaseCollection;\n\nexport interface IBaseCollection extends IBaseContent {\n  type: 'Collection';\n  collectionType: string;\n  anchor?: string | null;\n  preHeading?: string | null;\n  heading?: string | null;\n  postHeading?: string | null;\n  body?: unknown;\n  icon?: IVisual;\n  links?: ReadonlyArray<ILinkProps>;\n  additionalCopy?: unknown;\n  contents?: ReadonlyArray<CollectionContent>;\n}\n\nexport function isCollection(obj: unknown): obj is IBaseCollection {\n  if (typeof obj !== 'object' || obj === null) {\n    return false;\n  }\n  if ((obj as IBaseCollection).type !== 'Collection') {\n    return false;\n  }\n  return true;\n}\n\nexport interface IBaseExternalComponent extends IBaseContent {\n  type: 'External component';\n  externalType: string;\n  data: unknown | null;\n}\n\nexport function isExternalComponent(obj: unknown): obj is IBaseExternalComponent {\n  if (typeof obj !== 'object' || obj === null) {\n    return false;\n  }\n  if ((obj as IBaseExternalComponent).type !== 'External component') {\n    return false;\n  }\n  return true;\n}\n\nexport interface IPerson extends IBaseModel {\n  type: 'Person';\n  jobTitle?: string | null;\n  phoneNumber: string | null;\n  emailAddress: string | null;\n  location: string | null;\n  linkedIn: string | null;\n  bio: unknown;\n  href: string | undefined;\n  structuredData?: ReadonlyArray<unknown>;\n  contents?: ReadonlyArray<unknown>; // PageContent - will be narrowed at project level\n}\n\nexport type PersonLink = Omit<IPerson, BaseModelLinkOmissions | 'structuredData' | 'contents'>;\n\nexport function isPerson(content: IBaseModel): content is IPerson {\n  return content.type === 'Person';\n}\n","import type { BaseModelLinkOmissions, IBaseModel, IInternalLink, ITyped } from './common';\n\nexport interface IBasePage extends IBaseModel {\n  type: 'Page';\n  isHomePage: boolean;\n  structuredData?: ReadonlyArray<unknown>;\n  contents?: ReadonlyArray<ITyped>; // PageContent - will be narrowed at project level\n  tags?: ReadonlyArray<IInternalLink>;\n}\n\nexport type PageLink = Omit<IBasePage, BaseModelLinkOmissions | 'structuredData' | 'contents'>;\n\nexport function isPage(content: IBaseModel): content is IBasePage {\n  return content.type === 'Page';\n}\n","import type { BaseModelLinkOmissions, IBaseModel, ITyped } from './common';\n\nexport interface IBaseTag extends IBaseModel {\n  type: 'Tag';\n  tagType?: string | null;\n  contents?: ReadonlyArray<ITyped>; // PageContent - will be narrowed at project level\n}\n\nexport type TagLink = Omit<IBaseTag, BaseModelLinkOmissions | 'contents'>;\n\nexport function isTag(content: IBaseModel): content is IBaseTag {\n  return content.type === 'Tag';\n}\n\nexport interface IBaseTags extends IBaseModel {\n  type: 'Tags';\n}\n\nexport function isTags(content: IBaseModel): content is IBaseTags {\n  return content.type === 'Tags';\n}\n","import type { VideoTypeData } from '@extractus/oembed-extractor';\n\nexport type Vertical = 'Top' | 'Middle' | 'Bottom';\nexport type Horizontal = 'Left' | 'Middle' | 'Right';\n\ninterface IInternalBreakpoint {\n  maxWidth: number;\n  proportion: number;\n  pixels: number;\n  size: string;\n}\ntype IBreakpoint = Pick<IInternalBreakpoint, 'maxWidth'> &\n  Partial<Omit<IInternalBreakpoint, 'maxWidth'>>;\nexport interface IVisualSizes {\n  defaultSize?: string;\n  defaultPixels?: number;\n  breakpoints?: IBreakpoint[];\n}\n\nfunction fillInBreakpoints(breakpoints?: IBreakpoint[]): IInternalBreakpoint[] | undefined {\n  return breakpoints?.map(({ maxWidth, proportion, pixels, size }) => {\n    if (proportion) {\n      return {\n        maxWidth,\n        proportion,\n        pixels: Math.round(maxWidth * proportion),\n        size: `${Math.round(100 * proportion)}vw`,\n      };\n    }\n    if (pixels) {\n      const proportion = Math.round(maxWidth / pixels);\n      return {\n        maxWidth,\n        proportion,\n        pixels,\n        size: size ?? `${Math.round(100 * proportion)}vw`,\n      };\n    }\n\n    return { maxWidth, proportion: 1, pixels: maxWidth, size: size ?? `100vw` };\n  });\n}\nexport function processSizes({ defaultSize, defaultPixels, breakpoints }: IVisualSizes) {\n  return {\n    defaultSize,\n    defaultPixels,\n    breakpoints: fillInBreakpoints(breakpoints),\n  };\n}\n\nexport interface IVisualCommon {\n  type: string;\n  id: string;\n  name: string;\n  description?: string | null;\n  nameAsCaption?: boolean | null;\n  dontCrop?: boolean | null;\n  horizontalCropPosition?: Horizontal | null;\n  verticalCropPosition?: Vertical | null;\n  horizontalPosition?: Horizontal | null;\n  widthPercent?: number | null;\n}\n\nexport interface IOptimisedSvg {\n  data: string;\n  width: number;\n  height: number;\n}\n\ninterface IImageCommon extends IVisualCommon {\n  mimeType: string;\n}\nexport interface IPicture extends IImageCommon {\n  type: 'Picture';\n  src: string;\n  width: number;\n  height: number;\n  size: number;\n}\n\nexport interface ISvgImage extends IImageCommon {\n  type: 'Svg image';\n  size: number;\n  svgSrc: string;\n  width: number;\n  height: number;\n}\n\nexport interface ISvgData extends IImageCommon {\n  type: 'Svg data';\n  data: string;\n  width: number;\n  height: number;\n}\n\nexport type IImage = IPicture | ISvgImage | ISvgData;\n\nexport function isPicture(obj: IVisualCommon | undefined | null): obj is IPicture {\n  return obj?.type === 'Picture';\n}\n\nexport function isSvgImage(obj: IVisualCommon | undefined | null): obj is ISvgImage {\n  return obj?.type === 'Svg image';\n}\n\nexport function isSvgData(obj: IVisualCommon | undefined | null): obj is ISvgData {\n  return obj?.type === 'Svg data';\n}\n\nexport function isImage(obj: IVisualCommon | undefined | null): obj is IImage {\n  return isPicture(obj) || isSvgImage(obj) || isSvgData(obj);\n}\n\nexport interface IVideoDetails {\n  id: string;\n  videoUrl: string;\n  mimeType: string;\n  fileName: string;\n  size: number;\n}\n\nexport interface IVideoCommon extends IVisualCommon {\n  poster?: string;\n  loop?: boolean | null;\n  autoPlay?: boolean | null;\n  width?: number;\n  height?: number;\n  hideControls?: boolean | null;\n}\n\nexport interface ILocalVideo extends IVideoCommon {\n  type: 'Local video';\n  preview: IVideoDetails;\n  videoPrefix: string;\n}\n\nexport interface IFullVideo extends IVideoCommon {\n  type: 'Full video';\n  preview?: IVideoDetails;\n  full: IVideoDetails;\n  videoPrefix: string;\n}\n\nexport interface IExternalVideo extends IVideoCommon {\n  type: 'External video';\n  preview?: IVideoDetails;\n  external: string;\n  embed?: VideoTypeData;\n}\n\nexport type IVideo = ILocalVideo | IFullVideo | IExternalVideo;\n\nexport function isLocalVideo(obj: IVisualCommon | undefined | null): obj is ILocalVideo {\n  return obj?.type === 'Local video';\n}\n\nexport function isFullVideo(obj: IVisualCommon | undefined | null): obj is IFullVideo {\n  return obj?.type === 'Full video';\n}\n\nexport function isExternalVideo(obj: IVisualCommon | undefined | null): obj is IExternalVideo {\n  return obj?.type === 'External video';\n}\n\nexport function isVideo(obj: IVisualCommon | undefined | null): obj is IVideo {\n  return isLocalVideo(obj) || isFullVideo(obj) || isExternalVideo(obj);\n}\n\nexport interface IAnimation extends IVisualCommon {\n  type: 'Animation';\n  optimised?: IOptimisedSvg;\n  animationSrc: string;\n  loop?: boolean | null;\n  loopDelay?: number | null;\n  autoPlay?: boolean | null;\n}\n\nexport function isAnimation(obj: IVisualCommon | undefined | null) {\n  return obj?.type === 'Animation';\n}\n\nexport interface IVisual {\n  type: 'Visual';\n  id: string;\n  image?: IImage;\n  video?: IVideo;\n  animation?: IAnimation;\n}\n\nexport function isVisualVideo(visual: IVisual | undefined | null) {\n  return visual?.video !== undefined;\n}\nexport function isVisualImage(visual: IVisual | undefined | null) {\n  return visual?.image !== undefined;\n}\nexport function isVisualAnimation(visual: IVisual | undefined | null) {\n  return visual?.animation !== undefined;\n}\n\nexport interface IResponsiveVisual {\n  visual: IVisual;\n  hideVisual?: boolean;\n  mobileVisual?: IVisual;\n  hideMobileVisual?: boolean;\n  visualCustomSize?: number | null;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@se-studio/core-data-types",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Core TypeScript type definitions for SE Studio content models",
   "repository": {
     "type": "git",
@@ -28,10 +28,10 @@
     "nextjs"
   ],
   "devDependencies": {
-    "@biomejs/biome": "^2.3.3",
+    "@biomejs/biome": "^2.3.4",
     "tsup": "^8.5.0",
     "typescript": "^5.9.3",
-    "vitest": "^4.0.6"
+    "vitest": "^4.0.8"
   },
   "dependencies": {
     "@extractus/oembed-extractor": "^4.0.9"