Use peezy.tech npm scope
This commit is contained in:
parent
46878f0e15
commit
46180a2865
24 changed files with 73 additions and 73 deletions
8
.github/workflows/publish-codex-flows.yml
vendored
8
.github/workflows/publish-codex-flows.yml
vendored
|
|
@ -1,10 +1,10 @@
|
||||||
name: Publish @peezy-tech/codex-flows
|
name: Publish @peezy.tech/codex-flows
|
||||||
|
|
||||||
on:
|
on:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
inputs:
|
inputs:
|
||||||
confirm_package:
|
confirm_package:
|
||||||
description: "Type @peezy-tech/codex-flows to publish"
|
description: "Type @peezy.tech/codex-flows to publish"
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
|
|
||||||
|
|
@ -14,7 +14,7 @@ permissions:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
publish:
|
publish:
|
||||||
if: inputs.confirm_package == '@peezy-tech/codex-flows'
|
if: inputs.confirm_package == '@peezy.tech/codex-flows'
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
environment: npm-publish
|
environment: npm-publish
|
||||||
steps:
|
steps:
|
||||||
|
|
@ -39,7 +39,7 @@ jobs:
|
||||||
run: bun install --frozen-lockfile
|
run: bun install --frozen-lockfile
|
||||||
|
|
||||||
- name: Release check
|
- name: Release check
|
||||||
run: bun run --filter @peezy-tech/codex-flows release:check
|
run: bun run --filter @peezy.tech/codex-flows release:check
|
||||||
|
|
||||||
- name: Publish
|
- name: Publish
|
||||||
working-directory: packages/codex-client
|
working-directory: packages/codex-client
|
||||||
|
|
|
||||||
24
README.md
24
README.md
|
|
@ -59,7 +59,7 @@ bun run build
|
||||||
bun run test
|
bun run test
|
||||||
```
|
```
|
||||||
|
|
||||||
`bun run test` currently runs the `@peezy-tech/codex-flows` transport tests.
|
`bun run test` currently runs the `@peezy.tech/codex-flows` transport tests.
|
||||||
|
|
||||||
## Publishing
|
## Publishing
|
||||||
|
|
||||||
|
|
@ -67,17 +67,17 @@ The public home for this monorepo is `peezy-tech/codex-flows`. When seeding that
|
||||||
repo, copy this working tree without `.git`, initialize a fresh git history, and
|
repo, copy this working tree without `.git`, initialize a fresh git history, and
|
||||||
push it to the new public GitHub repo.
|
push it to the new public GitHub repo.
|
||||||
|
|
||||||
`@peezy-tech/codex-flows` is published from `packages/codex-client`.
|
`@peezy.tech/codex-flows` is published from `packages/codex-client`.
|
||||||
|
|
||||||
Before the first publish:
|
Before the first publish:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
bun run --filter @peezy-tech/codex-flows release:check
|
bun run --filter @peezy.tech/codex-flows release:check
|
||||||
```
|
```
|
||||||
|
|
||||||
Because the npm package does not exist yet, bootstrap the first version with a
|
Because the npm package does not exist yet, bootstrap the first version with a
|
||||||
human npm session or short-lived npm token from the public repo checkout. The
|
human npm session or short-lived npm token from the public repo checkout. The
|
||||||
`peezy-tech` npm organization/scope must exist first, and the publishing account
|
`peezy.tech` npm organization/scope must exist first, and the publishing account
|
||||||
or token must have write access to that scope:
|
or token must have write access to that scope:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
@ -87,7 +87,7 @@ npm publish --access public
|
||||||
|
|
||||||
After the package exists, configure npm trusted publishing for:
|
After the package exists, configure npm trusted publishing for:
|
||||||
|
|
||||||
- Package: `@peezy-tech/codex-flows`
|
- Package: `@peezy.tech/codex-flows`
|
||||||
- Repository: `peezy-tech/codex-flows`
|
- Repository: `peezy-tech/codex-flows`
|
||||||
- Workflow: `.github/workflows/publish-codex-flows.yml`
|
- Workflow: `.github/workflows/publish-codex-flows.yml`
|
||||||
- Environment: `npm-publish`
|
- Environment: `npm-publish`
|
||||||
|
|
@ -97,19 +97,19 @@ an npm token.
|
||||||
|
|
||||||
## Packages
|
## Packages
|
||||||
|
|
||||||
### `@peezy-tech/codex-flows`
|
### `@peezy.tech/codex-flows`
|
||||||
|
|
||||||
The low-level app-server client package. It exports:
|
The low-level app-server client package. It exports:
|
||||||
|
|
||||||
- `@peezy-tech/codex-flows`: Node/Bun entry with stdio and WebSocket transports.
|
- `@peezy.tech/codex-flows`: Node/Bun entry with stdio and WebSocket transports.
|
||||||
- `@peezy-tech/codex-flows/browser`: browser entry with WebSocket transport only.
|
- `@peezy.tech/codex-flows/browser`: browser entry with WebSocket transport only.
|
||||||
- `@peezy-tech/codex-flows/flows`: framework-agnostic helpers for app servers that want to start Codex-backed workflows.
|
- `@peezy.tech/codex-flows/flows`: framework-agnostic helpers for app servers that want to start Codex-backed workflows.
|
||||||
- `@peezy-tech/codex-flows/rpc`: JSON-RPC helpers and types.
|
- `@peezy.tech/codex-flows/rpc`: JSON-RPC helpers and types.
|
||||||
- `@peezy-tech/codex-flows/generated`: generated Codex app-server protocol types.
|
- `@peezy.tech/codex-flows/generated`: generated Codex app-server protocol types.
|
||||||
|
|
||||||
### `web`
|
### `web`
|
||||||
|
|
||||||
The browser app imports `@peezy-tech/codex-flows/browser`, opens a direct WebSocket
|
The browser app imports `@peezy.tech/codex-flows/browser`, opens a direct WebSocket
|
||||||
connection, lists threads, starts turns, interrupts running turns, and renders
|
connection, lists threads, starts turns, interrupts running turns, and renders
|
||||||
thread items and live app-server events.
|
thread items and live app-server events.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,7 @@
|
||||||
"test": "bun test test/*.test.ts"
|
"test": "bun test test/*.test.ts"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@peezy-tech/codex-flows": "workspace:*"
|
"@peezy.tech/codex-flows": "workspace:*"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/bun": "catalog:",
|
"@types/bun": "catalog:",
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
#!/usr/bin/env bun
|
#!/usr/bin/env bun
|
||||||
import { CodexAppServerClient } from "@peezy-tech/codex-flows";
|
import { CodexAppServerClient } from "@peezy.tech/codex-flows";
|
||||||
|
|
||||||
import { APP_SERVER_ACTIONS } from "./actions.ts";
|
import { APP_SERVER_ACTIONS } from "./actions.ts";
|
||||||
import { DEFAULT_WS_URL, parseArgs } from "./args.ts";
|
import { DEFAULT_WS_URL, parseArgs } from "./args.ts";
|
||||||
|
|
|
||||||
|
|
@ -16,8 +16,8 @@
|
||||||
"skipLibCheck": true,
|
"skipLibCheck": true,
|
||||||
"baseUrl": ".",
|
"baseUrl": ".",
|
||||||
"paths": {
|
"paths": {
|
||||||
"@peezy-tech/codex-flows": ["../../packages/codex-client/src/index.ts"],
|
"@peezy.tech/codex-flows": ["../../packages/codex-client/src/index.ts"],
|
||||||
"@peezy-tech/codex-flows/*": ["../../packages/codex-client/src/*"]
|
"@peezy.tech/codex-flows/*": ["../../packages/codex-client/src/*"]
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"include": ["src", "test"]
|
"include": ["src", "test"]
|
||||||
|
|
|
||||||
|
|
@ -16,7 +16,7 @@
|
||||||
"test": "bun test test/*.test.ts"
|
"test": "bun test test/*.test.ts"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@peezy-tech/codex-flows": "workspace:*",
|
"@peezy.tech/codex-flows": "workspace:*",
|
||||||
"discord.js": "catalog:"
|
"discord.js": "catalog:"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
import os from "node:os";
|
import os from "node:os";
|
||||||
import path from "node:path";
|
import path from "node:path";
|
||||||
|
|
||||||
import type { JsonRpcNotification, JsonRpcRequest } from "@peezy-tech/codex-flows/rpc";
|
import type { JsonRpcNotification, JsonRpcRequest } from "@peezy.tech/codex-flows/rpc";
|
||||||
import type { v2 } from "@peezy-tech/codex-flows/generated";
|
import type { v2 } from "@peezy.tech/codex-flows/generated";
|
||||||
|
|
||||||
import type { DiscordConsoleOutput } from "./console-output.ts";
|
import type { DiscordConsoleOutput } from "./console-output.ts";
|
||||||
import { DiscordThreadRunner, MessageDeduplicator } from "./runner.ts";
|
import { DiscordThreadRunner, MessageDeduplicator } from "./runner.ts";
|
||||||
|
|
|
||||||
|
|
@ -5,7 +5,7 @@ import type {
|
||||||
ReasoningEffort,
|
ReasoningEffort,
|
||||||
ReasoningSummary,
|
ReasoningSummary,
|
||||||
v2,
|
v2,
|
||||||
} from "@peezy-tech/codex-flows/generated";
|
} from "@peezy.tech/codex-flows/generated";
|
||||||
|
|
||||||
import type {
|
import type {
|
||||||
DiscordBridgeConfig,
|
DiscordBridgeConfig,
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
import {
|
import {
|
||||||
CodexAppServerClient,
|
CodexAppServerClient,
|
||||||
CodexStdioTransport,
|
CodexStdioTransport,
|
||||||
} from "@peezy-tech/codex-flows";
|
} from "@peezy.tech/codex-flows";
|
||||||
|
|
||||||
import { DiscordCodexBridge } from "./bridge.ts";
|
import { DiscordCodexBridge } from "./bridge.ts";
|
||||||
import { createDiscordConsoleOutput } from "./console-output.ts";
|
import { createDiscordConsoleOutput } from "./console-output.ts";
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
import type { JsonRpcNotification } from "@peezy-tech/codex-flows/rpc";
|
import type { JsonRpcNotification } from "@peezy.tech/codex-flows/rpc";
|
||||||
import type { v2 } from "@peezy-tech/codex-flows/generated";
|
import type { v2 } from "@peezy.tech/codex-flows/generated";
|
||||||
|
|
||||||
import type {
|
import type {
|
||||||
DiscordConsoleMessageKind,
|
DiscordConsoleMessageKind,
|
||||||
|
|
|
||||||
|
|
@ -2,8 +2,8 @@ import type {
|
||||||
ReasoningEffort,
|
ReasoningEffort,
|
||||||
ReasoningSummary,
|
ReasoningSummary,
|
||||||
v2,
|
v2,
|
||||||
} from "@peezy-tech/codex-flows/generated";
|
} from "@peezy.tech/codex-flows/generated";
|
||||||
import type { JsonRpcNotification, JsonRpcRequest } from "@peezy-tech/codex-flows/rpc";
|
import type { JsonRpcNotification, JsonRpcRequest } from "@peezy.tech/codex-flows/rpc";
|
||||||
import type { DiscordBridgeLogLevelSetting } from "./logger.ts";
|
import type { DiscordBridgeLogLevelSetting } from "./logger.ts";
|
||||||
|
|
||||||
export type DiscordBridgeConfig = {
|
export type DiscordBridgeConfig = {
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
import os from "node:os";
|
import os from "node:os";
|
||||||
import path from "node:path";
|
import path from "node:path";
|
||||||
import { describe, expect, test } from "bun:test";
|
import { describe, expect, test } from "bun:test";
|
||||||
import type { JsonRpcNotification, JsonRpcRequest } from "@peezy-tech/codex-flows/rpc";
|
import type { JsonRpcNotification, JsonRpcRequest } from "@peezy.tech/codex-flows/rpc";
|
||||||
import type { v2 } from "@peezy-tech/codex-flows/generated";
|
import type { v2 } from "@peezy.tech/codex-flows/generated";
|
||||||
|
|
||||||
import { DiscordCodexBridge, parseThreadStartIntent } from "../src/bridge.ts";
|
import { DiscordCodexBridge, parseThreadStartIntent } from "../src/bridge.ts";
|
||||||
import type {
|
import type {
|
||||||
|
|
|
||||||
|
|
@ -17,8 +17,8 @@
|
||||||
"types": ["node", "bun"],
|
"types": ["node", "bun"],
|
||||||
"baseUrl": ".",
|
"baseUrl": ".",
|
||||||
"paths": {
|
"paths": {
|
||||||
"@peezy-tech/codex-flows": ["../../packages/codex-client/src/index.ts"],
|
"@peezy.tech/codex-flows": ["../../packages/codex-client/src/index.ts"],
|
||||||
"@peezy-tech/codex-flows/*": ["../../packages/codex-client/src/*"]
|
"@peezy.tech/codex-flows/*": ["../../packages/codex-client/src/*"]
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"include": ["src", "test"]
|
"include": ["src", "test"]
|
||||||
|
|
|
||||||
|
|
@ -12,7 +12,7 @@
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@workspace/ui": "workspace:*",
|
"@workspace/ui": "workspace:*",
|
||||||
"@peezy-tech/codex-flows": "workspace:*",
|
"@peezy.tech/codex-flows": "workspace:*",
|
||||||
"lucide-react": "catalog:",
|
"lucide-react": "catalog:",
|
||||||
"react": "catalog:",
|
"react": "catalog:",
|
||||||
"react-dom": "catalog:"
|
"react-dom": "catalog:"
|
||||||
|
|
|
||||||
|
|
@ -26,7 +26,7 @@ import {
|
||||||
type JsonRpcNotification,
|
type JsonRpcNotification,
|
||||||
type JsonRpcRequest,
|
type JsonRpcRequest,
|
||||||
type v2,
|
type v2,
|
||||||
} from "@peezy-tech/codex-flows/browser";
|
} from "@peezy.tech/codex-flows/browser";
|
||||||
|
|
||||||
import { ThemeProvider } from "./components/theme-provider.tsx";
|
import { ThemeProvider } from "./components/theme-provider.tsx";
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -22,8 +22,8 @@
|
||||||
"baseUrl": ".",
|
"baseUrl": ".",
|
||||||
"paths": {
|
"paths": {
|
||||||
"@/*": ["./src/*"],
|
"@/*": ["./src/*"],
|
||||||
"@peezy-tech/codex-flows": ["../../packages/codex-client/src/index.ts"],
|
"@peezy.tech/codex-flows": ["../../packages/codex-client/src/index.ts"],
|
||||||
"@peezy-tech/codex-flows/*": ["../../packages/codex-client/src/*"],
|
"@peezy.tech/codex-flows/*": ["../../packages/codex-client/src/*"],
|
||||||
"@workspace/ui/*": ["../../packages/ui/src/*"]
|
"@workspace/ui/*": ["../../packages/ui/src/*"]
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
|
||||||
|
|
@ -8,8 +8,8 @@
|
||||||
"baseUrl": ".",
|
"baseUrl": ".",
|
||||||
"paths": {
|
"paths": {
|
||||||
"@/*": ["./src/*"],
|
"@/*": ["./src/*"],
|
||||||
"@peezy-tech/codex-flows": ["../../packages/codex-client/src/index.ts"],
|
"@peezy.tech/codex-flows": ["../../packages/codex-client/src/index.ts"],
|
||||||
"@peezy-tech/codex-flows/*": ["../../packages/codex-client/src/*"],
|
"@peezy.tech/codex-flows/*": ["../../packages/codex-client/src/*"],
|
||||||
"@workspace/ui/*": ["../../packages/ui/src/*"]
|
"@workspace/ui/*": ["../../packages/ui/src/*"]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
10
bun.lock
10
bun.lock
|
|
@ -12,7 +12,7 @@
|
||||||
"codex-app": "./src/index.ts",
|
"codex-app": "./src/index.ts",
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@peezy-tech/codex-flows": "workspace:*",
|
"@peezy.tech/codex-flows": "workspace:*",
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/bun": "catalog:",
|
"@types/bun": "catalog:",
|
||||||
|
|
@ -27,7 +27,7 @@
|
||||||
"codex-discord-bridge": "./src/index.ts",
|
"codex-discord-bridge": "./src/index.ts",
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@peezy-tech/codex-flows": "workspace:*",
|
"@peezy.tech/codex-flows": "workspace:*",
|
||||||
"discord.js": "catalog:",
|
"discord.js": "catalog:",
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
|
|
@ -40,7 +40,7 @@
|
||||||
"name": "web",
|
"name": "web",
|
||||||
"version": "0.0.1",
|
"version": "0.0.1",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@peezy-tech/codex-flows": "workspace:*",
|
"@peezy.tech/codex-flows": "workspace:*",
|
||||||
"@workspace/ui": "workspace:*",
|
"@workspace/ui": "workspace:*",
|
||||||
"lucide-react": "catalog:",
|
"lucide-react": "catalog:",
|
||||||
"react": "catalog:",
|
"react": "catalog:",
|
||||||
|
|
@ -57,7 +57,7 @@
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
"packages/codex-client": {
|
"packages/codex-client": {
|
||||||
"name": "@peezy-tech/codex-flows",
|
"name": "@peezy.tech/codex-flows",
|
||||||
"version": "0.1.0",
|
"version": "0.1.0",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/bun": "^1.3.13",
|
"@types/bun": "^1.3.13",
|
||||||
|
|
@ -295,7 +295,7 @@
|
||||||
|
|
||||||
"@open-draft/until": ["@open-draft/until@2.1.0", "", {}, "sha512-U69T3ItWHvLwGg5eJ0n3I62nWuE6ilHlmz7zM0npLBRvPRd7e6NYmg54vvRtP5mZG7kZqZCFVdsTWo7BPtBujg=="],
|
"@open-draft/until": ["@open-draft/until@2.1.0", "", {}, "sha512-U69T3ItWHvLwGg5eJ0n3I62nWuE6ilHlmz7zM0npLBRvPRd7e6NYmg54vvRtP5mZG7kZqZCFVdsTWo7BPtBujg=="],
|
||||||
|
|
||||||
"@peezy-tech/codex-flows": ["@peezy-tech/codex-flows@workspace:packages/codex-client"],
|
"@peezy.tech/codex-flows": ["@peezy.tech/codex-flows@workspace:packages/codex-client"],
|
||||||
|
|
||||||
"@rolldown/pluginutils": ["@rolldown/pluginutils@1.0.0-rc.3", "", {}, "sha512-eybk3TjzzzV97Dlj5c+XrBFW57eTNhzod66y9HrBlzJ6NsCrWCp/2kaPS3K9wJmurBC0Tdw4yPjXKZqlznim3Q=="],
|
"@rolldown/pluginutils": ["@rolldown/pluginutils@1.0.0-rc.3", "", {}, "sha512-eybk3TjzzzV97Dlj5c+XrBFW57eTNhzod66y9HrBlzJ6NsCrWCp/2kaPS3K9wJmurBC0Tdw4yPjXKZqlznim3Q=="],
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -42,6 +42,6 @@
|
||||||
"dev:web": "bun run --filter web dev",
|
"dev:web": "bun run --filter web dev",
|
||||||
"start": "bun run --filter web preview",
|
"start": "bun run --filter web preview",
|
||||||
"start:discord:debug:commentary": "bun run --filter codex-discord-bridge start:debug:commentary",
|
"start:discord:debug:commentary": "bun run --filter codex-discord-bridge start:debug:commentary",
|
||||||
"test": "bun run --filter @peezy-tech/codex-flows test && bun run --filter codex-app-cli test && bun run --filter codex-discord-bridge test"
|
"test": "bun run --filter @peezy.tech/codex-flows test && bun run --filter codex-app-cli test && bun run --filter codex-discord-bridge test"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
# @peezy-tech/codex-flows
|
# @peezy.tech/codex-flows
|
||||||
|
|
||||||
Workspace package for talking to `codex app-server`.
|
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
|
## Exports
|
||||||
|
|
||||||
- `@peezy-tech/codex-flows`
|
- `@peezy.tech/codex-flows`
|
||||||
- `CodexAppServerClient`
|
- `CodexAppServerClient`
|
||||||
- `CodexStdioTransport`
|
- `CodexStdioTransport`
|
||||||
- `CodexWebSocketTransport`
|
- `CodexWebSocketTransport`
|
||||||
- JSON-RPC helpers and types
|
- JSON-RPC helpers and types
|
||||||
- `@peezy-tech/codex-flows/browser`
|
- `@peezy.tech/codex-flows/browser`
|
||||||
- browser-safe `CodexAppServerClient`
|
- browser-safe `CodexAppServerClient`
|
||||||
- `CodexWebSocketTransport`
|
- `CodexWebSocketTransport`
|
||||||
- JSON-RPC helpers and types
|
- JSON-RPC helpers and types
|
||||||
- `@peezy-tech/codex-flows/flows`
|
- `@peezy.tech/codex-flows/flows`
|
||||||
- `CodexFlowClient`
|
- `CodexFlowClient`
|
||||||
- `createCodexFlowClient`
|
- `createCodexFlowClient`
|
||||||
- prompt/input normalization and optional turn completion waiting
|
- 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
|
- JSON-RPC message types and parsing helpers
|
||||||
- `@peezy-tech/codex-flows/generated`
|
- `@peezy.tech/codex-flows/generated`
|
||||||
- generated Codex app-server protocol types
|
- generated Codex app-server protocol types
|
||||||
- `@peezy-tech/codex-flows/generated/*`
|
- `@peezy.tech/codex-flows/generated/*`
|
||||||
- generated per-type modules
|
- generated per-type modules
|
||||||
|
|
||||||
## Transports
|
## 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.
|
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
|
```ts
|
||||||
import { CodexAppServerClient } from "@peezy-tech/codex-flows";
|
import { CodexAppServerClient } from "@peezy.tech/codex-flows";
|
||||||
|
|
||||||
const client = new CodexAppServerClient();
|
const client = new CodexAppServerClient();
|
||||||
await client.connect();
|
await client.connect();
|
||||||
|
|
@ -46,7 +46,7 @@ client.close();
|
||||||
Browser entry:
|
Browser entry:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
import { CodexAppServerClient } from "@peezy-tech/codex-flows/browser";
|
import { CodexAppServerClient } from "@peezy.tech/codex-flows/browser";
|
||||||
|
|
||||||
const client = new CodexAppServerClient({
|
const client = new CodexAppServerClient({
|
||||||
webSocketTransportOptions: { url: "ws://127.0.0.1:3585" },
|
webSocketTransportOptions: { url: "ws://127.0.0.1:3585" },
|
||||||
|
|
@ -57,7 +57,7 @@ await client.connect();
|
||||||
Flow helpers:
|
Flow helpers:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
import { createCodexFlowClient } from "@peezy-tech/codex-flows/flows";
|
import { createCodexFlowClient } from "@peezy.tech/codex-flows/flows";
|
||||||
|
|
||||||
const codex = createCodexFlowClient({
|
const codex = createCodexFlowClient({
|
||||||
appServerUrl: "ws://127.0.0.1:3585",
|
appServerUrl: "ws://127.0.0.1:3585",
|
||||||
|
|
@ -77,11 +77,11 @@ console.log(result.threadId, result.turnId);
|
||||||
## Scripts
|
## Scripts
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
bun run --filter @peezy-tech/codex-flows build
|
bun run --filter @peezy.tech/codex-flows build
|
||||||
bun run --filter @peezy-tech/codex-flows check:types
|
bun run --filter @peezy.tech/codex-flows check:types
|
||||||
bun run --filter @peezy-tech/codex-flows test
|
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 pack:dry-run
|
||||||
bun run --filter @peezy-tech/codex-flows release:check
|
bun run --filter @peezy.tech/codex-flows release:check
|
||||||
```
|
```
|
||||||
|
|
||||||
`build` emits ESM JavaScript, source maps, and declaration files into `dist`.
|
`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:
|
After publishing, install the package from npm:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
bun add @peezy-tech/codex-flows
|
bun add @peezy.tech/codex-flows
|
||||||
```
|
```
|
||||||
|
|
||||||
or:
|
or:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install @peezy-tech/codex-flows
|
npm install @peezy.tech/codex-flows
|
||||||
```
|
```
|
||||||
|
|
||||||
## Publishing
|
## Publishing
|
||||||
|
|
@ -105,19 +105,19 @@ npm install @peezy-tech/codex-flows
|
||||||
Run the release check before publishing:
|
Run the release check before publishing:
|
||||||
|
|
||||||
```bash
|
```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.
|
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
|
```bash
|
||||||
cd packages/codex-client
|
cd packages/codex-client
|
||||||
npm publish --access public
|
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
|
## Notes
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
{
|
{
|
||||||
"name": "@peezy-tech/codex-flows",
|
"name": "@peezy.tech/codex-flows",
|
||||||
"version": "0.1.0",
|
"version": "0.1.0",
|
||||||
"description": "Codex app-server JSON-RPC client, flow helpers, and generated protocol types.",
|
"description": "Codex app-server JSON-RPC client, flow helpers, and generated protocol types.",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
|
|
|
||||||
|
|
@ -1,9 +1,9 @@
|
||||||
const checks = [
|
const checks = [
|
||||||
["@peezy-tech/codex-flows", ["CodexAppServerClient"]],
|
["@peezy.tech/codex-flows", ["CodexAppServerClient"]],
|
||||||
["@peezy-tech/codex-flows/browser", ["CodexAppServerClient"]],
|
["@peezy.tech/codex-flows/browser", ["CodexAppServerClient"]],
|
||||||
["@peezy-tech/codex-flows/flows", ["CodexFlowClient", "createCodexFlowClient"]],
|
["@peezy.tech/codex-flows/flows", ["CodexFlowClient", "createCodexFlowClient"]],
|
||||||
["@peezy-tech/codex-flows/rpc", ["JsonRpcError"]],
|
["@peezy.tech/codex-flows/rpc", ["JsonRpcError"]],
|
||||||
["@peezy-tech/codex-flows/generated", ["v2"]],
|
["@peezy.tech/codex-flows/generated", ["v2"]],
|
||||||
] as const;
|
] as const;
|
||||||
|
|
||||||
for (const [specifier, expectedExports] of checks) {
|
for (const [specifier, expectedExports] of checks) {
|
||||||
|
|
|
||||||
|
|
@ -40,7 +40,7 @@ export class CodexAppServerClient extends CodexEventEmitter {
|
||||||
super();
|
super();
|
||||||
this.transport =
|
this.transport =
|
||||||
options.transport ?? defaultTransport(options);
|
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.#clientTitle = options.clientTitle ?? "Codex Client";
|
||||||
this.#clientVersion = options.clientVersion ?? "0.1.0";
|
this.#clientVersion = options.clientVersion ?? "0.1.0";
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -391,7 +391,7 @@ function clientIdentityOptions(
|
||||||
"clientName" | "clientTitle" | "clientVersion"
|
"clientName" | "clientTitle" | "clientVersion"
|
||||||
> {
|
> {
|
||||||
return compactUndefined({
|
return compactUndefined({
|
||||||
clientName: options.clientName ?? "peezy-tech-codex-flows",
|
clientName: options.clientName ?? "peezy.tech-codex-flows",
|
||||||
clientTitle: options.clientTitle ?? "Codex Flows SDK",
|
clientTitle: options.clientTitle ?? "Codex Flows SDK",
|
||||||
clientVersion: options.clientVersion ?? "0.1.0",
|
clientVersion: options.clientVersion ?? "0.1.0",
|
||||||
});
|
});
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue