diff --git a/AGENTS.md b/AGENTS.md index 9454e6e9..f48714ef 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -32,7 +32,7 @@ Apps (`apps/`): - `frontend` — **Next.js (App Router) + React**. Runs on port `4200`. Tailwind 3, Sentry-instrumented. - `extension` — browser extension. - `commands` — CLI commands. -- `sdk` — published SDK (`@reaatech/postmill-sdk`). +- `sdk` — published SDK (`@postmill-ai/postmill-sdk`). Libraries (`libraries/`): - `nestjs-libraries` — the bulk of shared server logic, Prisma schema, and repositories. **Most @@ -276,7 +276,7 @@ The deep per-subsystem detail lives in `docs/`. Follow the pointer rather than d | Analytics | Persisted daily snapshots, rollup/retention, best-time, recommendations | `docs/developer-docs/analytics-api.md` | | Data model / schema | Prisma models, migrations | `docs/developer-docs/data-model.md`, `docs/developer-docs/database.md` | | Webhooks | Event dispatch (SSRF-safe) | `docs/developer-docs/webhooks.md` | -| Public API / SDK | REST public API + `@reaatech/postmill-sdk` | `docs/developer-docs/public-api.md`, `docs/developer-docs/sdk.md` | +| Public API / SDK | REST public API + `@postmill-ai/postmill-sdk` | `docs/developer-docs/public-api.md`, `docs/developer-docs/sdk.md` | | Media studios / Designer | 46 media tools — Designer (Konva) + AI Designer + 38 provider studios + 6 stock browsers | `docs/user-guide/media/index.md`, `docs/developer-docs/designer.md` | | Campaigns | Campaign Hub — tagged items, UTM, approvals, goals, share reports, discussion | `docs/user-guide/campaigns.md` | | RBAC / team | Roles, permission catalog, sessions | `docs/user-guide/team-and-roles.md` | diff --git a/README.md b/README.md index 7bec30ef..96b3e903 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ Self-hosted, bring-your-own-key AI across 25+ providers, 36+ channels, and 46 built-in media tools — an open-source alternative to Buffer, Hootsuite, and Sprout Social. Postmill is built for agencies, teams, and multi-brand operators who want to schedule everywhere, generate on-brand content with their own AI keys, and own their entire stack. -**[Website](https://postmill.ai)** · **[Docs](https://docs.postmill.ai)** · **[Quick Start](#-quick-start)** · **[Node SDK (`@reaatech/postmill-sdk`)](https://www.npmjs.com/package/@reaatech/postmill-sdk)** · **[Public API](https://docs.postmill.ai)** +**[Website](https://postmill.ai)** · **[Docs](https://docs.postmill.ai)** · **[Quick Start](#-quick-start)** · **[Node SDK (`@postmill-ai/postmill-sdk`)](https://www.npmjs.com/package/@postmill-ai/postmill-sdk)** · **[Public API](https://docs.postmill.ai)** --- @@ -90,7 +90,7 @@ The frontend runs on port `4200`. For the full setup, configuration reference, a ## 🔗 Automation & integrations -Postmill exposes a full **Public API** for programmatic scheduling, analytics, and channel management, an **MCP** surface for AI agents, and an official Node SDK — [`@reaatech/postmill-sdk`](https://www.npmjs.com/package/@reaatech/postmill-sdk). The Public API is compatible with low-code automation platforms such as n8n, Make, and Zapier, so you can wire Postmill into your existing workflows. See the [API docs](https://docs.postmill.ai) to get started. +Postmill exposes a full **Public API** for programmatic scheduling, analytics, and channel management, an **MCP** surface for AI agents, and an official Node SDK — [`@postmill-ai/postmill-sdk`](https://www.npmjs.com/package/@postmill-ai/postmill-sdk). The Public API is compatible with low-code automation platforms such as n8n, Make, and Zapier, so you can wire Postmill into your existing workflows. See the [API docs](https://docs.postmill.ai) to get started. ## 🛠️ Tech stack diff --git a/SECURITY.md b/SECURITY.md index b794d9f4..82aa682b 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -11,7 +11,7 @@ We, at Postmill (reaatech), cover the following scopes for vulnerability disclos - The core repository for `postmill-app` (github.com/reaatech/postmill-app) - All `reaatech` repositories that are official components, tooling, or integrations of Postmill - Official Postmill container images published under `reaatech` on GHCR -- Official Postmill CLI tools and NPM packages (NPM org: @reaatech) +- Official Postmill CLI tools and NPM packages (NPM orgs: @postmill-ai and @reaatech) - Postmill-Cloud related infrastructure & services. (API, Frontend, Configurations etc.) - Plugins for Postmill maintained within the `reaatech` organization diff --git a/apps/sdk/README.md b/apps/sdk/README.md index e25228b3..1bfb7488 100644 --- a/apps/sdk/README.md +++ b/apps/sdk/README.md @@ -5,13 +5,13 @@ This is the NodeJS SDK for [Postmill](https://postmill.ai). You can start by installing the package: ```bash -npm install @reaatech/postmill-sdk +npm install @postmill-ai/postmill-sdk ``` ## Usage ```typescript -import Postmill from '@reaatech/postmill-sdk'; +import Postmill from '@postmill-ai/postmill-sdk'; const postmill = new Postmill('your api key', 'your self-hosted instance (optional)'); ``` diff --git a/apps/sdk/package.json b/apps/sdk/package.json index c4c24f01..117ca98c 100644 --- a/apps/sdk/package.json +++ b/apps/sdk/package.json @@ -1,5 +1,5 @@ { - "name": "@reaatech/postmill-sdk", + "name": "@postmill-ai/postmill-sdk", "version": "1.0.0", "description": "Official Node SDK for Postmill — schedule posts, manage channels, and drive the public API.", "main": "dist/index.js", @@ -28,11 +28,11 @@ "license": "AGPL-3.0", "repository": { "type": "git", - "url": "git+https://github.com/reaatech/postmill-app.git" + "url": "git+https://github.com/postmill-ai/postmill-app.git" }, "homepage": "https://postmill.ai", "bugs": { - "url": "https://github.com/reaatech/postmill-app/issues" + "url": "https://github.com/postmill-ai/postmill-app/issues" }, "devDependencies": { "@types/node": "^22.13.0", diff --git a/docs/developer-docs/architecture.md b/docs/developer-docs/architecture.md index 0083eadc..f3ee2f3e 100644 --- a/docs/developer-docs/architecture.md +++ b/docs/developer-docs/architecture.md @@ -30,7 +30,7 @@ postmill-app/ | `frontend` | Next.js App Router, React, Tailwind 3 | User-facing web app on port `4200`. | | `extension` | Browser extension | Chrome extension for cross-platform posting. | | `commands` | CLI | Command-line operations. | -| `sdk` | Node.js (published) | `@reaatech/postmill-sdk` for third-party integrations. | +| `sdk` | Node.js (published) | `@postmill-ai/postmill-sdk` for third-party integrations. | ### Libraries diff --git a/docs/developer-docs/index.md b/docs/developer-docs/index.md index 4081982c..06d997c1 100644 --- a/docs/developer-docs/index.md +++ b/docs/developer-docs/index.md @@ -44,7 +44,7 @@ Technical documentation for developers working on the Postmill codebase. This di | [MCP](./mcp.md) | Model Context Protocol server entrypoints, auth, rate limiting. | | [OAuth Apps](./oauth-apps.md) | OAuth application registration and management. | | [Plugs](./plugs.md) | Automation hooks (auto plugs and post plugs) for social channel providers. | -| [SDK](./sdk.md) | Official `@reaatech/postmill-sdk` Node.js SDK for the Public API. | +| [SDK](./sdk.md) | Official `@postmill-ai/postmill-sdk` Node.js SDK for the Public API. | | [Webhooks](./webhooks.md) | Webhook configuration, dispatch, and SSRF-safe delivery. | | [Adding a Provider](./adding-a-provider.md) | Step-by-step guide for adding a new social channel provider. | | [Adding an AI Adapter](./adding-an-ai-adapter.md) | Guide for implementing a new AI provider adapter. | diff --git a/docs/developer-docs/sdk.md b/docs/developer-docs/sdk.md index d116f2b2..08acad03 100644 --- a/docs/developer-docs/sdk.md +++ b/docs/developer-docs/sdk.md @@ -2,12 +2,12 @@ > Verified against v1.0.0 -The `@reaatech/postmill-sdk` is the official Node.js SDK for the Postmill Public API. It provides typed methods for creating posts, uploading media, listing integrations, and more. +The `@postmill-ai/postmill-sdk` is the official Node.js SDK for the Postmill Public API. It provides typed methods for creating posts, uploading media, listing integrations, and more. ## Installation ```bash -npm install @reaatech/postmill-sdk +npm install @postmill-ai/postmill-sdk ``` The SDK depends on `@gitroom/nestjs-libraries` for DTO types and uses the global `fetch` implementation (Node 18+, or a polyfill in older environments). @@ -15,7 +15,7 @@ The SDK depends on `@gitroom/nestjs-libraries` for DTO types and uses the global ## Quick start ```typescript -import Postmill from '@reaatech/postmill-sdk'; +import Postmill from '@postmill-ai/postmill-sdk'; const client = new Postmill('your-api-key'); @@ -124,8 +124,8 @@ deletePost(id: string): Promise ## Package details -- **Package name**: `@reaatech/postmill-sdk` -- **Version**: 0.1.0 +- **Package name**: `@postmill-ai/postmill-sdk` +- **Version**: 1.0.0 - **License**: AGPL-3.0 - **Build**: Uses `tsup` for bundling. - **Workspace dependency**: `@gitroom/nestjs-libraries`