@prompt-foundry/typescript-sdk - npm Package Compare versions

Comparing version 1.0.5 to 1.0.6

CHANGELOG.md

@@ -5,2 +5,2 @@ # Changelog
 
-### [1.0.5](https://github.com/prompt-foundry/typescript-sdk/compare/v1.0.4...v1.0.5) (2024-05-20)
+### [1.0.6](https://github.com/prompt-foundry/typescript-sdk/compare/v1.0.5...v1.0.6) (2024-05-21)

package.json

 {
   "name": "@prompt-foundry/typescript-sdk",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "The Typescript SDK for the prompt engineering, prompt management, and prompt testing tool Prompt Foundry.",
@@ -29,4 +29,3 @@ "main": "build/main/index.js",
     "prettier": "npm run lint -- --fix",
-    "test": "run-s build test:*",
-    "test:spelling": "cspell \"{README.md,.github/*.md,src/**/*.ts}\"",
+    "test": "run-s test:*",
     "test:unit": "jest",
@@ -42,3 +41,5 @@ "typecheck": "tsc --noEmit --incremental",
     "reset-hard": "git clean -dfx && git reset --hard && npm i",
-    "prepare-release": "run-s reset-hard test doc:html version doc:publish"
+    "prepare-release": "run-s reset-hard test doc:html version doc:publish",
+    "openapi": "run-s openapi:*",
+    "openapi:typegen": "npx openapicmd typegen https://api.promptfoundry.ai/sdk/openapi > src/types/openapi.d.ts"
   },
@@ -51,3 +52,2 @@ "engines": {
     "@types/jest": "^29.5.12",
-    "cspell": "^8.8.1",
     "cz-conventional-changelog": "^3.3.0",
@@ -86,3 +86,7 @@ "eslint": "^8.57.0",
     }
+  },
+  "dependencies": {
+    "axios": "^1.7.2",
+    "openapi-client-axios": "^7.5.4"
   }
 }

README.md

 # @prompt-foundry/typescript-sdk
 
-The Typescript/ JavasScript SDK for the prompt engineering, prompt management, and prompt testing tool.
+The TypeScript/ JavasScript prompt engineering, prompt management, and prompt testing tool.
 
 ## Installation
 
-`npm install @prompt-foundry/typescript-sdk`
+```bash
+npm install @prompt-foundry/typescript-sdk
+```
+
+## Usage
+
+```typescript
+import PromptFoundry from '@prompt-foundry/typescript-sdk'
+
+const pf = new PromptFoundry({
+  apiKey: '<API_KEY>'
+})
+
+const prompt = await pf.getPrompt({ promptId: 'HELLO' })
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

14853

increased by2.29%

Dev dependency count

21

decreased by-4.55%

Number of lines in readme file

22

increased by175%

Worsened metrics

Dependency count

2

increased byInfinity%

Dependency changes

• + Addedaxios@^1.7.2

• + Addedopenapi-client-axios@^7.5.4

• + Addedargparse@2.0.1(transitive)

• + Addedasynckit@0.4.0(transitive)

• + Addedaxios@1.7.9(transitive)

• + Addedbath-es5@3.0.3(transitive)

• + Addedcombined-stream@1.0.8(transitive)

• + Addeddelayed-stream@1.0.0(transitive)

• + Addeddereference-json-schema@0.2.1(transitive)

• + Addedfollow-redirects@1.15.9(transitive)

• + Addedform-data@4.0.1(transitive)

• + Addedjs-yaml@4.1.0(transitive)

• + Addedmime-db@1.52.0(transitive)

• + Addedmime-types@2.1.35(transitive)

• + Addedopenapi-client-axios@7.5.5(transitive)

• + Addedopenapi-types@12.1.3(transitive)

• + Addedproxy-from-env@1.1.0(transitive)