peezy-tech/codex-flows
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Use peezy.tech npm scope

Browse source
This commit is contained in:
matamune 2026-05-12 15:34:46 +00:00
parent 46878f0e15
commit 46180a2865
24 changed files with 73 additions and 73 deletions
Download patch file Download diff file Expand all files Collapse all files

40
packages/codex-client/README.md
View file

@ -1,4 +1,4 @@
# @peezy-tech/codex-flows
# @peezy.tech/codex-flows
Workspace package for talking to `codex app-server`.
@ -6,24 +6,24 @@ This package owns the low-level JSON-RPC client, transports, framework-agnostic
## Exports
- `@peezy-tech/codex-flows`
- `@peezy.tech/codex-flows`
- `CodexAppServerClient`
- `CodexStdioTransport`
- `CodexWebSocketTransport`
- JSON-RPC helpers and types
- `@peezy-tech/codex-flows/browser`
- `@peezy.tech/codex-flows/browser`
- browser-safe `CodexAppServerClient`
- `CodexWebSocketTransport`
- JSON-RPC helpers and types
- `@peezy-tech/codex-flows/flows`
- `@peezy.tech/codex-flows/flows`
- `CodexFlowClient`
- `createCodexFlowClient`
- prompt/input normalization and optional turn completion waiting
- `@peezy-tech/codex-flows/rpc`
- `@peezy.tech/codex-flows/rpc`
- JSON-RPC message types and parsing helpers
- `@peezy-tech/codex-flows/generated`
- `@peezy.tech/codex-flows/generated`
- generated Codex app-server protocol types
- `@peezy-tech/codex-flows/generated/*`
- `@peezy.tech/codex-flows/generated/*`
- generated per-type modules
## Transports
@ -33,7 +33,7 @@ This package owns the low-level JSON-RPC client, transports, framework-agnostic
It can also connect to an existing WebSocket app-server when `CODEX_WORKSPACE_APP_SERVER_WS_URL` is set, or when `webSocketTransportOptions.url` is passed.
```ts
import { CodexAppServerClient } from "@peezy-tech/codex-flows";
import { CodexAppServerClient } from "@peezy.tech/codex-flows";
const client = new CodexAppServerClient();
await client.connect();
@ -46,7 +46,7 @@ client.close();
Browser entry:
```ts
import { CodexAppServerClient } from "@peezy-tech/codex-flows/browser";
import { CodexAppServerClient } from "@peezy.tech/codex-flows/browser";
const client = new CodexAppServerClient({
webSocketTransportOptions: { url: "ws://127.0.0.1:3585" },
@ -57,7 +57,7 @@ await client.connect();
Flow helpers:
```ts
import { createCodexFlowClient } from "@peezy-tech/codex-flows/flows";
import { createCodexFlowClient } from "@peezy.tech/codex-flows/flows";
const codex = createCodexFlowClient({
appServerUrl: "ws://127.0.0.1:3585",
@ -77,11 +77,11 @@ console.log(result.threadId, result.turnId);
## Scripts
```bash
bun run --filter @peezy-tech/codex-flows build
bun run --filter @peezy-tech/codex-flows check:types
bun run --filter @peezy-tech/codex-flows test
bun run --filter @peezy-tech/codex-flows pack:dry-run
bun run --filter @peezy-tech/codex-flows release:check
bun run --filter @peezy.tech/codex-flows build
bun run --filter @peezy.tech/codex-flows check:types
bun run --filter @peezy.tech/codex-flows test
bun run --filter @peezy.tech/codex-flows pack:dry-run
bun run --filter @peezy.tech/codex-flows release:check
```
`build` emits ESM JavaScript, source maps, and declaration files into `dist`.
@ -91,13 +91,13 @@ bun run --filter @peezy-tech/codex-flows release:check
After publishing, install the package from npm:
```bash
bun add @peezy-tech/codex-flows
bun add @peezy.tech/codex-flows
```
or:
```bash
npm install @peezy-tech/codex-flows
npm install @peezy.tech/codex-flows
```
## Publishing
@ -105,19 +105,19 @@ npm install @peezy-tech/codex-flows
Run the release check before publishing:
```bash
bun run --filter @peezy-tech/codex-flows release:check
bun run --filter @peezy.tech/codex-flows release:check
```
The release check runs package tests, type checking, a clean `dist` build, and `npm pack --dry-run`. Review the pack output before publishing so only `dist`, `README.md`, and package metadata are included.
For the first publish, use a human npm session or short-lived npm token from the public `peezy-tech/codex-flows` repo checkout. The `peezy-tech` npm organization/scope must exist first, and the publishing account or token must have write access to that scope:
For the first publish, use a human npm session or short-lived npm token from the public `peezy-tech/codex-flows` repo checkout. The `peezy.tech` npm organization/scope must exist first, and the publishing account or token must have write access to that scope:
```bash
cd packages/codex-client
npm publish --access public
```
After `@peezy-tech/codex-flows` exists on npm, configure trusted publishing for `.github/workflows/publish-codex-flows.yml` in the public `peezy-tech/codex-flows` repo. Future publishes should run through GitHub Actions without an npm token.
After `@peezy.tech/codex-flows` exists on npm, configure trusted publishing for `.github/workflows/publish-codex-flows.yml` in the public `peezy-tech/codex-flows` repo. Future publishes should run through GitHub Actions without an npm token.
## Notes

2
packages/codex-client/package.json
View file

@ -1,5 +1,5 @@
{
"name": "@peezy-tech/codex-flows",
"name": "@peezy.tech/codex-flows",
"version": "0.1.0",
"description": "Codex app-server JSON-RPC client, flow helpers, and generated protocol types.",
"type": "module",

10
packages/codex-client/scripts/smoke-exports.ts
View file

@ -1,9 +1,9 @@
const checks = [
["@peezy-tech/codex-flows", ["CodexAppServerClient"]],
["@peezy-tech/codex-flows/browser", ["CodexAppServerClient"]],
["@peezy-tech/codex-flows/flows", ["CodexFlowClient", "createCodexFlowClient"]],
["@peezy-tech/codex-flows/rpc", ["JsonRpcError"]],
["@peezy-tech/codex-flows/generated", ["v2"]],
["@peezy.tech/codex-flows", ["CodexAppServerClient"]],
["@peezy.tech/codex-flows/browser", ["CodexAppServerClient"]],
["@peezy.tech/codex-flows/flows", ["CodexFlowClient", "createCodexFlowClient"]],
["@peezy.tech/codex-flows/rpc", ["JsonRpcError"]],
["@peezy.tech/codex-flows/generated", ["v2"]],
] as const;
for (const [specifier, expectedExports] of checks) {

2
packages/codex-client/src/app-server/client.ts
View file

@ -40,7 +40,7 @@ export class CodexAppServerClient extends CodexEventEmitter {
super();
this.transport =
options.transport ?? defaultTransport(options);
this.#clientName = options.clientName ?? "@peezy-tech/codex-flows";
this.#clientName = options.clientName ?? "@peezy.tech/codex-flows";
this.#clientTitle = options.clientTitle ?? "Codex Client";
this.#clientVersion = options.clientVersion ?? "0.1.0";

2
packages/codex-client/src/app-server/flows.ts
View file

@ -391,7 +391,7 @@ function clientIdentityOptions(
"clientName" | "clientTitle" | "clientVersion"
> {
return compactUndefined({
clientName: options.clientName ?? "peezy-tech-codex-flows",
clientName: options.clientName ?? "peezy.tech-codex-flows",
clientTitle: options.clientTitle ?? "Codex Flows SDK",
clientVersion: options.clientVersion ?? "0.1.0",
});