@biblioteksentralen/bmdb-search 0.0.0-beta.1

package/CHANGELOG.md

@@ -0,0 +1,3 @@
+# @biblioteksentralen/bmdb-search
+
+TODO

package/README.md

@@ -0,0 +1,83 @@
+# @biblioteksentralen/bmdb-search
+
+TypeScript client for searching Bibliotekenes metadatabrønn (BMDB).
+
+## Setup
+
+### Server context
+
+When used in a non-browser context, the `baseUrl` can be supplied directly, e.g.
+
+```typescript
+import { createBmdbSearchClient } from "@biblioteksentralen/bmdb-search";
+
+const bmdbSearchClient = createBmdbSearchClient({
+  clientIdentifier: "client-unique-description",
+  baseUrl: "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" });
+```
+
+## 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" } });
+```
+
+The arguments and response are fully typed.
+
+### Search works using 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.
+
+```typescript
+import { createBmdbSearchHooks } from "@biblioteksentralen/bmdb-search";
+
+const { useQuery, useInfiniteQuery, useSuspenseQuery, queryOptions } = createBmdbSearchHooks({
+  clientIdentifier: "client-unique-description",
+});
+
+const Component = (props) => {
+  const { data, error, isLoading } = useQuery("/works/search", { query: { query: "test" } });
+  return <div>Hello</div>
+};
+```
+
+## 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/index.cjs

@@ -0,0 +1,30 @@
+'use strict';
+
+var createFetchClient = require('openapi-fetch');
+var createReactQueryClient = require('openapi-react-query');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var createFetchClient__default = /*#__PURE__*/_interopDefault(createFetchClient);
+var createReactQueryClient__default = /*#__PURE__*/_interopDefault(createReactQueryClient);
+
+// src/client.ts
+var createBmdbSearchClient = ({
+  clientIdentifier,
+  version = "v2",
+  ...options
+}) => {
+  const baseUrl = `${options.baseUrl?.replace(/(.*)\/$/, "$1") ?? ""}/bmdb/api/${version}/`;
+  const client = createFetchClient__default.default({ ...options, baseUrl });
+  client.use({
+    onRequest({ request }) {
+      request.headers.set("client-identifier", clientIdentifier);
+      return request;
+    }
+  });
+  return client;
+};
+var createBmdbSearchHooks = (args) => createReactQueryClient__default.default("searchClient" in args ? args.searchClient : createBmdbSearchClient(args));
+
+exports.createBmdbSearchClient = createBmdbSearchClient;
+exports.createBmdbSearchHooks = createBmdbSearchHooks;