@squonk/account-server-client 4.3.1 → 4.4.0-4-4.2174798239

package/src/{account-server-api.schemas.ts → api/api.schemas.ts}

@@ -1,18 +1,38 @@
 /**
- * Generated by orval v7.10.0 🍺
+ * Generated by orval v7.16.1 🍺
  * Do not edit manually.
  * Account Server API
  * The Informatics Matters Account Server API.
 
 A service that provides access to the Account Server, which gives *registered* users access to and management of **Organisations**, **Units**, **Products**, **Users**, and **Assets**.
 
- * OpenAPI spec version: 4.3
+ * OpenAPI spec version: 4.4
  */
 export interface AsError {
   /** Brief error text that can be presented to the user */
   error: string;
 }
 
+export interface ActionGetResponse {
+  /** A list of Actions
+   */
+  actions: ActionDetail[];
+  /** The number of Actions returned
+   */
+  count: number;
+}
+
+export interface ActionDetail {
+  id: number;
+  action: string;
+  content: string;
+  timestamp: string;
+  merchant?: MerchantSummary;
+  product_id?: string;
+  unit_id?: string;
+  org_id?: string;
+}
+
 export type AssetGetByIdResponse = AssetDetail;
 
 export interface AssetGetResponse {
@@ -630,6 +650,23 @@ export interface MerchantDetail {
   api_hostname: string;
 }
 
+/**
+ * The kind of Service
+ */
+export type MerchantSummaryKind = (typeof MerchantSummaryKind)[keyof typeof MerchantSummaryKind];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const MerchantSummaryKind = { DATA_MANAGER: "DATA_MANAGER" } as const;
+
+export interface MerchantSummary {
+  /** The unique ID of the Merchant */
+  id: number;
+  /** The kind of Service */
+  kind: MerchantSummaryKind;
+  /** The name assigned to the Service */
+  name: string;
+}
+
 /**
  * The Unit's default product privacy setting
  */
@@ -985,6 +1022,14 @@ export type QProductIdParameter = string;
  */
 export type QUserIdParameter = string;
 
+export type QFormatParameter = (typeof QFormatParameter)[keyof typeof QFormatParameter];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const QFormatParameter = {
+  PROTOCOL_STRING: "PROTOCOL_STRING",
+  JSON_STRING: "JSON_STRING",
+} as const;
+
 /**
  * A date from which to retrieve assets. Any asset that occurs on ar after this date will be returned. UTC is assumed if no timezone is provided
  */
@@ -1117,3 +1162,38 @@ export type DetachAssetParams = {
    */
   m_id?: QMIdParameter;
 };
+
+export type GetActionsParams = {
+  /**
+   * The required format for delivered content.
+   */
+  format?: QFormatParameter;
+  /**
+   * A date from which to retrieve assets. Any asset that occurs on ar after this date will be returned. UTC is assumed if no timezone is provided
+   */
+  from?: QFromParameter;
+  /**
+   * A Merchant Identity
+   * @minimum 1
+   */
+  m_id?: QMIdParameter;
+  /**
+   * An Organisation Identity
+   * @pattern ^org-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
+   */
+  org_id?: QOrgIdParameter;
+  /**
+   * A Product Identity
+   * @pattern ^product-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
+   */
+  product_id?: QProductIdParameter;
+  /**
+   * A date where assets prior to this will be returned. Any asset that occurs prior this date will be returned. UTC is assumed if no timezone is provided
+   */
+  until?: QUntilParameter;
+  /**
+   * A Unit Identity
+   * @pattern ^unit-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
+   */
+  unit_id?: QUnitIdParameter;
+};

package/src/{asset → api/asset}/asset.ts

@@ -1,12 +1,12 @@
 /**
- * Generated by orval v7.10.0 🍺
+ * Generated by orval v7.16.1 🍺
  * Do not edit manually.
  * Account Server API
  * The Informatics Matters Account Server API.
 
 A service that provides access to the Account Server, which gives *registered* users access to and management of **Organisations**, **Units**, **Products**, **Users**, and **Assets**.
 
- * OpenAPI spec version: 4.3
+ * OpenAPI spec version: 4.4
  */
 import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {
@@ -36,12 +36,12 @@ import type {
   AttachAssetParams,
   DetachAssetParams,
   GetAssetParams,
-} from "../account-server-api.schemas";
+} from "../api.schemas";
 
-import { customInstance } from ".././custom-instance";
-import type { ErrorType } from ".././custom-instance";
-import { queryMutator } from ".././options-mutator";
-import { mutationMutator } from ".././options-mutator";
+import { customInstance } from "../../custom-instance";
+import type { ErrorType } from "../../custom-instance";
+import { queryMutator } from "../../options-mutator";
+import { mutationMutator } from "../../options-mutator";
 
 type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
 
@@ -380,7 +380,7 @@ export const getSpecificAsset = (
   return customInstance<AssetDetail>({ url: `/asset/${assetId}`, method: "GET", signal }, options);
 };
 
-export const getGetSpecificAssetQueryKey = (assetId: string) => {
+export const getGetSpecificAssetQueryKey = (assetId?: string) => {
   return [`/asset/${assetId}`] as const;
 };
 

package/src/{charges → api/charges}/charges.ts

@@ -1,12 +1,12 @@
 /**
- * Generated by orval v7.10.0 🍺
+ * Generated by orval v7.16.1 🍺
  * Do not edit manually.
  * Account Server API
  * The Informatics Matters Account Server API.
 
 A service that provides access to the Account Server, which gives *registered* users access to and management of **Organisations**, **Units**, **Products**, **Users**, and **Assets**.
 
- * OpenAPI spec version: 4.3
+ * OpenAPI spec version: 4.4
  */
 import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {
@@ -33,11 +33,11 @@ import type {
   OrganisationChargesGetResponse,
   ProductChargesGetResponse,
   UnitChargesGetResponse,
-} from "../account-server-api.schemas";
+} from "../api.schemas";
 
-import { customInstance } from ".././custom-instance";
-import type { ErrorType } from ".././custom-instance";
-import { queryMutator } from ".././options-mutator";
+import { customInstance } from "../../custom-instance";
+import type { ErrorType } from "../../custom-instance";
+import { queryMutator } from "../../options-mutator";
 
 type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
 
@@ -274,7 +274,7 @@ export const getOrganisationCharges = (
 };
 
 export const getGetOrganisationChargesQueryKey = (
-  orgId: string,
+  orgId?: string,
   params?: GetOrganisationChargesParams,
 ) => {
   return [`/charges/organisation/${orgId}`, ...(params ? [params] : [])] as const;
@@ -530,7 +530,7 @@ export const getProductCharges = (
 };
 
 export const getGetProductChargesQueryKey = (
-  productId: string,
+  productId?: string,
   params?: GetProductChargesParams,
 ) => {
   return [`/charges/product/${productId}`, ...(params ? [params] : [])] as const;
@@ -774,7 +774,7 @@ export const getUnitCharges = (
   );
 };
 
-export const getGetUnitChargesQueryKey = (unitId: string, params?: GetUnitChargesParams) => {
+export const getGetUnitChargesQueryKey = (unitId?: string, params?: GetUnitChargesParams) => {
   return [`/charges/unit/${unitId}`, ...(params ? [params] : [])] as const;
 };
 

package/src/{event-stream → api/event-stream}/event-stream.ts

@@ -1,12 +1,12 @@
 /**
- * Generated by orval v7.10.0 🍺
+ * Generated by orval v7.16.1 🍺
  * Do not edit manually.
  * Account Server API
  * The Informatics Matters Account Server API.
 
 A service that provides access to the Account Server, which gives *registered* users access to and management of **Organisations**, **Units**, **Products**, **Users**, and **Assets**.
 
- * OpenAPI spec version: 4.3
+ * OpenAPI spec version: 4.4
  */
 import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {
@@ -31,12 +31,12 @@ import type {
   EventStreamGetPostResponse,
   EventStreamPostBodyBody,
   EventStreamVersionGetResponse,
-} from "../account-server-api.schemas";
+} from "../api.schemas";
 
-import { customInstance } from ".././custom-instance";
-import type { ErrorType } from ".././custom-instance";
-import { queryMutator } from ".././options-mutator";
-import { mutationMutator } from ".././options-mutator";
+import { customInstance } from "../../custom-instance";
+import type { ErrorType } from "../../custom-instance";
+import { queryMutator } from "../../options-mutator";
+import { mutationMutator } from "../../options-mutator";
 
 type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
 

package/src/{merchant → api/merchant}/merchant.ts

@@ -1,12 +1,12 @@
 /**
- * Generated by orval v7.10.0 🍺
+ * Generated by orval v7.16.1 🍺
  * Do not edit manually.
  * Account Server API
  * The Informatics Matters Account Server API.
 
 A service that provides access to the Account Server, which gives *registered* users access to and management of **Organisations**, **Units**, **Products**, **Users**, and **Assets**.
 
- * OpenAPI spec version: 4.3
+ * OpenAPI spec version: 4.4
  */
 import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {
@@ -23,11 +23,11 @@ import type {
   UseSuspenseQueryResult,
 } from "@tanstack/react-query";
 
-import type { AsError, MerchantDetail, MerchantsGetResponse } from "../account-server-api.schemas";
+import type { AsError, MerchantDetail, MerchantsGetResponse } from "../api.schemas";
 
-import { customInstance } from ".././custom-instance";
-import type { ErrorType } from ".././custom-instance";
-import { queryMutator } from ".././options-mutator";
+import { customInstance } from "../../custom-instance";
+import type { ErrorType } from "../../custom-instance";
+import { queryMutator } from "../../options-mutator";
 
 type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
 
@@ -252,7 +252,7 @@ export const getService = (
   );
 };
 
-export const getGetServiceQueryKey = (mId: number) => {
+export const getGetServiceQueryKey = (mId?: number) => {
   return [`/merchant/${mId}`] as const;
 };
 

package/src/{organisation → api/organisation}/organisation.ts

@@ -1,12 +1,12 @@
 /**
- * Generated by orval v7.10.0 🍺
+ * Generated by orval v7.16.1 🍺
  * Do not edit manually.
  * Account Server API
  * The Informatics Matters Account Server API.
 
 A service that provides access to the Account Server, which gives *registered* users access to and management of **Organisations**, **Units**, **Products**, **Users**, and **Assets**.
 
- * OpenAPI spec version: 4.3
+ * OpenAPI spec version: 4.4
  */
 import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {
@@ -35,12 +35,12 @@ import type {
   OrganisationPostBodyBody,
   OrganisationPostResponse,
   OrganisationsGetResponse,
-} from "../account-server-api.schemas";
+} from "../api.schemas";
 
-import { customInstance } from ".././custom-instance";
-import type { ErrorType } from ".././custom-instance";
-import { queryMutator } from ".././options-mutator";
-import { mutationMutator } from ".././options-mutator";
+import { customInstance } from "../../custom-instance";
+import type { ErrorType } from "../../custom-instance";
+import { queryMutator } from "../../options-mutator";
+import { mutationMutator } from "../../options-mutator";
 
 type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
 
@@ -383,7 +383,7 @@ export const getOrganisation = (
   );
 };
 
-export const getGetOrganisationQueryKey = (orgId: string) => {
+export const getGetOrganisationQueryKey = (orgId?: string) => {
   return [`/organisation/${orgId}`] as const;
 };
 

package/src/{product → api/product}/product.ts

@@ -1,12 +1,12 @@
 /**
- * Generated by orval v7.10.0 🍺
+ * Generated by orval v7.16.1 🍺
  * Do not edit manually.
  * Account Server API
  * The Informatics Matters Account Server API.
 
 A service that provides access to the Account Server, which gives *registered* users access to and management of **Organisations**, **Units**, **Products**, **Users**, and **Assets**.
 
- * OpenAPI spec version: 4.3
+ * OpenAPI spec version: 4.4
  */
 import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {
@@ -35,12 +35,12 @@ import type {
   ProductsGetTypesResponse,
   UnitProductPostBodyBody,
   UnitProductPostResponse,
-} from "../account-server-api.schemas";
+} from "../api.schemas";
 
-import { customInstance } from ".././custom-instance";
-import type { ErrorType } from ".././custom-instance";
-import { queryMutator } from ".././options-mutator";
-import { mutationMutator } from ".././options-mutator";
+import { customInstance } from "../../custom-instance";
+import type { ErrorType } from "../../custom-instance";
+import { queryMutator } from "../../options-mutator";
+import { mutationMutator } from "../../options-mutator";
 
 type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
 
@@ -711,7 +711,7 @@ export const getProductsForOrganisation = (
   );
 };
 
-export const getGetProductsForOrganisationQueryKey = (orgId: string) => {
+export const getGetProductsForOrganisationQueryKey = (orgId?: string) => {
   return [`/product/organisation/${orgId}`] as const;
 };
 
@@ -1049,7 +1049,7 @@ export const getProductsForUnit = (
   );
 };
 
-export const getGetProductsForUnitQueryKey = (unitId: string) => {
+export const getGetProductsForUnitQueryKey = (unitId?: string) => {
   return [`/product/unit/${unitId}`] as const;
 };
 
@@ -1278,7 +1278,7 @@ export const getProduct = (
   );
 };
 
-export const getGetProductQueryKey = (productId: string) => {
+export const getGetProductQueryKey = (productId?: string) => {
   return [`/product/${productId}`] as const;
 };
 

package/src/{state → api/state}/state.ts

@@ -1,12 +1,12 @@
 /**
- * Generated by orval v7.10.0 🍺
+ * Generated by orval v7.16.1 🍺
  * Do not edit manually.
  * Account Server API
  * The Informatics Matters Account Server API.
 
 A service that provides access to the Account Server, which gives *registered* users access to and management of **Organisations**, **Units**, **Products**, **Users**, and **Assets**.
 
- * OpenAPI spec version: 4.3
+ * OpenAPI spec version: 4.4
  */
 import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {
@@ -23,11 +23,11 @@ import type {
   UseSuspenseQueryResult,
 } from "@tanstack/react-query";
 
-import type { AsError, StateGetVersionResponse } from "../account-server-api.schemas";
+import type { AsError, StateGetVersionResponse } from "../api.schemas";
 
-import { customInstance } from ".././custom-instance";
-import type { ErrorType } from ".././custom-instance";
-import { queryMutator } from ".././options-mutator";
+import { customInstance } from "../../custom-instance";
+import type { ErrorType } from "../../custom-instance";
+import { queryMutator } from "../../options-mutator";
 
 type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
 

package/src/{unit → api/unit}/unit.ts

@@ -1,12 +1,12 @@
 /**
- * Generated by orval v7.10.0 🍺
+ * Generated by orval v7.16.1 🍺
  * Do not edit manually.
  * Account Server API
  * The Informatics Matters Account Server API.
 
 A service that provides access to the Account Server, which gives *registered* users access to and management of **Organisations**, **Units**, **Products**, **Users**, and **Assets**.
 
- * OpenAPI spec version: 4.3
+ * OpenAPI spec version: 4.4
  */
 import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {
@@ -37,12 +37,12 @@ import type {
   UnitAllDetail,
   UnitPatchBodyBody,
   UnitsGetResponse,
-} from "../account-server-api.schemas";
+} from "../api.schemas";
 
-import { customInstance } from ".././custom-instance";
-import type { ErrorType } from ".././custom-instance";
-import { queryMutator } from ".././options-mutator";
-import { mutationMutator } from ".././options-mutator";
+import { customInstance } from "../../custom-instance";
+import type { ErrorType } from "../../custom-instance";
+import { queryMutator } from "../../options-mutator";
+import { mutationMutator } from "../../options-mutator";
 
 type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
 
@@ -62,7 +62,7 @@ export const getOrganisationUnits = (
   );
 };
 
-export const getGetOrganisationUnitsQueryKey = (orgId: string) => {
+export const getGetOrganisationUnitsQueryKey = (orgId?: string) => {
   return [`/organisation/${orgId}/unit`] as const;
 };
 
@@ -391,7 +391,7 @@ export const getUnit = (
   return customInstance<UnitAllDetail>({ url: `/unit/${unitId}`, method: "GET", signal }, options);
 };
 
-export const getGetUnitQueryKey = (unitId: string) => {
+export const getGetUnitQueryKey = (unitId?: string) => {
   return [`/unit/${unitId}`] as const;
 };
 

package/src/{user → api/user}/user.ts

@@ -1,12 +1,12 @@
 /**
- * Generated by orval v7.10.0 🍺
+ * Generated by orval v7.16.1 🍺
  * Do not edit manually.
  * Account Server API
  * The Informatics Matters Account Server API.
 
 A service that provides access to the Account Server, which gives *registered* users access to and management of **Organisations**, **Units**, **Products**, **Users**, and **Assets**.
 
- * OpenAPI spec version: 4.3
+ * OpenAPI spec version: 4.4
  */
 import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {
@@ -26,12 +26,12 @@ import type {
   UseSuspenseQueryResult,
 } from "@tanstack/react-query";
 
-import type { AsError, UserAccountDetail, UsersGetResponse } from "../account-server-api.schemas";
+import type { AsError, UserAccountDetail, UsersGetResponse } from "../api.schemas";
 
-import { customInstance } from ".././custom-instance";
-import type { ErrorType } from ".././custom-instance";
-import { queryMutator } from ".././options-mutator";
-import { mutationMutator } from ".././options-mutator";
+import { customInstance } from "../../custom-instance";
+import type { ErrorType } from "../../custom-instance";
+import { queryMutator } from "../../options-mutator";
+import { mutationMutator } from "../../options-mutator";
 
 type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
 
@@ -265,7 +265,7 @@ export const getOrganisationUsers = (
   );
 };
 
-export const getGetOrganisationUsersQueryKey = (orgId: string) => {
+export const getGetOrganisationUsersQueryKey = (orgId?: string) => {
   return [`/organisation/${orgId}/user`] as const;
 };
 
@@ -678,7 +678,7 @@ export const getOrganisationUnitUsers = (
   );
 };
 
-export const getGetOrganisationUnitUsersQueryKey = (unitId: string) => {
+export const getGetOrganisationUnitUsersQueryKey = (unitId?: string) => {
   return [`/unit/${unitId}/user`] as const;
 };
 

package/src/index.ts

@@ -1,6 +1,6 @@
 // Generated by orval
-// account-server-api Is replaced with the api name
-export * from "./account-server-api.schemas";
+// API_TARGET_NAME Is replaced with the api name
+export * from "./api/api.schemas";
 
 // Request instance and methods to change the baseUrl and auth token
 export * from "./custom-instance";

package/src/options-mutator.ts

@@ -4,7 +4,7 @@ export const queryMutator = <TQueryFnData, TError, TData>({
   queryKey,
   ...queryOptions
 }: UseQueryOptions<TQueryFnData, TError, TData>): UseQueryOptions<TQueryFnData, TError, TData> => {
-  const newQueryKey = ["account-server-api", ...queryKey];
+  const newQueryKey = ["API_TARGET_NAME", ...queryKey];
   return { queryKey: newQueryKey, ...queryOptions };
 };
 
@@ -18,7 +18,7 @@ export const mutationMutator = <TData, TError, TVariables, TContext>({
   TContext
 > => {
   if (Array.isArray(mutationKey)) {
-    const newMutationKey = ["account-server-api", ...mutationKey];
+    const newMutationKey = ["API_TARGET_NAME", ...mutationKey];
     return { mutationKey: newMutationKey, ...mutationOptions };
   }
   return { mutationKey: undefined, ...mutationOptions };

package/tsconfig.json

@@ -0,0 +1,29 @@
+{
+  "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,
+
+    /* AND if you're building for a library: */
+    "declaration": true,
+    "declarationMap": true,
+
+    /* If NOT transpiling with TypeScript: */
+    "module": "preserve",
+    "noEmit": true,
+
+    /* If your code runs in the DOM: */
+    "lib": ["es2022", "dom", "dom.iterable"]
+  }
+}

package/tsdown.config.ts

@@ -0,0 +1,52 @@
+import { defineConfig } from "tsdown";
+
+export default defineConfig({
+  entry: ["src/index.ts", "src/api/*/*.ts"],
+  dts: true,
+  format: ["cjs", "esm"],
+  target: "es2022",
+  platform: "neutral",
+  sourcemap: true,
+  unbundle: true,
+  exports: {
+    customExports(pkg, context) {
+      // Create simplified export paths for API modules (e.g., "./accounting" instead of "./api/accounting/accounting")
+      // Dynamically discovers modules from build output and includes proper type definitions for both ESM and CJS
+
+      // Extract module names from the build chunks
+      const modules = new Set<string>();
+
+      // Get chunks from all formats and extract module names
+      for (const format in context.chunks) {
+        const chunks = context.chunks[format as keyof typeof context.chunks];
+        if (chunks) {
+          for (const chunk of chunks) {
+            if (chunk.type === "chunk" && chunk.fileName) {
+              // Match pattern: api/{moduleName}/{moduleName}.js (or .cjs)
+              const match = chunk.fileName.match(/^api\/([^/]+)\/\1\.(js|cjs)$/);
+              if (match && match[1]) {
+                modules.add(match[1]);
+              }
+            }
+          }
+        }
+      }
+
+      // For each module, create a simplified export path
+      for (const moduleName of modules) {
+        pkg[`./${moduleName}`] = {
+          import: {
+            types: `./dist/api/${moduleName}/${moduleName}.d.ts`,
+            default: `./dist/api/${moduleName}/${moduleName}.js`,
+          },
+          require: {
+            types: `./dist/api/${moduleName}/${moduleName}.d.cts`,
+            default: `./dist/api/${moduleName}/${moduleName}.cjs`,
+          },
+        };
+      }
+
+      return pkg;
+    },
+  },
+});