@scouterna/scoutnet 0.3.6 → 0.3.7

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.3.7](https://github.com/Scouterna/scoutnet-api/compare/scoutnet-v0.3.6...scoutnet-v0.3.7) (2025-03-30)
+
+
+### Bug Fixes
+
+* include necessary files in packages ([3b71721](https://github.com/Scouterna/scoutnet-api/commit/3b7172133a6857c0fe2d78a2cee313a241aaa1c8))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * devDependencies
+    * @scouterna/scoutnet-openapi bumped to 0.1.6
+
 ## [0.3.6](https://github.com/Scouterna/scoutnet-api/compare/scoutnet-v0.3.5...scoutnet-v0.3.6) (2025-03-30)
 
 

package/README.md

@@ -3,7 +3,7 @@
 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).
+[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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scouterna/scoutnet",
-  "version": "0.3.6",
+  "version": "0.3.7",
   "description": "API client for the Scoutnet API.",
   "keywords": [
     "scouterna",
@@ -13,6 +13,13 @@
     "url": "https://github.com/Scouterna/scoutnet-api.git",
     "directory": "packages/scoutnet"
   },
+  "files": [
+    "dist",
+    "src",
+    "README.md",
+    "CHANGELOG.md",
+    "package.json"
+  ],
   "type": "module",
   "exports": {
     ".": "./dist/index.js"

package/src/generated/api-types.ts

@@ -0,0 +1,428 @@
+/**
+ * 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/dummy

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

package/tsconfig.json

@@ -1,25 +0,0 @@
-{
-  "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"]
-  }
-}