@otl-core/cms-types 1.1.0

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2025 OTL Core
+
+Licensed under the PolyForm Shield License, Version 1.0.0 (the "License");
+you may not use this file except in compliance with the License. You may
+obtain a copy of the License at
+
+    https://polyformproject.org/licenses/shield/1.0.0/
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+License for the specific language governing permissions and limitations
+under the License.

package/dist/index.cjs

@@ -0,0 +1,111 @@
+'use strict';
+
+// src/collection.types.ts
+var COLLECTION_TYPE_TEMPLATES = {
+  blog: {
+    entry_singular: "Post",
+    entry_plural: "Posts",
+    category_singular: "Category",
+    category_plural: "Categories",
+    author_singular: "Author",
+    author_plural: "Authors",
+    tag_singular: "Tag",
+    tag_plural: "Tags"
+  },
+  news: {
+    entry_singular: "Article",
+    entry_plural: "Articles",
+    category_singular: "Topic",
+    category_plural: "Topics",
+    author_singular: "Reporter",
+    author_plural: "Reporters",
+    tag_singular: "Tag",
+    tag_plural: "Tags"
+  },
+  knowledge_base: {
+    entry_singular: "Article",
+    entry_plural: "Articles",
+    category_singular: "Section",
+    category_plural: "Sections",
+    author_singular: "Contributor",
+    author_plural: "Contributors",
+    tag_singular: "Tag",
+    tag_plural: "Tags"
+  },
+  changelog: {
+    entry_singular: "Release",
+    entry_plural: "Releases",
+    category_singular: "Product",
+    category_plural: "Products",
+    author_singular: "Contributor",
+    author_plural: "Contributors",
+    tag_singular: "Tag",
+    tag_plural: "Tags"
+  },
+  case_studies: {
+    entry_singular: "Case Study",
+    entry_plural: "Case Studies",
+    category_singular: "Industry",
+    category_plural: "Industries",
+    author_singular: "Author",
+    author_plural: "Authors",
+    tag_singular: "Tag",
+    tag_plural: "Tags"
+  },
+  custom: {
+    entry_singular: "Entry",
+    entry_plural: "Entries",
+    category_singular: "Category",
+    category_plural: "Categories",
+    author_singular: "Author",
+    author_plural: "Authors",
+    tag_singular: "Tag",
+    tag_plural: "Tags"
+  }
+};
+
+// src/schema.types.ts
+var RESERVED_SECTION_TYPES = [
+  "hero-banner",
+  "content-blocks",
+  "feature-grid",
+  "testimonial-carousel",
+  "cta-banner",
+  "team-grid",
+  "faq-accordion",
+  "stats-showcase",
+  "logo-cloud"
+];
+var RESERVED_BLOCK_TYPES = [
+  "markdown",
+  "html",
+  "image",
+  "quote",
+  "gallery",
+  "embed",
+  "cta",
+  "divider",
+  "code",
+  "about-the-authors",
+  "more-from-the-authors",
+  "recommended-posts",
+  "related-posts"
+];
+function isReservedSchemaType(type) {
+  return RESERVED_SECTION_TYPES.includes(type) || RESERVED_BLOCK_TYPES.includes(type);
+}
+function isReservedSectionType(type) {
+  return RESERVED_SECTION_TYPES.includes(type);
+}
+function isReservedBlockType(type) {
+  return RESERVED_BLOCK_TYPES.includes(type);
+}
+
+exports.COLLECTION_TYPE_TEMPLATES = COLLECTION_TYPE_TEMPLATES;
+exports.RESERVED_BLOCK_TYPES = RESERVED_BLOCK_TYPES;
+exports.RESERVED_SECTION_TYPES = RESERVED_SECTION_TYPES;
+exports.isReservedBlockType = isReservedBlockType;
+exports.isReservedSchemaType = isReservedSchemaType;
+exports.isReservedSectionType = isReservedSectionType;
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/collection.types.ts","../src/schema.types.ts"],"names":[],"mappings":";;;AA4HO,IAAM,yBAAA,GAGT;AAAA,EACF,IAAA,EAAM;AAAA,IACJ,cAAA,EAAgB,MAAA;AAAA,IAChB,YAAA,EAAc,OAAA;AAAA,IACd,iBAAA,EAAmB,UAAA;AAAA,IACnB,eAAA,EAAiB,YAAA;AAAA,IACjB,eAAA,EAAiB,QAAA;AAAA,IACjB,aAAA,EAAe,SAAA;AAAA,IACf,YAAA,EAAc,KAAA;AAAA,IACd,UAAA,EAAY;AAAA,GACd;AAAA,EACA,IAAA,EAAM;AAAA,IACJ,cAAA,EAAgB,SAAA;AAAA,IAChB,YAAA,EAAc,UAAA;AAAA,IACd,iBAAA,EAAmB,OAAA;AAAA,IACnB,eAAA,EAAiB,QAAA;AAAA,IACjB,eAAA,EAAiB,UAAA;AAAA,IACjB,aAAA,EAAe,WAAA;AAAA,IACf,YAAA,EAAc,KAAA;AAAA,IACd,UAAA,EAAY;AAAA,GACd;AAAA,EACA,cAAA,EAAgB;AAAA,IACd,cAAA,EAAgB,SAAA;AAAA,IAChB,YAAA,EAAc,UAAA;AAAA,IACd,iBAAA,EAAmB,SAAA;AAAA,IACnB,eAAA,EAAiB,UAAA;AAAA,IACjB,eAAA,EAAiB,aAAA;AAAA,IACjB,aAAA,EAAe,cAAA;AAAA,IACf,YAAA,EAAc,KAAA;AAAA,IACd,UAAA,EAAY;AAAA,GACd;AAAA,EACA,SAAA,EAAW;AAAA,IACT,cAAA,EAAgB,SAAA;AAAA,IAChB,YAAA,EAAc,UAAA;AAAA,IACd,iBAAA,EAAmB,SAAA;AAAA,IACnB,eAAA,EAAiB,UAAA;AAAA,IACjB,eAAA,EAAiB,aAAA;AAAA,IACjB,aAAA,EAAe,cAAA;AAAA,IACf,YAAA,EAAc,KAAA;AAAA,IACd,UAAA,EAAY;AAAA,GACd;AAAA,EACA,YAAA,EAAc;AAAA,IACZ,cAAA,EAAgB,YAAA;AAAA,IAChB,YAAA,EAAc,cAAA;AAAA,IACd,iBAAA,EAAmB,UAAA;AAAA,IACnB,eAAA,EAAiB,YAAA;AAAA,IACjB,eAAA,EAAiB,QAAA;AAAA,IACjB,aAAA,EAAe,SAAA;AAAA,IACf,YAAA,EAAc,KAAA;AAAA,IACd,UAAA,EAAY;AAAA,GACd;AAAA,EACA,MAAA,EAAQ;AAAA,IACN,cAAA,EAAgB,OAAA;AAAA,IAChB,YAAA,EAAc,SAAA;AAAA,IACd,iBAAA,EAAmB,UAAA;AAAA,IACnB,eAAA,EAAiB,YAAA;AAAA,IACjB,eAAA,EAAiB,QAAA;AAAA,IACjB,aAAA,EAAe,SAAA;AAAA,IACf,YAAA,EAAc,KAAA;AAAA,IACd,UAAA,EAAY;AAAA;AAEhB;;;ACzJO,IAAM,sBAAA,GAAyB;AAAA,EACpC,aAAA;AAAA,EACA,gBAAA;AAAA,EACA,cAAA;AAAA,EACA,sBAAA;AAAA,EACA,YAAA;AAAA,EACA,WAAA;AAAA,EACA,eAAA;AAAA,EACA,gBAAA;AAAA,EACA;AACF;AAEO,IAAM,oBAAA,GAAuB;AAAA,EAClC,UAAA;AAAA,EACA,MAAA;AAAA,EACA,OAAA;AAAA,EACA,OAAA;AAAA,EACA,SAAA;AAAA,EACA,OAAA;AAAA,EACA,KAAA;AAAA,EACA,SAAA;AAAA,EACA,MAAA;AAAA,EACA,mBAAA;AAAA,EACA,uBAAA;AAAA,EACA,mBAAA;AAAA,EACA;AACF;AAMO,SAAS,qBAAqB,IAAA,EAA0C;AAC7E,EAAA,OACG,uBAA6C,QAAA,CAAS,IAAI,CAAA,IAC1D,oBAAA,CAA2C,SAAS,IAAI,CAAA;AAE7D;AAEO,SAAS,sBACd,IAAA,EAC6B;AAC7B,EAAA,OAAQ,sBAAA,CAA6C,SAAS,IAAI,CAAA;AACpE;AAEO,SAAS,oBAAoB,IAAA,EAAyC;AAC3E,EAAA,OAAQ,oBAAA,CAA2C,SAAS,IAAI,CAAA;AAClE","file":"index.cjs","sourcesContent":["/**\n * Collection types (public/engine-facing)\n */\n\nimport type { BlockInstance } from \"./blocks\";\nimport type { SEOConfig } from \"./pages.types\";\nimport type { SchemaInstance } from \"./schema.types\";\nimport type { SectionInstance } from \"./sections/section-config.types\";\nimport type { InputField } from \"./sections/input-fields.types\";\n\n/**\n * A vocabulary term can be a plain string or a locale-keyed map for i18n.\n */\nexport type VocabularyTerm = string | Record<string, string>;\n\n/**\n * Feature flags for a collection (which sub-entities are enabled)\n */\nexport interface CollectionFeatures {\n  authors: boolean;\n  tags: boolean;\n  categories: boolean;\n}\n\n/**\n * Social media link for a collection author\n */\nexport interface SocialLink {\n  platform: string;\n  url: string;\n}\n\n/**\n * Collection author entity\n */\nexport interface Author {\n  id: string;\n  collection_id: string;\n  name: string;\n  slug: string;\n  bio?: Record<string, string>;\n  excerpt?: Record<string, string>;\n  avatar_url?: string;\n  social_links?: SocialLink[];\n  email?: string;\n  website?: string;\n  url?: string;\n  custom_fields?: Record<string, unknown>;\n  created_at: string;\n  updated_at: string;\n}\n\n/**\n * Collection entry configuration\n */\nexport interface CollectionEntriesConfig {\n  custom_fields_schema?: InputField[];\n  allowed_block_types?: string;\n  default_entry_blocks?: BlockInstance[];\n  strict_block_structure?: boolean;\n}\n\n/**\n * Collection locale configuration\n */\nexport interface CollectionLocaleConfig {\n  locale: string;\n  title: string;\n  base_path: string;\n}\n\n/**\n * Collection layouts for different page types\n */\nexport interface CollectionLayouts {\n  entry: SectionInstance[];\n  index: SectionInstance[];\n  category: SectionInstance[];\n  category_index: SectionInstance[];\n  author: SectionInstance[];\n  tag: SectionInstance[];\n  author_index: SectionInstance[];\n  tag_index: SectionInstance[];\n}\n\n/**\n * Collection layouts per locale with inheritance support\n */\nexport interface CollectionLocaleLayouts {\n  locale: string;\n  layouts: CollectionLayouts;\n  inherits_from?: string;\n  inherited_by?: string[];\n}\n\n/**\n * Collection type determines the template used to seed vocabulary\n */\nexport type CollectionType =\n  | \"blog\"\n  | \"news\"\n  | \"knowledge_base\"\n  | \"changelog\"\n  | \"case_studies\"\n  | \"custom\";\n\n/**\n * Customizable vocabulary labels for collection UI\n */\nexport interface CollectionVocabulary {\n  entry_singular: VocabularyTerm;\n  entry_plural: VocabularyTerm;\n  category_singular: VocabularyTerm;\n  category_plural: VocabularyTerm;\n  author_singular: VocabularyTerm;\n  author_plural: VocabularyTerm;\n  tag_singular: VocabularyTerm;\n  tag_plural: VocabularyTerm;\n}\n\n/**\n * Default vocabulary templates seeded by the backend for each collection type.\n * Kept in sync with backend/cms-main/internal/models/collection.go CollectionTypeTemplates.\n */\nexport const COLLECTION_TYPE_TEMPLATES: Record<\n  CollectionType,\n  CollectionVocabulary\n> = {\n  blog: {\n    entry_singular: \"Post\",\n    entry_plural: \"Posts\",\n    category_singular: \"Category\",\n    category_plural: \"Categories\",\n    author_singular: \"Author\",\n    author_plural: \"Authors\",\n    tag_singular: \"Tag\",\n    tag_plural: \"Tags\",\n  },\n  news: {\n    entry_singular: \"Article\",\n    entry_plural: \"Articles\",\n    category_singular: \"Topic\",\n    category_plural: \"Topics\",\n    author_singular: \"Reporter\",\n    author_plural: \"Reporters\",\n    tag_singular: \"Tag\",\n    tag_plural: \"Tags\",\n  },\n  knowledge_base: {\n    entry_singular: \"Article\",\n    entry_plural: \"Articles\",\n    category_singular: \"Section\",\n    category_plural: \"Sections\",\n    author_singular: \"Contributor\",\n    author_plural: \"Contributors\",\n    tag_singular: \"Tag\",\n    tag_plural: \"Tags\",\n  },\n  changelog: {\n    entry_singular: \"Release\",\n    entry_plural: \"Releases\",\n    category_singular: \"Product\",\n    category_plural: \"Products\",\n    author_singular: \"Contributor\",\n    author_plural: \"Contributors\",\n    tag_singular: \"Tag\",\n    tag_plural: \"Tags\",\n  },\n  case_studies: {\n    entry_singular: \"Case Study\",\n    entry_plural: \"Case Studies\",\n    category_singular: \"Industry\",\n    category_plural: \"Industries\",\n    author_singular: \"Author\",\n    author_plural: \"Authors\",\n    tag_singular: \"Tag\",\n    tag_plural: \"Tags\",\n  },\n  custom: {\n    entry_singular: \"Entry\",\n    entry_plural: \"Entries\",\n    category_singular: \"Category\",\n    category_plural: \"Categories\",\n    author_singular: \"Author\",\n    author_plural: \"Authors\",\n    tag_singular: \"Tag\",\n    tag_plural: \"Tags\",\n  },\n};\n\n/**\n * Collection entity\n */\nexport interface Collection {\n  id: string;\n  site_id: string;\n  collection_type: CollectionType;\n  name: string;\n  vocabulary: CollectionVocabulary;\n  features: CollectionFeatures;\n  locales: CollectionLocaleConfig[];\n  description?: string;\n  entries_config: CollectionEntriesConfig;\n  author_custom_fields_schema?: InputField[];\n  category_custom_fields_schema?: InputField[];\n  tag_custom_fields_schema?: InputField[];\n  locale_layouts: CollectionLocaleLayouts[];\n  status: \"active\" | \"inactive\";\n  created_at: string;\n  updated_at: string;\n  deleted_at?: string;\n}\n\n/**\n * Collection category with multi-locale support\n */\nexport interface Category {\n  id: string;\n  collection_id: string;\n  parent_id?: string;\n  title: string;\n  name: Record<string, string>;\n  slug: Record<string, string>;\n  description?: Record<string, string>;\n  sort_order: number;\n  depth: number;\n  full_path: Record<string, string>;\n  seo?: Record<string, SEOConfig>;\n  custom_fields?: Record<string, unknown>;\n  is_visible: boolean;\n  children?: Category[];\n  created_at: string;\n  updated_at: string;\n  deleted_at?: string;\n}\n\n/**\n * Collection tag entity with multi-locale support\n */\nexport interface Tag {\n  id: string;\n  collection_id: string;\n  title: string;\n  name: Record<string, string>;\n  slug: Record<string, string>;\n  description?: Record<string, string>;\n  sort_order: number;\n  is_visible: boolean;\n  seo?: Record<string, SEOConfig>;\n  custom_fields?: Record<string, unknown>;\n  created_at: string;\n  updated_at: string;\n  deleted_at?: string;\n}\n\n/**\n * Collection category slug entry (normalized for path resolution)\n */\nexport interface CategorySlug {\n  id: string;\n  site_id: string;\n  collection_id: string;\n  category_id: string;\n  locale: string;\n  slug: string;\n  full_path: string;\n  created_at: string;\n  updated_at: string;\n}\n\n/**\n * Collection category tree node (for hierarchical display)\n */\nexport interface CategoryTreeNode extends Category {\n  children: CategoryTreeNode[];\n}\n\n/**\n * Collection entry variant info\n */\nexport interface EntryVariant {\n  id: string;\n  label: string;\n  draft_id?: string;\n  live_id?: string;\n}\n\n/**\n * Collection entry locale-specific content configuration\n */\nexport interface EntryLocaleContent {\n  locale: string;\n  slug: string;\n  enabled: boolean;\n  inherits_from?: string;\n  inherited_by?: string[];\n  seo?: SEOConfig;\n  variants: EntryVariant[];\n  active_version: string;\n  publish_at?: string;\n  expires_at?: string;\n  password_protection?: import(\"./pages.types\").PasswordProtection;\n  header_preset_id?: string;\n  footer_preset_id?: string;\n}\n\n/**\n * Collection entry with full content\n */\nexport interface Entry {\n  // Metadata\n  id: string;\n  collection_id: string;\n  category_id?: string;\n  tags: string[];\n  tag_ids: string[];\n  author_ids: string[];\n  is_featured: boolean;\n  featured_priority: number;\n  locale_content: EntryLocaleContent[];\n\n  // Content (for the current locale/variant/version)\n  title: string;\n  slug: string;\n  blocks?: SchemaInstance[];\n  content: string;\n  excerpt?: string;\n  featured_image?: MediaReference;\n  seo?: SEOConfig;\n  custom_fields?: Record<string, unknown>;\n  custom_field_values?: Record<string, unknown>;\n\n  // Publishing\n  status: \"draft\" | \"published\" | \"scheduled\" | \"expired\";\n  published_at?: string;\n  scheduled_at?: string;\n  expires_at?: string;\n\n  // Stats\n  reading_time_minutes: number;\n\n  // Context\n  current_locale: string;\n  current_variant: string;\n  current_version_type: \"draft\" | \"live\";\n\n  // Audit\n  created_at: string;\n  updated_at: string;\n  deleted_at?: string;\n}\n\n/**\n * Media reference for images/videos\n */\nexport interface MediaReference {\n  src: string;\n  alt: string;\n  width?: number;\n  height?: number;\n}\n\n/**\n * Media asset\n */\nexport interface Media {\n  id: string;\n  site_id: string;\n  filename: string;\n  original_name: string;\n  mime_type: string;\n  size: number;\n  url: string;\n  alt?: string;\n  dimensions?: MediaDimensions;\n  metadata?: Record<string, unknown>;\n  created_at: string;\n  updated_at: string;\n}\n\n/**\n * Media dimensions\n */\nexport interface MediaDimensions {\n  width: number;\n  height: number;\n}\n","// ============================================================================\n// UNIFIED SCHEMA SYSTEM - Public types for engine rendering\n// ============================================================================\n\n/**\n * Block target - what pages/contexts can a block be added to\n */\nexport type BlockTarget =\n  | \"collection.entry\"\n  | \"collection.index\"\n  | \"collection.category\"\n  | \"collection.category_index\"\n  | \"collection.author\"\n  | \"collection.author_index\"\n  | \"collection.tag\"\n  | \"collection.tag_index\"\n  | \"collection.search\"\n  | \"page\"\n  | \"form\"\n  | \"footer\"\n  | \"*\";\n\n/**\n * Schema instance in a page (section) or collection entry (block)\n */\nexport interface SchemaInstance {\n  id: string;\n  type: string;\n  config: Record<string, unknown>;\n}\n\n// ============================================================================\n// RESERVED/BUILT-IN SCHEMA TYPES\n// ============================================================================\n\nexport const RESERVED_SECTION_TYPES = [\n  \"hero-banner\",\n  \"content-blocks\",\n  \"feature-grid\",\n  \"testimonial-carousel\",\n  \"cta-banner\",\n  \"team-grid\",\n  \"faq-accordion\",\n  \"stats-showcase\",\n  \"logo-cloud\",\n] as const;\n\nexport const RESERVED_BLOCK_TYPES = [\n  \"markdown\",\n  \"html\",\n  \"image\",\n  \"quote\",\n  \"gallery\",\n  \"embed\",\n  \"cta\",\n  \"divider\",\n  \"code\",\n  \"about-the-authors\",\n  \"more-from-the-authors\",\n  \"recommended-posts\",\n  \"related-posts\",\n] as const;\n\nexport type ReservedSectionType = (typeof RESERVED_SECTION_TYPES)[number];\nexport type ReservedBlockType = (typeof RESERVED_BLOCK_TYPES)[number];\nexport type ReservedSchemaType = ReservedSectionType | ReservedBlockType;\n\nexport function isReservedSchemaType(type: string): type is ReservedSchemaType {\n  return (\n    (RESERVED_SECTION_TYPES as readonly string[]).includes(type) ||\n    (RESERVED_BLOCK_TYPES as readonly string[]).includes(type)\n  );\n}\n\nexport function isReservedSectionType(\n  type: string,\n): type is ReservedSectionType {\n  return (RESERVED_SECTION_TYPES as readonly string[]).includes(type);\n}\n\nexport function isReservedBlockType(type: string): type is ReservedBlockType {\n  return (RESERVED_BLOCK_TYPES as readonly string[]).includes(type);\n}\n"]}