@sushichan044/kg-core 0.0.0 → 0.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 sushichan044
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,45 +1,101 @@
 # @sushichan044/kg-core
 
-## ⚠️ IMPORTANT NOTICE ⚠️
-
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
-
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
-
-## Purpose
-
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@sushichan044/kg-core`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
-
-## What is OIDC Trusted Publishing?
-
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
-
-## Setup Instructions
-
-To properly configure OIDC trusted publishing for this package:
-
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
-
-## DO NOT USE THIS PACKAGE
-
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
-
-## More Information
-
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
-
----
-
-**Maintained for OIDC setup purposes only**
+Framework-independent parsing, composition, and proofreading for Japanese
+manuscripts.
+
+The package exposes plain readonly data transfer objects and pure processing
+functions. It does not own application state, persistence, React components,
+or DOM behavior.
+
+## Install
+
+```sh
+pnpm add @sushichan044/kg-core
+```
+
+## Processing pipeline
+
+```ts
+import {
+  ComposeError,
+  composeManuscript,
+  createDefaultProofreadingRules,
+  ManuscriptCompositionSettings,
+  manuscriptGridComposer,
+  ParseError,
+  parseManuscript,
+  pixivParser,
+  ProofreadError,
+  proofreadManuscript,
+} from "@sushichan044/kg-core";
+
+const parsed = parseManuscript(source, { parser: pixivParser });
+if (!parsed.ok) throw new Error(ParseError.describe(parsed.error));
+
+const composed = composeManuscript(parsed.value, {
+  composer: manuscriptGridComposer,
+  settings: ManuscriptCompositionSettings.defaults,
+});
+if (!composed.ok) throw new Error(ComposeError.describe(composed.error));
+
+const proofread = proofreadManuscript(composed.value, {
+  rules: createDefaultProofreadingRules(),
+});
+if (!proofread.ok) throw new Error(ProofreadError.describe(proofread.error));
+
+const diagnostics = [...parsed.warnings, ...proofread.value];
+```
+
+`parseManuscript` uses `plainTextParser` when no parser is supplied. The Pixiv
+parser normalizes ruby, bold, italic, and emphasis notation into a closed
+annotation union. Malformed or unknown notation remains visible and produces a
+parser warning.
+
+`composeManuscript` requires a composer. The built-in grid composer produces a
+self-contained snapshot containing the parsed manuscript, accepted settings,
+geometry, statistics, and page/stage/line/cell hierarchy. Every occupied
+element has source, display, and grapheme ranges; empty placement elements use
+`null`.
+
+## Extensions and validation
+
+Parsers implement `ManuscriptParser`. Composers implement `ManuscriptComposer`
+and provide Valibot schemas for their settings and layout. Proofreading rules
+carry `kind: "parsed"` or `kind: "composed"` to declare which manuscript they
+need, and report findings through `context.report`.
+
+A plugin signals its own failure with a `Rejection` — a plain reason string.
+Core turns that into a variant of the stage's error union, so plugins never
+construct core's error types.
+
+Each concept lives in its own module as a type plus a companion object of the
+same name, holding its schema and operations: `ManuscriptRange.merge`,
+`PaperSize.of`, `ManuscriptCompositionSettings.defaults`, and so on. Types are
+inferred from the schemas with `v.InferOutput`; source, display, and grapheme
+ranges are distinct branded types, and plugin IDs are branded `NamespacedId`.
+
+Processing functions return `ManuscriptResult`: success carries warnings, and
+failure carries exactly one error from a discriminated union, so callers can
+`switch` on `error.kind` exhaustively. Each error variant exposes its context
+as typed fields; `describe` renders one for display. Invalid settings and
+plugin output fail explicitly; values are never clamped or partially trusted.
+
+## Source mapping
+
+Source and display ranges are zero-based, end-exclusive UTF-16 offsets.
+Grapheme ranges index the normalized grapheme array. Diagnostics include
+one-based source line and column positions, so renderers do not need to search
+or recalculate locations.
+
+The default proofreading rules report common Japanese novel-style issues and
+Unicode variation sequences. Diagnostics do not modify the source and do not
+contain automatic fixes.
+
+## Browser support
+
+The package targets browser features that are Baseline Widely Available. It
+does not include polyfills.
+
+## License
+
+MIT