@azure/search-documents/package.json

Azure client library to use AI Search for node.js and browser.

{
  "name": "@azure/search-documents",
  "version": "13.0.0",
  "description": "Azure client library to use AI Search for node.js and browser.",
  "sdk-type": "client",
  "main": "./dist/commonjs/index.js",
  "module": "./dist/esm/index.js",
  "types": "./dist/commonjs/index.d.ts",
  "files": [
    "dist/",
    "README.md",
    "LICENSE"
  ],
  "browser": "./dist/browser/index.js",
  "//metadata": {
    "constantPaths": [
      {
        "path": "src/knowledgeBaseRetrieval/api/knowledgeBaseRetrievalContext.ts",
        "prefix": "userAgentInfo"
      },
      {
        "path": "src/search/api/searchContext.ts",
        "prefix": "userAgentInfo"
      },
      {
        "path": "src/searchIndex/api/searchIndexContext.ts",
        "prefix": "userAgentInfo"
      },
      {
        "path": "src/searchIndexer/api/searchIndexerContext.ts",
        "prefix": "userAgentInfo"
      }
    ]
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/Azure/azure-sdk-for-js",
    "directory": "sdk/search/search-documents"
  },
  "keywords": [
    "azure",
    "cloud"
  ],
  "author": "Microsoft Corporation",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/Azure/azure-sdk-for-js/issues"
  },
  "engines": {
    "node": ">=20.0.0"
  },
  "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/search/search-documents/README.md",
  "sideEffects": false,
  "dependencies": {
    "@azure/core-util": "^1.12.0",
    "@azure-rest/core-client": "^2.3.1",
    "@azure/core-auth": "^1.9.0",
    "@azure/core-rest-pipeline": "^1.20.0",
    "@azure/core-tracing": "^1.2.0",
    "@azure/logger": "^1.2.0",
    "tslib": "^2.8.1"
  },
  "devDependencies": {
    "@azure/identity": "4.13.0",
    "openai": "^6.16.0",
    "@types/node": "^20.19.25",
    "@vitest/browser-playwright": "^4.1.2",
    "@vitest/coverage-istanbul": "^4.1.2",
    "cross-env": "^10.1.0",
    "dotenv": "^16.6.1",
    "eslint": "^9.39.1",
    "playwright": "^1.58.2",
    "prettier": "^3.6.2",
    "react-native": "^0.84.1",
    "rimraf": "^6.1.0",
    "type-plus": "^7.6.2",
    "typescript": "~6.0.2",
    "vitest": "^4.1.2",
    "@azure-tools/test-credential": "^2.1.2",
    "@azure-tools/test-recorder": "^4.1.1",
    "@azure/dev-tool": "^1.0.0",
    "@azure-tools/test-utils-vitest": "^2.0.1",
    "@azure/eslint-plugin-azure-sdk": "^3.0.0"
  },
  "//sampleConfiguration": {
    "productName": "Azure Search Documents",
    "productSlugs": [
      "azure",
      "azure-cognitive-search",
      "azure-search"
    ],
    "requiredResources": {
      "Azure Search Documents instance": "https://learn.microsoft.com/azure/search/search-create-service-portal"
    }
  },
  "type": "module",
  "exports": {
    "./package.json": "./package.json",
    ".": {
      "browser": {
        "types": "./dist/browser/index.d.ts",
        "default": "./dist/browser/index.js"
      },
      "react-native": {
        "types": "./dist/react-native/index.d.ts",
        "default": "./dist/react-native/index.js"
      },
      "import": {
        "types": "./dist/esm/index.d.ts",
        "default": "./dist/esm/index.js"
      },
      "require": {
        "types": "./dist/commonjs/index.d.ts",
        "default": "./dist/commonjs/index.js"
      }
    },
    "./search": {
      "browser": {
        "types": "./dist/browser/search/index.d.ts",
        "default": "./dist/browser/search/index.js"
      },
      "react-native": {
        "types": "./dist/react-native/search/index.d.ts",
        "default": "./dist/react-native/search/index.js"
      },
      "import": {
        "types": "./dist/esm/search/index.d.ts",
        "default": "./dist/esm/search/index.js"
      },
      "require": {
        "types": "./dist/commonjs/search/index.d.ts",
        "default": "./dist/commonjs/search/index.js"
      }
    },
    "./search/api": {
      "browser": {
        "types": "./dist/browser/search/api/index.d.ts",
        "default": "./dist/browser/search/api/index.js"
      },
      "react-native": {
        "types": "./dist/react-native/search/api/index.d.ts",
        "default": "./dist/react-native/search/api/index.js"
      },
      "import": {
        "types": "./dist/esm/search/api/index.d.ts",
        "default": "./dist/esm/search/api/index.js"
      },
      "require": {
        "types": "./dist/commonjs/search/api/index.d.ts",
        "default": "./dist/commonjs/search/api/index.js"
      }
    },
    "./searchIndex": {
      "browser": {
        "types": "./dist/browser/searchIndex/index.d.ts",
        "default": "./dist/browser/searchIndex/index.js"
      },
      "react-native": {
        "types": "./dist/react-native/searchIndex/index.d.ts",
        "default": "./dist/react-native/searchIndex/index.js"
      },
      "import": {
        "types": "./dist/esm/searchIndex/index.d.ts",
        "default": "./dist/esm/searchIndex/index.js"
      },
      "require": {
        "types": "./dist/commonjs/searchIndex/index.d.ts",
        "default": "./dist/commonjs/searchIndex/index.js"
      }
    },
    "./searchIndex/api": {
      "browser": {
        "types": "./dist/browser/searchIndex/api/index.d.ts",
        "default": "./dist/browser/searchIndex/api/index.js"
      },
      "react-native": {
        "types": "./dist/react-native/searchIndex/api/index.d.ts",
        "default": "./dist/react-native/searchIndex/api/index.js"
      },
      "import": {
        "types": "./dist/esm/searchIndex/api/index.d.ts",
        "default": "./dist/esm/searchIndex/api/index.js"
      },
      "require": {
        "types": "./dist/commonjs/searchIndex/api/index.d.ts",
        "default": "./dist/commonjs/searchIndex/api/index.js"
      }
    },
    "./searchIndexer": {
      "browser": {
        "types": "./dist/browser/searchIndexer/index.d.ts",
        "default": "./dist/browser/searchIndexer/index.js"
      },
      "react-native": {
        "types": "./dist/react-native/searchIndexer/index.d.ts",
        "default": "./dist/react-native/searchIndexer/index.js"
      },
      "import": {
        "types": "./dist/esm/searchIndexer/index.d.ts",
        "default": "./dist/esm/searchIndexer/index.js"
      },
      "require": {
        "types": "./dist/commonjs/searchIndexer/index.d.ts",
        "default": "./dist/commonjs/searchIndexer/index.js"
      }
    },
    "./searchIndexer/api": {
      "browser": {
        "types": "./dist/browser/searchIndexer/api/index.d.ts",
        "default": "./dist/browser/searchIndexer/api/index.js"
      },
      "react-native": {
        "types": "./dist/react-native/searchIndexer/api/index.d.ts",
        "default": "./dist/react-native/searchIndexer/api/index.js"
      },
      "import": {
        "types": "./dist/esm/searchIndexer/api/index.d.ts",
        "default": "./dist/esm/searchIndexer/api/index.js"
      },
      "require": {
        "types": "./dist/commonjs/searchIndexer/api/index.d.ts",
        "default": "./dist/commonjs/searchIndexer/api/index.js"
      }
    },
    "./knowledgeBaseRetrieval": {
      "browser": {
        "types": "./dist/browser/knowledgeBaseRetrieval/index.d.ts",
        "default": "./dist/browser/knowledgeBaseRetrieval/index.js"
      },
      "react-native": {
        "types": "./dist/react-native/knowledgeBaseRetrieval/index.d.ts",
        "default": "./dist/react-native/knowledgeBaseRetrieval/index.js"
      },
      "import": {
        "types": "./dist/esm/knowledgeBaseRetrieval/index.d.ts",
        "default": "./dist/esm/knowledgeBaseRetrieval/index.js"
      },
      "require": {
        "types": "./dist/commonjs/knowledgeBaseRetrieval/index.d.ts",
        "default": "./dist/commonjs/knowledgeBaseRetrieval/index.js"
      }
    },
    "./knowledgeBaseRetrieval/api": {
      "browser": {
        "types": "./dist/browser/knowledgeBaseRetrieval/api/index.d.ts",
        "default": "./dist/browser/knowledgeBaseRetrieval/api/index.js"
      },
      "react-native": {
        "types": "./dist/react-native/knowledgeBaseRetrieval/api/index.d.ts",
        "default": "./dist/react-native/knowledgeBaseRetrieval/api/index.js"
      },
      "import": {
        "types": "./dist/esm/knowledgeBaseRetrieval/api/index.d.ts",
        "default": "./dist/esm/knowledgeBaseRetrieval/api/index.js"
      },
      "require": {
        "types": "./dist/commonjs/knowledgeBaseRetrieval/api/index.d.ts",
        "default": "./dist/commonjs/knowledgeBaseRetrieval/api/index.js"
      }
    },
    "./models": {
      "browser": {
        "types": "./dist/browser/models/index.d.ts",
        "default": "./dist/browser/models/index.js"
      },
      "react-native": {
        "types": "./dist/react-native/models/index.d.ts",
        "default": "./dist/react-native/models/index.js"
      },
      "import": {
        "types": "./dist/esm/models/index.d.ts",
        "default": "./dist/esm/models/index.js"
      },
      "require": {
        "types": "./dist/commonjs/models/index.d.ts",
        "default": "./dist/commonjs/models/index.js"
      }
    },
    "./models/azure/search/documents": {
      "browser": {
        "types": "./dist/browser/models/azure/search/documents/index.d.ts",
        "default": "./dist/browser/models/azure/search/documents/index.js"
      },
      "react-native": {
        "types": "./dist/react-native/models/azure/search/documents/index.d.ts",
        "default": "./dist/react-native/models/azure/search/documents/index.js"
      },
      "import": {
        "types": "./dist/esm/models/azure/search/documents/index.d.ts",
        "default": "./dist/esm/models/azure/search/documents/index.js"
      },
      "require": {
        "types": "./dist/commonjs/models/azure/search/documents/index.d.ts",
        "default": "./dist/commonjs/models/azure/search/documents/index.js"
      }
    },
    "./models/azure/search/documents/indexes": {
      "browser": {
        "types": "./dist/browser/models/azure/search/documents/indexes/index.d.ts",
        "default": "./dist/browser/models/azure/search/documents/indexes/index.js"
      },
      "react-native": {
        "types": "./dist/react-native/models/azure/search/documents/indexes/index.d.ts",
        "default": "./dist/react-native/models/azure/search/documents/indexes/index.js"
      },
      "import": {
        "types": "./dist/esm/models/azure/search/documents/indexes/index.d.ts",
        "default": "./dist/esm/models/azure/search/documents/indexes/index.js"
      },
      "require": {
        "types": "./dist/commonjs/models/azure/search/documents/indexes/index.d.ts",
        "default": "./dist/commonjs/models/azure/search/documents/indexes/index.js"
      }
    },
    "./models/azure/search/documents/knowledgeBases": {
      "browser": {
        "types": "./dist/browser/models/azure/search/documents/knowledgeBases/index.d.ts",
        "default": "./dist/browser/models/azure/search/documents/knowledgeBases/index.js"
      },
      "react-native": {
        "types": "./dist/react-native/models/azure/search/documents/knowledgeBases/index.d.ts",
        "default": "./dist/react-native/models/azure/search/documents/knowledgeBases/index.js"
      },
      "import": {
        "types": "./dist/esm/models/azure/search/documents/knowledgeBases/index.d.ts",
        "default": "./dist/esm/models/azure/search/documents/knowledgeBases/index.js"
      },
      "require": {
        "types": "./dist/commonjs/models/azure/search/documents/knowledgeBases/index.d.ts",
        "default": "./dist/commonjs/models/azure/search/documents/knowledgeBases/index.js"
      }
    }
  },
  "imports": {
    "#platform/*": {
      "browser": "./src/*-browser.mts",
      "react-native": "./src/*-react-native.mts",
      "default": "./src/*.ts"
    }
  },
  "scripts": {
    "build": "npm run clean && dev-tool run build-package && dev-tool run extract-api",
    "build:samples": "tsc -p config/tsconfig.samples.json",
    "check-format": "prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.{ts,mts}\" \"generated/**/*.{ts,mts}\" \"test/**/*.{ts,mts}\" \"samples-dev/**/*.{ts,mts}\" \"*.{js,mjs,json}\"",
    "clean": "rimraf --glob dist dist-* temp types *.tgz *.log",
    "execute:samples": "dev-tool samples run samples-dev",
    "extract-api": "dev-tool run build-package && dev-tool run extract-api",
    "format": "prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.{ts,mts}\" \"generated/**/*.{ts,mts}\" \"test/**/*.{ts,mts}\" \"samples-dev/**/*.{ts,mts}\" \"*.{js,mjs,json}\"",
    "generate:client": "tsp-client update -d --emitter-options=\"ignore-nullable-on-optional=true;wrap-non-model-return=false\" && npm run format && npx dev-tool customization apply --skip index.ts",
    "generate:embeddings": "ts-node scripts/generateSampleEmbeddings.ts",
    "lint": "eslint package.json src test samples-dev",
    "lint:fix": "eslint package.json src test samples-dev --fix --fix-type [problem,suggestion]",
    "pack": "pnpm pack 2>&1",
    "test": "tsc -b --noEmit && npm run test:node && npm run test:browser",
    "test:browser": "dev-tool run test:vitest --browser",
    "test:node": "dev-tool run test:vitest --test-proxy-debug",
    "test:node:preview": "cross-env TEST_PREVIEW=true dev-tool run test:vitest --test-proxy-debug",
    "update-snippets": "dev-tool run update-snippets"
  }
}