@usejunior/safe-docx 0.0.1 → 0.1.1

package/README.md

@@ -1,45 +1,28 @@
 # @usejunior/safe-docx
 
-## ⚠️ IMPORTANT NOTICE ⚠️
+[![npm version](https://img.shields.io/npm/v/%40usejunior%2Fsafe-docx)](https://www.npmjs.com/package/@usejunior/safe-docx)
+[![CI](https://github.com/UseJunior/safe-docx/actions/workflows/ci.yml/badge.svg)](https://github.com/UseJunior/safe-docx/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/UseJunior/safe-docx/blob/main/LICENSE)
 
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
+Canonical npm install name for Safe Docx MCP workflows.
 
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
+Use this package when you want coding agents to perform surgical edits on existing Word `.docx` documents with formatting preservation.
 
-## Purpose
+## Install and Run
 
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@usejunior/safe-docx`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
+```bash
+npx -y @usejunior/safe-docx
+```
 
-## What is OIDC Trusted Publishing?
+Implementation is provided by `@usejunior/docx-mcp`; this package re-exports the public API and CLI entrypoint under the canonical name.
 
-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.
+## Scope
 
-## Setup Instructions
+`@usejunior/safe-docx` is focused on brownfield editing of existing `.docx` files.
 
-To properly configure OIDC trusted publishing for this package:
+If your primary use case is creating new documents from scratch, use generation-oriented packages such as [`docx`](https://www.npmjs.com/package/docx).
 
-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
+## Full Docs
 
-## 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**
+- `packages/docx-mcp/README.md`
+- `packages/docx-mcp/docs/tool-reference.generated.md`

package/bin/safe-docx.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+import { runCli } from '@usejunior/docx-mcp';
+
+runCli(process.argv).catch((err) => {
+  // eslint-disable-next-line no-console
+  console.error(err);
+  process.exit(1);
+});

package/index.d.ts

@@ -0,0 +1 @@
+export * from '@usejunior/docx-mcp';

package/index.js

@@ -0,0 +1 @@
+export * from '@usejunior/docx-mcp';

package/package.json

@@ -1,10 +1,68 @@
 {
   "name": "@usejunior/safe-docx",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @usejunior/safe-docx",
+  "version": "0.1.1",
+  "description": "Canonical npm package for the Safe Docx MCP server and CLI",
+  "type": "module",
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "default": "./index.js"
+    }
+  },
+  "scripts": {
+    "build": "node -e \"console.log('safe-docx wrapper package: no build step required')\"",
+    "lint": "node -e \"process.exit(0)\"",
+    "test": "npm run test:run",
+    "test:run": "npm run build -w @usejunior/docx-mcp && node ./bin/safe-docx.js --help > /dev/null",
+    "prepack": "npm run test:run"
+  },
+  "bin": {
+    "safe-docx": "./bin/safe-docx.js",
+    "safedocx": "./bin/safe-docx.js"
+  },
+  "dependencies": {
+    "@usejunior/docx-mcp": "^0.1.1"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/UseJunior/safe-docx"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "bin",
+    "index.js",
+    "index.d.ts",
+    "README.md"
+  ],
+  "license": "MIT",
   "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
+    "mcp",
+    "mcp-server",
+    "model-context-protocol",
+    "docx",
+    "word",
+    "document-editing",
+    "tracked-changes",
+    "document-comparison",
+    "ai",
+    "llm",
+    "formatting-preservation",
+    "ooxml",
+    "serverless",
+    "cloudflare-workers",
+    "edge",
+    "vercel"
+  ],
+  "homepage": "https://github.com/UseJunior/safe-docx/tree/main/packages/safe-docx",
+  "bugs": {
+    "url": "https://github.com/UseJunior/safe-docx/issues"
+  }
 }