@riebeckite/plugin-bases 0.0.1

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

@@ -0,0 +1,180 @@
+# @riebeckite/plugin-bases
+
+Render Obsidian Bases definitions from fenced `base` code blocks. Filtering,
+sorting, and view composition run against the content manifest at build time, so
+no client-side JavaScript is required.
+
+[日本語](./README_ja.md)
+
+## Overview
+
+`bases()` recognises fenced blocks
+
+````md
+```base
+filters:
+  and:
+    - file.hasTag("featured")
+properties:
+  file.name:
+    displayName: Title
+  file.tags:
+    displayName: Tags
+views:
+  - type: table
+    name: Featured
+    order:
+      - file.name
+      - file.tags
+    limit: 10
+```
+````
+
+and renders them using the content manifest (every note's frontmatter, tags,
+links, and permalink).
+
+## Usage
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { bases } from "@riebeckite/plugin-bases";
+
+export default defineConfig({
+  // ...
+  plugins: [bases()],
+});
+```
+
+## Block syntax
+
+The block body is an Obsidian Base YAML document.
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `filters` | expression \| list \| object | Top-level filter applied to every view (below) |
+| `properties` | object | Property id -> display name (or `{ displayName }`) |
+| `views` | object[] | One or more views |
+
+### Views
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| `type` | `"table"` \| `"cards"` | Output kind. Defaults to `table` |
+| `name` | string | Optional label rendered above the view |
+| `filters` | filter | Additional filter, combined with the top-level filter using AND |
+| `order` | string \| string[] | Columns (property ids) and their display order |
+| `columns` | string \| string[] | Alias for `order` |
+| `sort` | object \| object[] \| string | Sort keys (below) |
+| `limit` | number | Row cap for this view; still bounded by the `limit` option |
+
+`sort` accepts the Core shape `{ field, order }`, the Obsidian shape
+`{ property, direction }`, or a shorthand string (`"-file.name"` sorts
+descending). When a view omits `order`/`columns`, the columns are the keys of
+`properties` (in order), or `["file.name", "file.tags"]`.
+
+### Filter grammar
+
+A filter is an expression string, a list of expressions (treated as AND), or an
+object with `and` / `or` / `not` keys. `and` and `or` take a list; `not` takes an
+expression or a list (the list is ANDed, then negated). A plain object whose keys
+are property names is treated as equality.
+
+| Expression | Description |
+| ---------- | ----------- |
+| `file.hasTag("x")` | Has the tag `x` (or a subtag `x/...`). Case-insensitive |
+| `file.inFolder("x")` | Slug equals `x` or starts with `x/` |
+| `file.hasLink("x")` | Links to `x` (by resolved slug, raw target, or file name) |
+| `file.name` / `file.title` | Note title |
+| `file.path` / `file.slug` | Slug |
+| `file.folder` | Parent folder of the slug |
+| `file.link` / `file.permalink` | Permalink |
+| `file.tags` | Tags |
+| `note.key` / `key` | A frontmatter value |
+
+Comparisons use `==`, `!=`, `>`, `<`, `>=`, `<=`, and `contains`. String
+comparisons are case-insensitive; `contains` tests array membership or substring
+containment. Bare scalar lists are ANDed.
+
+```yaml
+filters:
+  and:
+    - file.hasTag("featured")
+    - or:
+        - note.status == "published"
+        - note.status == "review"
+    - not:
+        - file.hasTag("draft")
+views:
+  - type: table
+    name: Featured
+    order: [file.name, note.status]
+    sort:
+      - property: file.name
+        direction: ASC
+    limit: 20
+```
+
+## Options
+
+| Option | Type | Default | Description |
+| ------ | ---- | ------- | ----------- |
+| `className` | `string` | `"rb-bases"` | Root CSS class |
+| `language` | `string` | `"base"` | Fence language to target |
+| `limit` | `number` | `100` | Global row cap applied to every view |
+| `showFallback` | `boolean` | `true` | Render the raw Base definition in a `<details>` fallback |
+| `view` | `string` | none | Render only the view with this name when a Base defines several |
+
+## Output HTML / CSS hooks
+
+```html
+<div class="rb-bases" data-bases data-bases-view="table">
+  <section class="rb-bases__view" data-bases-view="table">
+    <h3 class="rb-bases__view-name">Featured</h3>
+    <table class="rb-bases__table"> ... </table>
+  </section>
+  <details class="rb-bases__fallback"> ... </details>
+</div>
+```
+
+Stable classes: `rb-bases`, `rb-bases__view`, `rb-bases__view-name`,
+`rb-bases__table`, `rb-bases__heading`, `rb-bases__cell`, `rb-bases__row`,
+`rb-bases__link`, `rb-bases__tags`, `rb-bases__tag`, `rb-bases__cards`,
+`rb-bases__card`, `rb-bases__card-title`, `rb-bases__fields`, `rb-bases__field`,
+`rb-bases__field-label`, `rb-bases__field-value`, `rb-bases__empty`,
+`rb-bases__fallback`, `rb-bases--error`. Stable attributes: `data-bases`,
+`data-bases-view`.
+
+## Diagnostics
+
+A block that is not valid YAML, or that uses an unsupported filter expression or
+view shape, is left as a code block and reported through `file.message(...)` with
+`source: "@riebeckite/plugin-bases"`.
+
+## Limitations
+
+This is an MVP subset of Obsidian Bases:
+
+- Only the `table` and `cards` view types are rendered.
+- Inline boolean operators (`&&`, `||`, `!`) are not supported; use the
+  `and` / `or` / `not` YAML structure.
+- `if()` / `filter()` and other Base formula functions are not supported.
+- Nested property paths and `file.mtime` / `file.ctime` are mapped onto `date`.
+- Property-to-property comparisons are not supported; the right-hand side is a
+  literal.
+- Results are fixed at build time. Rebuilding a host note when a queried note
+  changes is future work; a full build always recomputes correctly.
+
+## Exports
+
+- `bases(options?)` — plugin factory (alias: `basesPlugin`)
+- `remarkBases(options?)` — remark transform usable on its own (`options.language`
+  selects the fence language)
+- `parseBases(document)` — compiles a parsed YAML Base document to a spec
+- `matchesCondition(condition, entry)` — condition evaluator
+- Types: `BasesOptions`, `BasesSpec`, `BasesView`, `BasesViewType`,
+  `BasesCondition`, `BasesValueRef`, `BasesBuiltinValue`, `BasesOperator`,
+  `BasesLiteral`
+
+## See also
+
+- [Plugin guide](../../../docs/en/plugin-system.md)

package/README_ja.md

@@ -0,0 +1,155 @@
+# @riebeckite/plugin-bases
+
+フェンスコードブロック `base` に書いた Obsidian Bases 定義を HTML にレンダリングします。フィルタ・ソート・ビューの組み立てはビルド時にコンテンツマニフェストに対して行われるため、クライアントサイド JavaScript は不要です。
+
+[English](./README.md)
+
+## 概要
+
+`bases()` は次のようなフェンスブロックを認識します。
+
+````md
+```base
+filters:
+  and:
+    - file.hasTag("featured")
+properties:
+  file.name:
+    displayName: Title
+  file.tags:
+    displayName: Tags
+views:
+  - type: table
+    name: Featured
+    order:
+      - file.name
+      - file.tags
+    limit: 10
+```
+````
+
+レンダリングにはコンテンツマニフェスト（各ノートの frontmatter・タグ・リンク・パーマリンク）を使います。
+
+## 使い方
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { bases } from "@riebeckite/plugin-bases";
+
+export default defineConfig({
+  // ...
+  plugins: [bases()],
+});
+```
+
+## ブロックの構文
+
+ブロック本体は Obsidian Base の YAML ドキュメントです。
+
+| フィールド | 型 | 説明 |
+| ---------- | -- | ---- |
+| `filters` | 式 \| リスト \| オブジェクト | 全ビューに適用するトップレベルフィルタ（後述） |
+| `properties` | オブジェクト | プロパティ ID → 表示名（または `{ displayName }`） |
+| `views` | オブジェクト[] | 1 つ以上のビュー |
+
+### ビュー
+
+| フィールド | 型 | 説明 |
+| ---------- | -- | ---- |
+| `type` | `"table"` \| `"cards"` | 出力形式。既定は `table` |
+| `name` | string | ビュー上部に表示する任意のラベル |
+| `filters` | フィルタ | トップレベルフィルタに AND で合成する追加フィルタ |
+| `order` | string \| string[] | 列（プロパティ ID）と表示順 |
+| `columns` | string \| string[] | `order` の別名 |
+| `sort` | オブジェクト \| オブジェクト[] \| string | ソートキー（後述） |
+| `limit` | number | このビューの行数上限。`limit` オプション以下に制限される |
+
+`sort` は Core 形式 `{ field, order }`、Obsidian 形式 `{ property, direction }`、短縮文字列（`"-file.name"` で降順）のいずれかを受け付けます。ビューに `order` / `columns` がない場合、列は `properties` のキー（定義順）、それもなければ `["file.name", "file.tags"]` になります。
+
+### フィルタの文法
+
+フィルタは式文字列、式のリスト（AND として扱う）、または `and` / `or` / `not` を持つオブジェクトです。`and` と `or` はリストを取り、`not` は式またはリスト（リストは AND でまとめてから否定）を取ります。プロパティ名をキーにした素のオブジェクトは等価比較として扱います。
+
+| 式 | 説明 |
+| -- | ---- |
+| `file.hasTag("x")` | タグ `x`（またはサブタグ `x/...`）を持つ。大文字小文字は区別しない |
+| `file.inFolder("x")` | スラグが `x` に一致するか `x/` で始まる |
+| `file.hasLink("x")` | `x` へのリンクがある（解決済みスラグ・生のターゲット・ファイル名で照合） |
+| `file.name` / `file.title` | ノートのタイトル |
+| `file.path` / `file.slug` | スラグ |
+| `file.folder` | スラグの親フォルダ |
+| `file.link` / `file.permalink` | パーマリンク |
+| `file.tags` | タグ |
+| `note.key` / `key` | frontmatter の値 |
+
+比較演算子は `==`、`!=`、`>`、`<`、`>=`、`<=`、`contains` です。文字列比較は大文字小文字を区別せず、`contains` は配列の要素または文字列の部分一致を調べます。スカラーのリストは AND として扱います。
+
+```yaml
+filters:
+  and:
+    - file.hasTag("featured")
+    - or:
+        - note.status == "published"
+        - note.status == "review"
+    - not:
+        - file.hasTag("draft")
+views:
+  - type: table
+    name: Featured
+    order: [file.name, note.status]
+    sort:
+      - property: file.name
+        direction: ASC
+    limit: 20
+```
+
+## オプション
+
+| オプション | 型 | 既定値 | 説明 |
+| ---------- | -- | ------ | ---- |
+| `className` | `string` | `"rb-bases"` | ルート CSS クラス |
+| `language` | `string` | `"base"` | 対象とするフェンス言語 |
+| `limit` | `number` | `100` | 全ビューに適用する行数上限 |
+| `showFallback` | `boolean` | `true` | 生の Base 定義を `<details>` のフォールバックに表示する |
+| `view` | `string` | なし | Base に複数ビューがあるとき、指定名のビューだけをレンダリングする |
+
+## 出力 HTML / CSS フック
+
+```html
+<div class="rb-bases" data-bases data-bases-view="table">
+  <section class="rb-bases__view" data-bases-view="table">
+    <h3 class="rb-bases__view-name">Featured</h3>
+    <table class="rb-bases__table"> ... </table>
+  </section>
+  <details class="rb-bases__fallback"> ... </details>
+</div>
+```
+
+安定クラス: `rb-bases`、`rb-bases__view`、`rb-bases__view-name`、`rb-bases__table`、`rb-bases__heading`、`rb-bases__cell`、`rb-bases__row`、`rb-bases__link`、`rb-bases__tags`、`rb-bases__tag`、`rb-bases__cards`、`rb-bases__card`、`rb-bases__card-title`、`rb-bases__fields`、`rb-bases__field`、`rb-bases__field-label`、`rb-bases__field-value`、`rb-bases__empty`、`rb-bases__fallback`、`rb-bases--error`。安定属性: `data-bases`、`data-bases-view`。
+
+## 診断
+
+YAML として不正なブロック、未対応のフィルタ式やビュー形状を使ったブロックはコードブロックのまま残し、`source: "@riebeckite/plugin-bases"` を付けて `file.message(...)` で報告します。
+
+## 制限事項
+
+これは Obsidian Bases の MVP サブセットです。
+
+- レンダリングできるのは `table` と `cards` の 2 種類のビューだけです。
+- インラインの論理演算子（`&&`、`||`、`!`）は未対応です。`and` / `or` / `not` の YAML 構造を使ってください。
+- `if()` / `filter()` などの Base フォーミュラ関数は未対応です。
+- ネストしたプロパティパスと `file.mtime` / `file.ctime` は `date` にマップされます。
+- プロパティ同士の比較は未対応で、右辺はリテラルです。
+- 結果はビルド時に確定します。参照先ノートの変更に応じてホストノートだけを再ビルドするのは今後の課題で、フルビルドでは常に正しく再計算されます。
+
+## エクスポート
+
+- `bases(options?)` — プラグインファクトリ（別名: `basesPlugin`）
+- `remarkBases(options?)` — 単体で使える remark トランスフォーム（`options.language` でフェンス言語を選択）
+- `parseBases(document)` — パース済み YAML Base ドキュメントをスペックにコンパイル
+- `matchesCondition(condition, entry)` — 条件評価関数
+- 型: `BasesOptions`、`BasesSpec`、`BasesView`、`BasesViewType`、`BasesCondition`、`BasesValueRef`、`BasesBuiltinValue`、`BasesOperator`、`BasesLiteral`
+
+## 関連
+
+- [プラグインガイド](../../../docs/ja/plugin-system.md)

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+import type { BasesOptions } from "./src/types.js";
+export { remarkBases } from "./src/remark.js";
+export { parseBases } from "./src/parse.js";
+export { matchesCondition, resolveValueRef } from "./src/evaluate.js";
+export type { BasesBuiltinValue, BasesCondition, BasesLiteral, BasesOperator, BasesOptions, BasesSpec, BasesValueRef, BasesView, BasesViewType, } from "./src/types.js";
+/**
+ * Renders Obsidian Bases definitions from fenced `base` code blocks.
+ *
+ * A block body is an Obsidian Base YAML document. It is compiled to a filter /
+ * sort / view spec at parse time and rendered against the content manifest at
+ * build time, so no client-side JavaScript is required.
+ */
+export declare function bases(options?: BasesOptions): import("@riebeckite/core").RiebeckitePlugin<BasesOptions>;
+/** Alias kept for symmetry with other plugin factories. */
+export declare const basesPlugin: typeof bases;