\n A Node.js library written in TypeScript to integrate the AIMS API.\n You MAY USE this library on the client as well as on the server side.\n \n \n Reach for more information at aimsapi.com\n \n \n Report a Bug\n -\n Ask a Question\n
\n \n\n
\n\n\n
\n\n\n
Table of Contents
\n\n- [Report a Bug](#report-a-bug)\n- [Getting Started](#getting-started)\n - [Authentication](#authentication)\n - [Example with Next.js](#example-with-nextjs)\n- [Usage](#usage)\n - [TypeScript support](#typescript-support)\n - [Routes](#routes)\n - [Response Structure](#response-structure)\n- [Development](#development)\n - [Naming conventions](#naming-conventions)\n- [License](#license)\n\n\n\n---\n\n\n\n\n## Getting Started\n\n\n\n \nTo work with the package you need to have npm (or other package manager) installed.\nLibrary supports Node.js version 18 and above, and can be used in a client codebase.\n \n \n\n```bash\nnpm install @aims-api/aims-node\n\n# or\n\npnpm add @aims-api/aims-node\n```\n\n### Authentication\n\nIn order to use the library you need to obtain an API key. You can get a demo key by contacting us at [hello@aimsapi.com](mailto:hello@aimsapi.com).\n\n\n\n\n### Example with Next.js\n\n\n\nTypeScript\n\n```typescript\n// pages/api/searchByText.ts\n\nimport { NextApiRequest, NextApiResponse } from 'next'\nimport { Client as AIMSClient } from '@aims-api/aims-node'\n\nconst handler = async (req: NextApiRequest, res: NextApiResponse) => {\n if (req.method === 'POST') {\n try {\n const { text, filter } = req.body\n const aims = new AIMSClient({\n authorization: 'YOUR_API_KEY',\n })\n const response = await aims.endpoints.query.byText({ text, detailed: true, filter })\n return res.status(200).send(response)\n } catch (error) {\n return res.status(error.status).json(error.json)\n }\n }\n return res.status(400).json('Method not allowed')\n}\n\nexport default handler\n```\n\n\n\nJavaScript\n\n\n```javascript\n// pages/api/searchByText.js\n\nimport { Client as AIMSClient } from '@aims-api/aims-node'\n\nconst handler = async (req, res) => {\n if (req.method === 'POST') {\n try {\n const { text, filter } = req.body\n const aims = new AIMSClient({\n authorization: 'YOUR_API_KEY',\n })\n const response = await aims.endpoints.query.byText({\n text,\n detailed: true,\n filter,\n })\n return res.status(200).send(response)\n } catch (error) {\n return res.status(error.status).json(error.json)\n }\n }\n return res.status(400).json('Method not allowed')\n}\n\nexport default handler\n```\n\n\n\n\n\n\n## Usage\n\nIt is common to make a proxy request from client app to the server in order to hide foreign URL.\n\nWhen you create a client instance in your codebase, you can then easily access all the existing endpoints via IDE autocomplete, as well as the required and optional parameters.\n\n### TypeScript support\n\nThe library uses [Zod](https://github.com/colinhacks/zod) for response validation and type generation. Some of the types, Zod schemas and enums are publicly exported and can be accessed from `@aims-api/aims-node/models`.\n\nIn contrast to `@aims-api/aims-node`, any import from `@aims-api/aims-node/models` could be used in both browser and node environment, if needed.\n\nPlease note that the models may be subject to change before version 1.0.0 of `@aims-api/aims-node` is released.\n\n__Example:__\n\n```typescript\nimport type { SearchResponse } from '@aims-api/aims-node/models'\n```\n\n### Routes\n\nThe library provides a set of endpoints that can be found in src/client/index.ts file by the `endpoints` property on line #95.\n\nList of all API endpoints could be found in [AIMS API Documentation](https://docs.aimsapi.com/) under Endpoints section, AIMS queries.\n\n### Response Structure\n\nBoth network errors and response structure errors are handled within a library, so the response is always a valid JavaScript Object in the following structure:\n\n```javascript\n// successful request\n{\n success: true\n data: any\n}\n\n// failed request\n{\n success: false\n error: AxiosError | ZodError\n}\n```\n\n## Development\n\n- Types should be inferred from Zod schemas, this way we are able to create valid checked responses and be generally flexible about the types. Zod schemas should be exported along with the types.\n\n### Naming conventions\n\n- zod schemas are suffixed with `*Schema` and the name is in `camelCase` (e.g. `collectionSchema`). Interfaces derived from these schemas do not have the suffix and are in `PascalCase` (e.g. `Collection`).\n- detailed objects use `detailed*` prefix (e.g. `DetailedCollection` or `detailedCollectionSchema`). This convention was adopted to correspond with requests with `detailed: true` argument.\n- endpoints should export their `*Request` and `*Response` types (e.g. `SimilarSearchResponse`). For other than getter responses, the type should be provided (e.g. `CreateSnapshotRequest` or `DeleteCollectionRequest`). __Note:__ These types represent payloads of the responses or requests, but are not in fact exported with the wrapping `Response`. The complete request type would be e.g. `type EndpointResponse = Response`.\n- arrays of objects use `*List*` member (e.g. `CollectionList` or `collectionListSchema`), using plural form is deprecated (one exception being `SimilarCollections`)\n\n## License\n\nSee LICENSE for more information.\n","readmeFilename":"README.md"}
![\"Created](\"https://img.shields.io/badge/created%20by-AIMS%20API-8137CF\"){kind=icon}
\n![\"NPM](\"https://img.shields.io/npm/v/@aims-api/aims-node.svg\")
\n