@biblioteksentralen/bmdb-search 0.0.0-beta.3 → 0.0.0-beta.31

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,78 @@
 # @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
-
-### Server context
+## Usage examples
 
-When used in a non-browser context, the `baseUrl` can be supplied directly, e.g.
+### Setup client
 
 ```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.bmdb.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:
+### Search works
 
 ```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*`,
-      },
-    ];
+const { data, error } = await bmdbSearchClient.GET("/{searchProfile}/works/search", {
+  params: {
+    path: { searchProfile: "global" },
+    query: { query: "test" },
   },
-};
-
-// 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):
+### Get works
 
 ```typescript
-// middleware.ts
-export const config = {
-  matcher: [
-    // ...other
-    "/((?!|bmdb/api|_next/static).*)",
-  ],
-};
+const { data, error } = await bmdbSearchClient.GET("/{searchProfile}/works", {
+  params: {
+    path: { searchProfile: "deichman" },
+    query: { ids: "1237715,1237713" },
+  },
+});
 ```
 
-## Usage examples
+### Search agents
 
-### Search works using client
+```typescript
+const { data, error } = await bmdbSearchClient.GET("/{searchProfile}/agents/search", {
+  params: {
+    path: { searchProfile: "tonsberg" },
+    query: { query: "test" },
+  },
+});
+```
 
-Uses [openapi-fetch](https://openapi-ts.dev/openapi-fetch/) to generate a typed search client.
+### Find all contributor roles for a given agent
 
 ```typescript
-import { createBmdbSearchClient } from "@biblioteksentralen/bmdb-search";
-
-const bmdbSearchClient = createBmdbSearchClient({ clientIdentifier: "client-unique-description" });
-const { data, error } = await bmdbSearchClient.GET("/works/search", { params: { query: { query: "test" } } });
+const { data, error } = await bmdbSearchClient.GET("/{searchProfile}/agents/search", {
+  params: {
+    path: { searchProfile: "global" },
+    query: { facet: "role", size: 0, facet_terms_size: 20 },
+  },
+});
 ```
 
 The arguments and response are fully typed.
 
-### Search works using react hooks
+## Usage with Next.js
 
-Uses [tanstack](https://tanstack.com/query/latest) for fetch management and [openapi-react-query](https://openapi-ts.dev/openapi-react-query/) for typing.
+The queries have to happen in a server context. For this purpose we can create a server client:
 
 ```typescript
-import { createBmdbSearchHooks } from "@biblioteksentralen/bmdb-search";
+"server only";
 
-const { useQuery, useInfiniteQuery, useSuspenseQuery, queryOptions } = createBmdbSearchHooks({
-  clientIdentifier: "client-unique-description",
-});
+import { createBmdbFetchClient } from "@biblioteksentralen/bmdb-search";
+import { headers } from "next/headers";
 
-const Component = (props) => {
-  const { data, error, isLoading } = useQuery("/works/search", { params: { query: { query: "test" } } });
-  return <div>Hello</div>
-};
+export const getBmdbServerFetchClient = async () =>
+  createBmdbFetchClient({
+    host: "https://search.bmdb.no/",
+    headers: await headers(),
+  });
 ```
-
-## Options
-
-### Client identification policy
-
-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.

package/dist/chunk-MLKGABMK.js

@@ -0,0 +1,7 @@
+var __defProp = Object.defineProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+
+export { __export };