@krantho/seo 0.0.0-stage → 1.0.1

package/dist/catalog/property-atoms.d.ts

@@ -0,0 +1,53 @@
+/** How a property value is obtained */
+export type PropertySource = 'auto' | 'manual' | 'computed' | 'site';
+/** How much Google's rule for the type needs the property */
+export type PropertyImportance = 'required' | 'recommended' | 'optional';
+/** A Schema.org property of a catalog type, as written: how it is edited and where its value comes from */
+export interface PropertySpec {
+    /** Schema.org property name (e.g., 'name', 'description', 'telephone') */
+    property: string;
+    /** Human-readable label */
+    label: string;
+    /** Field type for the Studio form */
+    fieldType: 'text' | 'textarea' | 'url' | 'email' | 'tel' | 'date' | 'number' | 'select' | 'array';
+    /** How the value is typically obtained */
+    source: PropertySource;
+    /** CMS field name this auto-maps from (if source is 'auto') */
+    autoMapField?: string | undefined;
+    /** Description shown in the Studio form */
+    hint?: string | undefined;
+}
+/** A catalog property with its importance, taken from Google's rule for the type */
+export interface PropertyDef extends PropertySpec {
+    importance: PropertyImportance;
+}
+export declare const SITE_NAME: PropertySpec;
+export declare const SITE_DESCRIPTION: PropertySpec;
+export declare const SITE_URL: PropertySpec;
+export declare const SITE_PHONE: PropertySpec;
+export declare const SITE_EMAIL: PropertySpec;
+export declare const SITE_ADDRESS: PropertySpec;
+export declare const OPENING_HOURS: PropertySpec;
+export declare const AREA_SERVED: PropertySpec;
+export declare const IMAGE_MANUAL: PropertySpec;
+export declare const IMAGE_AUTO: PropertySpec;
+export declare const PRICE_RANGE: PropertySpec;
+/** Core properties for business/organization site-level types */
+export declare const BUSINESS_CORE: readonly PropertySpec[];
+/** Document name auto-mapped from title field */
+export declare const DOC_NAME_FROM_TITLE: PropertySpec;
+/** Document description auto-mapped from description field */
+export declare const DOC_DESC_FROM_DESC: PropertySpec;
+/** Article headline auto-mapped from title */
+export declare const ARTICLE_HEADLINE: PropertySpec;
+/** Article description auto-mapped from meta-description */
+export declare const ARTICLE_DESCRIPTION: PropertySpec;
+/** Date published auto-mapped from date field */
+export declare const DATE_PUBLISHED: PropertySpec;
+/** Author auto-mapped from author field */
+export declare const AUTHOR_AUTO: PropertySpec;
+/** Provider from site config */
+export declare const PROVIDER_SITE: PropertySpec;
+/** Shared rating properties for AggregateRating and EmployerAggregateRating */
+export declare const RATING_PROPERTIES: readonly PropertySpec[];
+//# sourceMappingURL=property-atoms.d.ts.map

package/dist/catalog/property-atoms.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"property-atoms.d.ts","sourceRoot":"","sources":["../../src/catalog/property-atoms.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,CAAA;AAEpE,6DAA6D;AAC7D,MAAM,MAAM,kBAAkB,GAAG,UAAU,GAAG,aAAa,GAAG,UAAU,CAAA;AAExE,2GAA2G;AAC3G,MAAM,WAAW,YAAY;IAC3B,0EAA0E;IAC1E,QAAQ,EAAE,MAAM,CAAA;IAChB,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAA;IACb,qCAAqC;IACrC,SAAS,EAAE,MAAM,GAAG,UAAU,GAAG,KAAK,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,OAAO,CAAA;IACjG,0CAA0C;IAC1C,MAAM,EAAE,cAAc,CAAA;IACtB,+DAA+D;IAC/D,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACjC,2CAA2C;IAC3C,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC1B;AAED,oFAAoF;AACpF,MAAM,WAAW,WAAY,SAAQ,YAAY;IAC/C,UAAU,EAAE,kBAAkB,CAAA;CAC/B;AAMD,eAAO,MAAM,SAAS,EAAE,YAKvB,CAAA;AAED,eAAO,MAAM,gBAAgB,EAAE,YAK9B,CAAA;AAED,eAAO,MAAM,QAAQ,EAAE,YAKtB,CAAA;AAED,eAAO,MAAM,UAAU,EAAE,YAKxB,CAAA;AAED,eAAO,MAAM,UAAU,EAAE,YAKxB,CAAA;AAED,eAAO,MAAM,YAAY,EAAE,YAM1B,CAAA;AAED,eAAO,MAAM,aAAa,EAAE,YAM3B,CAAA;AAED,eAAO,MAAM,WAAW,EAAE,YAKzB,CAAA;AAED,eAAO,MAAM,YAAY,EAAE,YAK1B,CAAA;AAED,eAAO,MAAM,UAAU,EAAE,YAMxB,CAAA;AAED,eAAO,MAAM,WAAW,EAAE,YAMzB,CAAA;AAMD,iEAAiE;AACjE,eAAO,MAAM,aAAa,EAAE,SAAS,YAAY,EAOhD,CAAA;AAED,iDAAiD;AACjD,eAAO,MAAM,mBAAmB,EAAE,YAMjC,CAAA;AAED,8DAA8D;AAC9D,eAAO,MAAM,kBAAkB,EAAE,YAMhC,CAAA;AAED,8CAA8C;AAC9C,eAAO,MAAM,gBAAgB,EAAE,YAM9B,CAAA;AAED,4DAA4D;AAC5D,eAAO,MAAM,mBAAmB,EAAE,YAMjC,CAAA;AAED,iDAAiD;AACjD,eAAO,MAAM,cAAc,EAAE,YAM5B,CAAA;AAED,2CAA2C;AAC3C,eAAO,MAAM,WAAW,EAAE,YAMzB,CAAA;AAED,gCAAgC;AAChC,eAAO,MAAM,aAAa,EAAE,YAK3B,CAAA;AAED,+EAA+E;AAC/E,eAAO,MAAM,iBAAiB,EAAE,SAAS,YAAY,EA2BpD,CAAA"}

package/dist/catalog/property-atoms.js

@@ -0,0 +1,170 @@
+// ---------------------------------------------------------------------------
+// Shared property atoms — single properties reused across multiple types
+// ---------------------------------------------------------------------------
+export const SITE_NAME = {
+    property: 'name',
+    label: 'Name',
+    fieldType: 'text',
+    source: 'site',
+};
+export const SITE_DESCRIPTION = {
+    property: 'description',
+    label: 'Description',
+    fieldType: 'textarea',
+    source: 'site',
+};
+export const SITE_URL = {
+    property: 'url',
+    label: 'Website URL',
+    fieldType: 'url',
+    source: 'site',
+};
+export const SITE_PHONE = {
+    property: 'telephone',
+    label: 'Phone',
+    fieldType: 'tel',
+    source: 'site',
+};
+export const SITE_EMAIL = {
+    property: 'email',
+    label: 'Email',
+    fieldType: 'email',
+    source: 'site',
+};
+export const SITE_ADDRESS = {
+    property: 'address',
+    label: 'Address',
+    fieldType: 'text',
+    source: 'site',
+    hint: 'Street, City, State, ZIP',
+};
+export const OPENING_HOURS = {
+    property: 'openingHours',
+    label: 'Opening Hours',
+    fieldType: 'text',
+    source: 'site',
+    hint: 'e.g., Mo-Fr 09:00-17:00',
+};
+export const AREA_SERVED = {
+    property: 'areaServed',
+    label: 'Area Served',
+    fieldType: 'text',
+    source: 'site',
+};
+export const IMAGE_MANUAL = {
+    property: 'image',
+    label: 'Image',
+    fieldType: 'url',
+    source: 'manual',
+};
+export const IMAGE_AUTO = {
+    property: 'image',
+    label: 'Image',
+    fieldType: 'url',
+    source: 'auto',
+    autoMapField: 'image',
+};
+export const PRICE_RANGE = {
+    property: 'priceRange',
+    label: 'Price Range',
+    fieldType: 'text',
+    source: 'manual',
+    hint: 'e.g., $$ or $50-$200',
+};
+// ---------------------------------------------------------------------------
+// Shared property groups — common combinations used by multiple types
+// ---------------------------------------------------------------------------
+/** Core properties for business/organization site-level types */
+export const BUSINESS_CORE = [
+    SITE_NAME,
+    SITE_DESCRIPTION,
+    SITE_URL,
+    SITE_PHONE,
+    SITE_EMAIL,
+    SITE_ADDRESS,
+];
+/** Document name auto-mapped from title field */
+export const DOC_NAME_FROM_TITLE = {
+    property: 'name',
+    label: 'Name',
+    fieldType: 'text',
+    source: 'auto',
+    autoMapField: 'title',
+};
+/** Document description auto-mapped from description field */
+export const DOC_DESC_FROM_DESC = {
+    property: 'description',
+    label: 'Description',
+    fieldType: 'textarea',
+    source: 'auto',
+    autoMapField: 'description',
+};
+/** Article headline auto-mapped from title */
+export const ARTICLE_HEADLINE = {
+    property: 'headline',
+    label: 'Headline',
+    fieldType: 'text',
+    source: 'auto',
+    autoMapField: 'title',
+};
+/** Article description auto-mapped from meta-description */
+export const ARTICLE_DESCRIPTION = {
+    property: 'description',
+    label: 'Description',
+    fieldType: 'textarea',
+    source: 'auto',
+    autoMapField: 'meta-description',
+};
+/** Date published auto-mapped from date field */
+export const DATE_PUBLISHED = {
+    property: 'datePublished',
+    label: 'Date Published',
+    fieldType: 'date',
+    source: 'auto',
+    autoMapField: 'date',
+};
+/** Author auto-mapped from author field */
+export const AUTHOR_AUTO = {
+    property: 'author',
+    label: 'Author',
+    fieldType: 'text',
+    source: 'auto',
+    autoMapField: 'author',
+};
+/** Provider from site config */
+export const PROVIDER_SITE = {
+    property: 'provider',
+    label: 'Provider',
+    fieldType: 'text',
+    source: 'site',
+};
+/** Shared rating properties for AggregateRating and EmployerAggregateRating */
+export const RATING_PROPERTIES = [
+    {
+        property: 'ratingValue',
+        label: 'Average Rating',
+        fieldType: 'number',
+        source: 'manual',
+    },
+    {
+        property: 'reviewCount',
+        label: 'Review Count',
+        fieldType: 'number',
+        source: 'manual',
+    },
+    {
+        property: 'bestRating',
+        label: 'Best Rating',
+        fieldType: 'number',
+        source: 'manual',
+        hint: 'Default: 5',
+    },
+    {
+        property: 'worstRating',
+        label: 'Worst Rating',
+        fieldType: 'number',
+        source: 'manual',
+        hint: 'Default: 1',
+    },
+];
+//# sourceMappingURL=property-atoms.js.map

package/dist/catalog/property-atoms.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"property-atoms.js","sourceRoot":"","sources":["../../src/catalog/property-atoms.ts"],"names":[],"mappings":"AA2BA,8EAA8E;AAC9E,yEAAyE;AACzE,8EAA8E;AAE9E,MAAM,CAAC,MAAM,SAAS,GAAiB;IACrC,QAAQ,EAAE,MAAM;IAChB,KAAK,EAAE,MAAM;IACb,SAAS,EAAE,MAAM;IACjB,MAAM,EAAE,MAAM;CACf,CAAA;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAiB;IAC5C,QAAQ,EAAE,aAAa;IACvB,KAAK,EAAE,aAAa;IACpB,SAAS,EAAE,UAAU;IACrB,MAAM,EAAE,MAAM;CACf,CAAA;AAED,MAAM,CAAC,MAAM,QAAQ,GAAiB;IACpC,QAAQ,EAAE,KAAK;IACf,KAAK,EAAE,aAAa;IACpB,SAAS,EAAE,KAAK;IAChB,MAAM,EAAE,MAAM;CACf,CAAA;AAED,MAAM,CAAC,MAAM,UAAU,GAAiB;IACtC,QAAQ,EAAE,WAAW;IACrB,KAAK,EAAE,OAAO;IACd,SAAS,EAAE,KAAK;IAChB,MAAM,EAAE,MAAM;CACf,CAAA;AAED,MAAM,CAAC,MAAM,UAAU,GAAiB;IACtC,QAAQ,EAAE,OAAO;IACjB,KAAK,EAAE,OAAO;IACd,SAAS,EAAE,OAAO;IAClB,MAAM,EAAE,MAAM;CACf,CAAA;AAED,MAAM,CAAC,MAAM,YAAY,GAAiB;IACxC,QAAQ,EAAE,SAAS;IACnB,KAAK,EAAE,SAAS;IAChB,SAAS,EAAE,MAAM;IACjB,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,0BAA0B;CACjC,CAAA;AAED,MAAM,CAAC,MAAM,aAAa,GAAiB;IACzC,QAAQ,EAAE,cAAc;IACxB,KAAK,EAAE,eAAe;IACtB,SAAS,EAAE,MAAM;IACjB,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,yBAAyB;CAChC,CAAA;AAED,MAAM,CAAC,MAAM,WAAW,GAAiB;IACvC,QAAQ,EAAE,YAAY;IACtB,KAAK,EAAE,aAAa;IACpB,SAAS,EAAE,MAAM;IACjB,MAAM,EAAE,MAAM;CACf,CAAA;AAED,MAAM,CAAC,MAAM,YAAY,GAAiB;IACxC,QAAQ,EAAE,OAAO;IACjB,KAAK,EAAE,OAAO;IACd,SAAS,EAAE,KAAK;IAChB,MAAM,EAAE,QAAQ;CACjB,CAAA;AAED,MAAM,CAAC,MAAM,UAAU,GAAiB;IACtC,QAAQ,EAAE,OAAO;IACjB,KAAK,EAAE,OAAO;IACd,SAAS,EAAE,KAAK;IAChB,MAAM,EAAE,MAAM;IACd,YAAY,EAAE,OAAO;CACtB,CAAA;AAED,MAAM,CAAC,MAAM,WAAW,GAAiB;IACvC,QAAQ,EAAE,YAAY;IACtB,KAAK,EAAE,aAAa;IACpB,SAAS,EAAE,MAAM;IACjB,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,sBAAsB;CAC7B,CAAA;AAED,8EAA8E;AAC9E,sEAAsE;AACtE,8EAA8E;AAE9E,iEAAiE;AACjE,MAAM,CAAC,MAAM,aAAa,GAA4B;IACpD,SAAS;IACT,gBAAgB;IAChB,QAAQ;IACR,UAAU;IACV,UAAU;IACV,YAAY;CACb,CAAA;AAED,iDAAiD;AACjD,MAAM,CAAC,MAAM,mBAAmB,GAAiB;IAC/C,QAAQ,EAAE,MAAM;IAChB,KAAK,EAAE,MAAM;IACb,SAAS,EAAE,MAAM;IACjB,MAAM,EAAE,MAAM;IACd,YAAY,EAAE,OAAO;CACtB,CAAA;AAED,8DAA8D;AAC9D,MAAM,CAAC,MAAM,kBAAkB,GAAiB;IAC9C,QAAQ,EAAE,aAAa;IACvB,KAAK,EAAE,aAAa;IACpB,SAAS,EAAE,UAAU;IACrB,MAAM,EAAE,MAAM;IACd,YAAY,EAAE,aAAa;CAC5B,CAAA;AAED,8CAA8C;AAC9C,MAAM,CAAC,MAAM,gBAAgB,GAAiB;IAC5C,QAAQ,EAAE,UAAU;IACpB,KAAK,EAAE,UAAU;IACjB,SAAS,EAAE,MAAM;IACjB,MAAM,EAAE,MAAM;IACd,YAAY,EAAE,OAAO;CACtB,CAAA;AAED,4DAA4D;AAC5D,MAAM,CAAC,MAAM,mBAAmB,GAAiB;IAC/C,QAAQ,EAAE,aAAa;IACvB,KAAK,EAAE,aAAa;IACpB,SAAS,EAAE,UAAU;IACrB,MAAM,EAAE,MAAM;IACd,YAAY,EAAE,kBAAkB;CACjC,CAAA;AAED,iDAAiD;AACjD,MAAM,CAAC,MAAM,cAAc,GAAiB;IAC1C,QAAQ,EAAE,eAAe;IACzB,KAAK,EAAE,gBAAgB;IACvB,SAAS,EAAE,MAAM;IACjB,MAAM,EAAE,MAAM;IACd,YAAY,EAAE,MAAM;CACrB,CAAA;AAED,2CAA2C;AAC3C,MAAM,CAAC,MAAM,WAAW,GAAiB;IACvC,QAAQ,EAAE,QAAQ;IAClB,KAAK,EAAE,QAAQ;IACf,SAAS,EAAE,MAAM;IACjB,MAAM,EAAE,MAAM;IACd,YAAY,EAAE,QAAQ;CACvB,CAAA;AAED,gCAAgC;AAChC,MAAM,CAAC,MAAM,aAAa,GAAiB;IACzC,QAAQ,EAAE,UAAU;IACpB,KAAK,EAAE,UAAU;IACjB,SAAS,EAAE,MAAM;IACjB,MAAM,EAAE,MAAM;CACf,CAAA;AAED,+EAA+E;AAC/E,MAAM,CAAC,MAAM,iBAAiB,GAA4B;IACxD;QACE,QAAQ,EAAE,aAAa;QACvB,KAAK,EAAE,gBAAgB;QACvB,SAAS,EAAE,QAAQ;QACnB,MAAM,EAAE,QAAQ;KACjB;IACD;QACE,QAAQ,EAAE,aAAa;QACvB,KAAK,EAAE,cAAc;QACrB,SAAS,EAAE,QAAQ;QACnB,MAAM,EAAE,QAAQ;KACjB;IACD;QACE,QAAQ,EAAE,YAAY;QACtB,KAAK,EAAE,aAAa;QACpB,SAAS,EAAE,QAAQ;QACnB,MAAM,EAAE,QAAQ;QAChB,IAAI,EAAE,YAAY;KACnB;IACD;QACE,QAAQ,EAAE,aAAa;QACvB,KAAK,EAAE,cAAc;QACrB,SAAS,EAAE,QAAQ;QACnB,MAAM,EAAE,QAAQ;QAChB,IAAI,EAAE,YAAY;KACnB;CACF,CAAA"}

package/dist/catalog/types.d.ts

@@ -0,0 +1,53 @@
+import type { FeatureStatus } from '../profiles/types.js';
+import type { Lifecycle } from '../vocabulary/index.js';
+/** A curated Schema.org type, as written: what it is for and where it applies */
+interface CatalogEntry {
+    /** Schema.org @type value */
+    type: string;
+    /** Human-readable label */
+    label: string;
+    /** Short description of when to use this type */
+    description: string;
+    /** Category for grouping in the type browser */
+    category: CatalogCategory;
+    /** Whether this type applies at site level (global entity) */
+    siteLevel: boolean;
+    /** Whether this type applies at document level */
+    documentLevel: boolean;
+}
+/** A curated Schema.org type with the Google feature it enables, taken from the Google profile */
+export interface CatalogType extends CatalogEntry {
+    /** The Google search feature the type makes a page eligible for, if any */
+    richResult: string | null;
+    /** Whether Google shows that feature */
+    richResultStatus: FeatureStatus;
+    /** Google's documentation for the type; empty when Google documents none */
+    docsUrl: string;
+    /** Where the type stands in Schema.org; absent for a current, non-pending type */
+    lifecycle?: Lifecycle | undefined;
+}
+export type CatalogCategory = 'business' | 'content' | 'commerce' | 'people' | 'navigation' | 'reviews';
+export declare const CATEGORY_LABELS: {
+    business: string;
+    content: string;
+    commerce: string;
+    people: string;
+    navigation: string;
+    reviews: string;
+};
+/**
+ * The catalog. Each type's Google feature, status and documentation come from
+ * the Google profile, so the catalog cannot disagree with the rules findings
+ * are checked against.
+ */
+export declare const SCHEMA_CATALOG: readonly CatalogType[];
+/** Look up a catalog type by its Schema.org @type value */
+export declare function getCatalogType(type: string): CatalogType | undefined;
+/** Get catalog types filtered by category */
+export declare function getCatalogByCategory(category: CatalogCategory): readonly CatalogType[];
+/** Get catalog types that can be used at site level */
+export declare function getSiteLevelTypes(): readonly CatalogType[];
+/** Get catalog types that can be used at document level */
+export declare function getDocumentLevelTypes(): readonly CatalogType[];
+export {};
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/catalog/types.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAA;AAGvD,iFAAiF;AACjF,UAAU,YAAY;IACpB,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAA;IACb,iDAAiD;IACjD,WAAW,EAAE,MAAM,CAAA;IACnB,gDAAgD;IAChD,QAAQ,EAAE,eAAe,CAAA;IACzB,8DAA8D;IAC9D,SAAS,EAAE,OAAO,CAAA;IAClB,kDAAkD;IAClD,aAAa,EAAE,OAAO,CAAA;CACvB;AAED,kGAAkG;AAClG,MAAM,WAAW,WAAY,SAAQ,YAAY;IAC/C,2EAA2E;IAC3E,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,wCAAwC;IACxC,gBAAgB,EAAE,aAAa,CAAA;IAC/B,4EAA4E;IAC5E,OAAO,EAAE,MAAM,CAAA;IACf,kFAAkF;IAClF,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAA;CAClC;AAED,MAAM,MAAM,eAAe,GACvB,UAAU,GACV,SAAS,GACT,UAAU,GACV,QAAQ,GACR,YAAY,GACZ,SAAS,CAAA;AAEb,eAAO,MAAM,eAAe;;;;;;;CAOe,CAAA;AAyY3C;;;;GAIG;AACH,eAAO,MAAM,cAAc,EAAE,SAAS,WAAW,EAAqC,CAAA;AAetF,2DAA2D;AAC3D,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS,CAEpE;AAED,6CAA6C;AAC7C,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,eAAe,GAAG,SAAS,WAAW,EAAE,CAEtF;AAED,uDAAuD;AACvD,wBAAgB,iBAAiB,IAAI,SAAS,WAAW,EAAE,CAE1D;AAED,2DAA2D;AAC3D,wBAAgB,qBAAqB,IAAI,SAAS,WAAW,EAAE,CAE9D"}