@se-studio/core-ui 0.0.0-next16-20260822103555

package/dist/server/route-handlers.d.ts

@@ -0,0 +1,99 @@
+/** biome-ignore-all lint/suspicious/noExplicitAny: factory uses any for app-specific model types */
+import { type ArticleTypeFetchOptions, type CmsError, type CmsResponse, type FetchOptions, type IContentfulPerson, type IFetchedTemplate, type TagFetchOptions, type TagTypeFetchOptions } from '@se-studio/contentful-rest-api';
+import type { IBanner, IBaseArticle, IBaseArticleType, IBaseCustomType, IBasePage, IBaseTag, IBaseTagType } from '@se-studio/core-data-types';
+import type { Metadata, ResolvingMetadata } from 'next';
+import type { CmsRendererConfig } from '../CmsRendererConfig';
+import type { IBuildInformation } from '../utils/buildPageMetadata';
+import type { RouteHandlersPrepareHooks } from './route-handlers-types';
+import type { BasicLayoutProps, CmsRouteConfig, TemplateHandlersConfig, TemplateLayoutShell, TemplateRouteOptions } from './route-types';
+export interface RouteHandlersConfig<TPage extends IBasePage, TArticle extends IBaseArticle, TArticleType extends IBaseArticleType, TTag extends IBaseTag, TPerson extends IContentfulPerson, TCustomType extends IBaseCustomType> extends RouteHandlersPrepareHooks<TPage, TArticle, TArticleType, TTag, TPerson, TCustomType> {
+    rendererConfig: CmsRendererConfig<any>;
+    buildOptions: (options?: Partial<FetchOptions>) => FetchOptions;
+    buildInformation: IBuildInformation;
+    getBannersWithErrors: (options?: FetchOptions) => Promise<CmsResponse<IBanner[] | null>>;
+    getPageWithErrors: (slug: string, options?: FetchOptions) => Promise<CmsResponse<TPage | null>>;
+    getArticleWithErrors: (articleTypeSlug: string, slug: string, options?: FetchOptions) => Promise<CmsResponse<TArticle | null>>;
+    getArticleTypeWithErrors: (slug: string, options?: Partial<ArticleTypeFetchOptions>) => Promise<CmsResponse<TArticleType | null>>;
+    getTagWithErrors: (slug: string, options?: Partial<TagFetchOptions>) => Promise<CmsResponse<TTag | null>>;
+    getTagTypeWithErrors?: (slug: string, options?: Partial<TagTypeFetchOptions>) => Promise<CmsResponse<IBaseTagType | null>>;
+    getPersonWithErrors: (slug: string, options?: Partial<FetchOptions> & {
+        customType?: string;
+    }) => Promise<CmsResponse<TPerson | null>>;
+    getCustomTypeWithErrors: (slug: string, options?: FetchOptions) => Promise<CmsResponse<TCustomType | null>>;
+    getTemplateWithErrors: (cmsLabel: string, options?: FetchOptions) => Promise<CmsResponse<IFetchedTemplate | null>>;
+    /** Layout component. Uses `model: any` to accommodate apps that extend IBaseModel. */
+    LayoutComponent: React.ComponentType<Omit<BasicLayoutProps, 'model'> & {
+        model: any;
+    }>;
+    /** Optional presets for template and not-found routes. */
+    templates?: TemplateHandlersConfig;
+    constants: {
+        ARTICLES_SLUG: string;
+        TAGS_SLUG: string;
+        PEOPLE_SLUG: string;
+        /** Custom type slug for articles when using custom type. Undefined when not used. */
+        articlesCustomTypeSlug: string | undefined;
+        requireCustomTypeForArticleTypes: boolean;
+        enableTag: boolean;
+        enablePerson: boolean;
+        enableTagsIndex: boolean;
+        /**
+         * When true, tag index routes require a resolved `TAGS_SLUG` custom type from
+         * `getCustomTypeWithErrors` (legacy). When false or omitted, a tag with non-empty
+         * `contents` still renders if that shell is missing or stripped (e.g. hidden in production).
+         */
+        tagIndexRequiresCustomType?: boolean;
+    };
+}
+/**
+ * Creates all generate*Page and generate*Metadata functions for CMS route handlers.
+ * This factory centralises the logic from the per-app `appShared/` directory, accepting
+ * app-specific config (layout, fetch helpers, constants) via dependency injection.
+ *
+ * @example
+ * ```typescript
+ * // src/lib/route-handlers.ts
+ * import { createRouteHandlers } from '@se-studio/core-ui/server';
+ * export const { generatePage, generatePageMetadata, ... } = createRouteHandlers({ ... });
+ * ```
+ */
+export declare function createRouteHandlers<TPage extends IBasePage = IBasePage, TArticle extends IBaseArticle = IBaseArticle, TArticleType extends IBaseArticleType = IBaseArticleType, TTag extends IBaseTag = IBaseTag, TPerson extends IContentfulPerson = IContentfulPerson, TCustomType extends IBaseCustomType = IBaseCustomType>(config: RouteHandlersConfig<TPage, TArticle, TArticleType, TTag, TPerson, TCustomType>): {
+    buildLocaleAlternates: (path: string, locale: string) => Record<string, string> | undefined;
+    generatePage: (slug: string, path: string, routeConfig: CmsRouteConfig, locale?: string) => Promise<import("react").JSX.Element | undefined>;
+    generatePageMetadata: (slug: string, path: string, routeConfig: CmsRouteConfig, parent: ResolvingMetadata, locale?: string) => Promise<Metadata | undefined>;
+    generatePageTestMetadata: (variantSlug: string, canonicalSlug: string, canonicalPath: string, routeConfig: CmsRouteConfig, parent: ResolvingMetadata, locale?: string) => Promise<Metadata | undefined>;
+    generatePageTest: (variantSlug: string, canonicalSlug: string, canonicalPath: string, routeConfig: CmsRouteConfig, locale?: string) => Promise<import("react").JSX.Element | undefined>;
+    generateArticlePage: (articleTypeSlug: string, articleSlug: string, path: string, routeConfig: CmsRouteConfig, locale?: string) => Promise<import("react").JSX.Element | undefined>;
+    generateArticleMetadata: (articleTypeSlug: string, articleSlug: string, path: string, routeConfig: CmsRouteConfig, parent: ResolvingMetadata, locale?: string) => Promise<Metadata | undefined>;
+    generateArticleTypePage: (articleTypeSlug: string, path: string, routeConfig: CmsRouteConfig, locale?: string) => Promise<import("react").JSX.Element | undefined>;
+    generateArticleTypeMetadata: (articleTypeSlug: string, path: string, routeConfig: CmsRouteConfig, parent: ResolvingMetadata, locale?: string) => Promise<Metadata | undefined>;
+    generateArticleTypeTagPage: (articleTypeSlug: string, tagSlug: string, path: string, routeConfig: CmsRouteConfig, locale?: string) => Promise<import("react").JSX.Element | undefined>;
+    generateArticleTypeTagMetadata: (articleTypeSlug: string, tagSlug: string, path: string, routeConfig: CmsRouteConfig, parent: ResolvingMetadata, locale?: string) => Promise<Metadata | undefined>;
+    generateArticleTypesIndexPage: (path: string, routeConfig: CmsRouteConfig, locale?: string) => Promise<import("react").JSX.Element | undefined>;
+    generateArticleTypesIndexMetadata: (path: string, routeConfig: CmsRouteConfig, parent: ResolvingMetadata, locale?: string) => Promise<Metadata | undefined>;
+    generateTagPage: (tagSlug: string, path: string, routeConfig: CmsRouteConfig, locale?: string) => Promise<import("react").JSX.Element | undefined>;
+    generateTagMetadata: (tagSlug: string, path: string, routeConfig: CmsRouteConfig, parent: ResolvingMetadata, locale?: string) => Promise<Metadata | undefined>;
+    generateTagsIndexPage: (path: string, routeConfig: CmsRouteConfig, locale?: string) => Promise<import("react").JSX.Element | undefined>;
+    generateTagsIndexMetadata: (path: string, routeConfig: CmsRouteConfig, parent: ResolvingMetadata, locale?: string) => Promise<Metadata | undefined>;
+    generatePersonPage: (personSlug: string, path: string, routeConfig: CmsRouteConfig, locale?: string) => Promise<import("react").JSX.Element | undefined>;
+    generatePersonMetadata: (personSlug: string, path: string, routeConfig: CmsRouteConfig, parent: ResolvingMetadata, locale?: string) => Promise<Metadata | undefined>;
+    generateTeamIndexPage: (path: string, routeConfig: CmsRouteConfig, locale?: string) => Promise<import("react").JSX.Element | undefined>;
+    generateTeamIndexMetadata: (path: string, routeConfig: CmsRouteConfig, parent: ResolvingMetadata, locale?: string) => Promise<Metadata | undefined>;
+    generateCustomTypePage: (customTypeSlug: string, path: string, routeConfig: CmsRouteConfig, locale?: string) => Promise<import("react").JSX.Element | undefined>;
+    generateCustomTypeMetadata: (customTypeSlug: string, path: string, routeConfig: CmsRouteConfig, parent: ResolvingMetadata, locale?: string) => Promise<Metadata | undefined>;
+    generateTagTypePage: (tagTypeSlug: string, path: string, routeConfig: CmsRouteConfig, locale?: string) => Promise<import("react").JSX.Element | undefined>;
+    generateTagTypeMetadata: (tagTypeSlug: string, path: string, routeConfig: CmsRouteConfig, parent: ResolvingMetadata, locale?: string) => Promise<Metadata | undefined>;
+    generateTemplatePage: (cmsLabel: string, path: string, routeConfig: CmsRouteConfig, options?: TemplateRouteOptions & {
+        locale?: string;
+    }) => Promise<import("react").JSX.Element>;
+    generateTemplateMetadata: (cmsLabel: string, path: string, routeConfig: CmsRouteConfig, parent: ResolvingMetadata, options?: TemplateRouteOptions & {
+        locale?: string;
+    }) => Promise<Metadata>;
+    generateNotFoundPage: (locale?: string) => Promise<import("react").JSX.Element>;
+    generateNotFoundMetadata: () => Metadata;
+    getTemplateLayoutShell: (cmsLabel: string, locale?: string) => Promise<{
+        data: TemplateLayoutShell | null;
+        errors: CmsError[];
+    }>;
+};
+//# sourceMappingURL=route-handlers.d.ts.map

package/dist/server/route-handlers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"route-handlers.d.ts","sourceRoot":"","sources":["../../src/server/route-handlers.tsx"],"names":[],"mappings":"AAAA,oGAAoG;AACpG,OAAO,EACL,KAAK,uBAAuB,EAC5B,KAAK,QAAQ,EAEb,KAAK,WAAW,EAChB,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,mBAAmB,EAEzB,MAAM,gCAAgC,CAAC;AACxC,OAAO,KAAK,EAEV,OAAO,EACP,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,SAAS,EACT,QAAQ,EACR,YAAY,EACb,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,MAAM,CAAC;AAExD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAE9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AASpE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,KAAK,EACV,gBAAgB,EAEhB,cAAc,EACd,sBAAsB,EACtB,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,eAAe,CAAC;AASvB,MAAM,WAAW,mBAAmB,CAClC,KAAK,SAAS,SAAS,EACvB,QAAQ,SAAS,YAAY,EAC7B,YAAY,SAAS,gBAAgB,EACrC,IAAI,SAAS,QAAQ,EACrB,OAAO,SAAS,iBAAiB,EACjC,WAAW,SAAS,eAAe,CACnC,SAAQ,yBAAyB,CAAC,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC;IAC5F,cAAc,EAAE,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACvC,YAAY,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,KAAK,YAAY,CAAC;IAChE,gBAAgB,EAAE,iBAAiB,CAAC;IAEpC,oBAAoB,EAAE,CAAC,OAAO,CAAC,EAAE,YAAY,KAAK,OAAO,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC;IACzF,iBAAiB,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,KAAK,OAAO,CAAC,WAAW,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC;IAChG,oBAAoB,EAAE,CACpB,eAAe,EAAE,MAAM,EACvB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,YAAY,KACnB,OAAO,CAAC,WAAW,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC;IAC3C,wBAAwB,EAAE,CACxB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,OAAO,CAAC,uBAAuB,CAAC,KACvC,OAAO,CAAC,WAAW,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC,CAAC;IAC/C,gBAAgB,EAAE,CAChB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,KAC/B,OAAO,CAAC,WAAW,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC;IACvC,oBAAoB,CAAC,EAAE,CACrB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,KACnC,OAAO,CAAC,WAAW,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC,CAAC;IAC/C,mBAAmB,EAAE,CACnB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,KACtD,OAAO,CAAC,WAAW,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC;IAC1C,uBAAuB,EAAE,CACvB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,YAAY,KACnB,OAAO,CAAC,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC,CAAC;IAC9C,qBAAqB,EAAE,CACrB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,YAAY,KACnB,OAAO,CAAC,WAAW,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAC,CAAC;IAEnD,sFAAsF;IACtF,eAAe,EAAE,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,gBAAgB,EAAE,OAAO,CAAC,GAAG;QAAE,KAAK,EAAE,GAAG,CAAA;KAAE,CAAC,CAAC;IAEvF,0DAA0D;IAC1D,SAAS,CAAC,EAAE,sBAAsB,CAAC;IAEnC,SAAS,EAAE;QACT,aAAa,EAAE,MAAM,CAAC;QACtB,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,EAAE,MAAM,CAAC;QACpB,qFAAqF;QACrF,sBAAsB,EAAE,MAAM,GAAG,SAAS,CAAC;QAC3C,gCAAgC,EAAE,OAAO,CAAC;QAC1C,SAAS,EAAE,OAAO,CAAC;QACnB,YAAY,EAAE,OAAO,CAAC;QACtB,eAAe,EAAE,OAAO,CAAC;QACzB;;;;WAIG;QACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;KACtC,CAAC;CACH;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,SAAS,SAAS,GAAG,SAAS,EACnC,QAAQ,SAAS,YAAY,GAAG,YAAY,EAC5C,YAAY,SAAS,gBAAgB,GAAG,gBAAgB,EACxD,IAAI,SAAS,QAAQ,GAAG,QAAQ,EAChC,OAAO,SAAS,iBAAiB,GAAG,iBAAiB,EACrD,WAAW,SAAS,eAAe,GAAG,eAAe,EACrD,MAAM,EAAE,mBAAmB,CAAC,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC;kCAmCjD,MAAM,UAAU,MAAM,KAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS;yBA0NxF,MAAM,QACN,MAAM,eACC,cAAc,WAClB,MAAM;iCAtKT,MAAM,QACN,MAAM,eACC,cAAc,UACnB,iBAAiB,WAChB,MAAM;4CAwBF,MAAM,iBACJ,MAAM,iBACN,MAAM,eACR,cAAc,UACnB,iBAAiB,WAChB,MAAM;oCA4CF,MAAM,iBACJ,MAAM,iBACN,MAAM,eACR,cAAc,WAClB,MAAM;2CAsNE,MAAM,eACV,MAAM,QACb,MAAM,eACC,cAAc,WAClB,MAAM;+CA5CE,MAAM,eACV,MAAM,QACb,MAAM,eACC,cAAc,UACnB,iBAAiB,WAChB,MAAM;+CAiOE,MAAM,QACjB,MAAM,eACC,cAAc,WAClB,MAAM;mDA7DE,MAAM,QACjB,MAAM,eACC,cAAc,UACnB,iBAAiB,WAChB,MAAM;kDAmQE,MAAM,WACd,MAAM,QACT,MAAM,eACC,cAAc,WAClB,MAAM;sDAzEE,MAAM,WACd,MAAM,QACT,MAAM,eACC,cAAc,UACnB,iBAAiB,WAChB,MAAM;0CAsMT,MAAM,eACC,cAAc,WAClB,MAAM;8CAtCT,MAAM,eACC,cAAc,UACnB,iBAAiB,WAChB,MAAM;+BA2LN,MAAM,QACT,MAAM,eACC,cAAc,WAClB,MAAM;mCAnDN,MAAM,QACT,MAAM,eACC,cAAc,UACnB,iBAAiB,WAChB,MAAM;kCA2J0B,MAAM,eAAe,cAAc,WAAW,MAAM;sCAjCvF,MAAM,eACC,cAAc,UACnB,iBAAiB,WAChB,MAAM;qCAwLH,MAAM,QACZ,MAAM,eACC,cAAc,WAClB,MAAM;yCAxDH,MAAM,QACZ,MAAM,eACC,cAAc,UACnB,iBAAiB,WAChB,MAAM;kCAoK0B,MAAM,eAAe,cAAc,WAAW,MAAM;sCAhCvF,MAAM,eACC,cAAc,UACnB,iBAAiB,WAChB,MAAM;6CA2JC,MAAM,QAChB,MAAM,eACC,cAAc,WAClB,MAAM;iDArCC,MAAM,QAChB,MAAM,eACC,cAAc,UACnB,iBAAiB,WAChB,MAAM;uCAgKF,MAAM,QACb,MAAM,eACC,cAAc,WAClB,MAAM;2CAxCF,MAAM,QACb,MAAM,eACC,cAAc,UACnB,iBAAiB,WAChB,MAAM;qCA4JL,MAAM,QACV,MAAM,eACC,cAAc,YACjB,oBAAoB,GAAG;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE;yCA7B1C,MAAM,QACV,MAAM,eACC,cAAc,UACnB,iBAAiB,YACf,oBAAoB,GAAG;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE;oCAmFT,MAAM;oCApGd,QAAQ;uCAwHjC,MAAM,WACP,MAAM,KACd,OAAO,CAAC;QAAE,IAAI,EAAE,mBAAmB,GAAG,IAAI,CAAC;QAAC,MAAM,EAAE,QAAQ,EAAE,CAAA;KAAE,CAAC;EAmDrE"}