@unikvs/readonly 0.0.0 → 0.0.13

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026-present, tai-kun
+
+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,3 @@
 # @unikvs/readonly
 
-## ⚠️ 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 `@unikvs/readonly`
-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**
+[Document](https://tai-kun.github.io/unikvs/)

package/dist/index.d.ts

@@ -0,0 +1,92 @@
+import { ErrorOptions, IMiddleware, InvalidUsageErrorBase } from "@unikvs/core";
+//#region ../src/errors.d.ts
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-set-not-allowed)
+ */
+type ReadOnlySetNotAllowedErrorMeta = {
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-set-not-allowed)
+   */
+  readonly key: string;
+};
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-set-not-allowed)
+ */
+type ReadOnlySetNotAllowedErrorArgs = ErrorOptions & ReadOnlySetNotAllowedErrorMeta;
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-set-not-allowed)
+ */
+export declare class ReadOnlySetNotAllowedError extends InvalidUsageErrorBase<ReadOnlySetNotAllowedErrorMeta> {
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-set-not-allowed)
+   */
+  constructor(args: ReadOnlySetNotAllowedErrorArgs);
+}
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-delete-not-allowed)
+ */
+type ReadOnlyDeleteNotAllowedErrorMeta = {
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-delete-not-allowed)
+   */
+  readonly key: string;
+};
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-delete-not-allowed)
+ */
+type ReadOnlyDeleteNotAllowedErrorArgs = ErrorOptions & ReadOnlyDeleteNotAllowedErrorMeta;
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-delete-not-allowed)
+ */
+export declare class ReadOnlyDeleteNotAllowedError extends InvalidUsageErrorBase<ReadOnlyDeleteNotAllowedErrorMeta> {
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-delete-not-allowed)
+   */
+  constructor(args: ReadOnlyDeleteNotAllowedErrorArgs);
+}
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-clear-not-allowed)
+ */
+export declare class ReadOnlyClearNotAllowedError extends InvalidUsageErrorBase<undefined> {
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-clear-not-allowed)
+   */
+  constructor(options?: ErrorOptions);
+}
+//#endregion
+//#region ../src/readonly.d.ts
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#readonly)
+ */
+type ReadOnlyOptions = {
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#readonly-allow-delete)
+   */
+  readonly allowDelete?: boolean | undefined;
+};
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#readonly)
+ */
+declare class ReadOnly implements IMiddleware {
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#readonly)
+   */
+  readonly name: string;
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#readonly)
+   */
+  readonly allowDelete: boolean;
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#readonly)
+   */
+  constructor(options?: ReadOnlyOptions);
+  get isOpen(): boolean;
+  encode(c: IMiddleware.EncodeContext, _next: IMiddleware.INext): Promise<void>;
+  decode(c: IMiddleware.DecodeContext, next: IMiddleware.INext): Promise<void>;
+  encodeStream(c: IMiddleware.EncodeStreamContext, _next: IMiddleware.INext): Promise<void>;
+  decodeStream(c: IMiddleware.DecodeStreamContext, next: IMiddleware.INext): Promise<void>;
+  use(c: IMiddleware.UseContext, next: IMiddleware.INext): Promise<void>;
+}
+//#endregion
+export { ReadOnly, type ReadOnlyDeleteNotAllowedErrorArgs, type ReadOnlyDeleteNotAllowedErrorMeta, type ReadOnlyOptions, type ReadOnlySetNotAllowedErrorArgs, type ReadOnlySetNotAllowedErrorMeta };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/errors.ts","../src/readonly.ts"],"mappings":";;;;;KAKY;;;;WAID;;;;;KAMC,iCAAiC,eAAe;;;;qBAK/C,mCAAmC,sBAAsB;;;;EAQpE,YAAmB,MAAM;;;;;KAoBf;;;;WAID;;;;;KAMC,oCAAoC,eAAe;;;;qBAKlD,sCAAsC,sBAAsB;;;;EAQvE,YAAmB,MAAM;;;;;qBAsBd,qCAAqC;;;;EAQhD,YAAmB,UAAU;;;;;;;KC1FnB;;;;WAID;;;;;cAMU,oBAAoB;;;;WAIvB;;;;WAKA;;;;EAKhB,YAAmB,UAAU;MAIlB;EAIX,OAAoB,GAAG,YAAY,eAAe,OAAO,YAAY,QAAQ;EAI7E,OAAoB,GAAG,YAAY,eAAe,MAAM,YAAY,QAAQ;EAM5E,aACE,GAAG,YAAY,qBACf,OAAO,YAAY,QAClB;EAIH,aACE,GAAG,YAAY,qBACf,MAAM,YAAY,QACjB;EAMH,IAAiB,GAAG,YAAY,YAAY,MAAM,YAAY,QAAQ"}

package/dist/index.js

@@ -0,0 +1,97 @@
+import { InvalidUsageErrorBase, setErrorMessage } from "@unikvs/core";
+//#region ../src/errors.ts
+var _ReadOnlySetNotAllowedError;
+var _ReadOnlyDeleteNotAllowedError;
+var _ReadOnlyClearNotAllowedError;
+/**
+* [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-set-not-allowed)
+*/
+var ReadOnlySetNotAllowedError = class extends InvalidUsageErrorBase {
+	/**
+	* [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-set-not-allowed)
+	*/
+	constructor(args) {
+		const { key, ...options } = args;
+		super({ key }, ({ key: messageKey }) => `ReadOnly.set cannot write key ${JSON.stringify(messageKey)}.`, options);
+	}
+};
+_ReadOnlySetNotAllowedError = ReadOnlySetNotAllowedError;
+_ReadOnlySetNotAllowedError.prototype.name = "ReadOnlySetNotAllowedError";
+setErrorMessage(ReadOnlySetNotAllowedError, ({ key }) => `ReadOnly.set は読み取り専用のためキー ${JSON.stringify(key)} に書き込めません。`, "ja");
+/**
+* [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-delete-not-allowed)
+*/
+var ReadOnlyDeleteNotAllowedError = class extends InvalidUsageErrorBase {
+	/**
+	* [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-delete-not-allowed)
+	*/
+	constructor(args) {
+		const { key, ...options } = args;
+		super({ key }, ({ key: messageKey }) => `ReadOnly.delete with allowDelete false cannot delete key ${JSON.stringify(messageKey)}.`, options);
+	}
+};
+_ReadOnlyDeleteNotAllowedError = ReadOnlyDeleteNotAllowedError;
+_ReadOnlyDeleteNotAllowedError.prototype.name = "ReadOnlyDeleteNotAllowedError";
+setErrorMessage(ReadOnlyDeleteNotAllowedError, ({ key }) => `ReadOnly.delete は allowDelete が false のためキー ${JSON.stringify(key)} を削除できません。`, "ja");
+/**
+* [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-clear-not-allowed)
+*/
+var ReadOnlyClearNotAllowedError = class extends InvalidUsageErrorBase {
+	/**
+	* [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-clear-not-allowed)
+	*/
+	constructor(options) {
+		super("ReadOnly.clear with allowDelete false cannot delete all data.", options);
+	}
+};
+_ReadOnlyClearNotAllowedError = ReadOnlyClearNotAllowedError;
+_ReadOnlyClearNotAllowedError.prototype.name = "ReadOnlyClearNotAllowedError";
+setErrorMessage(ReadOnlyClearNotAllowedError, "ReadOnly.clear は allowDelete が false のため全件を削除できません。", "ja");
+//#endregion
+//#region ../src/readonly.ts
+/**
+* [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#readonly)
+*/
+var ReadOnly = class {
+	/**
+	* [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#readonly)
+	*/
+	constructor(options) {
+		this.name = "ReadOnly";
+		this.allowDelete = Boolean(options?.allowDelete);
+	}
+	get isOpen() {
+		return true;
+	}
+	async encode(c, _next) {
+		throw new ReadOnlySetNotAllowedError({ key: c.key });
+	}
+	async decode(c, next) {
+		c.destination = c.source;
+		await next();
+	}
+	async encodeStream(c, _next) {
+		throw new ReadOnlySetNotAllowedError({ key: c.key });
+	}
+	async decodeStream(c, next) {
+		c.destination = c.source;
+		await next();
+	}
+	async use(c, next) {
+		switch (c.action) {
+			case "set": throw new ReadOnlySetNotAllowedError({ key: c.key });
+			case "get":
+			case "has":
+			case "stream": break;
+			case "delete":
+				if (!this.allowDelete) throw new ReadOnlyDeleteNotAllowedError({ key: c.key });
+				break;
+			case "clear": if (!this.allowDelete) throw new ReadOnlyClearNotAllowedError();
+		}
+		await next();
+	}
+};
+//#endregion
+export { ReadOnly, ReadOnlyClearNotAllowedError, ReadOnlyDeleteNotAllowedError, ReadOnlySetNotAllowedError };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/errors.ts","../src/readonly.ts"],"sourcesContent":["import { type ErrorOptions, setErrorMessage, InvalidUsageErrorBase } from \"@unikvs/core\";\n\n/**\n * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-set-not-allowed)\n */\nexport type ReadOnlySetNotAllowedErrorMeta = {\n  /**\n   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-set-not-allowed)\n   */\n  readonly key: string;\n};\n\n/**\n * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-set-not-allowed)\n */\nexport type ReadOnlySetNotAllowedErrorArgs = ErrorOptions & ReadOnlySetNotAllowedErrorMeta;\n\n/**\n * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-set-not-allowed)\n */\nexport class ReadOnlySetNotAllowedError extends InvalidUsageErrorBase<ReadOnlySetNotAllowedErrorMeta> {\n  static {\n    this.prototype.name = \"ReadOnlySetNotAllowedError\";\n  }\n\n  /**\n   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-set-not-allowed)\n   */\n  public constructor(args: ReadOnlySetNotAllowedErrorArgs) {\n    const { key, ...options } = args;\n    const meta: ReadOnlySetNotAllowedErrorMeta = { key };\n    super(\n      meta,\n      ({ key: messageKey }) => `ReadOnly.set cannot write key ${JSON.stringify(messageKey)}.`,\n      options,\n    );\n  }\n}\n\nsetErrorMessage(\n  ReadOnlySetNotAllowedError,\n  ({ key }) => `ReadOnly.set は読み取り専用のためキー ${JSON.stringify(key)} に書き込めません。`,\n  \"ja\",\n);\n\n/**\n * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-delete-not-allowed)\n */\nexport type ReadOnlyDeleteNotAllowedErrorMeta = {\n  /**\n   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-delete-not-allowed)\n   */\n  readonly key: string;\n};\n\n/**\n * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-delete-not-allowed)\n */\nexport type ReadOnlyDeleteNotAllowedErrorArgs = ErrorOptions & ReadOnlyDeleteNotAllowedErrorMeta;\n\n/**\n * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-delete-not-allowed)\n */\nexport class ReadOnlyDeleteNotAllowedError extends InvalidUsageErrorBase<ReadOnlyDeleteNotAllowedErrorMeta> {\n  static {\n    this.prototype.name = \"ReadOnlyDeleteNotAllowedError\";\n  }\n\n  /**\n   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-delete-not-allowed)\n   */\n  public constructor(args: ReadOnlyDeleteNotAllowedErrorArgs) {\n    const { key, ...options } = args;\n    const meta: ReadOnlyDeleteNotAllowedErrorMeta = { key };\n    super(\n      meta,\n      ({ key: messageKey }) =>\n        `ReadOnly.delete with allowDelete false cannot delete key ${JSON.stringify(messageKey)}.`,\n      options,\n    );\n  }\n}\n\nsetErrorMessage(\n  ReadOnlyDeleteNotAllowedError,\n  ({ key }) =>\n    `ReadOnly.delete は allowDelete が false のためキー ${JSON.stringify(key)} を削除できません。`,\n  \"ja\",\n);\n\n/**\n * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-clear-not-allowed)\n */\nexport class ReadOnlyClearNotAllowedError extends InvalidUsageErrorBase<undefined> {\n  static {\n    this.prototype.name = \"ReadOnlyClearNotAllowedError\";\n  }\n\n  /**\n   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-clear-not-allowed)\n   */\n  public constructor(options?: ErrorOptions) {\n    super(\"ReadOnly.clear with allowDelete false cannot delete all data.\", options);\n  }\n}\n\nsetErrorMessage(\n  ReadOnlyClearNotAllowedError,\n  \"ReadOnly.clear は allowDelete が false のため全件を削除できません。\",\n  \"ja\",\n);\n","import { type IMiddleware } from \"@unikvs/core\";\n\nimport {\n  ReadOnlySetNotAllowedError,\n  ReadOnlyClearNotAllowedError,\n  ReadOnlyDeleteNotAllowedError,\n} from \"./errors.js\";\n\n/**\n * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#readonly)\n */\nexport type ReadOnlyOptions = {\n  /**\n   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#readonly-allow-delete)\n   */\n  readonly allowDelete?: boolean | undefined;\n};\n\n/**\n * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#readonly)\n */\nexport default class ReadOnly implements IMiddleware {\n  /**\n   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#readonly)\n   */\n  public readonly name: string = \"ReadOnly\";\n\n  /**\n   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#readonly)\n   */\n  public readonly allowDelete: boolean;\n\n  /**\n   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#readonly)\n   */\n  public constructor(options?: ReadOnlyOptions) {\n    this.allowDelete = Boolean(options?.allowDelete);\n  }\n\n  public get isOpen(): boolean {\n    return true;\n  }\n\n  public async encode(c: IMiddleware.EncodeContext, _next: IMiddleware.INext): Promise<void> {\n    throw new ReadOnlySetNotAllowedError({ key: c.key });\n  }\n\n  public async decode(c: IMiddleware.DecodeContext, next: IMiddleware.INext): Promise<void> {\n    c.destination = c.source;\n\n    await next();\n  }\n\n  public async encodeStream(\n    c: IMiddleware.EncodeStreamContext,\n    _next: IMiddleware.INext,\n  ): Promise<void> {\n    throw new ReadOnlySetNotAllowedError({ key: c.key });\n  }\n\n  public async decodeStream(\n    c: IMiddleware.DecodeStreamContext,\n    next: IMiddleware.INext,\n  ): Promise<void> {\n    c.destination = c.source;\n\n    await next();\n  }\n\n  public async use(c: IMiddleware.UseContext, next: IMiddleware.INext): Promise<void> {\n    switch (c.action) {\n      case \"set\": {\n        throw new ReadOnlySetNotAllowedError({ key: c.key });\n      }\n\n      case \"get\":\n      case \"has\":\n      case \"stream\": {\n        break;\n      }\n\n      case \"delete\": {\n        // 削除が許可されていない場合は delete を拒否します。\n        if (!this.allowDelete) {\n          throw new ReadOnlyDeleteNotAllowedError({ key: c.key });\n        }\n\n        break;\n      }\n\n      case \"clear\": {\n        // 削除が許可されていない場合は clear を拒否します。\n        if (!this.allowDelete) {\n          throw new ReadOnlyClearNotAllowedError();\n        }\n\n        break;\n      }\n\n      default: {\n        break;\n      }\n    }\n\n    await next();\n  }\n}\n"],"mappings":";;;;;;;;AAoBA,IAAa,6BAAb,cAAgD,sBAAsD;;;;CAQpG,YAAmB,MAAsC;EACvD,MAAM,EAAE,KAAK,GAAG,YAAY;EAE5B,MACE,EAF6C,IAE1C,IACF,EAAE,KAAK,iBAAiB,iCAAiC,KAAK,UAAU,UAAU,EAAE,IACrF,OACF;CACF;AACF;;AAfI,4BAAK,UAAU,OAAO;AAiB1B,gBACE,6BACC,EAAE,UAAU,6BAA6B,KAAK,UAAU,GAAG,EAAE,aAC9D,IACF;;;;AAoBA,IAAa,gCAAb,cAAmD,sBAAyD;;;;CAQ1G,YAAmB,MAAyC;EAC1D,MAAM,EAAE,KAAK,GAAG,YAAY;EAE5B,MACE,EAFgD,IAE7C,IACF,EAAE,KAAK,iBACN,4DAA4D,KAAK,UAAU,UAAU,EAAE,IACzF,OACF;CACF;AACF;;AAhBI,+BAAK,UAAU,OAAO;AAkB1B,gBACE,gCACC,EAAE,UACD,+CAA+C,KAAK,UAAU,GAAG,EAAE,aACrE,IACF;;;;AAKA,IAAa,+BAAb,cAAkD,sBAAiC;;;;CAQjF,YAAmB,SAAwB;EACzC,MAAM,iEAAiE,OAAO;CAChF;AACF;;AATI,8BAAK,UAAU,OAAO;AAW1B,gBACE,8BACA,uDACA,IACF;;;;;;ACzFA,IAAqB,WAArB,MAAqD;;;;CAcnD,YAAmB,SAA2B;EAV9C,KAAgB,OAAe;EAW7B,KAAK,cAAc,QAAQ,SAAS,WAAW;CACjD;CAEA,IAAW,SAAkB;EAC3B,OAAO;CACT;CAEA,MAAa,OAAO,GAA8B,OAAyC;EACzF,MAAM,IAAI,2BAA2B,EAAE,KAAK,EAAE,IAAI,CAAC;CACrD;CAEA,MAAa,OAAO,GAA8B,MAAwC;EACxF,EAAE,cAAc,EAAE;EAElB,MAAM,KAAK;CACb;CAEA,MAAa,aACX,GACA,OACe;EACf,MAAM,IAAI,2BAA2B,EAAE,KAAK,EAAE,IAAI,CAAC;CACrD;CAEA,MAAa,aACX,GACA,MACe;EACf,EAAE,cAAc,EAAE;EAElB,MAAM,KAAK;CACb;CAEA,MAAa,IAAI,GAA2B,MAAwC;EAClF,QAAQ,EAAE,QAAV;GACE,KAAK,OACH,MAAM,IAAI,2BAA2B,EAAE,KAAK,EAAE,IAAI,CAAC;GAGrD,KAAK;GACL,KAAK;GACL,KAAK,UACH;GAGF,KAAK;IAEH,IAAI,CAAC,KAAK,aACR,MAAM,IAAI,8BAA8B,EAAE,KAAK,EAAE,IAAI,CAAC;IAGxD;GAGF,KAAK,SAEH,IAAI,CAAC,KAAK,aACR,MAAM,IAAI,6BAA6B;EAS7C;EAEA,MAAM,KAAK;CACb;AACF"}

package/package.json

@@ -1,10 +1,47 @@
 {
   "name": "@unikvs/readonly",
-  "version": "0.0.0",
-  "description": "OIDC trusted publishing setup package for @unikvs/readonly",
-  "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
-}
+  "version": "0.0.13",
+  "description": "Transformer plugin that rejects writes and allows reads.",
+  "homepage": "https://tai-kun.github.io/unikvs/",
+  "license": "MIT",
+  "repository": {
+    "url": "https://github.com/tai-kun/unikvs",
+    "directory": "packages/readonly"
+  },
+  "files": [
+    "dist",
+    "src",
+    "package.json",
+    "LICENSE",
+    "README.md"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "dependencies": {
+    "@unikvs/core": "0.0.13"
+  },
+  "devDependencies": {
+    "@unikvs/memory": "0.0.13",
+    "@unikvs/testing": "0.0.0",
+    "@vitest/browser-playwright": "5.0.5",
+    "@vitest/coverage-istanbul": "5.0.5",
+    "@vitest/coverage-v8": "5.0.5",
+    "playwright": "1.64.1",
+    "unikvs": "0.0.13",
+    "valibot": "1.5.0",
+    "vite-plus": "1.3.0"
+  },
+  "peerDependencies": {
+    "@logtape/logtape": "^2.0.0"
+  },
+  "readme": "README.md",
+  "scripts": {
+    "build": "vp -C .config pack"
+  }
+}

package/src/errors.ts

@@ -0,0 +1,111 @@
+import { type ErrorOptions, setErrorMessage, InvalidUsageErrorBase } from "@unikvs/core";
+
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-set-not-allowed)
+ */
+export type ReadOnlySetNotAllowedErrorMeta = {
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-set-not-allowed)
+   */
+  readonly key: string;
+};
+
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-set-not-allowed)
+ */
+export type ReadOnlySetNotAllowedErrorArgs = ErrorOptions & ReadOnlySetNotAllowedErrorMeta;
+
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-set-not-allowed)
+ */
+export class ReadOnlySetNotAllowedError extends InvalidUsageErrorBase<ReadOnlySetNotAllowedErrorMeta> {
+  static {
+    this.prototype.name = "ReadOnlySetNotAllowedError";
+  }
+
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-set-not-allowed)
+   */
+  public constructor(args: ReadOnlySetNotAllowedErrorArgs) {
+    const { key, ...options } = args;
+    const meta: ReadOnlySetNotAllowedErrorMeta = { key };
+    super(
+      meta,
+      ({ key: messageKey }) => `ReadOnly.set cannot write key ${JSON.stringify(messageKey)}.`,
+      options,
+    );
+  }
+}
+
+setErrorMessage(
+  ReadOnlySetNotAllowedError,
+  ({ key }) => `ReadOnly.set は読み取り専用のためキー ${JSON.stringify(key)} に書き込めません。`,
+  "ja",
+);
+
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-delete-not-allowed)
+ */
+export type ReadOnlyDeleteNotAllowedErrorMeta = {
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-delete-not-allowed)
+   */
+  readonly key: string;
+};
+
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-delete-not-allowed)
+ */
+export type ReadOnlyDeleteNotAllowedErrorArgs = ErrorOptions & ReadOnlyDeleteNotAllowedErrorMeta;
+
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-delete-not-allowed)
+ */
+export class ReadOnlyDeleteNotAllowedError extends InvalidUsageErrorBase<ReadOnlyDeleteNotAllowedErrorMeta> {
+  static {
+    this.prototype.name = "ReadOnlyDeleteNotAllowedError";
+  }
+
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-delete-not-allowed)
+   */
+  public constructor(args: ReadOnlyDeleteNotAllowedErrorArgs) {
+    const { key, ...options } = args;
+    const meta: ReadOnlyDeleteNotAllowedErrorMeta = { key };
+    super(
+      meta,
+      ({ key: messageKey }) =>
+        `ReadOnly.delete with allowDelete false cannot delete key ${JSON.stringify(messageKey)}.`,
+      options,
+    );
+  }
+}
+
+setErrorMessage(
+  ReadOnlyDeleteNotAllowedError,
+  ({ key }) =>
+    `ReadOnly.delete は allowDelete が false のためキー ${JSON.stringify(key)} を削除できません。`,
+  "ja",
+);
+
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-clear-not-allowed)
+ */
+export class ReadOnlyClearNotAllowedError extends InvalidUsageErrorBase<undefined> {
+  static {
+    this.prototype.name = "ReadOnlyClearNotAllowedError";
+  }
+
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#error-read-only-clear-not-allowed)
+   */
+  public constructor(options?: ErrorOptions) {
+    super("ReadOnly.clear with allowDelete false cannot delete all data.", options);
+  }
+}
+
+setErrorMessage(
+  ReadOnlyClearNotAllowedError,
+  "ReadOnly.clear は allowDelete が false のため全件を削除できません。",
+  "ja",
+);

package/src/index.ts

@@ -0,0 +1,14 @@
+export type {
+  ReadOnlySetNotAllowedErrorArgs,
+  ReadOnlySetNotAllowedErrorMeta,
+  ReadOnlyDeleteNotAllowedErrorArgs,
+  ReadOnlyDeleteNotAllowedErrorMeta,
+} from "./errors.js";
+export {
+  ReadOnlySetNotAllowedError,
+  ReadOnlyClearNotAllowedError,
+  ReadOnlyDeleteNotAllowedError,
+} from "./errors.js";
+
+export type * from "./readonly.js";
+export { default as ReadOnly } from "./readonly.js";

package/src/readonly.ts

@@ -0,0 +1,107 @@
+import { type IMiddleware } from "@unikvs/core";
+
+import {
+  ReadOnlySetNotAllowedError,
+  ReadOnlyClearNotAllowedError,
+  ReadOnlyDeleteNotAllowedError,
+} from "./errors.js";
+
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#readonly)
+ */
+export type ReadOnlyOptions = {
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#readonly-allow-delete)
+   */
+  readonly allowDelete?: boolean | undefined;
+};
+
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#readonly)
+ */
+export default class ReadOnly implements IMiddleware {
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#readonly)
+   */
+  public readonly name: string = "ReadOnly";
+
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#readonly)
+   */
+  public readonly allowDelete: boolean;
+
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/readonly#readonly)
+   */
+  public constructor(options?: ReadOnlyOptions) {
+    this.allowDelete = Boolean(options?.allowDelete);
+  }
+
+  public get isOpen(): boolean {
+    return true;
+  }
+
+  public async encode(c: IMiddleware.EncodeContext, _next: IMiddleware.INext): Promise<void> {
+    throw new ReadOnlySetNotAllowedError({ key: c.key });
+  }
+
+  public async decode(c: IMiddleware.DecodeContext, next: IMiddleware.INext): Promise<void> {
+    c.destination = c.source;
+
+    await next();
+  }
+
+  public async encodeStream(
+    c: IMiddleware.EncodeStreamContext,
+    _next: IMiddleware.INext,
+  ): Promise<void> {
+    throw new ReadOnlySetNotAllowedError({ key: c.key });
+  }
+
+  public async decodeStream(
+    c: IMiddleware.DecodeStreamContext,
+    next: IMiddleware.INext,
+  ): Promise<void> {
+    c.destination = c.source;
+
+    await next();
+  }
+
+  public async use(c: IMiddleware.UseContext, next: IMiddleware.INext): Promise<void> {
+    switch (c.action) {
+      case "set": {
+        throw new ReadOnlySetNotAllowedError({ key: c.key });
+      }
+
+      case "get":
+      case "has":
+      case "stream": {
+        break;
+      }
+
+      case "delete": {
+        // 削除が許可されていない場合は delete を拒否します。
+        if (!this.allowDelete) {
+          throw new ReadOnlyDeleteNotAllowedError({ key: c.key });
+        }
+
+        break;
+      }
+
+      case "clear": {
+        // 削除が許可されていない場合は clear を拒否します。
+        if (!this.allowDelete) {
+          throw new ReadOnlyClearNotAllowedError();
+        }
+
+        break;
+      }
+
+      default: {
+        break;
+      }
+    }
+
+    await next();
+  }
+}