Merge pull request #254 from prompt-foundry/release-please--branches--main--changes--next--components--typescript-sdk

release: 1.17.0

Author: anthonyjgrove

.devcontainer/Dockerfile

@@ -19,3 +19,4 @@ jobs:
           bash ./bin/check-release-environment
         env:
           NPM_TOKEN: ${{ secrets.PROMPT_FOUNDRY_NPM_TOKEN || secrets.NPM_TOKEN }}
+

.devcontainer/devcontainer.json

@@ -8,4 +8,3 @@ dist
 /*.tgz
 .idea/
 
-build/tsconfig.tsbuildinfo

.eslintrc.js

@@ -1,3 +1,3 @@
 {
-  ".": "1.16.0"
+  ".": "1.17.0"
 }

.github/workflows/ci.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 22
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/prompt-foundry%2Fprompt-foundry-sdk-9cff8ea13f14bd0899df69243fe78b4f88d4d0172263aa260af1ea66a7d0484e.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/prompt-foundry%2Fprompt-foundry-sdk-84eb1e848fd165a965df78740df71651a8b413f023e5fdb6eb1acb9cce08e006.yml

.github/workflows/publish-npm.yml

@@ -19,3 +19,4 @@ if [[ lenErrors -gt 0 ]]; then
 fi
 
 echo "The environment is ready to push releases!"
+

.github/workflows/release-doctor.yml

@@ -2,8 +2,24 @@
 
 set -eux
 
-npm config set //registry.npmjs.org/:_authToken $NPM_TOKEN
+npm config set '//registry.npmjs.org/:_authToken' "$NPM_TOKEN"
 
+# Build the project
 yarn build
+
+# Navigate to the dist directory
 cd dist
-yarn publish --access public
+
+# Get the version from package.json
+VERSION="$(node -p "require('./package.json').version")"
+
+# Extract the pre-release tag if it exists
+if [[ "$VERSION" =~ -([a-zA-Z]+) ]]; then
+  # Extract the part before any dot in the pre-release identifier
+  TAG="${BASH_REMATCH[1]}"
+else
+  TAG="latest"
+fi
+
+# Publish with the appropriate tag
+yarn publish --access public --tag "$TAG"

.gitignore

@@ -1,18 +1,7 @@
 {
   "name": "@prompt-foundry/typescript-sdk",
-  "version": "1.16.0",
-  "description": "The prompt engineering, prompt management, and prompt evaluation tool for TypeScript, JavaScript, and NodeJS.",
-  "keywords": [
-    "typescript",
-    "javascript",
-    "nodejs",
-    "sdk",
-    "prompt",
-    "prompt-engineering",
-    "prompt-management",
-    "prompt-testing",
-    "openai"
-  ],
+  "version": "1.17.0",
+  "description": "The official TypeScript library for the Prompt Foundry API",
   "author": "Prompt Foundry <[email protected]>",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
@@ -32,7 +21,7 @@
     "prepare": "if ./scripts/utils/check-is-in-git-install.sh; then ./scripts/build; fi",
     "tsn": "ts-node -r tsconfig-paths/register",
     "lint": "./scripts/lint",
-    "fix": "eslint --fix --ext ts,js ."
+    "fix": "./scripts/format"
   },
   "dependencies": {
     "@types/node": "^18.11.18",

.prettierignore

@@ -5,4 +5,4 @@ set -e
 cd "$(dirname "$0")/.."
 
 echo "==> Running eslint --fix"
-./node_modules/.bin/eslint --fix --ext ts,js .
+ESLINT_USE_FLAT_CONFIG="false" ./node_modules/.bin/eslint --fix --ext ts,js .

.prettierrc.json

@@ -5,4 +5,4 @@ set -e
 cd "$(dirname "$0")/.."
 
 echo "==> Running eslint"
-./node_modules/.bin/eslint --ext ts,js .
+ESLINT_USE_FLAT_CONFIG="false" ./node_modules/.bin/eslint --ext ts,js .

.release-please-manifest.json

@@ -21,7 +21,7 @@ echo "==> Starting mock server with URL ${URL}"
 
 # Run prism mock on the given spec
 if [ "$1" == "--daemon" ]; then
-  npm exec --package=@stainless-api/[email protected].4 -- prism mock "$URL" &> .prism.log &
+  npm exec --package=@stainless-api/[email protected].5 -- prism mock "$URL" &> .prism.log &
 
   # Wait for server to come online
   echo -n "Waiting for server"
@@ -37,5 +37,5 @@ if [ "$1" == "--daemon" ]; then
 
   echo
 else
-  npm exec --package=@stainless-api/[email protected].4 -- prism mock "$URL"
+  npm exec --package=@stainless-api/[email protected].5 -- prism mock "$URL"
 fi

.stats.yml

@@ -194,7 +194,7 @@ export namespace PromptFoundry {
   export import CompletionCreateParams = API.CompletionCreateParams;
 
   export import Prompts = API.Prompts;
-  export import ModelParameters = API.ModelParameters;
+  export import Parameters = API.Parameters;
   export import PromptConfiguration = API.PromptConfiguration;
   export import PromptListResponse = API.PromptListResponse;
   export import PromptDeleteResponse = API.PromptDeleteResponse;

Brewfile

@@ -36,6 +36,13 @@ export interface CompletionCreateResponse {
    */
   message: CompletionCreateResponse.Message;
 
+  name: string;
+
+  /**
+   * The LLM model provider.
+   */
+  provider: 'ANTHROPIC' | 'OPENAI';
+
   stats: CompletionCreateResponse.Stats;
 }
 
@@ -45,7 +52,7 @@ export namespace CompletionCreateResponse {
    */
   export interface Message {
     content: Array<
-      | Message.TextContentBlockSchema
+      | Message.TextContentBlock
       | Message.ImageBase64ContentBlock
       | Message.ToolCallContentBlock
       | Message.ToolResultContentBlock
@@ -55,7 +62,7 @@ export namespace CompletionCreateResponse {
   }
 
   export namespace Message {
-    export interface TextContentBlockSchema {
+    export interface TextContentBlock {
       text: string;
 
       type: 'TEXT';
@@ -167,7 +174,7 @@ export interface CompletionCreateParams {
 export namespace CompletionCreateParams {
   export interface AppendMessage {
     content: Array<
-      | AppendMessage.TextContentBlockSchema
+      | AppendMessage.TextContentBlock
       | AppendMessage.ImageBase64ContentBlock
       | AppendMessage.ToolCallContentBlock
       | AppendMessage.ToolResultContentBlock
@@ -177,7 +184,7 @@ export namespace CompletionCreateParams {
   }
 
   export namespace AppendMessage {
-    export interface TextContentBlockSchema {
+    export interface TextContentBlock {
       text: string;
 
       type: 'TEXT';
@@ -241,7 +248,7 @@ export namespace CompletionCreateParams {
 
   export interface OverrideMessage {
     content: Array<
-      | OverrideMessage.TextContentBlockSchema
+      | OverrideMessage.TextContentBlock
       | OverrideMessage.ImageBase64ContentBlock
       | OverrideMessage.ToolCallContentBlock
       | OverrideMessage.ToolResultContentBlock
@@ -251,7 +258,7 @@ export namespace CompletionCreateParams {
   }
 
   export namespace OverrideMessage {
-    export interface TextContentBlockSchema {
+    export interface TextContentBlock {
       text: string;
 
       type: 'TEXT';

CHANGELOG.md

@@ -74,7 +74,7 @@ export interface Evaluation {
 export namespace Evaluation {
   export interface AppendedMessage {
     content: Array<
-      | AppendedMessage.TextContentBlockSchema
+      | AppendedMessage.TextContentBlock
       | AppendedMessage.ImageBase64ContentBlock
       | AppendedMessage.ToolCallContentBlock
       | AppendedMessage.ToolResultContentBlock
@@ -84,7 +84,7 @@ export namespace Evaluation {
   }
 
   export namespace AppendedMessage {
-    export interface TextContentBlockSchema {
+    export interface TextContentBlock {
       text: string;
 
       type: 'TEXT';
@@ -180,7 +180,7 @@ export interface EvaluationCreateParams {
 export namespace EvaluationCreateParams {
   export interface AppendedMessage {
     content: Array<
-      | AppendedMessage.TextContentBlockSchema
+      | AppendedMessage.TextContentBlock
       | AppendedMessage.ImageBase64ContentBlock
       | AppendedMessage.ToolCallContentBlock
       | AppendedMessage.ToolResultContentBlock
@@ -190,7 +190,7 @@ export namespace EvaluationCreateParams {
   }
 
   export namespace AppendedMessage {
-    export interface TextContentBlockSchema {
+    export interface TextContentBlock {
       text: string;
 
       type: 'TEXT';
@@ -280,7 +280,7 @@ export interface EvaluationUpdateParams {
 export namespace EvaluationUpdateParams {
   export interface AppendedMessage {
     content: Array<
-      | AppendedMessage.TextContentBlockSchema
+      | AppendedMessage.TextContentBlock
       | AppendedMessage.ImageBase64ContentBlock
       | AppendedMessage.ToolCallContentBlock
       | AppendedMessage.ToolResultContentBlock
@@ -290,7 +290,7 @@ export namespace EvaluationUpdateParams {
   }
 
   export namespace AppendedMessage {
-    export interface TextContentBlockSchema {
+    export interface TextContentBlock {
       text: string;
 
       type: 'TEXT';

CONTRIBUTING.md

@@ -19,7 +19,7 @@ export {
   EvaluationAssertions,
 } from './evaluation-assertions';
 export {
-  ModelParameters,
+  Parameters,
   PromptConfiguration,
   PromptListResponse,
   PromptDeleteResponse,