@quartz-community/encrypted-pages 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,63 @@
+export { BuildCtx, CSSResource, ChangeEvent, JSResource, PageGenerator, PageMatcher, ProcessedContent, QuartzEmitterPlugin, QuartzEmitterPluginInstance, QuartzFilterPlugin, QuartzFilterPluginInstance, QuartzPageTypePlugin, QuartzPageTypePluginInstance, QuartzPluginData, QuartzTransformerPlugin, QuartzTransformerPluginInstance, StaticResources, VirtualPage } from '@quartz-community/types';
+
+interface EncryptedPagesOptions {
+    /**
+     * PBKDF2 iteration count for key derivation.
+     * Higher = slower brute-force attacks, but also slower page unlock.
+     *
+     * @default 600_000
+     */
+    iterations: number;
+    /**
+     * Frontmatter field name that holds the page password.
+     *
+     * @default "password"
+     */
+    passwordField: string;
+    /**
+     * When `true`, encrypted pages are marked `file.data.unlisted = true`,
+     * hiding them from every build-time listing surface that respects the
+     * `unlisted` convention (contentIndex, RSS, sitemap, backlinks,
+     * recent-notes, folder-page, tag-page, graph, explorer, search).
+     *
+     * The page HTML is still emitted, so the page remains accessible by
+     * its direct URL. After successful client-side decryption, the page is
+     * dynamically added back to client-side discovery surfaces (graph,
+     * explorer, search) via the shadow content index emitted by
+     * {@link EncryptedContentIndex}.
+     *
+     * Per-page frontmatter `unlisted: true | false` overrides this option.
+     *
+     * NOTE: When `true`, the `EncryptedContentIndex` emitter MUST also be
+     * registered in your Quartz configuration. Without it, unlisted encrypted
+     * pages cannot be dynamically revealed after decryption and will remain
+     * invisible to graph/explorer/search for the entire session. The
+     * transformer emits a console warning at build time if it detects the
+     * emitter is missing.
+     *
+     * @default false
+     */
+    unlistWhenEncrypted: boolean;
+}
+interface EncryptedContentIndexOptions {
+    /**
+     * Output path for the shadow content index, relative to the Quartz output
+     * directory. The file is a JSON document wrapping a flat array of opaque
+     * encrypted blobs; see the README for the format.
+     *
+     * @default "static/encryptedContentIndex.json"
+     */
+    outputPath: string;
+    /**
+     * Frontmatter field name that holds the page password. Must match the
+     * `passwordField` used by the companion {@link EncryptedPages} transformer.
+     * When both plugins are loaded from the same package entry in
+     * quartz.config.yaml, Quartz passes the same merged options to both,
+     * so this field is automatically kept in sync.
+     *
+     * @default "password"
+     */
+    passwordField: string;
+}
+
+export type { EncryptedContentIndexOptions, EncryptedPagesOptions };

package/dist/types.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=types.js.map
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"types.js"}

package/package.json

@@ -0,0 +1,137 @@
+{
+  "name": "@quartz-community/encrypted-pages",
+  "version": "0.1.0",
+  "description": "Password-protected encrypted pages for Quartz. Encrypts page content at build time with AES-256-GCM and decrypts client-side using the Web Crypto API.",
+  "type": "module",
+  "license": "MIT",
+  "author": "Quartz Community",
+  "homepage": "https://quartz.jzhao.xyz",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/quartz-community/encrypted-pages"
+  },
+  "keywords": [
+    "quartz",
+    "quartz-plugin",
+    "encrypted-pages",
+    "password-protected",
+    "encryption",
+    "aes-gcm",
+    "rehype",
+    "hast"
+  ],
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./types": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/types.js"
+    },
+    "./components": {
+      "types": "./dist/components/index.d.ts",
+      "import": "./dist/components/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "lint": "eslint . --max-warnings=0",
+    "format": "prettier . --check",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit",
+    "check": "npm run typecheck && npm run lint && npm run format && npm run test",
+    "prepublishOnly": "npm run build"
+  },
+  "peerDependencies": {
+    "preact": "^10.0.0",
+    "vfile": "^6.0.3"
+  },
+  "peerDependenciesMeta": {
+    "preact": {
+      "optional": false
+    },
+    "vfile": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@quartz-community/types": "^0.2.1",
+    "@quartz-community/utils": "^0.1.0"
+  },
+  "devDependencies": {
+    "@types/hast": "^3.0.4",
+    "@types/node": "^24.10.0",
+    "@typescript-eslint/eslint-plugin": "^7.18.0",
+    "@typescript-eslint/parser": "^7.18.0",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "hast-util-to-html": "^9.0.4",
+    "preact": "^10.28.2",
+    "prettier": "^3.6.2",
+    "sass": "^1.97.3",
+    "tsup": "^8.5.0",
+    "typescript": "^5.9.3",
+    "unified": "^11.0.5",
+    "vfile": "^6.0.3",
+    "vitest": "^2.1.9"
+  },
+  "quartz": {
+    "name": "encrypted-pages",
+    "displayName": "Encrypted Pages",
+    "category": [
+      "transformer",
+      "emitter"
+    ],
+    "version": "1.0.0",
+    "quartzVersion": ">=5.0.0",
+    "dependencies": [],
+    "defaultOrder": 900,
+    "defaultEnabled": true,
+    "defaultOptions": {
+      "iterations": 600000,
+      "passwordField": "password",
+      "unlistWhenEncrypted": false,
+      "outputPath": "static/encryptedContentIndex.json"
+    },
+    "optionSchema": {
+      "iterations": {
+        "type": "number"
+      },
+      "passwordField": {
+        "type": "string"
+      },
+      "unlistWhenEncrypted": {
+        "type": "boolean"
+      },
+      "outputPath": {
+        "type": "string"
+      }
+    },
+    "components": {
+      "EncryptedPage": {
+        "displayName": "Encrypted Page",
+        "defaultPosition": "body",
+        "defaultPriority": 100
+      }
+    }
+  },
+  "engines": {
+    "node": ">=22",
+    "npm": ">=10.9.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}