@webnovel-proxy/core 0.0.0-stage → 0.0.1

package/README.md

@@ -1,3 +1,41 @@
-# Temporary Holding Version
+# @your-scope/core
 
-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.
+Browser- and Node-compatible shared utilities and Zod schemas.
+
+## Setup
+
+1. Replace `@your-scope/core` and the GitHub repository URL in `package.json`.
+2. Run `corepack enable` and `pnpm install`. Commit the generated `pnpm-lock.yaml`.
+3. Run `pnpm check`.
+
+## Usage
+
+```ts
+import { clamp, userSchema } from "@your-scope/core";
+import type { User } from "@your-scope/core";
+
+const value = clamp(15, 0, 10);
+const user: User = userSchema.parse({
+	id: "123e4567-e89b-42d3-a456-426614174000",
+	name: "Ada",
+	email: "ada@example.com",
+});
+```
+
+Both ESM and CommonJS are published. Consumers install `zod` transitively as a runtime dependency. Node-only utilities should live in a separate entry point/package; the main entry point must remain browser safe.
+
+## Trusted publishing setup
+
+1. The npm package must exist before you can add a trusted publisher (bootstrap the first release manually if required). Register the package on npm under your chosen name/scope.
+2. In npmjs.com → package settings → Trusted publishing, register the GitHub owner/repo and workflow filename `publish.yml`. Enable **npm publish** permission.
+3. Ensure `package.json` repository.url exactly matches the GitHub repository. Use a GitHub-hosted runner.
+4. Publish a version by bumping `package.json` version, running `pnpm install` (commit the updated lockfile), merging it to `main`, then tagging that commit:
+
+```sh
+git tag v0.1.0
+git push origin v0.1.0
+```
+
+A pushed `vX.Y.Z` tag invokes `.github/workflows/publish.yml`, checks the manifest version, runs checks, and publishes with short-lived OIDC credentials (no `NPM_TOKEN`). Protect release tags and restrict who can edit the workflow. npm CLI >=11.5.1 and Node >=22.14 are required for trusted publishing.
+
+Note: Before the first GitHub release, replace the package name and GitHub URL and configure npm's trusted publisher. The initial manual bootstrap publish may be needed depending on package availability and npm onboarding.

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+import * as z from "zod";
+export declare const Test: z.ZodObject<{
+  id: z.ZodUUID;
+}, z.core.$strip>;
+export type Test = z.infer<typeof Test>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,2 @@
+import*as e from"zod";const t=e.object({id:e.uuid()});export{t as Test};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["z","Test"],"sources":["../src/schemas/test.ts"],"sourcesContent":["import * as z from \"zod\";\n\nexport const Test = z.object({\n\tid: z.uuid(),\n});\nexport type Test = z.infer<typeof Test>;\n"],"mappings":"A,sBAEA,MAAaC,EAAOD,EAAE,OAAO,CAC5B,GAAIA,EAAE,KAAK,CACZ,CAAC,E"}

package/package.json

@@ -1,6 +1,62 @@
 {
   "name": "@webnovel-proxy/core",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.0.1",
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "engines": {
+    "node": ">=26"
+  },
+  "devEngines": {
+    "packageManager": {
+      "name": "pnpm",
+      "version": ">=12.0.0 <13.0.0",
+      "onFail": "error"
+    },
+    "runtime": {
+      "name": "node",
+      "version": "26.13.0",
+      "onFail": "error"
+    }
+  },
+  "imports": {
+    "#/*": "./src/*"
+  },
+  "dependencies": {
+    "zod": "^4.6.7"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.5",
+    "@types/node": "^26.6.6",
+    "eslint": "^10.14.0",
+    "globals": "^17.13.0",
+    "prettier": "^3.9.10",
+    "tsdown": "^0.23.4",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.72.1"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint --cache .",
+    "format": "prettier --write --cache .",
+    "format:check": "prettier --check src",
+    "check": "pnpm lint && pnpm typecheck && pnpm format:check && pnpm build"
+  }
 }