@or-sdk/knowledge-models 0.25.9-beta.4273.0 → 0.25.9-beta.4274.0

package/README.md

@@ -1,9 +1,23 @@
-## Installation:
+# `@or-sdk/knowledge-models`
+
+OneReach SDK client for Knowledge Models.
+
+## When to use
+
+- Use this package when integrating with the Knowledge Models capability on the OneReach platform.
+- Use its typed client and exported models instead of hand-writing requests to that service.
+
+## When not to use
+
+- Do not use it for a different platform capability; choose the dedicated `@or-sdk/*` package instead.
+- Do not use it for generic third-party HTTP calls.
+
+## Installation
 ```
 $ npm i @or-sdk/knowledge-models
 ```
 
-## Usage:
+## Usage
 ```typescript
 import { KnowledgeModels } from '@or-sdk/knowledge-models'
 
@@ -19,3 +33,34 @@ const knowledgeModels = new KnowledgeModels({
   discoveryUrl: 'http://example.discovery/endpoint'
 });
  ```
+
+## Configuration
+
+- Prefer `nluUrl` when the service URL is known; it avoids a discovery request.
+- Use `discoveryUrl` only when the service URL is not available.
+- Provide `token` as a bearer-token string or getter where supported.
+
+## Common pitfalls
+
+- Keep the client token current when it can expire; a token getter is preferable where the constructor accepts one.
+- Treat the generated TypeScript types as the authoritative contract for optional parameters and response shapes.
+
+## Method map
+
+| Method | Purpose |
+|---|---|
+| `listKnowledgeModels(...)` | See the exported TypeScript signature for parameters and result. |
+| `getKnowledgeModel(...)` | See the exported TypeScript signature for parameters and result. |
+| `createKnowledgeModel(...)` | See the exported TypeScript signature for parameters and result. |
+| `updateKnowledgeModel(...)` | See the exported TypeScript signature for parameters and result. |
+| `getLimitsIndex(...)` | See the exported TypeScript signature for parameters and result. |
+| `getLimits(...)` | See the exported TypeScript signature for parameters and result. |
+| `postLimits(...)` | See the exported TypeScript signature for parameters and result. |
+| `listPrebuiltEntities(...)` | See the exported TypeScript signature for parameters and result. |
+| `listEntities(...)` | See the exported TypeScript signature for parameters and result. |
+| `listFeatures(...)` | See the exported TypeScript signature for parameters and result. |
+| `listApplications(...)` | See the exported TypeScript signature for parameters and result. |
+
+## More detail
+
+Full signatures and exported types are available in `src/` and `dist/types/`.

package/package.json

@@ -1,22 +1,19 @@
 {
   "name": "@or-sdk/knowledge-models",
-  "version": "0.25.9-beta.4273.0",
+  "version": "0.25.9-beta.4274.0",
+  "description": "OneReach SDK client for Knowledge Models",
   "license": "Apache-2.0",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
-  "dependencies": {
-    "@or-sdk/base": "^0.44.8-beta.4273.0"
-  },
-  "devDependencies": {
-    "concurrently": "^9.2.0",
-    "typescript": "^5.6.2"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
+  "files": [
+    "dist",
+    "src",
+    "README.md",
+    "CHANGELOG.md"
+  ],
   "scripts": {
-    "build": "concurrently 'pnpm:build:*(!watch)'",
+    "build": "pnpm clean && concurrently 'pnpm:build:*(!watch)'",
     "build:cjs": "tsc --project tsconfig.json",
     "build:esm": "tsc --project tsconfig.esm.json",
     "build:types": "tsc --project tsconfig.types.json",
@@ -26,5 +23,15 @@
     "build:watch:types": "tsc --project tsconfig.types.json -w",
     "clean": "rm -rf ./dist",
     "dev": "pnpm build:watch:esm"
+  },
+  "dependencies": {
+    "@or-sdk/base": "^0.44.7"
+  },
+  "devDependencies": {
+    "concurrently": "9.0.1",
+    "typescript": "5.6.2"
+  },
+  "publishConfig": {
+    "access": "public"
   }
-}
+}

package/src/KnowledgeModels.ts

@@ -48,7 +48,7 @@ export class KnowledgeModels extends Base {
   private async getFullList<T>(
     method: CalApiParams['method'],
     route: string,
-    queryParams: { [key: string]: unknown; } = {},
+    queryParams: { [key: string]: unknown; } = {}
   ): Promise<List<T>> {
     const params = {
       ...queryParams,

package/tsconfig.dev.json

@@ -1,8 +0,0 @@
-{
-  "extends": "./tsconfig.esm.json",
-  "compilerOptions": {
-    "declarationDir": "./dist/types",
-    "rootDir": "./src",
-     "declaration": true
-  }
-}

package/tsconfig.esm.json

@@ -1,12 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "outDir": "./dist/esm",
-    "declarationDir": "./dist/types",
-    "module": "ES6",
-    "target": "es6",
-    "rootDir": "./src",
-    "declaration": true,
-    "declarationMap": true
-  }
-}

package/tsconfig.json

@@ -1,7 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "outDir": "./dist/cjs/",
-    "rootDir": "./src"
-  }
-}

package/tsconfig.types.json

@@ -1,11 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "outDir": "./dist/types",
-    "rootDir": "./src",
-    "declaration": true,
-    "declarationMap": true,
-    "emitDeclarationOnly": true,
-    "removeComments": false
-  }
-}