@ikatec/digisac-api-sdk 4.1.0 → 4.2.0

package/dist/apis/terms/TermsApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TermsApi.d.ts","sourceRoot":"","sources":["../../../src/apis/terms/TermsApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAC5C,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAChE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AAEnC;;;;;;GAMG;AACH,qBAAa,QAAS,SAAQ,OAAQ,YAAW,UAAU,CAAC,IAAI,CAAC;IAC/D,SAAgB,QAAQ,YAAW;IAEnC,8FAA8F;IAC9F,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,YAAY,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAKhG;;;OAGG;IACH,YAAY,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAI/D;;;;;;OAMG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;CAO7E"}
+{"version":3,"file":"TermsApi.d.ts","sourceRoot":"","sources":["../../../src/apis/terms/TermsApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAC5C,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAChE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AAEnC;;;;;;GAMG;AACH,qBAAa,QAAS,SAAQ,OAAQ,YAAW,UAAU,CAAC,IAAI,CAAC;IAC/D,SAAgB,QAAQ,YAAW;IAEnC;;;OAGG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,YAAY,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAKhG;;;OAGG;IACH,YAAY,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAI/D;;;;;;OAMG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;CAO7E"}

package/dist/apis/terms/TermsApi.mjs

@@ -10,7 +10,10 @@ import { BaseApi } from "../../core/BaseApi.mjs";
 */
 var TermsApi = class extends BaseApi {
 	basePath = "/terms";
-	/** Returns a single term by its ID, scoped to the current account (`null` when not found). */
+	/**
+	* Returns a single term by its ID, scoped to the current account. When it does not exist the
+	* backend answers 200 with an empty body, which resolves to `undefined`.
+	*/
 	getById(id, query, headers) {
 		const queryString = this.toQueryString(query);
 		return this.client.get(`${this.basePath}/${id}${queryString}`, headers);

package/dist/apis/terms/TermsApi.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"TermsApi.mjs","names":[],"sources":["../../../src/apis/terms/TermsApi.ts"],"sourcesContent":["import { BaseApi } from '../../core/BaseApi'\nimport type { GetByIdQuery, HasGetById } from '../../core/types'\nimport type { Term } from './types'\n\n/**\n * Platform terms of use. Terms are published by Agnus (billing) and accepted by the account users,\n * so the `/terms` route has no create/list/update/delete — only the routes below.\n *\n * `GET /terms/:id/export-pdf` is not exposed: it answers a binary PDF, and `ApiClient` only\n * handles JSON/text bodies.\n */\nexport class TermsApi extends BaseApi implements HasGetById<Term> {\n  public readonly basePath = '/terms'\n\n  /** Returns a single term by its ID, scoped to the current account (`null` when not found). */\n  getById(id: string, query?: GetByIdQuery<Term>, headers?: Record<string, string>): Promise<Term> {\n    const queryString = this.toQueryString(query)\n    return this.client.get<Term>(`${this.basePath}/${id}${queryString}`, headers)\n  }\n\n  /**\n   * Returns the terms of the current account that were not agreed to yet (`agreementDate` null).\n   * The backend answers a plain array (not paginated) and ignores query parameters.\n   */\n  getNotAgreed(headers?: Record<string, string>): Promise<Term[]> {\n    return this.client.get<Term[]>(`${this.basePath}/terms-not-agreed`, headers)\n  }\n\n  /**\n   * Agrees to the given terms on behalf of the authenticated user. IRREVERSIBLE: the acceptance is\n   * registered on Agnus, the terms get `agreementDate`/`userId`, and the signed PDFs are e-mailed\n   * to the user. Only terms of the current account are affected.\n   *\n   * The response is passed through from Agnus as-is, so it is not typed.\n   */\n  agree(termIds: string[], headers?: Record<string, string>): Promise<unknown> {\n    return this.client.patch<unknown, { terms: string[] }>(\n      `${this.basePath}/agree`,\n      { terms: termIds },\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;;;;;;;AAWA,IAAa,WAAb,cAA8B,QAAoC;CAChE,AAAgB,WAAW;;CAG3B,QAAQ,IAAY,OAA4B,SAAiD;EAC/F,MAAM,cAAc,KAAK,cAAc,MAAM;AAC7C,SAAO,KAAK,OAAO,IAAU,GAAG,KAAK,SAAS,GAAG,KAAK,eAAe,QAAQ;;;;;;CAO/E,aAAa,SAAmD;AAC9D,SAAO,KAAK,OAAO,IAAY,GAAG,KAAK,SAAS,oBAAoB,QAAQ;;;;;;;;;CAU9E,MAAM,SAAmB,SAAoD;AAC3E,SAAO,KAAK,OAAO,MACjB,GAAG,KAAK,SAAS,SACjB,EAAE,OAAO,SAAS,EAClB,QACD"}
+{"version":3,"file":"TermsApi.mjs","names":[],"sources":["../../../src/apis/terms/TermsApi.ts"],"sourcesContent":["import { BaseApi } from '../../core/BaseApi'\nimport type { GetByIdQuery, HasGetById } from '../../core/types'\nimport type { Term } from './types'\n\n/**\n * Platform terms of use. Terms are published by Agnus (billing) and accepted by the account users,\n * so the `/terms` route has no create/list/update/delete — only the routes below.\n *\n * `GET /terms/:id/export-pdf` is not exposed: it answers a binary PDF, and `ApiClient` only\n * handles JSON/text bodies.\n */\nexport class TermsApi extends BaseApi implements HasGetById<Term> {\n  public readonly basePath = '/terms'\n\n  /**\n   * Returns a single term by its ID, scoped to the current account. When it does not exist the\n   * backend answers 200 with an empty body, which resolves to `undefined`.\n   */\n  getById(id: string, query?: GetByIdQuery<Term>, headers?: Record<string, string>): Promise<Term> {\n    const queryString = this.toQueryString(query)\n    return this.client.get<Term>(`${this.basePath}/${id}${queryString}`, headers)\n  }\n\n  /**\n   * Returns the terms of the current account that were not agreed to yet (`agreementDate` null).\n   * The backend answers a plain array (not paginated) and ignores query parameters.\n   */\n  getNotAgreed(headers?: Record<string, string>): Promise<Term[]> {\n    return this.client.get<Term[]>(`${this.basePath}/terms-not-agreed`, headers)\n  }\n\n  /**\n   * Agrees to the given terms on behalf of the authenticated user. IRREVERSIBLE: the acceptance is\n   * registered on Agnus, the terms get `agreementDate`/`userId`, and the signed PDFs are e-mailed\n   * to the user. Only terms of the current account are affected.\n   *\n   * The response is passed through from Agnus as-is, so it is not typed.\n   */\n  agree(termIds: string[], headers?: Record<string, string>): Promise<unknown> {\n    return this.client.patch<unknown, { terms: string[] }>(\n      `${this.basePath}/agree`,\n      { terms: termIds },\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;;;;;;;AAWA,IAAa,WAAb,cAA8B,QAAoC;CAChE,AAAgB,WAAW;;;;;CAM3B,QAAQ,IAAY,OAA4B,SAAiD;EAC/F,MAAM,cAAc,KAAK,cAAc,MAAM;AAC7C,SAAO,KAAK,OAAO,IAAU,GAAG,KAAK,SAAS,GAAG,KAAK,eAAe,QAAQ;;;;;;CAO/E,aAAa,SAAmD;AAC9D,SAAO,KAAK,OAAO,IAAY,GAAG,KAAK,SAAS,oBAAoB,QAAQ;;;;;;;;;CAU9E,MAAM,SAAmB,SAAoD;AAC3E,SAAO,KAAK,OAAO,MACjB,GAAG,KAAK,SAAS,SACjB,EAAE,OAAO,SAAS,EAClB,QACD"}

package/dist/apis/timetable/types.d.ts

@@ -1,8 +1,14 @@
+export type TimetableWeekDay = 'sun' | 'mon' | 'tue' | 'wed' | 'thu' | 'fri' | 'sat';
+/**
+ * A working period of the timetable. `start`/`end` are `HH:MM` and `end` must be later than
+ * `start`; the period applies to every day in `weekDays`.
+ */
 export type TimetableWorkSlot = {
-    day: number;
+    /** `HH:MM` */
     start: string;
+    /** `HH:MM`, later than `start`. */
     end: string;
-    active: boolean;
+    weekDays: TimetableWeekDay[];
 };
 export type Timetable = {
     id: string;
@@ -14,13 +20,12 @@ export type Timetable = {
     updatedAt: string;
 };
 export type CreateTimetablePayload = {
+    /** Must be unique in the account (409 otherwise, unless the account allows duplicate names). */
     name: string;
+    /** Minutes before the end of the period to notify. Must be truthy: `0` answers 400 `required`. */
     previousTimeToNotification: number;
     workPlan: TimetableWorkSlot[];
 };
-export type UpdateTimetablePayload = {
-    name?: string;
-    previousTimeToNotification?: number;
-    workPlan?: TimetableWorkSlot[];
-};
+/** The backend requires the three fields on every update (400 `required` otherwise). */
+export type UpdateTimetablePayload = CreateTimetablePayload;
 //# sourceMappingURL=types.d.ts.map

package/dist/apis/timetable/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/timetable/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,iBAAiB,GAAG;IAC9B,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,0BAA0B,EAAE,MAAM,CAAA;IAClC,QAAQ,EAAE,iBAAiB,EAAE,CAAA;IAC7B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,0BAA0B,EAAE,MAAM,CAAA;IAClC,QAAQ,EAAE,iBAAiB,EAAE,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,0BAA0B,CAAC,EAAE,MAAM,CAAA;IACnC,QAAQ,CAAC,EAAE,iBAAiB,EAAE,CAAA;CAC/B,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/timetable/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,gBAAgB,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAA;AAEpF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,cAAc;IACd,KAAK,EAAE,MAAM,CAAA;IACb,mCAAmC;IACnC,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,gBAAgB,EAAE,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,0BAA0B,EAAE,MAAM,CAAA;IAClC,QAAQ,EAAE,iBAAiB,EAAE,CAAA;IAC7B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,gGAAgG;IAChG,IAAI,EAAE,MAAM,CAAA;IACZ,kGAAkG;IAClG,0BAA0B,EAAE,MAAM,CAAA;IAClC,QAAQ,EAAE,iBAAiB,EAAE,CAAA;CAC9B,CAAA;AAED,wFAAwF;AACxF,MAAM,MAAM,sBAAsB,GAAG,sBAAsB,CAAA"}

package/dist/core/BaseCrudApi.cjs

@@ -1,36 +1,9 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_core_BaseApi = require('./BaseApi.cjs');
+const require_core_BaseReadApi = require('./BaseReadApi.cjs');
 
 //#region src/core/BaseCrudApi.ts
-var BaseCrudApi = class extends require_core_BaseApi.BaseApi {
-	basePath;
-	constructor(client, basePath) {
-		super(client);
-		this.basePath = basePath.replace(/\/$/, "");
-	}
-	getMany(query, headers) {
-		const queryString = this.toQueryString(query);
-		return this.client.get(`${this.basePath}${queryString}`, headers);
-	}
-	/**
-	* Returns the first resource matching the query, or `null` when none match.
-	* Convenience over `getMany` with `limit: 1`.
-	* @permissions $resourceName.view
-	*/
-	async getOne(query, headers) {
-		return (await this.getMany({
-			...query,
-			limit: 1,
-			paginate: false
-		}, headers))?.[0] ?? null;
-	}
-	/**
-	* Returns a single resource by ID.
-	* @permissions $resourceName.view
-	*/
-	getById(id, query, headers) {
-		return this.client.get(`${this.basePath}/${id}${this.toQueryString(query)}`, headers);
-	}
+/** Generic CRUD resource: the reads of `BaseReadApi` plus `create`, `updateById` and `deleteById`. */
+var BaseCrudApi = class extends require_core_BaseReadApi.BaseReadApi {
 	/**
 	* Creates a new resource.
 	* @permissions $resourceName.create

package/dist/core/BaseCrudApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"BaseCrudApi.cjs","names":["BaseApi"],"sources":["../../src/core/BaseCrudApi.ts"],"sourcesContent":["import type { ApiClient } from './ApiClient'\nimport { BaseApi } from './BaseApi'\nimport type { CrudApi, GetByIdQuery, ListQuery, Paginated } from './types'\nexport type {\n  WhereClause,\n  IncludeItem,\n  ListQuery,\n  GetByIdQuery,\n  Paginated,\n  HasGetMany,\n  HasGetById,\n  HasCreate,\n  HasUpdateById,\n  HasDeleteById,\n  CrudApi,\n} from './types'\n\nexport class BaseCrudApi<\n  TResponse,\n  TCreate,\n  TUpdate = TCreate,\n  TQuery extends ListQuery<TResponse> = ListQuery<TResponse>,\n>\n  extends BaseApi\n  implements CrudApi<TResponse, TCreate, TUpdate, TQuery>\n{\n  public readonly basePath: string\n\n  constructor(client: ApiClient, basePath: string) {\n    super(client)\n    this.basePath = basePath.replace(/\\/$/, '')\n  }\n\n  getMany(\n    query: TQuery & { paginate: false },\n    headers?: Record<string, string>,\n  ): Promise<TResponse[]>\n  getMany(\n    query?: TQuery & { paginate?: true },\n    headers?: Record<string, string>,\n  ): Promise<Paginated<TResponse>>\n  getMany(\n    query?: TQuery,\n    headers?: Record<string, string>,\n  ): Promise<Paginated<TResponse> | TResponse[]>\n  getMany(\n    query?: TQuery,\n    headers?: Record<string, string>,\n  ): Promise<Paginated<TResponse> | TResponse[]> {\n    const queryString = this.toQueryString(query)\n    return this.client.get<Paginated<TResponse> | TResponse[]>(\n      `${this.basePath}${queryString}`,\n      headers,\n    )\n  }\n\n  /**\n   * Returns the first resource matching the query, or `null` when none match.\n   * Convenience over `getMany` with `limit: 1`.\n   * @permissions $resourceName.view\n   */\n  async getOne(query?: TQuery, headers?: Record<string, string>): Promise<TResponse | null> {\n    const results = await this.getMany(\n      { ...query, limit: 1, paginate: false } as TQuery & { paginate: false },\n      headers,\n    )\n    // An empty response body resolves to `undefined`.\n    return results?.[0] ?? null\n  }\n\n  /**\n   * Returns a single resource by ID.\n   * @permissions $resourceName.view\n   */\n  getById(\n    id: string,\n    query?: GetByIdQuery<TResponse>,\n    headers?: Record<string, string>,\n  ): Promise<TResponse> {\n    return this.client.get<TResponse>(`${this.basePath}/${id}${this.toQueryString(query)}`, headers)\n  }\n\n  /**\n   * Creates a new resource.\n   * @permissions $resourceName.create\n   */\n  create(body: TCreate, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.post<TResponse, TCreate>(this.basePath, body, headers)\n  }\n\n  /**\n   * Updates an existing resource by ID.\n   * @permissions $resourceName.update\n   */\n  updateById(id: string, body: TUpdate, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.put<TResponse, TUpdate>(`${this.basePath}/${id}`, body, headers)\n  }\n\n  /**\n   * Deletes a resource by ID.\n   * @permissions $resourceName.delete\n   */\n  deleteById(id: string, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.delete<TResponse>(`${this.basePath}/${id}`, headers)\n  }\n}\n"],"mappings":";;;;AAiBA,IAAa,cAAb,cAMUA,6BAEV;CACE,AAAgB;CAEhB,YAAY,QAAmB,UAAkB;AAC/C,QAAM,OAAO;AACb,OAAK,WAAW,SAAS,QAAQ,OAAO,GAAG;;CAe7C,QACE,OACA,SAC6C;EAC7C,MAAM,cAAc,KAAK,cAAc,MAAM;AAC7C,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,WAAW,eACnB,QACD;;;;;;;CAQH,MAAM,OAAO,OAAgB,SAA6D;AAMxF,UALgB,MAAM,KAAK,QACzB;GAAE,GAAG;GAAO,OAAO;GAAG,UAAU;GAAO,EACvC,QACD,IAEgB,MAAM;;;;;;CAOzB,QACE,IACA,OACA,SACoB;AACpB,SAAO,KAAK,OAAO,IAAe,GAAG,KAAK,SAAS,GAAG,KAAK,KAAK,cAAc,MAAM,IAAI,QAAQ;;;;;;CAOlG,OAAO,MAAe,SAAsD;AAC1E,SAAO,KAAK,OAAO,KAAyB,KAAK,UAAU,MAAM,QAAQ;;;;;;CAO3E,WAAW,IAAY,MAAe,SAAsD;AAC1F,SAAO,KAAK,OAAO,IAAwB,GAAG,KAAK,SAAS,GAAG,MAAM,MAAM,QAAQ;;;;;;CAOrF,WAAW,IAAY,SAAsD;AAC3E,SAAO,KAAK,OAAO,OAAkB,GAAG,KAAK,SAAS,GAAG,MAAM,QAAQ"}
+{"version":3,"file":"BaseCrudApi.cjs","names":["BaseReadApi"],"sources":["../../src/core/BaseCrudApi.ts"],"sourcesContent":["import { BaseReadApi } from './BaseReadApi'\nimport type { CrudApi, ListQuery } from './types'\nexport type {\n  WhereClause,\n  IncludeItem,\n  ListQuery,\n  GetByIdQuery,\n  Paginated,\n  HasGetMany,\n  HasGetById,\n  HasCreate,\n  HasUpdateById,\n  HasDeleteById,\n  CrudApi,\n} from './types'\n\n/** Generic CRUD resource: the reads of `BaseReadApi` plus `create`, `updateById` and `deleteById`. */\nexport class BaseCrudApi<\n  TResponse,\n  TCreate,\n  TUpdate = TCreate,\n  TQuery extends ListQuery<TResponse> = ListQuery<TResponse>,\n>\n  extends BaseReadApi<TResponse, TQuery>\n  implements CrudApi<TResponse, TCreate, TUpdate, TQuery>\n{\n  /**\n   * Creates a new resource.\n   * @permissions $resourceName.create\n   */\n  create(body: TCreate, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.post<TResponse, TCreate>(this.basePath, body, headers)\n  }\n\n  /**\n   * Updates an existing resource by ID.\n   * @permissions $resourceName.update\n   */\n  updateById(id: string, body: TUpdate, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.put<TResponse, TUpdate>(`${this.basePath}/${id}`, body, headers)\n  }\n\n  /**\n   * Deletes a resource by ID.\n   * @permissions $resourceName.delete\n   */\n  deleteById(id: string, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.delete<TResponse>(`${this.basePath}/${id}`, headers)\n  }\n}\n"],"mappings":";;;;;AAiBA,IAAa,cAAb,cAMUA,qCAEV;;;;;CAKE,OAAO,MAAe,SAAsD;AAC1E,SAAO,KAAK,OAAO,KAAyB,KAAK,UAAU,MAAM,QAAQ;;;;;;CAO3E,WAAW,IAAY,MAAe,SAAsD;AAC1F,SAAO,KAAK,OAAO,IAAwB,GAAG,KAAK,SAAS,GAAG,MAAM,MAAM,QAAQ;;;;;;CAOrF,WAAW,IAAY,SAAsD;AAC3E,SAAO,KAAK,OAAO,OAAkB,GAAG,KAAK,SAAS,GAAG,MAAM,QAAQ"}

package/dist/core/BaseCrudApi.d.ts

@@ -1,28 +1,8 @@
-import type { ApiClient } from './ApiClient';
-import { BaseApi } from './BaseApi';
-import type { CrudApi, GetByIdQuery, ListQuery, Paginated } from './types';
+import { BaseReadApi } from './BaseReadApi';
+import type { CrudApi, ListQuery } from './types';
 export type { WhereClause, IncludeItem, ListQuery, GetByIdQuery, Paginated, HasGetMany, HasGetById, HasCreate, HasUpdateById, HasDeleteById, CrudApi, } from './types';
-export declare class BaseCrudApi<TResponse, TCreate, TUpdate = TCreate, TQuery extends ListQuery<TResponse> = ListQuery<TResponse>> extends BaseApi implements CrudApi<TResponse, TCreate, TUpdate, TQuery> {
-    readonly basePath: string;
-    constructor(client: ApiClient, basePath: string);
-    getMany(query: TQuery & {
-        paginate: false;
-    }, headers?: Record<string, string>): Promise<TResponse[]>;
-    getMany(query?: TQuery & {
-        paginate?: true;
-    }, headers?: Record<string, string>): Promise<Paginated<TResponse>>;
-    getMany(query?: TQuery, headers?: Record<string, string>): Promise<Paginated<TResponse> | TResponse[]>;
-    /**
-     * Returns the first resource matching the query, or `null` when none match.
-     * Convenience over `getMany` with `limit: 1`.
-     * @permissions $resourceName.view
-     */
-    getOne(query?: TQuery, headers?: Record<string, string>): Promise<TResponse | null>;
-    /**
-     * Returns a single resource by ID.
-     * @permissions $resourceName.view
-     */
-    getById(id: string, query?: GetByIdQuery<TResponse>, headers?: Record<string, string>): Promise<TResponse>;
+/** Generic CRUD resource: the reads of `BaseReadApi` plus `create`, `updateById` and `deleteById`. */
+export declare class BaseCrudApi<TResponse, TCreate, TUpdate = TCreate, TQuery extends ListQuery<TResponse> = ListQuery<TResponse>> extends BaseReadApi<TResponse, TQuery> implements CrudApi<TResponse, TCreate, TUpdate, TQuery> {
     /**
      * Creates a new resource.
      * @permissions $resourceName.create

package/dist/core/BaseCrudApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BaseCrudApi.d.ts","sourceRoot":"","sources":["../../src/core/BaseCrudApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAC1E,YAAY,EACV,WAAW,EACX,WAAW,EACX,SAAS,EACT,YAAY,EACZ,SAAS,EACT,UAAU,EACV,UAAU,EACV,SAAS,EACT,aAAa,EACb,aAAa,EACb,OAAO,GACR,MAAM,SAAS,CAAA;AAEhB,qBAAa,WAAW,CACtB,SAAS,EACT,OAAO,EACP,OAAO,GAAG,OAAO,EACjB,MAAM,SAAS,SAAS,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC,CAE1D,SAAQ,OACR,YAAW,OAAO,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC;IAEvD,SAAgB,QAAQ,EAAE,MAAM,CAAA;gBAEpB,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM;IAK/C,OAAO,CACL,KAAK,EAAE,MAAM,GAAG;QAAE,QAAQ,EAAE,KAAK,CAAA;KAAE,EACnC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,EAAE,CAAC;IACvB,OAAO,CACL,KAAK,CAAC,EAAE,MAAM,GAAG;QAAE,QAAQ,CAAC,EAAE,IAAI,CAAA;KAAE,EACpC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IAChC,OAAO,CACL,KAAK,CAAC,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,SAAS,EAAE,CAAC;IAY9C;;;;OAIG;IACG,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;IASzF;;;OAGG;IACH,OAAO,CACL,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC,EAC/B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC;IAIrB;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;IAI3E;;;OAGG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;IAI3F;;;OAGG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;CAG7E"}
+{"version":3,"file":"BaseCrudApi.d.ts","sourceRoot":"","sources":["../../src/core/BaseCrudApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AACjD,YAAY,EACV,WAAW,EACX,WAAW,EACX,SAAS,EACT,YAAY,EACZ,SAAS,EACT,UAAU,EACV,UAAU,EACV,SAAS,EACT,aAAa,EACb,aAAa,EACb,OAAO,GACR,MAAM,SAAS,CAAA;AAEhB,sGAAsG;AACtG,qBAAa,WAAW,CACtB,SAAS,EACT,OAAO,EACP,OAAO,GAAG,OAAO,EACjB,MAAM,SAAS,SAAS,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC,CAE1D,SAAQ,WAAW,CAAC,SAAS,EAAE,MAAM,CACrC,YAAW,OAAO,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC;IAEvD;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;IAI3E;;;OAGG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;IAI3F;;;OAGG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;CAG7E"}

package/dist/core/BaseCrudApi.mjs

@@ -1,35 +1,8 @@
-import { BaseApi } from "./BaseApi.mjs";
+import { BaseReadApi } from "./BaseReadApi.mjs";
 
 //#region src/core/BaseCrudApi.ts
-var BaseCrudApi = class extends BaseApi {
-	basePath;
-	constructor(client, basePath) {
-		super(client);
-		this.basePath = basePath.replace(/\/$/, "");
-	}
-	getMany(query, headers) {
-		const queryString = this.toQueryString(query);
-		return this.client.get(`${this.basePath}${queryString}`, headers);
-	}
-	/**
-	* Returns the first resource matching the query, or `null` when none match.
-	* Convenience over `getMany` with `limit: 1`.
-	* @permissions $resourceName.view
-	*/
-	async getOne(query, headers) {
-		return (await this.getMany({
-			...query,
-			limit: 1,
-			paginate: false
-		}, headers))?.[0] ?? null;
-	}
-	/**
-	* Returns a single resource by ID.
-	* @permissions $resourceName.view
-	*/
-	getById(id, query, headers) {
-		return this.client.get(`${this.basePath}/${id}${this.toQueryString(query)}`, headers);
-	}
+/** Generic CRUD resource: the reads of `BaseReadApi` plus `create`, `updateById` and `deleteById`. */
+var BaseCrudApi = class extends BaseReadApi {
 	/**
 	* Creates a new resource.
 	* @permissions $resourceName.create

package/dist/core/BaseCrudApi.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"BaseCrudApi.mjs","names":[],"sources":["../../src/core/BaseCrudApi.ts"],"sourcesContent":["import type { ApiClient } from './ApiClient'\nimport { BaseApi } from './BaseApi'\nimport type { CrudApi, GetByIdQuery, ListQuery, Paginated } from './types'\nexport type {\n  WhereClause,\n  IncludeItem,\n  ListQuery,\n  GetByIdQuery,\n  Paginated,\n  HasGetMany,\n  HasGetById,\n  HasCreate,\n  HasUpdateById,\n  HasDeleteById,\n  CrudApi,\n} from './types'\n\nexport class BaseCrudApi<\n  TResponse,\n  TCreate,\n  TUpdate = TCreate,\n  TQuery extends ListQuery<TResponse> = ListQuery<TResponse>,\n>\n  extends BaseApi\n  implements CrudApi<TResponse, TCreate, TUpdate, TQuery>\n{\n  public readonly basePath: string\n\n  constructor(client: ApiClient, basePath: string) {\n    super(client)\n    this.basePath = basePath.replace(/\\/$/, '')\n  }\n\n  getMany(\n    query: TQuery & { paginate: false },\n    headers?: Record<string, string>,\n  ): Promise<TResponse[]>\n  getMany(\n    query?: TQuery & { paginate?: true },\n    headers?: Record<string, string>,\n  ): Promise<Paginated<TResponse>>\n  getMany(\n    query?: TQuery,\n    headers?: Record<string, string>,\n  ): Promise<Paginated<TResponse> | TResponse[]>\n  getMany(\n    query?: TQuery,\n    headers?: Record<string, string>,\n  ): Promise<Paginated<TResponse> | TResponse[]> {\n    const queryString = this.toQueryString(query)\n    return this.client.get<Paginated<TResponse> | TResponse[]>(\n      `${this.basePath}${queryString}`,\n      headers,\n    )\n  }\n\n  /**\n   * Returns the first resource matching the query, or `null` when none match.\n   * Convenience over `getMany` with `limit: 1`.\n   * @permissions $resourceName.view\n   */\n  async getOne(query?: TQuery, headers?: Record<string, string>): Promise<TResponse | null> {\n    const results = await this.getMany(\n      { ...query, limit: 1, paginate: false } as TQuery & { paginate: false },\n      headers,\n    )\n    // An empty response body resolves to `undefined`.\n    return results?.[0] ?? null\n  }\n\n  /**\n   * Returns a single resource by ID.\n   * @permissions $resourceName.view\n   */\n  getById(\n    id: string,\n    query?: GetByIdQuery<TResponse>,\n    headers?: Record<string, string>,\n  ): Promise<TResponse> {\n    return this.client.get<TResponse>(`${this.basePath}/${id}${this.toQueryString(query)}`, headers)\n  }\n\n  /**\n   * Creates a new resource.\n   * @permissions $resourceName.create\n   */\n  create(body: TCreate, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.post<TResponse, TCreate>(this.basePath, body, headers)\n  }\n\n  /**\n   * Updates an existing resource by ID.\n   * @permissions $resourceName.update\n   */\n  updateById(id: string, body: TUpdate, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.put<TResponse, TUpdate>(`${this.basePath}/${id}`, body, headers)\n  }\n\n  /**\n   * Deletes a resource by ID.\n   * @permissions $resourceName.delete\n   */\n  deleteById(id: string, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.delete<TResponse>(`${this.basePath}/${id}`, headers)\n  }\n}\n"],"mappings":";;;AAiBA,IAAa,cAAb,cAMU,QAEV;CACE,AAAgB;CAEhB,YAAY,QAAmB,UAAkB;AAC/C,QAAM,OAAO;AACb,OAAK,WAAW,SAAS,QAAQ,OAAO,GAAG;;CAe7C,QACE,OACA,SAC6C;EAC7C,MAAM,cAAc,KAAK,cAAc,MAAM;AAC7C,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,WAAW,eACnB,QACD;;;;;;;CAQH,MAAM,OAAO,OAAgB,SAA6D;AAMxF,UALgB,MAAM,KAAK,QACzB;GAAE,GAAG;GAAO,OAAO;GAAG,UAAU;GAAO,EACvC,QACD,IAEgB,MAAM;;;;;;CAOzB,QACE,IACA,OACA,SACoB;AACpB,SAAO,KAAK,OAAO,IAAe,GAAG,KAAK,SAAS,GAAG,KAAK,KAAK,cAAc,MAAM,IAAI,QAAQ;;;;;;CAOlG,OAAO,MAAe,SAAsD;AAC1E,SAAO,KAAK,OAAO,KAAyB,KAAK,UAAU,MAAM,QAAQ;;;;;;CAO3E,WAAW,IAAY,MAAe,SAAsD;AAC1F,SAAO,KAAK,OAAO,IAAwB,GAAG,KAAK,SAAS,GAAG,MAAM,MAAM,QAAQ;;;;;;CAOrF,WAAW,IAAY,SAAsD;AAC3E,SAAO,KAAK,OAAO,OAAkB,GAAG,KAAK,SAAS,GAAG,MAAM,QAAQ"}
+{"version":3,"file":"BaseCrudApi.mjs","names":[],"sources":["../../src/core/BaseCrudApi.ts"],"sourcesContent":["import { BaseReadApi } from './BaseReadApi'\nimport type { CrudApi, ListQuery } from './types'\nexport type {\n  WhereClause,\n  IncludeItem,\n  ListQuery,\n  GetByIdQuery,\n  Paginated,\n  HasGetMany,\n  HasGetById,\n  HasCreate,\n  HasUpdateById,\n  HasDeleteById,\n  CrudApi,\n} from './types'\n\n/** Generic CRUD resource: the reads of `BaseReadApi` plus `create`, `updateById` and `deleteById`. */\nexport class BaseCrudApi<\n  TResponse,\n  TCreate,\n  TUpdate = TCreate,\n  TQuery extends ListQuery<TResponse> = ListQuery<TResponse>,\n>\n  extends BaseReadApi<TResponse, TQuery>\n  implements CrudApi<TResponse, TCreate, TUpdate, TQuery>\n{\n  /**\n   * Creates a new resource.\n   * @permissions $resourceName.create\n   */\n  create(body: TCreate, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.post<TResponse, TCreate>(this.basePath, body, headers)\n  }\n\n  /**\n   * Updates an existing resource by ID.\n   * @permissions $resourceName.update\n   */\n  updateById(id: string, body: TUpdate, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.put<TResponse, TUpdate>(`${this.basePath}/${id}`, body, headers)\n  }\n\n  /**\n   * Deletes a resource by ID.\n   * @permissions $resourceName.delete\n   */\n  deleteById(id: string, headers?: Record<string, string>): Promise<TResponse> {\n    return this.client.delete<TResponse>(`${this.basePath}/${id}`, headers)\n  }\n}\n"],"mappings":";;;;AAiBA,IAAa,cAAb,cAMU,YAEV;;;;;CAKE,OAAO,MAAe,SAAsD;AAC1E,SAAO,KAAK,OAAO,KAAyB,KAAK,UAAU,MAAM,QAAQ;;;;;;CAO3E,WAAW,IAAY,MAAe,SAAsD;AAC1F,SAAO,KAAK,OAAO,IAAwB,GAAG,KAAK,SAAS,GAAG,MAAM,MAAM,QAAQ;;;;;;CAOrF,WAAW,IAAY,SAAsD;AAC3E,SAAO,KAAK,OAAO,OAAkB,GAAG,KAAK,SAAS,GAAG,MAAM,QAAQ"}

package/dist/core/BaseReadApi.cjs

@@ -0,0 +1,44 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_core_BaseApi = require('./BaseApi.cjs');
+
+//#region src/core/BaseReadApi.ts
+/**
+* Generic read-only resource: `getMany`, `getOne` and `getById` under `basePath`. Base of
+* `BaseCrudApi`, and of the resources the backend only serves for reading (e.g. permissions,
+* auth history).
+*/
+var BaseReadApi = class extends require_core_BaseApi.BaseApi {
+	basePath;
+	constructor(client, basePath) {
+		super(client);
+		this.basePath = basePath.replace(/\/$/, "");
+	}
+	getMany(query, headers) {
+		const queryString = this.toQueryString(query);
+		return this.client.get(`${this.basePath}${queryString}`, headers);
+	}
+	/**
+	* Returns the first resource matching the query, or `null` when none match.
+	* Convenience over `getMany` with `limit: 1`.
+	* @permissions $resourceName.view
+	*/
+	async getOne(query, headers) {
+		return (await this.getMany({
+			...query,
+			limit: 1,
+			paginate: false
+		}, headers))?.[0] ?? null;
+	}
+	/**
+	* Returns a single resource by ID. When it does not exist most routes answer 200 with an empty
+	* body, which resolves to `undefined`.
+	* @permissions $resourceName.view
+	*/
+	getById(id, query, headers) {
+		return this.client.get(`${this.basePath}/${id}${this.toQueryString(query)}`, headers);
+	}
+};
+
+//#endregion
+exports.BaseReadApi = BaseReadApi;
+//# sourceMappingURL=BaseReadApi.cjs.map

package/dist/core/BaseReadApi.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseReadApi.cjs","names":["BaseApi"],"sources":["../../src/core/BaseReadApi.ts"],"sourcesContent":["import type { ApiClient } from './ApiClient'\nimport { BaseApi } from './BaseApi'\nimport type { GetByIdQuery, HasGetById, HasGetMany, ListQuery, Paginated } from './types'\n\n/**\n * Generic read-only resource: `getMany`, `getOne` and `getById` under `basePath`. Base of\n * `BaseCrudApi`, and of the resources the backend only serves for reading (e.g. permissions,\n * auth history).\n */\nexport class BaseReadApi<TResponse, TQuery extends ListQuery<TResponse> = ListQuery<TResponse>>\n  extends BaseApi\n  implements HasGetMany<TResponse, TQuery>, HasGetById<TResponse>\n{\n  public readonly basePath: string\n\n  constructor(client: ApiClient, basePath: string) {\n    super(client)\n    this.basePath = basePath.replace(/\\/$/, '')\n  }\n\n  getMany(\n    query: TQuery & { paginate: false },\n    headers?: Record<string, string>,\n  ): Promise<TResponse[]>\n  getMany(\n    query?: TQuery & { paginate?: true },\n    headers?: Record<string, string>,\n  ): Promise<Paginated<TResponse>>\n  getMany(\n    query?: TQuery,\n    headers?: Record<string, string>,\n  ): Promise<Paginated<TResponse> | TResponse[]>\n  getMany(\n    query?: TQuery,\n    headers?: Record<string, string>,\n  ): Promise<Paginated<TResponse> | TResponse[]> {\n    const queryString = this.toQueryString(query)\n    return this.client.get<Paginated<TResponse> | TResponse[]>(\n      `${this.basePath}${queryString}`,\n      headers,\n    )\n  }\n\n  /**\n   * Returns the first resource matching the query, or `null` when none match.\n   * Convenience over `getMany` with `limit: 1`.\n   * @permissions $resourceName.view\n   */\n  async getOne(query?: TQuery, headers?: Record<string, string>): Promise<TResponse | null> {\n    const results = await this.getMany(\n      { ...query, limit: 1, paginate: false } as TQuery & { paginate: false },\n      headers,\n    )\n    // An empty response body resolves to `undefined`.\n    return results?.[0] ?? null\n  }\n\n  /**\n   * Returns a single resource by ID. When it does not exist most routes answer 200 with an empty\n   * body, which resolves to `undefined`.\n   * @permissions $resourceName.view\n   */\n  getById(\n    id: string,\n    query?: GetByIdQuery<TResponse>,\n    headers?: Record<string, string>,\n  ): Promise<TResponse> {\n    return this.client.get<TResponse>(`${this.basePath}/${id}${this.toQueryString(query)}`, headers)\n  }\n}\n"],"mappings":";;;;;;;;;AASA,IAAa,cAAb,cACUA,6BAEV;CACE,AAAgB;CAEhB,YAAY,QAAmB,UAAkB;AAC/C,QAAM,OAAO;AACb,OAAK,WAAW,SAAS,QAAQ,OAAO,GAAG;;CAe7C,QACE,OACA,SAC6C;EAC7C,MAAM,cAAc,KAAK,cAAc,MAAM;AAC7C,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,WAAW,eACnB,QACD;;;;;;;CAQH,MAAM,OAAO,OAAgB,SAA6D;AAMxF,UALgB,MAAM,KAAK,QACzB;GAAE,GAAG;GAAO,OAAO;GAAG,UAAU;GAAO,EACvC,QACD,IAEgB,MAAM;;;;;;;CAQzB,QACE,IACA,OACA,SACoB;AACpB,SAAO,KAAK,OAAO,IAAe,GAAG,KAAK,SAAS,GAAG,KAAK,KAAK,cAAc,MAAM,IAAI,QAAQ"}

package/dist/core/BaseReadApi.d.ts

@@ -0,0 +1,32 @@
+import type { ApiClient } from './ApiClient';
+import { BaseApi } from './BaseApi';
+import type { GetByIdQuery, HasGetById, HasGetMany, ListQuery, Paginated } from './types';
+/**
+ * Generic read-only resource: `getMany`, `getOne` and `getById` under `basePath`. Base of
+ * `BaseCrudApi`, and of the resources the backend only serves for reading (e.g. permissions,
+ * auth history).
+ */
+export declare class BaseReadApi<TResponse, TQuery extends ListQuery<TResponse> = ListQuery<TResponse>> extends BaseApi implements HasGetMany<TResponse, TQuery>, HasGetById<TResponse> {
+    readonly basePath: string;
+    constructor(client: ApiClient, basePath: string);
+    getMany(query: TQuery & {
+        paginate: false;
+    }, headers?: Record<string, string>): Promise<TResponse[]>;
+    getMany(query?: TQuery & {
+        paginate?: true;
+    }, headers?: Record<string, string>): Promise<Paginated<TResponse>>;
+    getMany(query?: TQuery, headers?: Record<string, string>): Promise<Paginated<TResponse> | TResponse[]>;
+    /**
+     * Returns the first resource matching the query, or `null` when none match.
+     * Convenience over `getMany` with `limit: 1`.
+     * @permissions $resourceName.view
+     */
+    getOne(query?: TQuery, headers?: Record<string, string>): Promise<TResponse | null>;
+    /**
+     * Returns a single resource by ID. When it does not exist most routes answer 200 with an empty
+     * body, which resolves to `undefined`.
+     * @permissions $resourceName.view
+     */
+    getById(id: string, query?: GetByIdQuery<TResponse>, headers?: Record<string, string>): Promise<TResponse>;
+}
+//# sourceMappingURL=BaseReadApi.d.ts.map

package/dist/core/BaseReadApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseReadApi.d.ts","sourceRoot":"","sources":["../../src/core/BaseReadApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAEzF;;;;GAIG;AACH,qBAAa,WAAW,CAAC,SAAS,EAAE,MAAM,SAAS,SAAS,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC,CAC5F,SAAQ,OACR,YAAW,UAAU,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC;IAE/D,SAAgB,QAAQ,EAAE,MAAM,CAAA;gBAEpB,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM;IAK/C,OAAO,CACL,KAAK,EAAE,MAAM,GAAG;QAAE,QAAQ,EAAE,KAAK,CAAA;KAAE,EACnC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,EAAE,CAAC;IACvB,OAAO,CACL,KAAK,CAAC,EAAE,MAAM,GAAG;QAAE,QAAQ,CAAC,EAAE,IAAI,CAAA;KAAE,EACpC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IAChC,OAAO,CACL,KAAK,CAAC,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,SAAS,EAAE,CAAC;IAY9C;;;;OAIG;IACG,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;IASzF;;;;OAIG;IACH,OAAO,CACL,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC,EAC/B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC;CAGtB"}

package/dist/core/BaseReadApi.mjs

@@ -0,0 +1,43 @@
+import { BaseApi } from "./BaseApi.mjs";
+
+//#region src/core/BaseReadApi.ts
+/**
+* Generic read-only resource: `getMany`, `getOne` and `getById` under `basePath`. Base of
+* `BaseCrudApi`, and of the resources the backend only serves for reading (e.g. permissions,
+* auth history).
+*/
+var BaseReadApi = class extends BaseApi {
+	basePath;
+	constructor(client, basePath) {
+		super(client);
+		this.basePath = basePath.replace(/\/$/, "");
+	}
+	getMany(query, headers) {
+		const queryString = this.toQueryString(query);
+		return this.client.get(`${this.basePath}${queryString}`, headers);
+	}
+	/**
+	* Returns the first resource matching the query, or `null` when none match.
+	* Convenience over `getMany` with `limit: 1`.
+	* @permissions $resourceName.view
+	*/
+	async getOne(query, headers) {
+		return (await this.getMany({
+			...query,
+			limit: 1,
+			paginate: false
+		}, headers))?.[0] ?? null;
+	}
+	/**
+	* Returns a single resource by ID. When it does not exist most routes answer 200 with an empty
+	* body, which resolves to `undefined`.
+	* @permissions $resourceName.view
+	*/
+	getById(id, query, headers) {
+		return this.client.get(`${this.basePath}/${id}${this.toQueryString(query)}`, headers);
+	}
+};
+
+//#endregion
+export { BaseReadApi };
+//# sourceMappingURL=BaseReadApi.mjs.map

package/dist/core/BaseReadApi.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseReadApi.mjs","names":[],"sources":["../../src/core/BaseReadApi.ts"],"sourcesContent":["import type { ApiClient } from './ApiClient'\nimport { BaseApi } from './BaseApi'\nimport type { GetByIdQuery, HasGetById, HasGetMany, ListQuery, Paginated } from './types'\n\n/**\n * Generic read-only resource: `getMany`, `getOne` and `getById` under `basePath`. Base of\n * `BaseCrudApi`, and of the resources the backend only serves for reading (e.g. permissions,\n * auth history).\n */\nexport class BaseReadApi<TResponse, TQuery extends ListQuery<TResponse> = ListQuery<TResponse>>\n  extends BaseApi\n  implements HasGetMany<TResponse, TQuery>, HasGetById<TResponse>\n{\n  public readonly basePath: string\n\n  constructor(client: ApiClient, basePath: string) {\n    super(client)\n    this.basePath = basePath.replace(/\\/$/, '')\n  }\n\n  getMany(\n    query: TQuery & { paginate: false },\n    headers?: Record<string, string>,\n  ): Promise<TResponse[]>\n  getMany(\n    query?: TQuery & { paginate?: true },\n    headers?: Record<string, string>,\n  ): Promise<Paginated<TResponse>>\n  getMany(\n    query?: TQuery,\n    headers?: Record<string, string>,\n  ): Promise<Paginated<TResponse> | TResponse[]>\n  getMany(\n    query?: TQuery,\n    headers?: Record<string, string>,\n  ): Promise<Paginated<TResponse> | TResponse[]> {\n    const queryString = this.toQueryString(query)\n    return this.client.get<Paginated<TResponse> | TResponse[]>(\n      `${this.basePath}${queryString}`,\n      headers,\n    )\n  }\n\n  /**\n   * Returns the first resource matching the query, or `null` when none match.\n   * Convenience over `getMany` with `limit: 1`.\n   * @permissions $resourceName.view\n   */\n  async getOne(query?: TQuery, headers?: Record<string, string>): Promise<TResponse | null> {\n    const results = await this.getMany(\n      { ...query, limit: 1, paginate: false } as TQuery & { paginate: false },\n      headers,\n    )\n    // An empty response body resolves to `undefined`.\n    return results?.[0] ?? null\n  }\n\n  /**\n   * Returns a single resource by ID. When it does not exist most routes answer 200 with an empty\n   * body, which resolves to `undefined`.\n   * @permissions $resourceName.view\n   */\n  getById(\n    id: string,\n    query?: GetByIdQuery<TResponse>,\n    headers?: Record<string, string>,\n  ): Promise<TResponse> {\n    return this.client.get<TResponse>(`${this.basePath}/${id}${this.toQueryString(query)}`, headers)\n  }\n}\n"],"mappings":";;;;;;;;AASA,IAAa,cAAb,cACU,QAEV;CACE,AAAgB;CAEhB,YAAY,QAAmB,UAAkB;AAC/C,QAAM,OAAO;AACb,OAAK,WAAW,SAAS,QAAQ,OAAO,GAAG;;CAe7C,QACE,OACA,SAC6C;EAC7C,MAAM,cAAc,KAAK,cAAc,MAAM;AAC7C,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,WAAW,eACnB,QACD;;;;;;;CAQH,MAAM,OAAO,OAAgB,SAA6D;AAMxF,UALgB,MAAM,KAAK,QACzB;GAAE,GAAG;GAAO,OAAO;GAAG,UAAU;GAAO,EACvC,QACD,IAEgB,MAAM;;;;;;;CAQzB,QACE,IACA,OACA,SACoB;AACpB,SAAO,KAAK,OAAO,IAAe,GAAG,KAAK,SAAS,GAAG,KAAK,KAAK,cAAc,MAAM,IAAI,QAAQ"}

package/dist/core/index.cjs

@@ -2,6 +2,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_core_errors = require('./errors.cjs');
 const require_core_BaseApiClient = require('./BaseApiClient.cjs');
 const require_core_BaseApi = require('./BaseApi.cjs');
+const require_core_BaseReadApi = require('./BaseReadApi.cjs');
 const require_core_BaseCrudApi = require('./BaseCrudApi.cjs');
 const require_core_ArchivableCrudApi = require('./ArchivableCrudApi.cjs');
 
@@ -13,6 +14,7 @@ exports.BadRequestError = require_core_errors.BadRequestError;
 exports.BaseApi = require_core_BaseApi.BaseApi;
 exports.BaseApiClient = require_core_BaseApiClient.BaseApiClient;
 exports.BaseCrudApi = require_core_BaseCrudApi.BaseCrudApi;
+exports.BaseReadApi = require_core_BaseReadApi.BaseReadApi;
 exports.ConflictError = require_core_errors.ConflictError;
 exports.DigisacError = require_core_errors.DigisacError;
 exports.InternalServerError = require_core_errors.InternalServerError;

package/dist/core/index.d.ts

@@ -5,6 +5,7 @@ export type { QueryFormat } from './queryString';
 export { DigisacError, ApiConnectionError, ApiError, BadRequestError, ValidationError, AuthenticationError, PaymentRequiredError, PermissionDeniedError, NotFoundError, ConflictError, UnprocessableEntityError, RateLimitError, InternalServerError, parseFieldErrors, } from './errors';
 export type { FieldError, ErrorClassName, ApiErrorOptions } from './errors';
 export { BaseApi } from './BaseApi';
+export { BaseReadApi } from './BaseReadApi';
 export { BaseCrudApi } from './BaseCrudApi';
 export { ArchivableCrudApi } from './ArchivableCrudApi';
 export type { WhereClause, IncludeItem, ListQuery, GetByIdQuery, Paginated } from './types';

package/dist/core/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/core/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,YAAY,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAA;AAC3D,YAAY,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAChD,OAAO,EACL,YAAY,EACZ,kBAAkB,EAClB,QAAQ,EACR,eAAe,EACf,eAAe,EACf,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,aAAa,EACb,aAAa,EACb,wBAAwB,EACxB,cAAc,EACd,mBAAmB,EACnB,gBAAgB,GACjB,MAAM,UAAU,CAAA;AACjB,YAAY,EAAE,UAAU,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAC3E,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AACvD,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/core/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,YAAY,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAA;AAC3D,YAAY,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAChD,OAAO,EACL,YAAY,EACZ,kBAAkB,EAClB,QAAQ,EACR,eAAe,EACf,eAAe,EACf,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,aAAa,EACb,aAAa,EACb,wBAAwB,EACxB,cAAc,EACd,mBAAmB,EACnB,gBAAgB,GACjB,MAAM,UAAU,CAAA;AACjB,YAAY,EAAE,UAAU,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAC3E,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AACvD,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA"}

package/dist/core/index.mjs

@@ -1,7 +1,8 @@
 import { ApiConnectionError, ApiError, AuthenticationError, BadRequestError, ConflictError, DigisacError, InternalServerError, NotFoundError, PaymentRequiredError, PermissionDeniedError, RateLimitError, UnprocessableEntityError, ValidationError, parseFieldErrors } from "./errors.mjs";
 import { BaseApiClient } from "./BaseApiClient.mjs";
 import { BaseApi } from "./BaseApi.mjs";
+import { BaseReadApi } from "./BaseReadApi.mjs";
 import { BaseCrudApi } from "./BaseCrudApi.mjs";
 import { ArchivableCrudApi } from "./ArchivableCrudApi.mjs";
 
-export { ApiConnectionError, ApiError, ArchivableCrudApi, AuthenticationError, BadRequestError, BaseApi, BaseApiClient, BaseCrudApi, ConflictError, DigisacError, InternalServerError, NotFoundError, PaymentRequiredError, PermissionDeniedError, RateLimitError, UnprocessableEntityError, ValidationError, parseFieldErrors };
+export { ApiConnectionError, ApiError, ArchivableCrudApi, AuthenticationError, BadRequestError, BaseApi, BaseApiClient, BaseCrudApi, BaseReadApi, ConflictError, DigisacError, InternalServerError, NotFoundError, PaymentRequiredError, PermissionDeniedError, RateLimitError, UnprocessableEntityError, ValidationError, parseFieldErrors };

package/dist/index.cjs

@@ -2,6 +2,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_core_errors = require('./core/errors.cjs');
 const require_core_BaseApiClient = require('./core/BaseApiClient.cjs');
 const require_core_BaseApi = require('./core/BaseApi.cjs');
+const require_core_BaseReadApi = require('./core/BaseReadApi.cjs');
 const require_core_BaseCrudApi = require('./core/BaseCrudApi.cjs');
 const require_core_ArchivableCrudApi = require('./core/ArchivableCrudApi.cjs');
 require('./core/index.cjs');
@@ -14,6 +15,7 @@ exports.BadRequestError = require_core_errors.BadRequestError;
 exports.BaseApi = require_core_BaseApi.BaseApi;
 exports.BaseApiClient = require_core_BaseApiClient.BaseApiClient;
 exports.BaseCrudApi = require_core_BaseCrudApi.BaseCrudApi;
+exports.BaseReadApi = require_core_BaseReadApi.BaseReadApi;
 exports.ConflictError = require_core_errors.ConflictError;
 exports.DigisacError = require_core_errors.DigisacError;
 exports.InternalServerError = require_core_errors.InternalServerError;

package/dist/index.mjs

@@ -1,8 +1,9 @@
 import { ApiConnectionError, ApiError, AuthenticationError, BadRequestError, ConflictError, DigisacError, InternalServerError, NotFoundError, PaymentRequiredError, PermissionDeniedError, RateLimitError, UnprocessableEntityError, ValidationError, parseFieldErrors } from "./core/errors.mjs";
 import { BaseApiClient } from "./core/BaseApiClient.mjs";
 import { BaseApi } from "./core/BaseApi.mjs";
+import { BaseReadApi } from "./core/BaseReadApi.mjs";
 import { BaseCrudApi } from "./core/BaseCrudApi.mjs";
 import { ArchivableCrudApi } from "./core/ArchivableCrudApi.mjs";
 import "./core/index.mjs";
 
-export { ApiConnectionError, ApiError, ArchivableCrudApi, AuthenticationError, BadRequestError, BaseApi, BaseApiClient, BaseCrudApi, ConflictError, DigisacError, InternalServerError, NotFoundError, PaymentRequiredError, PermissionDeniedError, RateLimitError, UnprocessableEntityError, ValidationError, parseFieldErrors };
+export { ApiConnectionError, ApiError, ArchivableCrudApi, AuthenticationError, BadRequestError, BaseApi, BaseApiClient, BaseCrudApi, BaseReadApi, ConflictError, DigisacError, InternalServerError, NotFoundError, PaymentRequiredError, PermissionDeniedError, RateLimitError, UnprocessableEntityError, ValidationError, parseFieldErrors };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ikatec/digisac-api-sdk",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",

package/src/apis/authHistory/AuthHistoryApi.test.ts

@@ -25,7 +25,6 @@ const entry: AuthHistory = {
   event: 'auth',
   userId: 'user-1',
   accountId: 'acc-1',
-  branch: 'main',
   originIP: '127.0.0.1',
   originUA: 'Mozilla/5.0',
   createdAt: '2024-01-01T00:00:00Z',
@@ -95,10 +94,19 @@ describe('AuthHistoryApi', () => {
       expect(result).toEqual(entry)
     })
 
+    it('sends the query (e.g. include) in the query string, not as headers', async () => {
+      vi.mocked(client.get).mockResolvedValue(entry)
+      await api.getById('ah-1', { include: ['user'] })
+      expect(client.get).toHaveBeenCalledWith(
+        `/auth-history/ah-1?query=${encodeURIComponent(JSON.stringify({ include: ['user'] }))}`,
+        undefined,
+      )
+    })
+
     it('forwards custom headers', async () => {
       vi.mocked(client.get).mockResolvedValue(entry)
       const headers = { 'X-Custom': 'h' }
-      await api.getById('ah-1', headers)
+      await api.getById('ah-1', undefined, headers)
       expect(client.get).toHaveBeenCalledWith('/auth-history/ah-1', headers)
     })
 

package/src/apis/authHistory/AuthHistoryApi.ts

@@ -1,43 +1,17 @@
-import { BaseApi } from '../../core/BaseApi'
-import type { ListQuery, Paginated, HasGetMany, HasGetById } from '../../core/types'
+import type { ApiClient } from '../../core/ApiClient'
+import { BaseReadApi } from '../../core/BaseReadApi'
 import type { AuthHistory } from './types'
 
-export class AuthHistoryApi
-  extends BaseApi
-  implements HasGetMany<AuthHistory>, HasGetById<AuthHistory>
-{
-  /**
-   * Returns a paginated list of authentication events (auth, password_change, logout). Non-admin users can only see their own records.
-   * @permissions authHistory.view
-   */
-  getMany(
-    query: ListQuery<AuthHistory> & { paginate: false },
-    headers?: Record<string, string>,
-  ): Promise<AuthHistory[]>
-  getMany(
-    query?: ListQuery<AuthHistory> & { paginate?: true },
-    headers?: Record<string, string>,
-  ): Promise<Paginated<AuthHistory>>
-  getMany(
-    query?: ListQuery<AuthHistory>,
-    headers?: Record<string, string>,
-  ): Promise<Paginated<AuthHistory> | AuthHistory[]>
-  getMany(
-    query?: ListQuery<AuthHistory>,
-    headers?: Record<string, string>,
-  ): Promise<Paginated<AuthHistory> | AuthHistory[]> {
-    const queryString = this.toQueryString(query)
-    return this.client.get<Paginated<AuthHistory> | AuthHistory[]>(
-      `/auth-history${queryString}`,
-      headers,
-    )
-  }
-
-  /**
-   * Returns a single authentication event by its ID. Non-admin users can only access their own records.
-   * @permissions authHistory.view
-   */
-  getById(id: string, headers?: Record<string, string>): Promise<AuthHistory> {
-    return this.client.get<AuthHistory>(`/auth-history/${id}`, headers)
+/**
+ * Authentication events (auth, password_change, logout), read-only (guarded by
+ * `authHistory.view`). Non-admin users can only see and access their own records.
+ *
+ * Since 4.2 `getById` has the base signature `(id, query?, headers?)`: a call written as
+ * `getById(id, headers)` with the headers in a variable still compiles, but the headers are sent
+ * as the query string — move them to the third argument.
+ */
+export class AuthHistoryApi extends BaseReadApi<AuthHistory> {
+  constructor(client: ApiClient) {
+    super(client, '/auth-history')
   }
 }

package/src/apis/authHistory/types.ts

@@ -8,9 +8,10 @@ export type AuthHistory = {
   event: AuthHistoryEvent
   userId: string
   accountId: string
-  branch: string
-  originIP: string
-  originUA: string
+  /** Nullable in the database. */
+  originIP: string | null
+  /** Nullable in the database. */
+  originUA: string | null
   createdAt: string
   updatedAt: string
   // relationships