@scouterna/scoutnet 0.3.6

package/CHANGELOG.md

@@ -0,0 +1,106 @@
+# Changelog
+
+## [0.3.6](https://github.com/Scouterna/scoutnet-api/compare/scoutnet-v0.3.5...scoutnet-v0.3.6) (2025-03-30)
+
+
+### Bug Fixes
+
+* dummy ([a29431c](https://github.com/Scouterna/scoutnet-api/commit/a29431ce4ca49c5120e0f6855877b43c601a8a38))
+
+## [0.3.5](https://github.com/Scouterna/scoutnet-api/compare/scoutnet-v0.3.4...scoutnet-v0.3.5) (2025-03-30)
+
+
+### Bug Fixes
+
+* add metadata to packages ([e2a5728](https://github.com/Scouterna/scoutnet-api/commit/e2a5728ba5ec3604f46a4d70a9ac891b399073d9))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * devDependencies
+    * @scouterna/scoutnet-openapi bumped to 0.1.5
+
+## [0.3.4](https://github.com/Scouterna/scoutnet-api/compare/scoutnet-v0.3.3...scoutnet-v0.3.4) (2025-03-30)
+
+
+### Bug Fixes
+
+* dummy change ([60e78ee](https://github.com/Scouterna/scoutnet-api/commit/60e78eeaf9940e30564c0856d3a038da96e4efd1))
+
+## [0.3.3](https://github.com/Scouterna/scoutnet-api/compare/scoutnet-v0.3.2...scoutnet-v0.3.3) (2025-03-30)
+
+
+### Bug Fixes
+
+* add author to public packages ([e963310](https://github.com/Scouterna/scoutnet-api/commit/e963310c54ece98eda03ea85a2bea8dd3fb98e08))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * devDependencies
+    * @scouterna/scoutnet-openapi bumped to 0.1.4
+
+## [0.3.2](https://github.com/Scouterna/scoutnet-api/compare/scoutnet-v0.3.1...scoutnet-v0.3.2) (2025-03-27)
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * devDependencies
+    * @scouterna/scoutnet-openapi bumped to 0.1.3
+
+## [0.3.1](https://github.com/Scouterna/scoutnet-api/compare/scoutnet-v0.3.0...scoutnet-v0.3.1) (2025-03-27)
+
+
+### Bug Fixes
+
+* add jsdoc to createAuthorizationHeader ([9441e0d](https://github.com/Scouterna/scoutnet-api/commit/9441e0dd0b20fbadc7dd91d70c39539c9b3c0c87))
+
+## [0.3.0](https://github.com/Scouterna/scoutnet-api/compare/scoutnet-v0.2.0...scoutnet-v0.3.0) (2025-03-27)
+
+
+### Features
+
+* initial commit ([b4f964b](https://github.com/Scouterna/scoutnet-api/commit/b4f964bf7ce908386feaed5171f0acc73f27942d))
+
+
+### Bug Fixes
+
+* remove unfinished sentence ([56e46c3](https://github.com/Scouterna/scoutnet-api/commit/56e46c31cc7abc9ce759802ea6eadee289aaed46))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * devDependencies
+    * @scouterna/scoutnet-openapi bumped to 0.1.2
+
+## [0.2.0](https://github.com/Scouterna/scoutnet-api/compare/@scoutnet/scoutnet-v0.1.0...@scoutnet/scoutnet-v0.2.0) (2025-03-27)
+
+
+### Features
+
+* initial commit ([b4f964b](https://github.com/Scouterna/scoutnet-api/commit/b4f964bf7ce908386feaed5171f0acc73f27942d))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * devDependencies
+    * @scouterna/scoutnet-openapi bumped to 0.1.1
+
+## 0.1.0 (2025-03-27)
+
+
+### Features
+
+* initial commit ([b4f964b](https://github.com/Scouterna/scoutnet-api/commit/b4f964bf7ce908386feaed5171f0acc73f27942d))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * devDependencies
+    * @scouterna/scoutnet-openapi bumped to 0.1.0

package/README.md

@@ -0,0 +1,101 @@
+# Scoutnet Node.js API Client
+
+This is an API client for the Scoutnet API developed and maintained by
+[Scouternas e-tjänster](https://etjanster.scout.se/). It is automatically
+generated from the
+[Scoutnet OpenAPI Document](https://github.com/Scouterna/scoutnet-api/blob/main/packages/scoutnet-openapi/scoutnet.yaml).
+
+The client uses [openapi-typescript](https://openapi-ts.dev/introduction) and
+[openapi-fetch](https://openapi-ts.dev/openapi-fetch/) under the hood. This NPM
+package exports all types generated by openapi-typescript as well as a modified
+version of the `createClient` method from openapi-fetch. This means that you can
+use just the types if you need to build something very custom. For complete
+usage instructions, check out their documentation.
+
+## Installation
+
+The client is available on NPM:
+
+```bash
+npm i @scouterna/scoutnet
+```
+
+## Usage
+
+### Creating the client
+
+You must always start by creating an instance of the API client. This ensures
+all requests will be fully type safe.
+
+```ts
+const client = createClient();
+```
+
+You can pass options when creating the client that will apply to all requests.
+For example, you might want to use a different server during development.
+
+```ts
+const client = createClient({
+  baseUrl: 'https://s1.test.custard.no/api'
+});
+```
+
+### Making requests
+
+When making requests you provide the endpoint you want to call, and the types
+are automatically inferred. Because all endpoints in the Scoutnet API have
+unique access keys this is also where you set the Authorization header.
+
+```ts
+const result = await client.GET("/project/get/participants", {
+  headers: {
+    Authorization: createAuthorizationHeader({
+      resourceId: '12345',
+      key: '80vn4...n724',
+    }),
+  },
+});
+
+if ('error' in result) {
+  // Handle the error properly
+  throw new Error(`Request failed with status code ${result.response.status}`);
+}
+
+console.log(data.participants);
+//               ^ Access fully typed properties
+```
+
+There are two important notes to be made here.
+
+First, make sure to use `if ('error' in result)` to check if there is an error
+as in the example above and not just `if (result.error)`. Since Scoutnet returns
+an empty body on errors such as 401 the latter will pass even though there is an
+error.
+
+Second, often times you will receive multiple levels of data. Consider the
+following simplified example of a response:
+```json
+{
+  "first_name": "Janne",
+  "last_name": "Långben",
+  "contact_info": {
+    "1": "0701 23 45 67"
+  }
+}
+```
+
+As you can see the `contact_info` property contains an object of arbitrary data.
+If we instead imagine there was no contact info the response would look like
+this:
+```json
+{
+  "first_name": "Janne",
+  "last_name": "Långben",
+  "contact_info": []
+}
+```
+
+Notice how `contact_info` suddenly became an empty array. This is a quirk of the
+Scoutnet API that happens every time there is an empty object and you will have
+to handle it accordingly. The return type of the API methods should help you
+catch these cases.

package/dist/client.d.ts

@@ -0,0 +1,12 @@
+import type { ClientOptions as OpenApiClientOptions } from "openapi-fetch";
+import type { paths } from "./generated/api-types.js";
+export type APICredentials = {
+    resourceId: number | string;
+    key: string;
+};
+export type ClientOptions = OpenApiClientOptions;
+export declare const createClient: ({ baseUrl, ...clientOptions }: ClientOptions) => import("openapi-fetch").Client<paths, `${string}/${string}`>;
+/**
+ * Creates an authorization header for the Scoutnet API.
+ */
+export declare const createAuthorizationHeader: ({ resourceId, key: token, }: APICredentials) => string;

package/dist/client.js

@@ -0,0 +1,23 @@
+import openApiCreateClient from "openapi-fetch";
+export const createClient = ({ baseUrl = "https://scoutnet.se/api", ...clientOptions }) => {
+    const client = openApiCreateClient({
+        baseUrl,
+        ...clientOptions,
+    });
+    return client;
+};
+const base64encode = (data) => {
+    if (typeof window === "undefined") {
+        return Buffer.from(data).toString("base64");
+    }
+    return window.btoa(data);
+};
+/**
+ * Creates an authorization header for the Scoutnet API.
+ */
+export const createAuthorizationHeader = ({ resourceId, key: token, }) => {
+    const authString = `${resourceId}:${token}`;
+    const encoded = base64encode(authString);
+    return `Basic ${encoded}`;
+};
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,mBAAmB,MAAM,eAAe,CAAC;AAWhD,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,EAC3B,OAAO,GAAG,yBAAyB,EACnC,GAAG,aAAa,EACF,EAAE,EAAE;IAClB,MAAM,MAAM,GAAG,mBAAmB,CAAQ;QACxC,OAAO;QACP,GAAG,aAAa;KACjB,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,EAAE;IACpC,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;QAClC,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC9C,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,EACxC,UAAU,EACV,GAAG,EAAE,KAAK,GACK,EAAE,EAAE;IACnB,MAAM,UAAU,GAAG,GAAG,UAAU,IAAI,KAAK,EAAE,CAAC;IAC5C,MAAM,OAAO,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC;IACzC,OAAO,SAAS,OAAO,EAAE,CAAC;AAC5B,CAAC,CAAC"}

package/dist/generated/api-types.d.ts

@@ -0,0 +1,410 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    "/body_key_list": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Restricted endpoint. Get a list of all bodies and their relations to each other
+         * @description For security reasons this endpoint is not publicly available and can only be used by internally developed systems.
+         */
+        get: operations["listBodyKeys"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/project/get/groups": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get a list of groups with members attending a project */
+        get: operations["getProjectGroups"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/project/get/participants": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get a list of members who are registered on the project */
+        get: operations["getProjectParticipants"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/project/checkin": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        /** Update the check-in state of participant(s) on the project */
+        put: operations["updateCheckin"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        body: {
+            /** @description Unique key for the body. Usually body type and body ID separated by an underscore. */
+            body_key?: string;
+            /** @description The name of the body. */
+            body_name?: string;
+            /** @enum {string} */
+            body_type?: "organisation" | "region" | "network" | "district" | "corps" | "group" | "troop" | "patrol";
+            /** @description ID of the body. */
+            body_id?: number;
+            /** @description ID of the organisation this body belongs to. If this body is an organisation, this is the same as body_id. */
+            organisation_id?: number;
+        };
+        address: {
+            care_of?: string;
+            location_name?: string;
+            line_1?: string;
+            line_2?: string;
+            line_3?: string;
+            post_code?: string;
+            post_town?: string;
+            latitude?: string;
+            longitude?: string;
+            info?: string;
+            country_code?: string;
+            section_name?: string;
+            section_priority?: boolean;
+        };
+        project_stats: {
+            project_id?: number;
+            group_participants?: number;
+            project_name?: string;
+            /** @description NOT YET DOCUMENTED */
+            questions?: Record<string, never>;
+        };
+        group: {
+            /** @description The name of the group. */
+            name?: string;
+            /** @description A description of the group. */
+            description?: string;
+            /** @description Group ID number. */
+            group_no?: number;
+            /** @description Corps or "samverkansorganisation". `null` means Scouterna. */
+            corps_id?: number;
+            /** @description 1: Scoutkår
+             *     2: Sjöscoutkår
+             *     3: Hub-Kår
+             *      */
+            group_types?: number[];
+            /** @description 1: Bäverscouter
+             *     2: Spårarscouter
+             *     3: Upptäckarscouter
+             *     4: Äventyrarscouter
+             *     5: Utmanarscouter
+             *     6: Roverscouter
+             *     7: Annat
+             *     8: Familjescouter
+             *      */
+            troop_types?: number[];
+            /** @description Municipality ID. Name can be found in the region object. */
+            municipality_id?: number;
+            /** @description County ID. Name can be found in the region object. */
+            county_id?: number;
+            /** @description Whether the group is open for new members or not. */
+            public_registration_enabled?: boolean;
+            /** @description Destination list for public registration.
+             *     1: Medlemskap som väntar på godkännande (Membership waiting for approval)
+             *     2: Flytta till väntelista (Move to waiting list)
+             *      */
+            destination_list?: number;
+            /** @description NOT YET DOCUMENTED */
+            badges?: Record<string, never>;
+            addresses?: {
+                [key: string]: components["schemas"]["address"];
+            };
+            email?: {
+                [key: string]: string;
+            };
+            email_membership?: {
+                [key: string]: string;
+            };
+            project_stats?: {
+                [key: string]: components["schemas"]["project_stats"];
+            };
+        };
+        district: {
+            /** @description The name of the district. */
+            name?: string;
+            groups?: {
+                [key: string]: components["schemas"]["group"];
+            };
+        };
+        region: {
+            /** @description The name of the region. */
+            name?: string;
+            districts?: {
+                [key: string]: components["schemas"]["district"];
+            };
+            /** @description NOT YET DOCUMENTED */
+            corps?: Record<string, never>;
+            /** @description Key-value map of municipality IDs (used in the response) to their names. */
+            municipalities?: {
+                [key: string]: string;
+            };
+            /** @description Key-value map of country IDs (used in the response) to their names. */
+            conties?: {
+                [key: string]: string;
+            };
+        };
+        organisation: {
+            /** @description The name of the organisation. */
+            name?: string;
+            regions?: {
+                [key: string]: components["schemas"]["region"];
+            };
+        };
+        project_member: {
+            checked_in?: boolean | null;
+            attended?: boolean | null;
+            cancelled?: boolean | null;
+            member_status?: number | null;
+            member_no?: number | null;
+            group_registration?: boolean | null;
+            first_name?: string | null;
+            last_name?: string | null;
+            ssno?: string | null;
+            registration_date?: string | null;
+            cancelled_date?: string | null;
+            primary_email?: string | null;
+            fee_id?: number | null;
+            primary_membership_info?: {
+                patrol_id?: number | null;
+                patrol_name?: string | null;
+                troop_id?: number | null;
+                troop_name?: string | null;
+                group_id?: number | null;
+                group_name?: string | null;
+                district_id?: number | null;
+                district_name?: string | null;
+                region_id?: number | null;
+                region_name?: string | null;
+                organisation_id?: number | null;
+                organisation_name?: string | null;
+            } | unknown[] | null;
+            group_registration_info?: {
+                group_id?: number | null;
+                patrol_id?: number | null;
+                group_name?: string | null;
+                org_id?: number | null;
+                org_name?: string | null;
+                district_id?: number | null;
+                district_name?: string | null;
+                patrol_name?: string | null;
+            } | {
+                group_id?: number | null;
+                patrol_id?: number | null;
+                group_name?: string | null;
+                org_id?: number | null;
+                org_name?: string | null;
+                district_id?: number | null;
+                district_name?: string | null;
+                patrol_name?: string | null;
+            } | null;
+            /** @description NOT YET DOCUMENTED */
+            questions?: Record<string, never>;
+            contact_info?: {
+                [key: string]: string;
+            };
+        };
+        project_get_participants_labels: {
+            member_status?: {
+                [key: string]: string;
+            };
+            sex?: {
+                [key: string]: string;
+            };
+            project_fee?: {
+                [key: string]: string;
+            };
+            contact_type?: {
+                [key: string]: string;
+            };
+        };
+        checkin: {
+            /**
+             * @description Set to 1 to mark the participant as checked in, 0 to mark as checked out.
+             * @enum {number}
+             */
+            checked_in?: 0 | 1;
+            /** @description A comment to be stored with the check-in. If checked_in is not provided a comment will be stored without changing the check-in state. */
+            comment?: string;
+            /**
+             * @description Only applicable when checking out. Set to 1 to mark the participant as attended, 0 to mark as not attended. Default is 1.
+             * @default 1
+             * @enum {number}
+             */
+            attended: 0 | 1;
+        };
+        checkin_response: {
+            /** @description List of member IDs that were checked in. */
+            checked_in?: number[];
+            /** @description List of member IDs that were checked out and marked as attended. */
+            checked_out_attended?: number[];
+            /** @description List of member IDs that were checked out and marked as not attended. */
+            checked_out_not_attended?: number[];
+            /** @description List of member IDs that were not changed. If only a comment was added, the member is still in this list. */
+            unchanged?: number[];
+            /** @description List of member IDs that exist but are not participants on the project. */
+            not_found?: number[];
+            /** @description List of member IDs that do not exist in the system. */
+            no_member?: number[];
+            /** @description Total number of members that were processed. Unchanged members are counted as well. */
+            total?: number;
+            /** @description NOT YET DOCUMENTED */
+            updated_questions?: Record<string, never>;
+        };
+    };
+    responses: {
+        /** @description When unauthorized there will be no response body. */
+        NotAuthorized: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content?: never;
+        };
+    };
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    listBodyKeys: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: components["schemas"]["body"];
+                    };
+                };
+            };
+            401: components["responses"]["NotAuthorized"];
+        };
+    };
+    getProjectGroups: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Keys of the response object are group IDs and values are group objects. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: components["schemas"]["organisation"];
+                    };
+                };
+            };
+            401: components["responses"]["NotAuthorized"];
+        };
+    };
+    getProjectParticipants: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        participants?: {
+                            [key: string]: components["schemas"]["project_member"];
+                        } | unknown[] | null;
+                        labels?: components["schemas"]["project_get_participants_labels"];
+                    };
+                };
+            };
+            401: components["responses"]["NotAuthorized"];
+        };
+    };
+    updateCheckin: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description An object where the keys are member IDs and the values are objects with check-in details. */
+        requestBody: {
+            content: {
+                "application/json": {
+                    [key: string]: components["schemas"]["checkin"];
+                };
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["checkin_response"];
+                };
+            };
+            401: components["responses"]["NotAuthorized"];
+        };
+    };
+}

package/dist/generated/api-types.js

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export {};
+//# sourceMappingURL=api-types.js.map

package/dist/generated/api-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-types.js","sourceRoot":"","sources":["../../src/generated/api-types.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./generated/api-types.js";
+export * from "./client.js";

package/dist/index.js

@@ -0,0 +1,3 @@
+export * from "./generated/api-types.js";
+export * from "./client.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,cAAc,aAAa,CAAC"}

package/dummy

@@ -0,0 +1,2 @@
+Dummy file for triggering releases
+Another dummy commit

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@scouterna/scoutnet",
+  "version": "0.3.6",
+  "description": "API client for the Scoutnet API.",
+  "keywords": [
+    "scouterna",
+    "scoutnet"
+  ],
+  "author": "Malcolm Nihlén <malcolm.nihlen@scouterna.se>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Scouterna/scoutnet-api.git",
+    "directory": "packages/scoutnet"
+  },
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "scripts": {
+    "build": "pnpm run build:types && pnpm run build:format && pnpm run build:typescript",
+    "build:types": "openapi-typescript ./node_modules/@scouterna/scoutnet-openapi/scoutnet.yaml -o ./src/generated/api-types.ts",
+    "build:format": "biome format --write ./src/generated/api-types.ts",
+    "build:typescript": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.10",
+    "openapi-typescript": "^7.6.0",
+    "typescript": "~5.6.2",
+    "@scouterna/scoutnet-openapi": "workspace:^"
+  },
+  "dependencies": {
+    "openapi-fetch": "^0.13.4"
+  }
+}

package/src/client.ts

@@ -0,0 +1,43 @@
+import type { ClientOptions as OpenApiClientOptions } from "openapi-fetch";
+import openApiCreateClient from "openapi-fetch";
+
+import type { paths } from "./generated/api-types.js";
+
+export type APICredentials = {
+  resourceId: number | string;
+  key: string;
+};
+
+export type ClientOptions = OpenApiClientOptions;
+
+export const createClient = ({
+  baseUrl = "https://scoutnet.se/api",
+  ...clientOptions
+}: ClientOptions) => {
+  const client = openApiCreateClient<paths>({
+    baseUrl,
+    ...clientOptions,
+  });
+
+  return client;
+};
+
+const base64encode = (data: string) => {
+  if (typeof window === "undefined") {
+    return Buffer.from(data).toString("base64");
+  }
+
+  return window.btoa(data);
+};
+
+/**
+ * Creates an authorization header for the Scoutnet API.
+ */
+export const createAuthorizationHeader = ({
+  resourceId,
+  key: token,
+}: APICredentials) => {
+  const authString = `${resourceId}:${token}`;
+  const encoded = base64encode(authString);
+  return `Basic ${encoded}`;
+};

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./generated/api-types.js";
+export * from "./client.js";

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    /* Base Options: */
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "target": "es2022",
+    "allowJs": true,
+    "resolveJsonModule": true,
+    "moduleDetection": "force",
+    "isolatedModules": true,
+    "verbatimModuleSyntax": true,
+
+    /* Strictness */
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+
+    /* Transpilation */
+    "module": "NodeNext",
+    "outDir": "dist",
+    "sourceMap": true,
+    "declaration": true,
+    "lib": ["es2022", "dom"]
+  }
+}