@airdraft/plugin-seo 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+All notable changes to `@airdraft/plugin-seo` will be documented here.
+
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { withSeo } from './withSeo.js';
+export type { WithSeoOptions } from './withSeo.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AACtC,YAAY,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export { withSeo } from './withSeo.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA"}

package/dist/withSeo.d.ts

@@ -0,0 +1,30 @@
+import type { Plugin } from '@airdraft/core';
+export interface WithSeoOptions {
+    /**
+     * Collection names to inject SEO fields into.
+     * Omit to apply to all collections.
+     */
+    collections?: string[];
+}
+/**
+ * Injects a pre-defined `seo` object field into the specified collections
+ * (or all collections if none are specified).
+ *
+ * Added fields:
+ * - `seo.title` — Meta / OG title
+ * - `seo.description` — Meta description
+ * - `seo.image` — Open Graph image URL
+ * - `seo.noIndex` — Opt out of indexing (default: false)
+ *
+ * ```ts
+ * import { withSeo } from '@airdraft/plugin-seo'
+ *
+ * plugins: [
+ *   withSeo({ collections: ['posts', 'pages'] }),
+ *   // or to apply to all:
+ *   withSeo(),
+ * ]
+ * ```
+ */
+export declare function withSeo(options?: WithSeoOptions): Plugin;
+//# sourceMappingURL=withSeo.d.ts.map

package/dist/withSeo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"withSeo.d.ts","sourceRoot":"","sources":["../src/withSeo.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAa,MAAM,gBAAgB,CAAA;AAMvD,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;CACvB;AAsBD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,OAAO,CAAC,OAAO,GAAE,cAAmB,GAAG,MAAM,CA2B5D"}

package/dist/withSeo.js

@@ -0,0 +1,63 @@
+// ---------------------------------------------------------------------------
+// SEO field schema
+// ---------------------------------------------------------------------------
+/** The `seo` object field injected by this plugin. */
+const SEO_FIELD = {
+    type: 'object',
+    label: 'SEO',
+    fields: {
+        title: { type: 'string', label: 'Meta title' },
+        description: { type: 'text', label: 'Meta description' },
+        image: { type: 'image', label: 'OG image' },
+        noIndex: { type: 'boolean', label: 'No index', default: false },
+    },
+};
+// ---------------------------------------------------------------------------
+// withSeo
+// ---------------------------------------------------------------------------
+/**
+ * Injects a pre-defined `seo` object field into the specified collections
+ * (or all collections if none are specified).
+ *
+ * Added fields:
+ * - `seo.title` — Meta / OG title
+ * - `seo.description` — Meta description
+ * - `seo.image` — Open Graph image URL
+ * - `seo.noIndex` — Opt out of indexing (default: false)
+ *
+ * ```ts
+ * import { withSeo } from '@airdraft/plugin-seo'
+ *
+ * plugins: [
+ *   withSeo({ collections: ['posts', 'pages'] }),
+ *   // or to apply to all:
+ *   withSeo(),
+ * ]
+ * ```
+ */
+export function withSeo(options = {}) {
+    return {
+        name: 'seo',
+        schema(schema) {
+            const updatedCollections = { ...schema.collections };
+            for (const [name, col] of Object.entries(schema.collections)) {
+                // Skip if a target list is given and this collection isn't in it
+                // (explicitly empty array = no collections; omitting = all collections)
+                if (options.collections !== undefined && !options.collections.includes(name))
+                    continue;
+                // Skip if this collection already has a `seo` field
+                if ('seo' in col.fields)
+                    continue;
+                updatedCollections[name] = {
+                    ...col,
+                    fields: {
+                        ...col.fields,
+                        seo: SEO_FIELD,
+                    },
+                };
+            }
+            return { ...schema, collections: updatedCollections };
+        },
+    };
+}
+//# sourceMappingURL=withSeo.js.map

package/dist/withSeo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"withSeo.js","sourceRoot":"","sources":["../src/withSeo.ts"],"names":[],"mappings":"AAcA,8EAA8E;AAC9E,mBAAmB;AACnB,8EAA8E;AAE9E,sDAAsD;AACtD,MAAM,SAAS,GAAG;IAChB,IAAI,EAAE,QAAiB;IACvB,KAAK,EAAE,KAAK;IACZ,MAAM,EAAE;QACN,KAAK,EAAE,EAAE,IAAI,EAAE,QAAiB,EAAE,KAAK,EAAE,YAAY,EAAE;QACvD,WAAW,EAAE,EAAE,IAAI,EAAE,MAAe,EAAE,KAAK,EAAE,kBAAkB,EAAE;QACjE,KAAK,EAAE,EAAE,IAAI,EAAE,OAAgB,EAAE,KAAK,EAAE,UAAU,EAAE;QACpD,OAAO,EAAE,EAAE,IAAI,EAAE,SAAkB,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,EAAE;KACzE;CACF,CAAA;AAED,8EAA8E;AAC9E,UAAU;AACV,8EAA8E;AAE9E;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,OAAO,CAAC,UAA0B,EAAE;IAClD,OAAO;QACL,IAAI,EAAE,KAAK;QAEX,MAAM,CAAC,MAAiB;YACtB,MAAM,kBAAkB,GAAG,EAAE,GAAG,MAAM,CAAC,WAAW,EAAE,CAAA;YAEpD,KAAK,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC7D,iEAAiE;gBACjE,wEAAwE;gBACxE,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC;oBAAE,SAAQ;gBAEtF,oDAAoD;gBACpD,IAAI,KAAK,IAAI,GAAG,CAAC,MAAM;oBAAE,SAAQ;gBAEjC,kBAAkB,CAAC,IAAI,CAAC,GAAG;oBACzB,GAAG,GAAG;oBACN,MAAM,EAAE;wBACN,GAAG,GAAG,CAAC,MAAM;wBACb,GAAG,EAAE,SAAS;qBACf;iBACF,CAAA;YACH,CAAC;YAED,OAAO,EAAE,GAAG,MAAM,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAA;QACvD,CAAC;KACF,CAAA;AACH,CAAC"}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@airdraft/plugin-seo",
+  "version": "0.1.0",
+  "description": "Airdraft SEO plugin — meta fields, OG, sitemap generation",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": ["dist", "README.md", "CHANGELOG.md"],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "clean": "rm -rf dist",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run build",
+    "release": "standard-version",
+    "release:patch": "standard-version --release-as patch",
+    "release:minor": "standard-version --release-as minor",
+    "release:major": "standard-version --release-as major"
+  },
+  "publishConfig": { "access": "public" },
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "standard-version": "^9.5.0",
+    "tsx": "^4.7.0",
+    "typescript": "^5.4.0",
+    "vitest": "^1.5.0"
+  },
+  "dependencies": {
+    "@airdraft/core": "*"
+  },
+  "engines": { "node": ">=18.0.0" }
+}