@searkin/next 0.1.0 → 0.1.2

package/README.md

@@ -7,13 +7,13 @@ Compatible avec Next.js 13.4 à 16, en App Router comme en Pages Router.
 ## Installation
 
 ```bash
-npm install @searkin/next
 npx @searkin/next init --key sks_…
 ```
 
 `init` commence par détecter si le projet utilise l'App Router ou le Pages Router, et s'il a un dossier `src/`. Il effectue ensuite les opérations suivantes :
 
-- il écrit `SEARKIN_KEY` dans `.env.local`, ainsi que `SEARKIN_SITE_URL` s'il peut la déduire de `NEXT_PUBLIC_SERVER_URL` / `NEXT_PUBLIC_SITE_URL` (ou de l'option `--site-url`) ;
+- il ajoute `@searkin/next` aux dépendances du site, avec le gestionnaire de paquets du projet (npm, pnpm, yarn ou bun, d'après son fichier de verrouillage). L'option `--no-install` l'en dispense ;
+- il écrit `SEARKIN_KEY` dans `.env.local` (et `SEARKIN_SITE_URL` seulement avec l'option `--site-url`) ;
 - il crée la route `app/api/searkin/[...searkin]/route.ts`, ou `pages/api/searkin/[...searkin].ts` en Pages Router ;
 - il crée `middleware.ts` (`proxy.ts` à partir de Next 16). Si ce fichier existe déjà, il n'y touche pas et affiche les deux lignes à ajouter ;
 - il affiche un exemple de `generateMetadata`, sans modifier vos pages.
@@ -25,7 +25,7 @@ Vous pouvez relancer `init` sans risque. Tout fichier modifié est d'abord sauve
 | Variable | Rôle |
 |---|---|
 | `SEARKIN_KEY` | Clé de site `sks_…` générée par Searkin. Elle sert seulement à lire les valeurs de ce site et à vérifier les rafraîchissements |
-| `SEARKIN_SITE_URL` | URL publique, pour rendre les canonicals absolus (à défaut : `NEXT_PUBLIC_SERVER_URL`, puis `NEXT_PUBLIC_SITE_URL`) |
+| `SEARKIN_SITE_URL` | Facultatif. URL publique servant à rendre les canonicals absolus. Par défaut, Searkin fournit l'adresse du site suivi ; à définir seulement si le site est servi ailleurs (préproduction…). À défaut : `NEXT_PUBLIC_SERVER_URL`, puis `NEXT_PUBLIC_SITE_URL`, puis l'adresse fournie par Searkin |
 | `SEARKIN_API` | Facultatif (par défaut : `https://app.searkin.com/api/proxy`) |
 | `SEARKIN_OUTPUT` | `export` si le site est exporté de manière statique (valeur renvoyée par le ping) |
 

package/dist/cli.js

@@ -1,12 +1,13 @@
 #!/usr/bin/env node
 /**
- * npx @searkin/next init --key sks_… [--dir <projet>] [--site-url https://…] [--dry-run]
+ * npx @searkin/next init --key sks_… [--dir <projet>] [--site-url https://…] [--dry-run] [--no-install]
  */
+import { spawnSync } from 'node:child_process';
 import { copyFileSync, existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
 import { dirname, join, relative, resolve } from 'node:path';
 import { VERSION } from './shared.js';
 function parseArgs(argv) {
-    const a = { dir: process.cwd(), dryRun: false };
+    const a = { dir: process.cwd(), dryRun: false, install: true };
     for (let i = 0; i < argv.length; i++) {
         const v = argv[i];
         if (v === '--key')
@@ -19,6 +20,8 @@ function parseArgs(argv) {
             a.dir = resolve(argv[++i] || '.');
         else if (v === '--dry-run')
             a.dryRun = true;
+        else if (v === '--no-install')
+            a.install = false;
         else if (v === '--version' || v === '-v')
             a.cmd = 'version';
         else if (!v.startsWith('-') && !a.cmd)
@@ -64,19 +67,6 @@ function upsertEnv(root, file, vars, dryRun) {
         write(root, file, next, dryRun);
     return changed;
 }
-function readEnvValue(root, names) {
-    for (const f of ['.env.local', '.env.production', '.env']) {
-        const p = join(root, f);
-        if (!existsSync(p))
-            continue;
-        for (const name of names) {
-            const m = new RegExp(`^${name}=["']?([^"'\\n]+)`, 'm').exec(readFileSync(p, 'utf8'));
-            if (m && /^https?:\/\//.test(m[1]))
-                return m[1].trim().replace(/\/+$/, '');
-        }
-    }
-    return undefined;
-}
 function nextMajor(root) {
     try {
         const pkg = JSON.parse(readFileSync(join(root, 'package.json'), 'utf8'));
@@ -133,6 +123,46 @@ export async function getServerSideProps({ resolvedUrl }) {
 export default function Page({ seo }) {
   return <><SearkinHead seo={seo} />…</>
 }`;
+/** Gestionnaire de paquets du projet, d'après son fichier de verrouillage. */
+function packageManager(root) {
+    if (existsSync(join(root, 'pnpm-lock.yaml')))
+        return { cmd: 'pnpm', add: ['add'] };
+    if (existsSync(join(root, 'yarn.lock')))
+        return { cmd: 'yarn', add: ['add'] };
+    if (existsSync(join(root, 'bun.lock')) || existsSync(join(root, 'bun.lockb')))
+        return { cmd: 'bun', add: ['add'] };
+    return { cmd: 'npm', add: ['install'] };
+}
+/** Les fichiers créés importent `@searkin/next` : le paquet doit être une
+ * dépendance du site (lancé par `npx`, il ne l'est pas encore). */
+function ensureDependency(root, args) {
+    let pkg;
+    try {
+        pkg = JSON.parse(readFileSync(join(root, 'package.json'), 'utf8'));
+    }
+    catch {
+        pkg = {};
+    }
+    if (pkg.dependencies?.['@searkin/next'] || pkg.devDependencies?.['@searkin/next']) {
+        log('Dépendance @searkin/next : déjà présente.');
+        return true;
+    }
+    const pm = packageManager(root);
+    const cmd = [pm.cmd, ...pm.add, `@searkin/next@^${VERSION}`];
+    if (args.dryRun || !args.install) {
+        log(`Dépendance @searkin/next : à installer avec « ${cmd.join(' ')} ».`);
+        return true;
+    }
+    log(`Installation : ${cmd.join(' ')}`);
+    const res = spawnSync(cmd[0], cmd.slice(1), {
+        cwd: root, stdio: 'inherit', shell: process.platform === 'win32',
+    });
+    if (res.status !== 0) {
+        log(`Échec de l'installation : lancez « ${cmd.join(' ')} » à la racine du projet, puis relancez init.`);
+        return false;
+    }
+    return true;
+}
 function init(args) {
     const root = args.dir;
     log(`@searkin/next ${VERSION} — init${args.dryRun ? ' (simulation)' : ''}`);
@@ -150,18 +180,20 @@ function init(args) {
     log(`Projet : ${hasApp ? 'App Router' : ''}${hasApp && hasPages ? ' + ' : ''}${hasPages ? 'Pages Router' : ''}${!hasApp && !hasPages ? 'aucun dossier app/ ni pages/' : ''}${base !== root ? ' (src/)' : ''}, Next ${major}${isExport ? ', output: export' : ''}`);
     if (!hasApp && !hasPages)
         return 1;
+    // 0. Dépendance (les fichiers ci-dessous l'importent).
+    if (!ensureDependency(root, args))
+        return 1;
     // 1. Variables d'environnement.
     if (args.key) {
         if (!/^sks_[A-Za-z0-9_-]{16,}$/.test(args.key))
             log('Attention : la clé ne ressemble pas à une clé de site Searkin (sks_…).');
         const vars = { SEARKIN_KEY: args.key };
-        const siteUrl = args.siteUrl || readEnvValue(root, ['SEARKIN_SITE_URL', 'NEXT_PUBLIC_SERVER_URL', 'NEXT_PUBLIC_SITE_URL', 'SITE_URL']);
-        if (siteUrl)
-            vars.SEARKIN_SITE_URL = siteUrl;
+        // Adresse publique : fournie par Searkin avec chaque réponse. SEARKIN_SITE_URL
+        // n'est écrite que sur demande (--site-url), pour une préproduction par exemple.
+        if (args.siteUrl)
+            vars.SEARKIN_SITE_URL = args.siteUrl.replace(/\/+$/, '');
         const changed = upsertEnv(root, join(root, '.env.local'), vars, args.dryRun);
         log(changed.length ? `.env.local : ${changed.join(', ')} écrit(s).` : '.env.local : déjà à jour.');
-        if (!siteUrl)
-            log('  SEARKIN_SITE_URL non déduit : ajoutez l’URL publique du site (canonicals absolus).');
     }
     // 2. Route /api/searkin/*.
     if (isExport) {
@@ -225,7 +257,7 @@ function main() {
     }
     if (!args.cmd || args.cmd === 'init')
         return init(args);
-    log('Usage : npx @searkin/next init --key sks_… [--site-url https://…] [--dir <projet>] [--dry-run]');
+    log('Usage : npx @searkin/next init --key sks_… [--site-url https://…] [--dir <projet>] [--dry-run] [--no-install]');
     return 1;
 }
 process.exitCode = main();

package/dist/index.js

@@ -1,4 +1,4 @@
-import { absoluteUrl, CACHE_TAG, config, fetchRedirectRules, isPermanent, normalizePath, robotsFor, searkinGet, } from './shared.js';
+import { absoluteUrl, CACHE_TAG, fetchRedirectRules, isPermanent, normalizePath, robotsFor, searkinGet, siteUrlFor, } from './shared.js';
 export { VERSION, CACHE_TAG } from './shared.js';
 /**
  * Valeurs SEO brutes de Searkin pour un chemin ({} si rien n'est défini, null si l'API est
@@ -20,7 +20,7 @@ export function applySearkinSeo(seo, base = {}) {
     if (seo.description)
         out.description = seo.description;
     if (seo.canonical) {
-        out.alternates = { ...(base.alternates || {}), canonical: absoluteUrl(seo.canonical, config().siteUrl) };
+        out.alternates = { ...(base.alternates || {}), canonical: absoluteUrl(seo.canonical, siteUrlFor(seo)) };
     }
     const robots = robotsFor(seo.robots);
     if (robots)

package/dist/pages.js

@@ -1,6 +1,6 @@
 import HeadModule from 'next/head.js';
 import { createElement, Fragment } from 'react';
-import { absoluteUrl, config as env, outputMode, parseRevalidateBody, verifySignature, VERSION } from './shared.js';
+import { absoluteUrl, outputMode, siteUrlFor, parseRevalidateBody, verifySignature, VERSION } from './shared.js';
 export { getSearkinSeo } from './index.js';
 // next/head est un module CommonJS : selon le chargeur, le composant est l'export par défaut ou son .default.
 const Head = (HeadModule.default ?? HeadModule);
@@ -8,7 +8,7 @@ const Head = (HeadModule.default ?? HeadModule);
 export function SearkinHead({ seo, path }) {
     if (!seo)
         return null;
-    const siteUrl = env().siteUrl;
+    const siteUrl = siteUrlFor(seo);
     const children = [];
     if (seo.title)
         children.push(createElement('title', { key: 'searkin-title' }, seo.title));

package/dist/shared.d.ts

@@ -1,4 +1,4 @@
-export declare const VERSION = "0.1.0";
+export declare const VERSION = "0.1.2";
 export declare const CACHE_TAG = "searkin";
 export type SearkinRobots = 'default' | 'index' | 'noindex' | null;
 export type SearkinSeo = {
@@ -8,6 +8,8 @@ export type SearkinSeo = {
     canonical?: string | null;
     robots?: SearkinRobots;
     updated_at?: string | null;
+    /** Adresse publique du site connue de Searkin (canonicals absolus sans SEARKIN_SITE_URL). */
+    site_url?: string | null;
 };
 export type SearkinRedirectRule = {
     source: string;
@@ -30,6 +32,9 @@ type FetchInit = RequestInit & {
 };
 /** GET authentifié vers l'API site de Searkin. Renvoie null (et journalise une fois) en cas d'échec. */
 export declare function searkinGet<T>(path: string, init?: FetchInit, missingKey?: string): Promise<T | null>;
+/** Base des canonicals : variable d'environnement (surcharge, ex. préproduction),
+ * sinon l'adresse publique renvoyée par Searkin. */
+export declare const siteUrlFor: (seo: SearkinSeo | null | undefined) => string | undefined;
 export declare const absoluteUrl: (value: string, siteUrl?: string) => string;
 export declare const robotsFor: (robots: SearkinRobots | undefined) => {
     index: boolean;

package/dist/shared.js

@@ -1,5 +1,5 @@
 // Code commun, sans dépendance Node : utilisable côté serveur, en Edge (middleware) et au build.
-export const VERSION = '0.1.0';
+export const VERSION = '0.1.2';
 export const CACHE_TAG = 'searkin';
 const DEFAULT_API = 'https://app.searkin.com/api/proxy';
 const env = (name) => {
@@ -64,6 +64,9 @@ export async function searkinGet(path, init = {}, missingKey = 'SEARKIN_KEY abse
         return null;
     }
 }
+/** Base des canonicals : variable d'environnement (surcharge, ex. préproduction),
+ * sinon l'adresse publique renvoyée par Searkin. */
+export const siteUrlFor = (seo) => config().siteUrl || (seo?.site_url ? seo.site_url.replace(/\/+$/, '') : undefined);
 export const absoluteUrl = (value, siteUrl) => {
     if (/^https?:\/\//i.test(value))
         return value;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@searkin/next",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Searkin pour les sites Next.js sans CMS : métadonnées SEO, redirections et rafraîchissement signé, pilotés depuis Searkin.",
   "license": "MIT",
   "type": "module",