hazo_blog 0.1.0

package/dist/types/index.d.ts

@@ -0,0 +1,141 @@
+import type { ComponentType } from "react";
+/** Publication state. A post is "live" when published, or scheduled and due. */
+export type PostStatus = "draft" | "published" | "scheduled";
+/** A FAQ question/answer pair (drives the visible FAQ + FAQPage JSON-LD). */
+export interface FaqItem {
+    question: string;
+    answer: string;
+}
+/** A blog category (single per post). */
+export interface BlogCategory {
+    id: string;
+    scope_id?: string | null;
+    slug: string;
+    name: string;
+    description: string;
+    colour: string;
+    created_at?: string;
+    updated_at?: string;
+}
+/** A free-form tag (many-to-many with posts). */
+export interface BlogTag {
+    id: string;
+    scope_id?: string | null;
+    slug: string;
+    name: string;
+    created_at?: string;
+    updated_at?: string;
+}
+/** A blog post row. `content` is raw MDX; `content_html` is an optional cache. */
+export interface BlogPost {
+    id: string;
+    scope_id?: string | null;
+    slug: string;
+    title: string;
+    content: string;
+    content_html?: string | null;
+    excerpt?: string | null;
+    category_id?: string | null;
+    author_id?: string | null;
+    meta_title: string;
+    meta_description: string;
+    canonical_url?: string | null;
+    og_image?: string | null;
+    featured_image?: string | null;
+    image_ref?: string | null;
+    faq_json: string;
+    reading_time: number;
+    status: PostStatus;
+    publish_date?: string | null;
+    created_at: string;
+    updated_at: string;
+}
+/** A post joined with its category + resolved tags + parsed FAQ. */
+export interface BlogPostWithRelations extends BlogPost {
+    category?: BlogCategory | null;
+    tags: BlogTag[];
+    faq: FaqItem[];
+}
+/** Resolved author info (feeds <AuthorBio> + JSON-LD Person). */
+export interface AuthorInfo {
+    name: string;
+    url: string;
+    bio?: string;
+    avatar?: string;
+}
+/** Input for creating/updating a post (upsert by slug). */
+export interface UpsertPostInput {
+    slug: string;
+    title: string;
+    content: string;
+    category_id?: string | null;
+    category_name?: string | null;
+    author_id?: string | null;
+    meta_title?: string;
+    meta_description?: string;
+    canonical_url?: string | null;
+    og_image?: string | null;
+    featured_image?: string | null;
+    image_ref?: string | null;
+    faq?: FaqItem[];
+    tags?: string[];
+    status?: PostStatus;
+    publish_date?: string | null;
+}
+/** Options for listing posts. */
+export interface ListPostsOptions {
+    page?: number;
+    perPage?: number;
+    categorySlug?: string;
+    tagSlug?: string;
+    /** Include drafts + future-scheduled (admin views). Default false. */
+    includeUnpublished?: boolean;
+}
+/** Paginated list result. */
+export interface PaginatedPosts {
+    posts: BlogPostWithRelations[];
+    total: number;
+    page: number;
+    perPage: number;
+    totalPages: number;
+}
+/** Analytics event names emitted by the blog. */
+export type BlogAnalyticsEvent = "blog_post_view" | "blog_read_complete" | "blog_search" | "blog_share";
+/**
+ * The host-supplied configuration that parameterizes the whole package.
+ * This is the central contract between hazo_blog and its consumer.
+ */
+export interface BlogConfig {
+    /** Brand name used in titles + JSON-LD publisher. */
+    siteName: string;
+    /** Absolute site origin, e.g. "https://gotimer.org" (no trailing slash). */
+    baseUrl: string;
+    /** Blog base path. Default "/blog". */
+    basePath?: string;
+    /** Absolute logo URL (JSON-LD publisher logo). */
+    logoUrl: string;
+    /** Absolute fallback OG image URL. */
+    defaultOgImage: string;
+    /** Default site author (used when a post has no author_id). */
+    author: AuthorInfo;
+    /** Resolve a per-post author (e.g. from hazo_auth users). */
+    getAuthor?: (id: string) => AuthorInfo | Promise<AuthorInfo>;
+    /** Return a hazo_connect adapter (never imported at module top-level). */
+    getHazoConnect: () => Promise<unknown> | unknown;
+    /** Admin guard — host wires this to a hazo_auth permission check. */
+    authorize: (req: Request) => boolean | Promise<boolean>;
+    /** Optional tenant/scope resolver for multi-tenant consumers. */
+    resolveScope?: (req: Request) => string | null;
+    /** Host-injected/overridden MDX components (e.g. TimerEmbed). */
+    mdxComponents?: Record<string, ComponentType<unknown>>;
+    /** Analytics sink; falls back to window.gtag/dataLayer when omitted. */
+    onAnalyticsEvent?: (name: BlogAnalyticsEvent, params: Record<string, unknown>) => void;
+    /** ISR revalidate window in seconds. Default 3600. */
+    revalidateSeconds?: number;
+}
+/** Resolved config with defaults applied. */
+export interface ResolvedBlogConfig extends BlogConfig {
+    basePath: string;
+    revalidateSeconds: number;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAE3C,gFAAgF;AAChF,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,WAAW,GAAG,WAAW,CAAC;AAE7D,6EAA6E;AAC7E,MAAM,WAAW,OAAO;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,yCAAyC;AACzC,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,iDAAiD;AACjD,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,kFAAkF;AAClF,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;IACzB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,UAAU,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,oEAAoE;AACpE,MAAM,WAAW,qBAAsB,SAAQ,QAAQ;IACrD,QAAQ,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC;IAC/B,IAAI,EAAE,OAAO,EAAE,CAAC;IAChB,GAAG,EAAE,OAAO,EAAE,CAAC;CAChB;AAED,iEAAiE;AACjE,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,2DAA2D;AAC3D,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,GAAG,CAAC,EAAE,OAAO,EAAE,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,iCAAiC;AACjC,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sEAAsE;IACtE,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED,6BAA6B;AAC7B,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,qBAAqB,EAAE,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,iDAAiD;AACjD,MAAM,MAAM,kBAAkB,GAC1B,gBAAgB,GAChB,oBAAoB,GACpB,aAAa,GACb,YAAY,CAAC;AAEjB;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,qDAAqD;IACrD,QAAQ,EAAE,MAAM,CAAC;IACjB,4EAA4E;IAC5E,OAAO,EAAE,MAAM,CAAC;IAChB,uCAAuC;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kDAAkD;IAClD,OAAO,EAAE,MAAM,CAAC;IAChB,sCAAsC;IACtC,cAAc,EAAE,MAAM,CAAC;IACvB,+DAA+D;IAC/D,MAAM,EAAE,UAAU,CAAC;IACnB,6DAA6D;IAC7D,SAAS,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC7D,0EAA0E;IAC1E,cAAc,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC;IACjD,qEAAqE;IACrE,SAAS,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACxD,iEAAiE;IACjE,YAAY,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,MAAM,GAAG,IAAI,CAAC;IAC/C,iEAAiE;IACjE,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IACvD,wEAAwE;IACxE,gBAAgB,CAAC,EAAE,CAAC,IAAI,EAAE,kBAAkB,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC;IACvF,sDAAsD;IACtD,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,6CAA6C;AAC7C,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,EAAE,MAAM,CAAC;CAC3B"}

package/dist/types/index.js

@@ -0,0 +1,3 @@
+// hazo_blog — domain types and the BlogConfig contract.
+// This module is server/client neutral (pure types + interfaces only).
+export {};

package/package.json

@@ -0,0 +1,100 @@
+{
+  "name": "hazo_blog",
+  "version": "0.1.0",
+  "description": "SEO-optimized blogging package: posts, categories, tags, MDX content, and GA4/GSC/Bing-ready SEO.",
+  "type": "module",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./client": {
+      "types": "./dist/index.client.d.ts",
+      "import": "./dist/index.client.js"
+    },
+    "./seo": {
+      "types": "./dist/seo/index.d.ts",
+      "import": "./dist/seo/index.js"
+    },
+    "./next": {
+      "types": "./dist/next/index.d.ts",
+      "import": "./dist/next/index.js"
+    },
+    "./config": {
+      "types": "./dist/config/index.d.ts",
+      "import": "./dist/config/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "db_setup_postgres.sql",
+    "db_setup_sqlite.sql",
+    "README.md",
+    "CHANGE_LOG.md",
+    "SETUP_CHECKLIST.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "type-check": "tsc --noEmit",
+    "test": "node --experimental-vm-modules ../node_modules/jest/bin/jest.js --config jest.config.cjs"
+  },
+  "peerDependencies": {
+    "hazo_core": "^1.0.1",
+    "hazo_connect": "^3.0.0",
+    "hazo_api": "^2.1.1",
+    "hazo_files": "^3.0.0",
+    "hazo_ui": "^3.2.0",
+    "hazo_images": "^1.2.0",
+    "hazo_jobs": "^0.12.0",
+    "hazo_auth": "^9.0.1",
+    "react": "^18.0.0 || ^19.0.0",
+    "react-dom": "^18.0.0 || ^19.0.0",
+    "next": "^14.0.0 || ^16.0.0"
+  },
+  "peerDependenciesMeta": {
+    "hazo_images": { "optional": true },
+    "hazo_jobs": { "optional": true },
+    "hazo_auth": { "optional": true }
+  },
+  "dependencies": {
+    "next-mdx-remote": "^6.0.0",
+    "remark-gfm": "^4.0.1"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.2",
+    "jest": "^30.2.0",
+    "ts-jest": "^29.4.5",
+    "@types/jest": "^30.0.0",
+    "jest-environment-node": "^30.2.0",
+    "@types/node": "^22.10.0",
+    "@types/react": "^19.0.0",
+    "@types/react-dom": "^19.0.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "next": "^16.0.10",
+    "hazo_core": "^1.0.1",
+    "hazo_connect": "^3.0.0",
+    "hazo_api": "^2.1.1",
+    "hazo_files": "^3.0.0",
+    "hazo_ui": "^3.2.0",
+    "tailwindcss": "^4.2.4",
+    "@tailwindcss/postcss": "^4.2.4",
+    "postcss": "^8.4.49"
+  },
+  "keywords": [
+    "blog",
+    "blogging",
+    "cms",
+    "mdx",
+    "seo",
+    "ga4",
+    "sitemap",
+    "rss",
+    "hazo"
+  ],
+  "author": "Pubs Abayasiri",
+  "license": "MIT"
+}