negirau 0.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 2026 Shinsuke Mori
+
+   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,57 @@
+# negirau
+
+Typed TypeScript client for the [Negirau](https://negirau.com) public API (read-only, anonymous, CORS-open).
+
+Hand-written around resource namespaces, a typed error hierarchy, and retries with exponential backoff — dependency-free, and kept honest by contract tests: they load the service's build-time-generated `openapi.json` and prove that every operation is covered, that requests only use spec-declared parameters, and that spec-conformant payloads satisfy the exported types.
+Drift between the API and this client fails CI — the same guarantee code generation gave, without generated code.
+
+## Install
+
+```
+npm install negirau
+```
+
+## Usage
+
+```ts
+import { Negirau } from "negirau";
+
+const client = new Negirau();
+
+const found = await client.subjects.list({ q: "消防", limit: 5 }); // free-text name search
+for (const subject of found.subjects) {
+  console.log(subject.id, subject.name);
+}
+
+const nearby = await client.subjects.listNear(35.64, 139.65, { radius: 3000 });
+
+const reactions = await client.subjects.reactions.retrieve("0e6f9b3a-6b1e-4b8a-9a6a-1c2d3e4f5a6b", {
+  period: "2026-W33", // or a month ("2026-08"), a year ("2026"), or "all"
+});
+console.log(reactions.total); // a display value: exact up to 100, "100+" beyond
+```
+
+Errors and retries:
+
+```ts
+import { Negirau, NotFoundError } from "negirau";
+
+const client = new Negirau({ maxRetries: 2 }); // 408/409/429/5xx retry with exponential backoff
+
+try {
+  await client.subjects.retrieve("no-such-subject");
+} catch (error) {
+  if (error instanceof NotFoundError) {
+    console.error(error.statusCode, error.code); // 404 not_found
+  }
+}
+```
+
+## Notes
+
+- Counts are display values by design: exact up to 100, `"100+"` beyond, and never rankings — no API returns unbounded exact numbers.
+- There are no bulk dumps: resolve names with `client.subjects.list({ q })` (server-side trigram search, Japanese and English substrings).
+
+## License
+
+Apache-2.0.

package/dist/index.d.mts

@@ -0,0 +1,129 @@
+//#region src/core.d.ts
+interface TransportOptions {
+  baseURL: string;
+  timeoutMs: number;
+  maxRetries: number;
+  fetch: typeof fetch;
+}
+//#endregion
+//#region src/types.d.ts
+/** Public response types, contract-tested against the spec (tests/contract.test.ts). */
+/** Display value — the only count representation the API ever exposes: exact up to 100, "100+" beyond. */
+type DisplayValue = string;
+/** A recipient of appreciation — a name, optionally with a location and an active period. */
+interface Subject {
+  /** Public identifier; the page URL is https://negirau.com/subjects/{id}. */
+  id: string;
+  name: string;
+  lat: number | null;
+  lng: number | null;
+}
+/** A subject returned by a near search, with its distance from the query point. */
+interface NearbySubject extends Subject {
+  distance_m: number;
+}
+/** One page of a cursor-paginated subject listing. */
+interface SubjectPage {
+  subjects: Subject[];
+  next_cursor: string | null;
+}
+interface SubjectListParams {
+  /** Free-text name search: 1-2 characters match as a name prefix, 3+ anywhere in the name. */
+  q?: string;
+  /** Page size (1-100, default 20). */
+  limit?: number;
+  cursor?: string;
+}
+/** Reaction display values for one subject over a period. */
+interface ReactionsSummary {
+  id: string;
+  /** The aggregation period as requested ('2026-W33', '2026-08', '2026', or 'all'). */
+  period: string;
+  total: DisplayValue;
+  by_type: Record<string, DisplayValue>;
+}
+//#endregion
+//#region src/resources/subjects.d.ts
+/** Sub-resource: `client.subjects.reactions.retrieve(id)`. */
+declare class Reactions {
+  #private;
+  constructor(transport: TransportOptions);
+  /** Reaction display values for a subject; `period` is an ISO week (2026-W33), month (2026-08), year (2026), or 'all'. */
+  retrieve(id: string, params?: {
+    period?: string;
+  }): Promise<ReactionsSummary>;
+}
+/** The recipients of appreciation. */
+declare class Subjects {
+  #private;
+  readonly reactions: Reactions;
+  constructor(transport: TransportOptions);
+  /** List/search subjects (cursor-paginated); `q` is free-text name search. */
+  list(params?: SubjectListParams): Promise<SubjectPage>;
+  /** Find spatial subjects near a point, closest first (radius in meters). */
+  listNear(lat: number, lng: number, params?: {
+    radius?: number;
+    limit?: number;
+  }): Promise<NearbySubject[]>;
+  /** Fetch one subject by its public identifier. */
+  retrieve(id: string): Promise<Subject>;
+}
+//#endregion
+//#region src/error.d.ts
+/** Exception hierarchy. */
+/** Base class for every error this SDK throws. */
+declare class NegirauError extends Error {}
+/** The request never produced a response (DNS, TLS, refused, ...). */
+declare class APIConnectionError extends NegirauError {
+  constructor(message?: string, options?: {
+    cause?: unknown;
+  });
+}
+/** The request timed out. */
+declare class APITimeoutError extends APIConnectionError {
+  constructor(options?: {
+    cause?: unknown;
+  });
+}
+/** A non-success HTTP response, with the API's `code` (e.g. "not_found"). */
+declare class APIStatusError extends NegirauError {
+  readonly statusCode: number;
+  /** Machine-readable code from the API, e.g. "not_found" or "invalid_query". */
+  readonly code: string;
+  constructor(statusCode: number, code: string);
+}
+/** HTTP 400. */
+declare class BadRequestError extends APIStatusError {}
+/** HTTP 404. */
+declare class NotFoundError extends APIStatusError {}
+/** HTTP 429. */
+declare class RateLimitError extends APIStatusError {}
+/** HTTP 5xx. */
+declare class InternalServerError extends APIStatusError {}
+//#endregion
+//#region src/index.d.ts
+interface NegirauOptions {
+  /** Defaults to the production base, https://api.negirau.com/v1. */
+  baseURL?: string;
+  /** Per-request timeout in milliseconds (default 10 000). */
+  timeout?: number;
+  /** Retries for 408/409/429/5xx and network failures (default 2). */
+  maxRetries?: number;
+  /** Custom fetch implementation (tests, polyfills). */
+  fetch?: typeof fetch;
+}
+/**
+ * Entry point:
+ *
+ * ```ts
+ * import { Negirau } from "negirau";
+ * const client = new Negirau();
+ * const page = await client.subjects.list({ q: "消防" });
+ * ```
+ */
+declare class Negirau {
+  readonly subjects: Subjects;
+  constructor(options?: NegirauOptions);
+}
+//#endregion
+export { APIConnectionError, APIStatusError, APITimeoutError, BadRequestError, type DisplayValue, InternalServerError, type NearbySubject, Negirau, NegirauError, NegirauOptions, NotFoundError, RateLimitError, Reactions, type ReactionsSummary, type Subject, type SubjectListParams, type SubjectPage, Subjects };

package/dist/index.mjs

@@ -0,0 +1,180 @@
+//#region src/error.ts
+/** Exception hierarchy. */
+/** Base class for every error this SDK throws. */
+var NegirauError = class extends Error {};
+/** The request never produced a response (DNS, TLS, refused, ...). */
+var APIConnectionError = class extends NegirauError {
+	constructor(message = "Connection error.", options) {
+		super(message, options);
+		this.name = "APIConnectionError";
+	}
+};
+/** The request timed out. */
+var APITimeoutError = class extends APIConnectionError {
+	constructor(options) {
+		super("Request timed out.", options);
+		this.name = "APITimeoutError";
+	}
+};
+/** A non-success HTTP response, with the API's `code` (e.g. "not_found"). */
+var APIStatusError = class extends NegirauError {
+	statusCode;
+	/** Machine-readable code from the API, e.g. "not_found" or "invalid_query". */
+	code;
+	constructor(statusCode, code) {
+		super(`${statusCode}: ${code}`);
+		this.name = new.target.name;
+		this.statusCode = statusCode;
+		this.code = code;
+	}
+};
+/** HTTP 400. */
+var BadRequestError = class extends APIStatusError {};
+/** HTTP 404. */
+var NotFoundError = class extends APIStatusError {};
+/** HTTP 429. */
+var RateLimitError = class extends APIStatusError {};
+/** HTTP 5xx. */
+var InternalServerError = class extends APIStatusError {};
+const STATUS_CLASSES = {
+	400: BadRequestError,
+	404: NotFoundError,
+	429: RateLimitError
+};
+/** Build the most specific error class for a non-success response. */
+async function makeStatusError(response) {
+	const code = await response.json().then((body) => String(body.error ?? "unknown")).catch(() => "unknown");
+	return new (STATUS_CLASSES[response.status] ?? (response.status >= 500 ? InternalServerError : APIStatusError))(response.status, code);
+}
+const RETRYABLE_STATUS = /* @__PURE__ */ new Set([
+	408,
+	409,
+	429
+]);
+function shouldRetry(status) {
+	return RETRYABLE_STATUS.has(status) || status >= 500;
+}
+function backoffMs(attempt) {
+	return Math.min(500 * 2 ** attempt, 8e3);
+}
+function sleep(ms) {
+	return new Promise((resolve) => {
+		setTimeout(resolve, ms);
+	});
+}
+function queryString(params) {
+	const search = new URLSearchParams();
+	for (const [key, value] of Object.entries(params)) if (value !== void 0) search.set(key, String(value));
+	const encoded = search.toString();
+	return encoded === "" ? "" : `?${encoded}`;
+}
+/** One GET attempt; undefined means "retryable failure, back off and go again". */
+async function attempt(transport, url, last) {
+	const controller = new AbortController();
+	const timer = setTimeout(() => controller.abort(), transport.timeoutMs);
+	try {
+		return await transport.fetch(url, {
+			headers: { accept: "application/json" },
+			signal: controller.signal
+		});
+	} catch (cause) {
+		if (!last) return;
+		if (controller.signal.aborted) throw new APITimeoutError({ cause });
+		throw new APIConnectionError(void 0, { cause });
+	} finally {
+		clearTimeout(timer);
+	}
+}
+/** GET a spec-relative path with retries; resolves to the parsed JSON body. */
+async function get(transport, path, params = {}) {
+	const url = `${transport.baseURL}${path}${queryString(params)}`;
+	for (let tries = 0; tries <= transport.maxRetries; tries += 1) {
+		const last = tries === transport.maxRetries;
+		const response = await attempt(transport, url, last);
+		if (response) {
+			if (response.ok) return await response.json();
+			if (last || !shouldRetry(response.status)) throw await makeStatusError(response);
+			await response.body?.cancel();
+		}
+		await sleep(backoffMs(tries));
+	}
+	/* v8 ignore next 2 -- the loop always returns or throws */
+	throw new Error("unreachable");
+}
+//#endregion
+//#region src/resources/subjects.ts
+/** The `subjects` resource (`client.subjects.list()` etc.). */
+/** Sub-resource: `client.subjects.reactions.retrieve(id)`. */
+var Reactions = class {
+	#transport;
+	constructor(transport) {
+		this.#transport = transport;
+	}
+	/** Reaction display values for a subject; `period` is an ISO week (2026-W33), month (2026-08), year (2026), or 'all'. */
+	retrieve(id, params = {}) {
+		return get(this.#transport, `/subjects/${encodeURIComponent(id)}/reactions`, { period: params.period });
+	}
+};
+/** The recipients of appreciation. */
+var Subjects = class {
+	#transport;
+	reactions;
+	constructor(transport) {
+		this.#transport = transport;
+		this.reactions = new Reactions(transport);
+	}
+	/** List/search subjects (cursor-paginated); `q` is free-text name search. */
+	list(params = {}) {
+		return get(this.#transport, "/subjects", {
+			q: params.q,
+			limit: params.limit,
+			cursor: params.cursor
+		});
+	}
+	/** Find spatial subjects near a point, closest first (radius in meters). */
+	async listNear(lat, lng, params = {}) {
+		return (await get(this.#transport, "/subjects", {
+			near: `${lat},${lng}`,
+			radius: params.radius,
+			limit: params.limit
+		})).subjects;
+	}
+	/** Fetch one subject by its public identifier. */
+	retrieve(id) {
+		return get(this.#transport, `/subjects/${encodeURIComponent(id)}`);
+	}
+};
+//#endregion
+//#region src/index.ts
+/**
+* Hand-written, dependency-free client for the Negirau public API
+* (read-only, anonymous): resource namespaces, a typed error hierarchy,
+* and retries with exponential backoff.
+*
+* Conformance with the API's openapi.json is enforced by the contract tests in
+* tests/contract.test.ts — drift fails CI, the same guarantee code generation
+* gave, without generated code.
+*/
+/**
+* Entry point:
+*
+* ```ts
+* import { Negirau } from "negirau";
+* const client = new Negirau();
+* const page = await client.subjects.list({ q: "消防" });
+* ```
+*/
+var Negirau = class {
+	subjects;
+	constructor(options = {}) {
+		const transport = {
+			baseURL: options.baseURL ?? "https://api.negirau.com/v1",
+			timeoutMs: options.timeout ?? 1e4,
+			maxRetries: options.maxRetries ?? 2,
+			fetch: options.fetch ?? ((input, init) => fetch(input, init))
+		};
+		this.subjects = new Subjects(transport);
+	}
+};
+//#endregion
+export { APIConnectionError, APIStatusError, APITimeoutError, BadRequestError, InternalServerError, Negirau, NegirauError, NotFoundError, RateLimitError, Reactions, Subjects };

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "negirau",
+  "version": "0.0.0",
+  "description": "TypeScript client for the Negirau public API",
+  "keywords": [
+    "api",
+    "appreciation",
+    "client",
+    "gratitude",
+    "negirau"
+  ],
+  "homepage": "https://negirau.com",
+  "bugs": "https://github.com/sincekmori/negirau/issues",
+  "license": "Apache-2.0",
+  "author": "Shinsuke Mori <sincekmori@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sincekmori/negirau.git",
+    "directory": "packages/client-ts"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "scripts": {
+    "build": "tsdown",
+    "check": "tsc -p tsconfig.json --noEmit && tsc -p tsconfig.tests.json --noEmit && publint && attw --pack . --profile esm-only",
+    "test": "vitest run"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.5",
+    "@types/node": "^26.2.0",
+    "@vitest/coverage-v8": "^4.1.10",
+    "ajv": "^8.20.0",
+    "publint": "^0.3.23",
+    "tsdown": "^0.22.14",
+    "typescript": "^7.0.2",
+    "vitest": "^4.1.10"
+  },
+  "engines": {
+    "node": ">=22"
+  }
+}