@carlonicora/nextjs-jsonapi 5.3.0 → 5.4.0

package/dist/BlogPostInterface-BB_4wcDR.d.mts

@@ -0,0 +1,124 @@
+import { A as ApiDataInterface } from './ApiDataInterface-BcZeXy5X.mjs';
+import { U as UserInterface } from './user.interface-CIWGlbqM.mjs';
+
+declare const BLOG_LIST_LAYOUTS: readonly ["featured", "column", "rail"];
+type BlogListLayout = (typeof BLOG_LIST_LAYOUTS)[number];
+declare const BLOG_POST_STATUSES: readonly ["draft", "published", "unpublished"];
+type BlogPostStatus = (typeof BLOG_POST_STATUSES)[number];
+declare const BLOG_TRANSLATION_SOURCES: readonly ["original", "ai", "manual"];
+type BlogTranslationSource = (typeof BLOG_TRANSLATION_SOURCES)[number];
+type BlogAiStatus = "pending" | "in_progress" | "completed" | "failed";
+declare const BLOG_SETTINGS_ID = "5f3c2a9e-8d41-4b7a-9c2e-1a6b0d4e7f13";
+declare const BLOG_MODULE_ID = "c1d0e6a2-4b8f-4f3e-9a7d-2e5b8c6f1a90";
+/**
+ * Storage root for blog images (covers, category images, images pasted into a
+ * post body). Blog content belongs to the platform, not to a company, and the
+ * administrators who write it may belong to no company, so the keys are
+ * `blog/<folder>/<id>/<file>` instead of `companies/<companyId>/...`. An app's
+ * S3 key access policy must allow Administrators on this root.
+ */
+declare const BLOG_UPLOAD_ROOT = "blog";
+declare const BLOG_POST_UPLOAD_PREFIX = "blog/blog-posts";
+declare const BLOG_CATEGORY_UPLOAD_PREFIX = "blog/blog-categories";
+/** Path prefix of the token-free public blog endpoints (`public/blog-posts`, ...). */
+declare const BLOG_PUBLIC_PREFIX = "public";
+/** Action segments under a blog resource (`blog-posts/:id/publish`, ...). */
+declare const BLOG_ACTION: {
+    readonly publish: "publish";
+    readonly unpublish: "unpublish";
+    readonly retranslate: "retranslate";
+    readonly related: "related";
+};
+
+type BlogCategoryTranslationInput = {
+    id: string;
+    name?: string;
+    slug?: string;
+    description?: string;
+};
+interface BlogCategoryTranslationInterface extends ApiDataInterface {
+    get language(): string;
+    get isOriginal(): boolean;
+    get source(): BlogTranslationSource;
+    get aiStatus(): BlogAiStatus;
+    get name(): string;
+    get slug(): string;
+    get description(): string | undefined;
+    get translatedAt(): Date | undefined;
+    get category(): BlogCategoryInterface | undefined;
+}
+
+type BlogCategoryInput = {
+    id: string;
+    originalLanguage?: string;
+    name?: string;
+    slug?: string;
+    description?: string;
+    image?: string;
+};
+interface BlogCategoryInterface extends ApiDataInterface {
+    get originalLanguage(): string;
+    get image(): string | undefined;
+    get translations(): BlogCategoryTranslationInterface[];
+    get original(): BlogCategoryTranslationInterface | undefined;
+    get language(): string | undefined;
+    get name(): string | undefined;
+    get slug(): string | undefined;
+    get description(): string | undefined;
+}
+
+type BlogPostTranslationInput = {
+    id: string;
+    title?: string;
+    slug?: string;
+    summary?: string;
+    body?: any;
+    coverImageAlt?: string;
+};
+interface BlogPostTranslationInterface extends ApiDataInterface {
+    get language(): string;
+    get isOriginal(): boolean;
+    get source(): BlogTranslationSource;
+    get aiStatus(): BlogAiStatus;
+    get title(): string;
+    get slug(): string;
+    get summary(): string | undefined;
+    get body(): any;
+    get coverImageAlt(): string | undefined;
+    get readingMinutes(): number;
+    get translatedAt(): Date | undefined;
+    get post(): BlogPostInterface | undefined;
+}
+
+type BlogPostInput = {
+    id: string;
+    originalLanguage?: string;
+    title?: string;
+    slug?: string;
+    summary?: string;
+    body?: any;
+    coverImage?: string;
+    coverImageAlt?: string;
+    categoryIds?: string[];
+};
+interface BlogPostInterface extends ApiDataInterface {
+    get status(): BlogPostStatus;
+    get originalLanguage(): string;
+    get coverImage(): string | undefined;
+    get publishedAt(): Date | undefined;
+    get author(): UserInterface | undefined;
+    get categories(): BlogCategoryInterface[];
+    get translations(): BlogPostTranslationInterface[];
+    get original(): BlogPostTranslationInterface | undefined;
+    get language(): string | undefined;
+    get title(): string | undefined;
+    get slug(): string | undefined;
+    get summary(): string | undefined;
+    get body(): any;
+    get coverImageAlt(): string | undefined;
+    get readingMinutes(): number | undefined;
+    get authorName(): string | undefined;
+    get categoryIds(): string[];
+}
+
+export { type BlogListLayout as B, type BlogCategoryInterface as a, type BlogPostInterface as b, BLOG_LIST_LAYOUTS as c, type BlogPostInput as d, type BlogPostTranslationInput as e, type BlogPostTranslationInterface as f, type BlogCategoryInput as g, type BlogCategoryTranslationInput as h, type BlogCategoryTranslationInterface as i, type BlogAiStatus as j, BLOG_POST_STATUSES as k, type BlogPostStatus as l, BLOG_TRANSLATION_SOURCES as m, type BlogTranslationSource as n, BLOG_SETTINGS_ID as o, BLOG_MODULE_ID as p, BLOG_UPLOAD_ROOT as q, BLOG_POST_UPLOAD_PREFIX as r, BLOG_CATEGORY_UPLOAD_PREFIX as s, BLOG_PUBLIC_PREFIX as t, BLOG_ACTION as u };

package/dist/BlogPostInterface-bWAT1rfR.d.ts

@@ -0,0 +1,124 @@
+import { A as ApiDataInterface } from './ApiDataInterface-BcZeXy5X.js';
+import { U as UserInterface } from './user.interface-C0ZdsBZj.js';
+
+declare const BLOG_LIST_LAYOUTS: readonly ["featured", "column", "rail"];
+type BlogListLayout = (typeof BLOG_LIST_LAYOUTS)[number];
+declare const BLOG_POST_STATUSES: readonly ["draft", "published", "unpublished"];
+type BlogPostStatus = (typeof BLOG_POST_STATUSES)[number];
+declare const BLOG_TRANSLATION_SOURCES: readonly ["original", "ai", "manual"];
+type BlogTranslationSource = (typeof BLOG_TRANSLATION_SOURCES)[number];
+type BlogAiStatus = "pending" | "in_progress" | "completed" | "failed";
+declare const BLOG_SETTINGS_ID = "5f3c2a9e-8d41-4b7a-9c2e-1a6b0d4e7f13";
+declare const BLOG_MODULE_ID = "c1d0e6a2-4b8f-4f3e-9a7d-2e5b8c6f1a90";
+/**
+ * Storage root for blog images (covers, category images, images pasted into a
+ * post body). Blog content belongs to the platform, not to a company, and the
+ * administrators who write it may belong to no company, so the keys are
+ * `blog/<folder>/<id>/<file>` instead of `companies/<companyId>/...`. An app's
+ * S3 key access policy must allow Administrators on this root.
+ */
+declare const BLOG_UPLOAD_ROOT = "blog";
+declare const BLOG_POST_UPLOAD_PREFIX = "blog/blog-posts";
+declare const BLOG_CATEGORY_UPLOAD_PREFIX = "blog/blog-categories";
+/** Path prefix of the token-free public blog endpoints (`public/blog-posts`, ...). */
+declare const BLOG_PUBLIC_PREFIX = "public";
+/** Action segments under a blog resource (`blog-posts/:id/publish`, ...). */
+declare const BLOG_ACTION: {
+    readonly publish: "publish";
+    readonly unpublish: "unpublish";
+    readonly retranslate: "retranslate";
+    readonly related: "related";
+};
+
+type BlogCategoryTranslationInput = {
+    id: string;
+    name?: string;
+    slug?: string;
+    description?: string;
+};
+interface BlogCategoryTranslationInterface extends ApiDataInterface {
+    get language(): string;
+    get isOriginal(): boolean;
+    get source(): BlogTranslationSource;
+    get aiStatus(): BlogAiStatus;
+    get name(): string;
+    get slug(): string;
+    get description(): string | undefined;
+    get translatedAt(): Date | undefined;
+    get category(): BlogCategoryInterface | undefined;
+}
+
+type BlogCategoryInput = {
+    id: string;
+    originalLanguage?: string;
+    name?: string;
+    slug?: string;
+    description?: string;
+    image?: string;
+};
+interface BlogCategoryInterface extends ApiDataInterface {
+    get originalLanguage(): string;
+    get image(): string | undefined;
+    get translations(): BlogCategoryTranslationInterface[];
+    get original(): BlogCategoryTranslationInterface | undefined;
+    get language(): string | undefined;
+    get name(): string | undefined;
+    get slug(): string | undefined;
+    get description(): string | undefined;
+}
+
+type BlogPostTranslationInput = {
+    id: string;
+    title?: string;
+    slug?: string;
+    summary?: string;
+    body?: any;
+    coverImageAlt?: string;
+};
+interface BlogPostTranslationInterface extends ApiDataInterface {
+    get language(): string;
+    get isOriginal(): boolean;
+    get source(): BlogTranslationSource;
+    get aiStatus(): BlogAiStatus;
+    get title(): string;
+    get slug(): string;
+    get summary(): string | undefined;
+    get body(): any;
+    get coverImageAlt(): string | undefined;
+    get readingMinutes(): number;
+    get translatedAt(): Date | undefined;
+    get post(): BlogPostInterface | undefined;
+}
+
+type BlogPostInput = {
+    id: string;
+    originalLanguage?: string;
+    title?: string;
+    slug?: string;
+    summary?: string;
+    body?: any;
+    coverImage?: string;
+    coverImageAlt?: string;
+    categoryIds?: string[];
+};
+interface BlogPostInterface extends ApiDataInterface {
+    get status(): BlogPostStatus;
+    get originalLanguage(): string;
+    get coverImage(): string | undefined;
+    get publishedAt(): Date | undefined;
+    get author(): UserInterface | undefined;
+    get categories(): BlogCategoryInterface[];
+    get translations(): BlogPostTranslationInterface[];
+    get original(): BlogPostTranslationInterface | undefined;
+    get language(): string | undefined;
+    get title(): string | undefined;
+    get slug(): string | undefined;
+    get summary(): string | undefined;
+    get body(): any;
+    get coverImageAlt(): string | undefined;
+    get readingMinutes(): number | undefined;
+    get authorName(): string | undefined;
+    get categoryIds(): string[];
+}
+
+export { type BlogListLayout as B, type BlogCategoryInterface as a, type BlogPostInterface as b, BLOG_LIST_LAYOUTS as c, type BlogPostInput as d, type BlogPostTranslationInput as e, type BlogPostTranslationInterface as f, type BlogCategoryInput as g, type BlogCategoryTranslationInput as h, type BlogCategoryTranslationInterface as i, type BlogAiStatus as j, BLOG_POST_STATUSES as k, type BlogPostStatus as l, BLOG_TRANSLATION_SOURCES as m, type BlogTranslationSource as n, BLOG_SETTINGS_ID as o, BLOG_MODULE_ID as p, BLOG_UPLOAD_ROOT as q, BLOG_POST_UPLOAD_PREFIX as r, BLOG_CATEGORY_UPLOAD_PREFIX as s, BLOG_PUBLIC_PREFIX as t, BLOG_ACTION as u };