Merge pull request #254 from prompt-foundry/release-please--branches-…

…-main--changes--next--components--typescript-sdk release: 1.17.0
prompt-foundry · Aug 22, 2024 · c5493bb · c5493bb
2 parents e20bc0a + 2a209a0
commit c5493bb
Show file tree

Hide file tree

Showing 90 changed files with 345 additions and 250 deletions.
diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
diff --git a/.eslintrc.js b/.eslintrc.js
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
diff --git a/.github/workflows/publish-npm.yml b/.github/workflows/publish-npm.yml
diff --git a/.github/workflows/release-doctor.yml b/.github/workflows/release-doctor.yml
@@ -19,3 +19,4 @@ jobs:
           bash ./bin/check-release-environment
         env:
           NPM_TOKEN: ${{ secrets.PROMPT_FOUNDRY_NPM_TOKEN || secrets.NPM_TOKEN }}
+
diff --git a/.gitignore b/.gitignore
@@ -8,4 +8,3 @@ dist
 /*.tgz
 .idea/
 
-build/tsconfig.tsbuildinfo
diff --git a/.prettierignore b/.prettierignore
diff --git a/.prettierrc.json b/.prettierrc.json
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -1,3 +1,3 @@
 {
-  ".": "1.16.0"
+  ".": "1.17.0"
 }
diff --git a/.stats.yml b/.stats.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
diff --git a/Brewfile b/Brewfile
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
diff --git a/LICENSE b/LICENSE
diff --git a/README.md b/README.md
diff --git a/SECURITY.md b/SECURITY.md
diff --git a/api.md b/api.md
@@ -12,7 +12,7 @@ Methods:
 
 Types:
 
-- <code><a href="./src/resources/prompts.ts">ModelParameters</a></code>
+- <code><a href="./src/resources/prompts.ts">Parameters</a></code>
 - <code><a href="./src/resources/prompts.ts">PromptConfiguration</a></code>
 - <code><a href="./src/resources/prompts.ts">PromptListResponse</a></code>
 - <code><a href="./src/resources/prompts.ts">PromptDeleteResponse</a></code>
@@ -24,7 +24,7 @@ Methods:
 - <code title="get /sdk/v1/prompts">client.prompts.<a href="./src/resources/prompts.ts">list</a>() -> PromptListResponse</code>
 - <code title="delete /sdk/v1/prompts/{id}">client.prompts.<a href="./src/resources/prompts.ts">delete</a>(id) -> PromptDeleteResponse</code>
 - <code title="get /sdk/v1/prompts/{id}">client.prompts.<a href="./src/resources/prompts.ts">get</a>(id) -> PromptConfiguration</code>
-- <code title="post /sdk/v1/prompts/{id}">client.prompts.<a href="./src/resources/prompts.ts">getParameters</a>(id, { ...params }) -> ModelParameters</code>
+- <code title="post /sdk/v1/prompts/{id}">client.prompts.<a href="./src/resources/prompts.ts">getParameters</a>(id, { ...params }) -> Parameters</code>
 
 # Tools
 

diff --git a/bin/check-release-environment b/bin/check-release-environment
@@ -19,3 +19,4 @@ if [[ lenErrors -gt 0 ]]; then
 fi
 
 echo "The environment is ready to push releases!"
+
diff --git a/bin/publish-npm b/bin/publish-npm
@@ -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"
diff --git a/examples/.keep b/examples/.keep
diff --git a/jest.config.ts b/jest.config.ts
diff --git a/package.json b/package.json
@@ -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",

diff --git a/release-please-config.json b/release-please-config.json
diff --git a/scripts/format b/scripts/format
@@ -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 .
diff --git a/scripts/lint b/scripts/lint
@@ -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 .
diff --git a/scripts/mock b/scripts/mock
@@ -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
diff --git a/scripts/utils/check-version.cjs b/scripts/utils/check-version.cjs
diff --git a/scripts/utils/fix-index-exports.cjs b/scripts/utils/fix-index-exports.cjs
diff --git a/scripts/utils/make-dist-package-json.cjs b/scripts/utils/make-dist-package-json.cjs
diff --git a/scripts/utils/postprocess-files.cjs b/scripts/utils/postprocess-files.cjs
diff --git a/src/_shims/MultipartBody.ts b/src/_shims/MultipartBody.ts
diff --git a/src/_shims/README.md b/src/_shims/README.md
diff --git a/src/_shims/auto/runtime-bun.ts b/src/_shims/auto/runtime-bun.ts
diff --git a/src/_shims/auto/runtime-deno.ts b/src/_shims/auto/runtime-deno.ts
diff --git a/src/_shims/auto/runtime-node.ts b/src/_shims/auto/runtime-node.ts
diff --git a/src/_shims/auto/runtime.ts b/src/_shims/auto/runtime.ts
diff --git a/src/_shims/auto/types-deno.ts b/src/_shims/auto/types-deno.ts
diff --git a/src/_shims/auto/types-node.ts b/src/_shims/auto/types-node.ts
diff --git a/src/_shims/auto/types.d.ts b/src/_shims/auto/types.d.ts
diff --git a/src/_shims/auto/types.js b/src/_shims/auto/types.js
diff --git a/src/_shims/auto/types.mjs b/src/_shims/auto/types.mjs
diff --git a/src/_shims/bun-runtime.ts b/src/_shims/bun-runtime.ts
diff --git a/src/_shims/index-deno.ts b/src/_shims/index-deno.ts
diff --git a/src/_shims/index.d.ts b/src/_shims/index.d.ts
diff --git a/src/_shims/index.js b/src/_shims/index.js
diff --git a/src/_shims/index.mjs b/src/_shims/index.mjs
diff --git a/src/_shims/manual-types.d.ts b/src/_shims/manual-types.d.ts
diff --git a/src/_shims/manual-types.js b/src/_shims/manual-types.js
diff --git a/src/_shims/manual-types.mjs b/src/_shims/manual-types.mjs
diff --git a/src/_shims/node-runtime.ts b/src/_shims/node-runtime.ts
diff --git a/src/_shims/node-types.d.ts b/src/_shims/node-types.d.ts
diff --git a/src/_shims/node-types.js b/src/_shims/node-types.js
diff --git a/src/_shims/node-types.mjs b/src/_shims/node-types.mjs
diff --git a/src/_shims/registry.ts b/src/_shims/registry.ts
diff --git a/src/_shims/web-runtime.ts b/src/_shims/web-runtime.ts
diff --git a/src/_shims/web-types.d.ts b/src/_shims/web-types.d.ts
diff --git a/src/_shims/web-types.js b/src/_shims/web-types.js
diff --git a/src/_shims/web-types.mjs b/src/_shims/web-types.mjs
diff --git a/src/core.ts b/src/core.ts
diff --git a/src/error.ts b/src/error.ts
diff --git a/src/index.ts b/src/index.ts
@@ -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;

diff --git a/src/lib/.keep b/src/lib/.keep
diff --git a/src/resource.ts b/src/resource.ts
diff --git a/src/resources/completion.ts b/src/resources/completion.ts
@@ -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';

diff --git a/src/resources/evaluation-assertions.ts b/src/resources/evaluation-assertions.ts
diff --git a/src/resources/evaluations.ts b/src/resources/evaluations.ts
@@ -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';

diff --git a/src/resources/index.ts b/src/resources/index.ts
@@ -19,7 +19,7 @@ export {
   EvaluationAssertions,
 } from './evaluation-assertions';
 export {
-  ModelParameters,
+  Parameters,
   PromptConfiguration,
   PromptListResponse,
   PromptDeleteResponse,
Original file line number	Diff line number	Diff line change
Expand Up		@@ -19,3 +19,4 @@ jobs:
		bash ./bin/check-release-environment
		env:
		NPM_TOKEN: ${{ secrets.PROMPT_FOUNDRY_NPM_TOKEN \|\| secrets.NPM_TOKEN }}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,4 +8,3 @@ dist
		/*.tgz
		.idea/

		build/tsconfig.tsbuildinfo
Original file line number	Diff line number	Diff line change
Expand Up		@@ -19,3 +19,4 @@ if [[ lenErrors -gt 0 ]]; then
		fi

		echo "The environment is ready to push releases!"