@biblioteksentralen/bmdb-search 0.0.0-beta.2 → 0.0.0-beta.20

package/CHANGELOG.md

@@ -1,3 +1,10 @@
 # @biblioteksentralen/bmdb-search
 
-TODO
+## 0.0.0-beta.16
+
+- [BREAKING] `/{profile}` prefix for all routes
+- Removed `clientIdentifier`
+
+## 0.0.0-beta.14
+
+- Refactored `Work.subjects` model

package/README.md

@@ -1,95 +1,44 @@
 # @biblioteksentralen/bmdb-search
 
-TypeScript client for searching Bibliotekenes metadatabrønn (BMDB).
+TypeScript client for searching Bibliotekenes metadatabrønn (BMDB) using [openapi-fetch](https://openapi-ts.dev/openapi-fetch/).
 
-## Setup
+## Options
 
-### Server context
+## Usage examples
 
-When used in a non-browser context, the `baseUrl` can be supplied directly, e.g.
+### Search works
 
 ```typescript
-import { createBmdbSearchClient } from "@biblioteksentralen/bmdb-search";
+import { createBmdbFetchClient } from "@biblioteksentralen/bmdb-search";
 
-const bmdbSearchClient = createBmdbSearchClient({
-  clientIdentifier: "client-unique-description",
-  baseUrl: "https://search.data.bs.no",
+const bmdbSearchClient = createBmdbFetchClient({
+  host: "https://search.data.bs.no",
 });
-```
-
-### Browser context
 
-In browsers, a content security policy typically has to be taken into account. One approach is to use URL rewrites. If for example using Next.js, this can be achieved using the config file:
-
-```typescript
-// next.config.js or similar
-const searchApiHost = "https://search.data.bs.no";
-
-const config = {
-  // ... other config ...
-  rewrites() {
-    return [
-      {
-        source: "/bmdb/api/:path*",
-        destination: `${searchApiHost}/bmdb/api/:path*`,
-      },
-    ];
-  },
-};
-
-// File utilizing search client
-import { createBmdbSearchClient } from "@biblioteksentralen/bmdb-search";
-
-const bmdbSearchClient = createBmdbSearchClient({ clientIdentifier: "client-unique-description" });
-```
-
-For Next.js it might also have to be exempt from handling in middleware (e.g. internationalization):
-
-```typescript
-// middleware.ts
-export const config = {
-  matcher: [
-    // ...other
-    "/((?!|bmdb/api|_next/static).*)",
-  ],
-};
-```
-
-## Usage examples
-
-### Search works using client
-
-Uses [openapi-fetch](https://openapi-ts.dev/openapi-fetch/) to generate a typed search client.
-
-```typescript
-import { createBmdbSearchClient } from "@biblioteksentralen/bmdb-search";
-
-const bmdbSearchClient = createBmdbSearchClient({ clientIdentifier: "client-unique-description" });
-const { data, error } = await bmdbSearchClient.GET("/works/search", { query: { query: "test" } });
+const { data, error } = await bmdbSearchClient.GET("/works/search", { params: { query: { query: "test" } } });
 ```
 
 The arguments and response are fully typed.
 
-### Search works using react hooks
+### Usage with tanstack-query, openapi-react-query and React hooks
 
-Uses [tanstack](https://tanstack.com/query/latest) for fetch management and [openapi-react-query](https://openapi-ts.dev/openapi-react-query/) for typing.
+Using [tanstack](https://tanstack.com/query/latest) for fetching with state management and [openapi-react-query](https://openapi-ts.dev/openapi-react-query/) for typing.
 
 ```typescript
-import { createBmdbSearchHooks } from "@biblioteksentralen/bmdb-search";
+import { createBmdbFetchClient } from "@biblioteksentralen/bmdb-search";
+import createReactQueryClient from "openapi-react-query";
 
-const { useQuery, useInfiniteQuery, useSuspenseQuery, queryOptions } = createBmdbSearchHooks({
-  clientIdentifier: "client-unique-description",
+const bmdbSearchClient = createBmdbFetchClient({
+  host: "https://search.data.bs.no"
 });
 
-const Component = (props) => {
-  const { data, error, isLoading } = useQuery("/works/search", { query: { query: "test" } });
-  return <div>Hello</div>
-};
-```
+const { useQuery } = createReactQueryClient(bmdbSearchClient);
 
-## Options
-
-### Client identification policy
+const Component = () => {
+  const { data, error, isLoading } = useQuery("get", "/works/search", { params: { query: { query: "test" } } });
+  if (isLoading) return <div>Loading</div>;
+  if (error) return <div>Something went wrong</div>;
+  return <div>Found {data?.total} works</div>;
+};
 
-The API does not require authentication, but clients should identify themselves using a descriptive
-name and a contact address in the `clientIdentifier` string. We will only contact you about usage of the API.
+```