@riebeckite/plugin-archive 0.0.0-stage → 0.0.17

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright Rerurate_514
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,70 @@
-# Temporary Holding Version
+# @riebeckite/plugin-archive
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[日本語](./README_ja.md)
+
+Monthly archive listing pages for Riebeckite. The plugin builds its listings with
+the Core collection engine (`buildContentCollections`), so links, ordering, and
+pagination reuse the same query pipeline as the rest of the site.
+
+## Installation
+
+```bash
+pnpm add @riebeckite/plugin-archive
+```
+
+## Usage
+
+```ts
+import { archive } from "@riebeckite/plugin-archive";
+
+export default {
+  plugins: [archive()],
+};
+```
+
+## Page types
+
+The plugin registers a single Page Type, `archive`, and only while the plugin is
+enabled. Routes are generated by the plugin, not by application code.
+
+- `archive`: one listing page per month at `<basePath>/<yyyy>/<mm>`, with
+  additional pages at `<basePath>/<yyyy>/<mm>/page/<n>` when pagination applies.
+
+Entries are grouped by the first available date among `published`, `date`, and
+`created`, at month granularity. Months are ordered newest first, and every link
+uses the entry's resolved permalink.
+
+## Publication and localization
+
+Listings are built from `manifest.discoverableEntries`, so unlisted, draft, and
+scheduled notes never appear. The period title and the previous/next pagination
+labels follow `site.locale`; set `locale` on the plugin to override it. Japanese
+and English labels are provided, and the period is formatted through
+`Intl.DateTimeFormat` for any locale.
+
+## Options
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `basePath` | `string` | `"/archive"` | Path prefix for the generated pages. An empty string disables them. |
+| `pageSize` | `number` | `10` | Entries per page. `0` keeps a single page. |
+| `locale` | `string` | `site.locale` | Locale used for the period and pagination labels. |
+| `className` | `string` | `"rb-archive"` | Root CSS class for the rendered fragment. |
+
+## Exports
+
+- `archive` / `archivePlugin` — the plugin factory.
+- `resolveArchiveOptions` — resolves options with defaults.
+- `buildArchiveCollections` — builds the monthly collections for entries.
+- `archiveDefinitions` — the Core collection definitions used by the plugin.
+- `renderArchivePage` — renders one archive listing page to HTML.
+- `formatArchivePeriod`, `archivePaginationLabels` — locale helpers.
+- `DEFAULT_ARCHIVE_BASE_PATH`, `DEFAULT_ARCHIVE_PAGE_SIZE`,
+  `DEFAULT_ARCHIVE_CLASS_NAME`, `ARCHIVE_COLLECTION_KIND`.
+
+## Notes
+
+The plugin ships no stylesheet; the rendered fragment carries `rb-archive`
+classes so a site can style it directly. Set `basePath` to a different prefix if
+`/archive` clashes with existing content, and set it to `""` to turn the
+generated pages off without removing the plugin.

package/README_ja.md

@@ -0,0 +1,72 @@
+# @riebeckite/plugin-archive
+
+[English](./README.md)
+
+Riebeckite の月別アーカイブ一覧ページです。Core の collection 機構
+(`buildContentCollections`) で一覧を組み立てるため、リンク・順序・ページ
+ネーションはサイト全体と同じ query パイプラインを再利用します。
+
+## インストール
+
+```bash
+pnpm add @riebeckite/plugin-archive
+```
+
+## 使い方
+
+```ts
+import { archive } from "@riebeckite/plugin-archive";
+
+export default {
+  plugins: [archive()],
+};
+```
+
+## ページタイプ
+
+`archive` という 1 つの Page Type を登録し、plugin を有効にしている間だけ
+ルートを生成します。ルートはアプリケーションコードではなく plugin が生成
+します。
+
+- `archive`: `<basePath>/<yyyy>/<mm>` に月ごとの一覧ページを、ページネー
+  ションがある場合は `<basePath>/<yyyy>/<mm>/page/<n>` に追加ページを生成
+  します。
+
+エントリは `published`、`date`、`created` のうち最初に利用できる日付を月単
+位でグループ化します。月は新しい順に並び、各リンクはエントリの解決済み
+パーマリンクを使います。
+
+## publication と l10n
+
+一覧は `manifest.discoverableEntries` から組み立てるため、unlisted・下書き・
+スケジュール公開のノートは現れません。期間タイトルと前後ページのラベルは
+`site.locale` に従います。plugin の `locale` で上書きできます。日本語と英語
+のラベルを用意し、期間は `Intl.DateTimeFormat` で任意のロケール向けに整形し
+ます。
+
+## オプション
+
+| オプション | 型 | 既定値 | 説明 |
+| --- | --- | --- | --- |
+| `basePath` | `string` | `"/archive"` | 生成ページのパス接頭辞。空文字列で無効化します。 |
+| `pageSize` | `number` | `10` | 1 ページあたりのエントリ数。`0` で単一ページにします。 |
+| `locale` | `string` | `site.locale` | 期間・ページネーションのラベルに使うロケール。 |
+| `className` | `string` | `"rb-archive"` | 描画フラグメントのルート CSS クラス。 |
+
+## エクスポート
+
+- `archive` / `archivePlugin` — plugin ファクトリ。
+- `resolveArchiveOptions` — 既定値を適用してオプションを解決します。
+- `buildArchiveCollections` — エントリから月別 collection を組み立てます。
+- `archiveDefinitions` — plugin が使う Core collection 定義。
+- `renderArchivePage` — アーカイブ一覧ページを HTML に描画します。
+- `formatArchivePeriod`、`archivePaginationLabels` — ロケール補助関数。
+- `DEFAULT_ARCHIVE_BASE_PATH`、`DEFAULT_ARCHIVE_PAGE_SIZE`、
+  `DEFAULT_ARCHIVE_CLASS_NAME`、`ARCHIVE_COLLECTION_KIND`。
+
+## 補足
+
+スタイルシートは同梱しません。描画フラグメントは `rb-archive` クラスを持つ
+ので、サイト側で直接スタイルできます。`/archive` が既存コンテンツと衝突す
+る場合は `basePath` を変更し、plugin を残したまま生成ページを止めたい場合は
+`""` を設定します。

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import type { ArchiveOptions } from "./src/types.js";
+export { ARCHIVE_COLLECTION_KIND, archiveDefinitions, buildArchiveCollections, } from "./src/collections.js";
+export { archivePaginationLabels, formatArchivePeriod } from "./src/locale.js";
+export { DEFAULT_ARCHIVE_BASE_PATH, DEFAULT_ARCHIVE_CLASS_NAME, DEFAULT_ARCHIVE_PAGE_SIZE, resolveArchiveOptions, } from "./src/options.js";
+export { renderArchivePage } from "./src/pages.js";
+export type { ArchiveOptions, ArchivePage, ResolvedArchiveOptions, } from "./src/types.js";
+export declare const ARCHIVE_PLUGIN_NAME = "archive";
+export declare function archive(options?: ArchiveOptions): import("@riebeckite/core").RiebeckitePlugin<ArchiveOptions>;
+export declare const archivePlugin: typeof archive;

package/dist/index.js

@@ -0,0 +1,188 @@
+// index.ts
+import {
+  definePlugin
+} from "@riebeckite/core";
+
+// src/collections.ts
+import {
+  buildContentCollections
+} from "@riebeckite/core";
+
+// src/locale.ts
+function archivePaginationLabels(locale) {
+  return isJapanese(locale) ? { previous: "前のページ", next: "次のページ" } : { previous: "Previous", next: "Next" };
+}
+function formatArchivePeriod(value, locale) {
+  const match = /^(\d{4})(?:-(\d{1,2}))?$/.exec(value);
+  if (!match) return value;
+  const year = Number(match[1]);
+  const month = match[2] ? Number(match[2]) : null;
+  const tag = isJapanese(locale) ? "ja-JP" : locale && locale.trim() !== "" ? locale : "en-US";
+  const options = month === null ? { year: "numeric", timeZone: "UTC" } : { year: "numeric", month: "long", timeZone: "UTC" };
+  return new Intl.DateTimeFormat(tag, options).format(
+    new Date(Date.UTC(year, (month ?? 1) - 1, 1))
+  );
+}
+function isJapanese(locale) {
+  return Boolean(locale && /^ja($|[-_])/i.test(locale));
+}
+
+// src/collections.ts
+var ARCHIVE_COLLECTION_KIND = "archive";
+function archiveDefinitions(options, locale) {
+  return [
+    {
+      kind: ARCHIVE_COLLECTION_KIND,
+      basePath: options.basePath,
+      groupBy: {
+        by: "date",
+        fields: ["published", "date", "created"],
+        granularity: "month"
+      },
+      order: "desc",
+      pageSize: options.pageSize,
+      resolveTitle: ({ value }) => formatArchivePeriod(value, locale),
+      resolvePath: ({ value }) => `${options.basePath}/${value.replace(/-/g, "/")}`
+    }
+  ];
+}
+function buildArchiveCollections(entries, options, locale) {
+  if (options.basePath === "") return [];
+  return buildContentCollections(entries, archiveDefinitions(options, locale));
+}
+
+// src/options.ts
+var DEFAULT_ARCHIVE_BASE_PATH = "/archive";
+var DEFAULT_ARCHIVE_PAGE_SIZE = 10;
+var DEFAULT_ARCHIVE_CLASS_NAME = "rb-archive";
+function resolveArchiveOptions(options = {}) {
+  return {
+    basePath: normalizeBasePath(options.basePath ?? DEFAULT_ARCHIVE_BASE_PATH),
+    pageSize: normalizePageSize(options.pageSize ?? DEFAULT_ARCHIVE_PAGE_SIZE),
+    locale: options.locale?.trim() ? options.locale.trim() : null,
+    className: options.className?.trim() || DEFAULT_ARCHIVE_CLASS_NAME
+  };
+}
+function normalizeBasePath(value) {
+  const trimmed = value.trim().replace(/\/+$/, "");
+  if (trimmed.length === 0) return "";
+  return trimmed.startsWith("/") ? trimmed : `/${trimmed}`;
+}
+function normalizePageSize(value) {
+  return typeof value === "number" && Number.isFinite(value) && value > 0 ? Math.floor(value) : 0;
+}
+
+// src/pages.ts
+import {
+  escapeHtml,
+  escapeHtmlAttribute
+} from "@riebeckite/core";
+function renderArchivePage(collection, options, locale) {
+  const className = escapeHtmlAttribute(options.className);
+  const posts = collection.entries.map(
+    (entry) => `<li class="${className}__item"><a class="${className}__link" href="${escapeHtmlAttribute(
+      entry.permalink
+    )}">${escapeHtml(entry.title)}</a></li>`
+  ).join("");
+  const labels = archivePaginationLabels(locale);
+  const navigation = [];
+  if (collection.page.previousPath) {
+    navigation.push(
+      `<a class="${className}__link" rel="prev" href="${escapeHtmlAttribute(
+        collection.page.previousPath
+      )}">${escapeHtml(labels.previous)}</a>`
+    );
+  }
+  if (collection.page.nextPath) {
+    navigation.push(
+      `<a class="${className}__link" rel="next" href="${escapeHtmlAttribute(
+        collection.page.nextPath
+      )}">${escapeHtml(labels.next)}</a>`
+    );
+  }
+  const pagination = navigation.length > 0 ? `<nav class="${className}__pagination">${navigation.join(" ")}</nav>` : "";
+  const html = `<section class="${className}" data-rr-archive="${escapeHtmlAttribute(
+    collection.value
+  )}"><h1 class="${className}__title">${escapeHtml(
+    collection.title
+  )}</h1><ul class="${className}__list">${posts}</ul>${pagination}</section>`;
+  return { title: collection.title, html };
+}
+
+// index.ts
+var ARCHIVE_PLUGIN_NAME = "archive";
+function archive(options = {}) {
+  const resolved = resolveArchiveOptions(options);
+  return definePlugin({
+    name: ARCHIVE_PLUGIN_NAME,
+    options,
+    validateOptions: validateArchiveOptions,
+    pageTypes: [
+      {
+        id: "archive",
+        paths: ({ manifest, config }) => buildArchiveCollections(
+          manifest.discoverableEntries,
+          resolved,
+          resolveLocale(config, resolved)
+        ).map((collection) => collection.path),
+        outputDependencies: [{ type: "global" }],
+        resolve: ({ manifest, pathname, config }) => {
+          if (resolved.basePath === "") return null;
+          const locale = resolveLocale(config, resolved);
+          const collection = buildArchiveCollections(
+            manifest.discoverableEntries,
+            resolved,
+            locale
+          ).find((candidate) => candidate.path === pathname);
+          if (!collection) return null;
+          const page = renderArchivePage(collection, resolved, locale);
+          return {
+            type: "archive",
+            pathname: collection.path,
+            title: page.title,
+            body: page.html
+          };
+        }
+      }
+    ]
+  });
+}
+var archivePlugin = archive;
+function resolveLocale(config, options) {
+  return options.locale ?? config?.site.locale ?? "en";
+}
+function validateArchiveOptions(options) {
+  if (!options) return [];
+  const issues = [];
+  if (options.basePath !== void 0 && typeof options.basePath !== "string") {
+    issues.push({ path: "basePath", message: "Expected a string." });
+  }
+  for (const key of ["locale", "className"]) {
+    const value = options[key];
+    if (value !== void 0 && (typeof value !== "string" || value.trim() === "")) {
+      issues.push({ path: key, message: "Expected a non-empty string." });
+    }
+  }
+  if (options.pageSize !== void 0 && (typeof options.pageSize !== "number" || !Number.isInteger(options.pageSize) || options.pageSize < 0)) {
+    issues.push({
+      path: "pageSize",
+      message: "Expected a non-negative integer."
+    });
+  }
+  return issues;
+}
+export {
+  ARCHIVE_COLLECTION_KIND,
+  ARCHIVE_PLUGIN_NAME,
+  DEFAULT_ARCHIVE_BASE_PATH,
+  DEFAULT_ARCHIVE_CLASS_NAME,
+  DEFAULT_ARCHIVE_PAGE_SIZE,
+  archive,
+  archiveDefinitions,
+  archivePaginationLabels,
+  archivePlugin,
+  buildArchiveCollections,
+  formatArchivePeriod,
+  renderArchivePage,
+  resolveArchiveOptions
+};

package/dist/src/collections.d.ts

@@ -0,0 +1,5 @@
+import { type ContentCollection, type ContentCollectionDefinition, type ContentManifestEntry } from "@riebeckite/core";
+import type { ResolvedArchiveOptions } from "./types.js";
+export declare const ARCHIVE_COLLECTION_KIND = "archive";
+export declare function archiveDefinitions(options: ResolvedArchiveOptions, locale: string): readonly ContentCollectionDefinition[];
+export declare function buildArchiveCollections(entries: readonly ContentManifestEntry[], options: ResolvedArchiveOptions, locale: string): ContentCollection[];

package/dist/src/locale.d.ts

@@ -0,0 +1,5 @@
+export declare function archivePaginationLabels(locale: string | null | undefined): {
+    previous: string;
+    next: string;
+};
+export declare function formatArchivePeriod(value: string, locale: string | null | undefined): string;

package/dist/src/options.d.ts

@@ -0,0 +1,5 @@
+import type { ArchiveOptions, ResolvedArchiveOptions } from "./types.js";
+export declare const DEFAULT_ARCHIVE_BASE_PATH = "/archive";
+export declare const DEFAULT_ARCHIVE_PAGE_SIZE = 10;
+export declare const DEFAULT_ARCHIVE_CLASS_NAME = "rb-archive";
+export declare function resolveArchiveOptions(options?: ArchiveOptions): ResolvedArchiveOptions;

package/dist/src/pages.d.ts

@@ -0,0 +1,3 @@
+import { type ContentCollection } from "@riebeckite/core";
+import type { ArchivePage, ResolvedArchiveOptions } from "./types.js";
+export declare function renderArchivePage(collection: ContentCollection, options: ResolvedArchiveOptions, locale: string): ArchivePage;

package/dist/src/types.d.ts

@@ -0,0 +1,16 @@
+export type ArchiveOptions = {
+    basePath?: string;
+    pageSize?: number;
+    locale?: string;
+    className?: string;
+};
+export type ResolvedArchiveOptions = {
+    basePath: string;
+    pageSize: number;
+    locale: string | null;
+    className: string;
+};
+export type ArchivePage = {
+    title: string;
+    html: string;
+};

package/package.json

@@ -1,6 +1,55 @@
 {
   "name": "@riebeckite/plugin-archive",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.0.17",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "source": "./index.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "dependencies": {
+    "@riebeckite/core": "0.0.17"
+  },
+  "devDependencies": {
+    "tsx": "^4.22.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "LICENSE",
+    "README.md",
+    "README_ja.md",
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Rerurate514/riebeckite.git",
+    "directory": "packages/plugins/archive"
+  },
+  "homepage": "https://github.com/Rerurate514/riebeckite#readme",
+  "bugs": {
+    "url": "https://github.com/Rerurate514/riebeckite/issues"
+  },
+  "description": "Monthly archive listing pages built on the Core collection engine.",
+  "keywords": [
+    "riebeckite",
+    "plugin",
+    "archive",
+    "collections"
+  ],
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "build": "node ../../../scripts/build_package.mjs",
+    "test": "node --import tsx --test \"test/*.test.ts\""
+  }
 }