@daftarai/methodology

Canonical cultural methodology content + disclaimer-injection helper for cultural-tier Daftarai plugins.

This package supplies the authoritative bilingual (ar+en) methodology for each cultural category in the Daftarai plugin system: zakat, hijri, prayer-times, fasting, halal. Cultural-tier plugins read from this package to ensure all responses cite the same canonical sources and disclaimers.

Install

pnpm add @daftarai/methodology @daftarai/capabilities

@daftarai/methodology is only needed when your plugin's pluginTier is cultural and the manifest's culturalCategory is set.

Quick start

import { getMethodology, injectDisclaimer } from "@daftarai/methodology";

const methodology = getMethodology("zakat");

const arWithDisclaimer = injectDisclaimer({
  methodology,
  locale: "ar",
  responseText: "زكاتك السنوية تساوي 1,250 ريال.",
});

What's exported

• getMethodology(category) — returns the methodology bundle for a category (markdown content + version metadata)
• injectDisclaimer({ methodology, locale, responseText }) — appends the canonical disclaimer (per locale) to a plugin response
• checkCulturalSignGate({ ... }) — sign-pipeline conformance check; rejects with a typed code if a cultural plugin's response violates the methodology contract
• resolveForPlugin({ ... }) — resolves the methodology-version a plugin was certified against (used during sandbox dispatch)
• Methodology, MethodologyVersion, ResolvedMethodology, Locale, SignPipelineRejection, MethodologyNotFoundError — types

Methodology versioning

Each category folder ships a version.json. When a methodology is updated, the previous version is marked DEPRECATED and existing certified plugins keep resolving against their certified-against version until they re-submit for review. Plugin developers should treat methodology.version.version as part of their plugin's published-against contract.

License

MIT — see LICENSE.

Methodology content (methodology.ar.md / methodology.en.md per category) is also MIT-licensed but is the product of expert review specific to the MENA Daftarai context. If you fork the methodology, please contribute corrections back via a pull request to the upstream repo.