@ikatec/digisac-api-sdk 4.0.0 → 4.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -2
- package/dist/apis/authHistory/AuthHistoryApi.cjs +3 -9
- package/dist/apis/authHistory/AuthHistoryApi.cjs.map +1 -1
- package/dist/apis/authHistory/AuthHistoryApi.d.ts +3 -4
- package/dist/apis/authHistory/AuthHistoryApi.d.ts.map +1 -1
- package/dist/apis/authHistory/AuthHistoryApi.mjs +3 -7
- package/dist/apis/authHistory/AuthHistoryApi.mjs.map +1 -1
- package/dist/apis/clientFeedback/ClientFeedbackApi.cjs +2 -5
- package/dist/apis/clientFeedback/ClientFeedbackApi.cjs.map +1 -1
- package/dist/apis/clientFeedback/ClientFeedbackApi.d.ts +2 -4
- package/dist/apis/clientFeedback/ClientFeedbackApi.d.ts.map +1 -1
- package/dist/apis/clientFeedback/ClientFeedbackApi.mjs +3 -5
- package/dist/apis/clientFeedback/ClientFeedbackApi.mjs.map +1 -1
- package/dist/apis/contacts/ContactsApi.cjs +2 -2
- package/dist/apis/contacts/ContactsApi.cjs.map +1 -1
- package/dist/apis/contacts/ContactsApi.mjs +2 -2
- package/dist/apis/contacts/ContactsApi.mjs.map +1 -1
- package/dist/apis/me/MeApi.cjs +2 -5
- package/dist/apis/me/MeApi.cjs.map +1 -1
- package/dist/apis/me/MeApi.d.ts +2 -4
- package/dist/apis/me/MeApi.d.ts.map +1 -1
- package/dist/apis/me/MeApi.mjs +3 -5
- package/dist/apis/me/MeApi.mjs.map +1 -1
- package/dist/apis/serviceAccessManagement/ServiceAccessManagementApi.cjs +3 -9
- package/dist/apis/serviceAccessManagement/ServiceAccessManagementApi.cjs.map +1 -1
- package/dist/apis/serviceAccessManagement/ServiceAccessManagementApi.d.ts +3 -4
- package/dist/apis/serviceAccessManagement/ServiceAccessManagementApi.d.ts.map +1 -1
- package/dist/apis/serviceAccessManagement/ServiceAccessManagementApi.mjs +3 -7
- package/dist/apis/serviceAccessManagement/ServiceAccessManagementApi.mjs.map +1 -1
- package/dist/apis/stickerUsers/StickerUsersApi.cjs +3 -9
- package/dist/apis/stickerUsers/StickerUsersApi.cjs.map +1 -1
- package/dist/apis/stickerUsers/StickerUsersApi.d.ts +3 -4
- package/dist/apis/stickerUsers/StickerUsersApi.d.ts.map +1 -1
- package/dist/apis/stickerUsers/StickerUsersApi.mjs +3 -7
- package/dist/apis/stickerUsers/StickerUsersApi.mjs.map +1 -1
- package/dist/apis/terms/TermsApi.cjs +3 -12
- package/dist/apis/terms/TermsApi.cjs.map +1 -1
- package/dist/apis/terms/TermsApi.d.ts +2 -4
- package/dist/apis/terms/TermsApi.d.ts.map +1 -1
- package/dist/apis/terms/TermsApi.mjs +3 -10
- package/dist/apis/terms/TermsApi.mjs.map +1 -1
- package/dist/apis/transcripts/TranscriptsApi.cjs +2 -5
- package/dist/apis/transcripts/TranscriptsApi.cjs.map +1 -1
- package/dist/apis/transcripts/TranscriptsApi.d.ts +2 -4
- package/dist/apis/transcripts/TranscriptsApi.d.ts.map +1 -1
- package/dist/apis/transcripts/TranscriptsApi.mjs +3 -5
- package/dist/apis/transcripts/TranscriptsApi.mjs.map +1 -1
- package/dist/core/ApiClient.d.ts +3 -0
- package/dist/core/ApiClient.d.ts.map +1 -1
- package/dist/core/ArchivableCrudApi.cjs +0 -2
- package/dist/core/ArchivableCrudApi.cjs.map +1 -1
- package/dist/core/ArchivableCrudApi.d.ts.map +1 -1
- package/dist/core/ArchivableCrudApi.mjs +0 -2
- package/dist/core/ArchivableCrudApi.mjs.map +1 -1
- package/dist/core/BaseApi.cjs +34 -0
- package/dist/core/BaseApi.cjs.map +1 -0
- package/dist/core/BaseApi.d.ts +20 -0
- package/dist/core/BaseApi.d.ts.map +1 -0
- package/dist/core/BaseApi.mjs +33 -0
- package/dist/core/BaseApi.mjs.map +1 -0
- package/dist/core/BaseApiClient.cjs +4 -1
- package/dist/core/BaseApiClient.cjs.map +1 -1
- package/dist/core/BaseApiClient.d.ts +7 -1
- package/dist/core/BaseApiClient.d.ts.map +1 -1
- package/dist/core/BaseApiClient.mjs +4 -1
- package/dist/core/BaseApiClient.mjs.map +1 -1
- package/dist/core/BaseCrudApi.cjs +6 -16
- package/dist/core/BaseCrudApi.cjs.map +1 -1
- package/dist/core/BaseCrudApi.d.ts +3 -2
- package/dist/core/BaseCrudApi.d.ts.map +1 -1
- package/dist/core/BaseCrudApi.mjs +6 -14
- package/dist/core/BaseCrudApi.mjs.map +1 -1
- package/dist/core/bindMethods.cjs +24 -0
- package/dist/core/bindMethods.cjs.map +1 -0
- package/dist/core/bindMethods.d.ts +7 -0
- package/dist/core/bindMethods.d.ts.map +1 -0
- package/dist/core/bindMethods.mjs +22 -0
- package/dist/core/bindMethods.mjs.map +1 -0
- package/dist/core/index.cjs +2 -0
- package/dist/core/index.d.ts +3 -0
- package/dist/core/index.d.ts.map +1 -1
- package/dist/core/index.mjs +2 -1
- package/dist/core/queryString.cjs +22 -0
- package/dist/core/queryString.cjs.map +1 -0
- package/dist/core/queryString.d.ts +14 -0
- package/dist/core/queryString.d.ts.map +1 -0
- package/dist/core/queryString.mjs +18 -0
- package/dist/core/queryString.mjs.map +1 -0
- package/dist/core/types.d.ts +2 -0
- package/dist/core/types.d.ts.map +1 -1
- package/dist/core/withQueryFormat.cjs +42 -0
- package/dist/core/withQueryFormat.cjs.map +1 -0
- package/dist/core/withQueryFormat.d.ts +10 -0
- package/dist/core/withQueryFormat.d.ts.map +1 -0
- package/dist/core/withQueryFormat.mjs +40 -0
- package/dist/core/withQueryFormat.mjs.map +1 -0
- package/dist/index.cjs +2 -0
- package/dist/index.mjs +2 -1
- package/package.json +1 -1
- package/src/apis/authHistory/AuthHistoryApi.test.ts +1 -1
- package/src/apis/authHistory/AuthHistoryApi.ts +10 -10
- package/src/apis/campaigns/CampaignsApi.test.ts +1 -1
- package/src/apis/clientFeedback/ClientFeedbackApi.ts +5 -7
- package/src/apis/contacts/ContactsApi.test.ts +1 -1
- package/src/apis/contacts/ContactsApi.ts +2 -2
- package/src/apis/me/MeApi.ts +2 -8
- package/src/apis/messages/MessagesApi.test.ts +2 -2
- package/src/apis/queryFormat.test.ts +198 -0
- package/src/apis/serviceAccessManagement/ServiceAccessManagementApi.test.ts +2 -2
- package/src/apis/serviceAccessManagement/ServiceAccessManagementApi.ts +10 -10
- package/src/apis/stickerUsers/StickerUsersApi.test.ts +1 -1
- package/src/apis/stickerUsers/StickerUsersApi.ts +7 -10
- package/src/apis/terms/TermsApi.ts +3 -12
- package/src/apis/transcripts/TranscriptsApi.ts +2 -7
- package/src/core/ApiClient.ts +4 -0
- package/src/core/ArchivableCrudApi.ts +0 -2
- package/src/core/BaseApi.test.ts +164 -0
- package/src/core/BaseApi.ts +32 -0
- package/src/core/BaseApiClient.test.ts +10 -0
- package/src/core/BaseApiClient.ts +9 -1
- package/src/core/BaseCrudApi.test-d.ts +9 -0
- package/src/core/BaseCrudApi.test.ts +131 -60
- package/src/core/BaseCrudApi.ts +14 -14
- package/src/core/bindMethods.ts +26 -0
- package/src/core/index.ts +3 -0
- package/src/core/queryString.test.ts +71 -0
- package/src/core/queryString.ts +30 -0
- package/src/core/types.ts +5 -0
- package/src/core/withQueryFormat.test.ts +136 -0
- package/src/core/withQueryFormat.ts +47 -0
|
@@ -1,13 +1,9 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { BaseApi } from "../../core/BaseApi.mjs";
|
|
2
2
|
|
|
3
3
|
//#region src/apis/stickerUsers/StickerUsersApi.ts
|
|
4
|
-
var StickerUsersApi = class {
|
|
5
|
-
client;
|
|
6
|
-
constructor(client) {
|
|
7
|
-
this.client = client;
|
|
8
|
-
}
|
|
4
|
+
var StickerUsersApi = class extends BaseApi {
|
|
9
5
|
getMany(query, headers) {
|
|
10
|
-
const queryString =
|
|
6
|
+
const queryString = this.toQueryString(query);
|
|
11
7
|
return this.client.get(`/sticker-users${queryString}`, headers);
|
|
12
8
|
}
|
|
13
9
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"StickerUsersApi.mjs","names":[],"sources":["../../../src/apis/stickerUsers/StickerUsersApi.ts"],"sourcesContent":["import
|
|
1
|
+
{"version":3,"file":"StickerUsersApi.mjs","names":[],"sources":["../../../src/apis/stickerUsers/StickerUsersApi.ts"],"sourcesContent":["import { BaseApi } from '../../core/BaseApi'\nimport type { ListQuery, Paginated, HasGetMany } from '../../core/types'\nimport type { StickerUser } from './types'\n\nexport class StickerUsersApi extends BaseApi implements HasGetMany<StickerUser> {\n /**\n * Returns a paginated list of sticker-user associations with their related file.\n * @permissions stickers.send\n */\n getMany(\n query: ListQuery<StickerUser> & { paginate: false },\n headers?: Record<string, string>,\n ): Promise<StickerUser[]>\n getMany(\n query?: ListQuery<StickerUser> & { paginate?: true },\n headers?: Record<string, string>,\n ): Promise<Paginated<StickerUser>>\n getMany(\n query?: ListQuery<StickerUser>,\n headers?: Record<string, string>,\n ): Promise<Paginated<StickerUser> | StickerUser[]>\n getMany(\n query?: ListQuery<StickerUser>,\n headers?: Record<string, string>,\n ): Promise<Paginated<StickerUser> | StickerUser[]> {\n const queryString = this.toQueryString(query)\n return this.client.get<Paginated<StickerUser> | StickerUser[]>(\n `/sticker-users${queryString}`,\n headers,\n )\n }\n}\n"],"mappings":";;;AAIA,IAAa,kBAAb,cAAqC,QAA2C;CAiB9E,QACE,OACA,SACiD;EACjD,MAAM,cAAc,KAAK,cAAc,MAAM;AAC7C,SAAO,KAAK,OAAO,IACjB,iBAAiB,eACjB,QACD"}
|
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
|
|
2
|
-
const
|
|
3
|
-
let qs = require("qs");
|
|
4
|
-
qs = require_chunk.__toESM(qs);
|
|
2
|
+
const require_core_BaseApi = require('../../core/BaseApi.cjs');
|
|
5
3
|
|
|
6
4
|
//#region src/apis/terms/TermsApi.ts
|
|
7
5
|
/**
|
|
@@ -11,18 +9,11 @@ qs = require_chunk.__toESM(qs);
|
|
|
11
9
|
* `GET /terms/:id/export-pdf` is not exposed: it answers a binary PDF, and `ApiClient` only
|
|
12
10
|
* handles JSON/text bodies.
|
|
13
11
|
*/
|
|
14
|
-
var TermsApi = class {
|
|
15
|
-
client;
|
|
12
|
+
var TermsApi = class extends require_core_BaseApi.BaseApi {
|
|
16
13
|
basePath = "/terms";
|
|
17
|
-
constructor(client) {
|
|
18
|
-
this.client = client;
|
|
19
|
-
this.getById = this.getById.bind(this);
|
|
20
|
-
this.getNotAgreed = this.getNotAgreed.bind(this);
|
|
21
|
-
this.agree = this.agree.bind(this);
|
|
22
|
-
}
|
|
23
14
|
/** Returns a single term by its ID, scoped to the current account (`null` when not found). */
|
|
24
15
|
getById(id, query, headers) {
|
|
25
|
-
const queryString =
|
|
16
|
+
const queryString = this.toQueryString(query);
|
|
26
17
|
return this.client.get(`${this.basePath}/${id}${queryString}`, headers);
|
|
27
18
|
}
|
|
28
19
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TermsApi.cjs","names":[],"sources":["../../../src/apis/terms/TermsApi.ts"],"sourcesContent":["import
|
|
1
|
+
{"version":3,"file":"TermsApi.cjs","names":["BaseApi"],"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,cAA8BA,6BAAoC;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"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { BaseApi } from '../../core/BaseApi';
|
|
2
2
|
import type { GetByIdQuery, HasGetById } from '../../core/types';
|
|
3
3
|
import type { Term } from './types';
|
|
4
4
|
/**
|
|
@@ -8,10 +8,8 @@ import type { Term } from './types';
|
|
|
8
8
|
* `GET /terms/:id/export-pdf` is not exposed: it answers a binary PDF, and `ApiClient` only
|
|
9
9
|
* handles JSON/text bodies.
|
|
10
10
|
*/
|
|
11
|
-
export declare class TermsApi implements HasGetById<Term> {
|
|
12
|
-
protected readonly client: ApiClient;
|
|
11
|
+
export declare class TermsApi extends BaseApi implements HasGetById<Term> {
|
|
13
12
|
readonly basePath = "/terms";
|
|
14
|
-
constructor(client: ApiClient);
|
|
15
13
|
/** Returns a single term by its ID, scoped to the current account (`null` when not found). */
|
|
16
14
|
getById(id: string, query?: GetByIdQuery<Term>, headers?: Record<string, string>): Promise<Term>;
|
|
17
15
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TermsApi.d.ts","sourceRoot":"","sources":["../../../src/apis/terms/TermsApi.ts"],"names":[],"mappings":"
|
|
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"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { BaseApi } from "../../core/BaseApi.mjs";
|
|
2
2
|
|
|
3
3
|
//#region src/apis/terms/TermsApi.ts
|
|
4
4
|
/**
|
|
@@ -8,18 +8,11 @@ import qs from "qs";
|
|
|
8
8
|
* `GET /terms/:id/export-pdf` is not exposed: it answers a binary PDF, and `ApiClient` only
|
|
9
9
|
* handles JSON/text bodies.
|
|
10
10
|
*/
|
|
11
|
-
var TermsApi = class {
|
|
12
|
-
client;
|
|
11
|
+
var TermsApi = class extends BaseApi {
|
|
13
12
|
basePath = "/terms";
|
|
14
|
-
constructor(client) {
|
|
15
|
-
this.client = client;
|
|
16
|
-
this.getById = this.getById.bind(this);
|
|
17
|
-
this.getNotAgreed = this.getNotAgreed.bind(this);
|
|
18
|
-
this.agree = this.agree.bind(this);
|
|
19
|
-
}
|
|
20
13
|
/** Returns a single term by its ID, scoped to the current account (`null` when not found). */
|
|
21
14
|
getById(id, query, headers) {
|
|
22
|
-
const queryString =
|
|
15
|
+
const queryString = this.toQueryString(query);
|
|
23
16
|
return this.client.get(`${this.basePath}/${id}${queryString}`, headers);
|
|
24
17
|
}
|
|
25
18
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TermsApi.mjs","names":[],"sources":["../../../src/apis/terms/TermsApi.ts"],"sourcesContent":["import
|
|
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"}
|
|
@@ -1,12 +1,9 @@
|
|
|
1
1
|
Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
|
|
2
|
+
const require_core_BaseApi = require('../../core/BaseApi.cjs');
|
|
2
3
|
|
|
3
4
|
//#region src/apis/transcripts/TranscriptsApi.ts
|
|
4
|
-
var TranscriptsApi = class {
|
|
5
|
-
client;
|
|
5
|
+
var TranscriptsApi = class extends require_core_BaseApi.BaseApi {
|
|
6
6
|
basePath = "/transcripts";
|
|
7
|
-
constructor(client) {
|
|
8
|
-
this.client = client;
|
|
9
|
-
}
|
|
10
7
|
/** Triggers audio transcription for a message by dispatching an async job, and marks it as transcribing. */
|
|
11
8
|
getById(id, headers) {
|
|
12
9
|
return this.client.get(`${this.basePath}/${id}`, headers);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TranscriptsApi.cjs","names":[],"sources":["../../../src/apis/transcripts/TranscriptsApi.ts"],"sourcesContent":["import
|
|
1
|
+
{"version":3,"file":"TranscriptsApi.cjs","names":["BaseApi"],"sources":["../../../src/apis/transcripts/TranscriptsApi.ts"],"sourcesContent":["import { BaseApi } from '../../core/BaseApi'\nimport type { HasGetById } from '../../core/types'\nimport type { TranscriptResponse } from './types'\n\nexport class TranscriptsApi extends BaseApi implements HasGetById<TranscriptResponse> {\n private readonly basePath = '/transcripts'\n\n /** Triggers audio transcription for a message by dispatching an async job, and marks it as transcribing. */\n getById(id: string, headers?: Record<string, string>): Promise<TranscriptResponse> {\n return this.client.get<TranscriptResponse>(`${this.basePath}/${id}`, headers)\n }\n}\n"],"mappings":";;;;AAIA,IAAa,iBAAb,cAAoCA,6BAAkD;CACpF,AAAiB,WAAW;;CAG5B,QAAQ,IAAY,SAA+D;AACjF,SAAO,KAAK,OAAO,IAAwB,GAAG,KAAK,SAAS,GAAG,MAAM,QAAQ"}
|
|
@@ -1,10 +1,8 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { BaseApi } from '../../core/BaseApi';
|
|
2
2
|
import type { HasGetById } from '../../core/types';
|
|
3
3
|
import type { TranscriptResponse } from './types';
|
|
4
|
-
export declare class TranscriptsApi implements HasGetById<TranscriptResponse> {
|
|
5
|
-
private readonly client;
|
|
4
|
+
export declare class TranscriptsApi extends BaseApi implements HasGetById<TranscriptResponse> {
|
|
6
5
|
private readonly basePath;
|
|
7
|
-
constructor(client: ApiClient);
|
|
8
6
|
/** Triggers audio transcription for a message by dispatching an async job, and marks it as transcribing. */
|
|
9
7
|
getById(id: string, headers?: Record<string, string>): Promise<TranscriptResponse>;
|
|
10
8
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TranscriptsApi.d.ts","sourceRoot":"","sources":["../../../src/apis/transcripts/TranscriptsApi.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"TranscriptsApi.d.ts","sourceRoot":"","sources":["../../../src/apis/transcripts/TranscriptsApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAC5C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAEjD,qBAAa,cAAe,SAAQ,OAAQ,YAAW,UAAU,CAAC,kBAAkB,CAAC;IACnF,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAiB;IAE1C,4GAA4G;IAC5G,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAGnF"}
|
|
@@ -1,10 +1,8 @@
|
|
|
1
|
+
import { BaseApi } from "../../core/BaseApi.mjs";
|
|
2
|
+
|
|
1
3
|
//#region src/apis/transcripts/TranscriptsApi.ts
|
|
2
|
-
var TranscriptsApi = class {
|
|
3
|
-
client;
|
|
4
|
+
var TranscriptsApi = class extends BaseApi {
|
|
4
5
|
basePath = "/transcripts";
|
|
5
|
-
constructor(client) {
|
|
6
|
-
this.client = client;
|
|
7
|
-
}
|
|
8
6
|
/** Triggers audio transcription for a message by dispatching an async job, and marks it as transcribing. */
|
|
9
7
|
getById(id, headers) {
|
|
10
8
|
return this.client.get(`${this.basePath}/${id}`, headers);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TranscriptsApi.mjs","names":[],"sources":["../../../src/apis/transcripts/TranscriptsApi.ts"],"sourcesContent":["import
|
|
1
|
+
{"version":3,"file":"TranscriptsApi.mjs","names":[],"sources":["../../../src/apis/transcripts/TranscriptsApi.ts"],"sourcesContent":["import { BaseApi } from '../../core/BaseApi'\nimport type { HasGetById } from '../../core/types'\nimport type { TranscriptResponse } from './types'\n\nexport class TranscriptsApi extends BaseApi implements HasGetById<TranscriptResponse> {\n private readonly basePath = '/transcripts'\n\n /** Triggers audio transcription for a message by dispatching an async job, and marks it as transcribing. */\n getById(id: string, headers?: Record<string, string>): Promise<TranscriptResponse> {\n return this.client.get<TranscriptResponse>(`${this.basePath}/${id}`, headers)\n }\n}\n"],"mappings":";;;AAIA,IAAa,iBAAb,cAAoC,QAAkD;CACpF,AAAiB,WAAW;;CAG5B,QAAQ,IAAY,SAA+D;AACjF,SAAO,KAAK,OAAO,IAAwB,GAAG,KAAK,SAAS,GAAG,MAAM,QAAQ"}
|
package/dist/core/ApiClient.d.ts
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
|
+
import type { QueryFormat } from './queryString';
|
|
1
2
|
export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
|
|
2
3
|
export interface ApiClient {
|
|
4
|
+
/** How list/get queries are serialized in the URL (defaults to `'json'` when absent). */
|
|
5
|
+
readonly queryFormat?: QueryFormat;
|
|
3
6
|
setAccessToken(accessToken: string): this;
|
|
4
7
|
request<TResponse = unknown, TBody = unknown>(method: HttpMethod, endpoint: string, body?: TBody, headers?: Record<string, string>): Promise<TResponse>;
|
|
5
8
|
get<TResponse = unknown>(endpoint: string, headers?: Record<string, string>): Promise<TResponse>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ApiClient.d.ts","sourceRoot":"","sources":["../../src/core/ApiClient.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAA;AAEpE,MAAM,WAAW,SAAS;IACxB,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IACzC,OAAO,CAAC,SAAS,GAAG,OAAO,EAAE,KAAK,GAAG,OAAO,EAC1C,MAAM,EAAE,UAAU,EAClB,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,KAAK,EACZ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,CAAA;IACrB,GAAG,CAAC,SAAS,GAAG,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA;IAChG,IAAI,CAAC,SAAS,GAAG,OAAO,EAAE,KAAK,GAAG,OAAO,EACvC,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,KAAK,EACZ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,CAAA;IACrB,GAAG,CAAC,SAAS,GAAG,OAAO,EAAE,KAAK,GAAG,OAAO,EACtC,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,KAAK,EACZ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,CAAA;IACrB,KAAK,CAAC,SAAS,GAAG,OAAO,EAAE,KAAK,GAAG,OAAO,EACxC,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,KAAK,EACZ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,CAAA;IACrB,MAAM,CAAC,SAAS,GAAG,OAAO,EACxB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,CAAA;CACtB"}
|
|
1
|
+
{"version":3,"file":"ApiClient.d.ts","sourceRoot":"","sources":["../../src/core/ApiClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAEhD,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAA;AAEpE,MAAM,WAAW,SAAS;IACxB,yFAAyF;IACzF,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,CAAA;IAClC,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IACzC,OAAO,CAAC,SAAS,GAAG,OAAO,EAAE,KAAK,GAAG,OAAO,EAC1C,MAAM,EAAE,UAAU,EAClB,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,KAAK,EACZ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,CAAA;IACrB,GAAG,CAAC,SAAS,GAAG,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA;IAChG,IAAI,CAAC,SAAS,GAAG,OAAO,EAAE,KAAK,GAAG,OAAO,EACvC,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,KAAK,EACZ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,CAAA;IACrB,GAAG,CAAC,SAAS,GAAG,OAAO,EAAE,KAAK,GAAG,OAAO,EACtC,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,KAAK,EACZ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,CAAA;IACrB,KAAK,CAAC,SAAS,GAAG,OAAO,EAAE,KAAK,GAAG,OAAO,EACxC,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,KAAK,EACZ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,CAAA;IACrB,MAAM,CAAC,SAAS,GAAG,OAAO,EACxB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC,CAAA;CACtB"}
|
|
@@ -15,8 +15,6 @@ const require_core_BaseCrudApi = require('./BaseCrudApi.cjs');
|
|
|
15
15
|
var ArchivableCrudApi = class extends require_core_BaseCrudApi.BaseCrudApi {
|
|
16
16
|
constructor(client, basePath) {
|
|
17
17
|
super(client, basePath);
|
|
18
|
-
this.archive = this.archive.bind(this);
|
|
19
|
-
this.unarchive = this.unarchive.bind(this);
|
|
20
18
|
}
|
|
21
19
|
/**
|
|
22
20
|
* Archives a resource (soft-delete) by setting `archivedAt` to the current time.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ArchivableCrudApi.cjs","names":["BaseCrudApi"],"sources":["../../src/core/ArchivableCrudApi.ts"],"sourcesContent":["import type { ApiClient } from './ApiClient'\nimport { BaseCrudApi } from './BaseCrudApi'\nimport type { ListQuery } from './types'\n\n/**\n * CRUD base for resources that support soft-delete via an `archivedAt` timestamp\n * (PUT `${basePath}/${id}` with `{ archivedAt }`). Adds `archive`/`unarchive` on\n * top of {@link BaseCrudApi}.\n *\n * Only extend this for resources whose archive write mechanism is `archivedAt`.\n * Resources that archive through a different field (e.g. cards use `isArchived`)\n * or a dedicated endpoint (e.g. ticket-topics POST `/archive`) must NOT use this\n * base and should implement `archive`/`unarchive` themselves.\n */\nexport class ArchivableCrudApi<\n TResponse,\n TCreate,\n TUpdate extends { archivedAt?: string | null } = TCreate & { archivedAt?: string | null },\n TQuery extends ListQuery<TResponse> = ListQuery<TResponse>,\n> extends BaseCrudApi<TResponse, TCreate, TUpdate, TQuery> {\n constructor(client: ApiClient, basePath: string) {\n super(client, basePath)\n
|
|
1
|
+
{"version":3,"file":"ArchivableCrudApi.cjs","names":["BaseCrudApi"],"sources":["../../src/core/ArchivableCrudApi.ts"],"sourcesContent":["import type { ApiClient } from './ApiClient'\nimport { BaseCrudApi } from './BaseCrudApi'\nimport type { ListQuery } from './types'\n\n/**\n * CRUD base for resources that support soft-delete via an `archivedAt` timestamp\n * (PUT `${basePath}/${id}` with `{ archivedAt }`). Adds `archive`/`unarchive` on\n * top of {@link BaseCrudApi}.\n *\n * Only extend this for resources whose archive write mechanism is `archivedAt`.\n * Resources that archive through a different field (e.g. cards use `isArchived`)\n * or a dedicated endpoint (e.g. ticket-topics POST `/archive`) must NOT use this\n * base and should implement `archive`/`unarchive` themselves.\n */\nexport class ArchivableCrudApi<\n TResponse,\n TCreate,\n TUpdate extends { archivedAt?: string | null } = TCreate & { archivedAt?: string | null },\n TQuery extends ListQuery<TResponse> = ListQuery<TResponse>,\n> extends BaseCrudApi<TResponse, TCreate, TUpdate, TQuery> {\n constructor(client: ApiClient, basePath: string) {\n super(client, basePath)\n }\n\n /**\n * Archives a resource (soft-delete) by setting `archivedAt` to the current time.\n * @permissions $resourceName.update\n */\n archive(id: string, headers?: Record<string, string>): Promise<TResponse> {\n return this.updateById(id, { archivedAt: new Date().toISOString() } as TUpdate, headers)\n }\n\n /**\n * Restores a previously archived resource by clearing `archivedAt`.\n * @permissions $resourceName.update\n */\n unarchive(id: string, headers?: Record<string, string>): Promise<TResponse> {\n return this.updateById(id, { archivedAt: null } as TUpdate, headers)\n }\n}\n"],"mappings":";;;;;;;;;;;;;;AAcA,IAAa,oBAAb,cAKUA,qCAAiD;CACzD,YAAY,QAAmB,UAAkB;AAC/C,QAAM,QAAQ,SAAS;;;;;;CAOzB,QAAQ,IAAY,SAAsD;AACxE,SAAO,KAAK,WAAW,IAAI,EAAE,6BAAY,IAAI,MAAM,EAAC,aAAa,EAAE,EAAa,QAAQ;;;;;;CAO1F,UAAU,IAAY,SAAsD;AAC1E,SAAO,KAAK,WAAW,IAAI,EAAE,YAAY,MAAM,EAAa,QAAQ"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ArchivableCrudApi.d.ts","sourceRoot":"","sources":["../../src/core/ArchivableCrudApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAExC;;;;;;;;;GASG;AACH,qBAAa,iBAAiB,CAC5B,SAAS,EACT,OAAO,EACP,OAAO,SAAS;IAAE,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,GAAG,OAAO,GAAG;IAAE,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,EACzF,MAAM,SAAS,SAAS,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC,CAC1D,SAAQ,WAAW,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC;gBAC5C,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM;
|
|
1
|
+
{"version":3,"file":"ArchivableCrudApi.d.ts","sourceRoot":"","sources":["../../src/core/ArchivableCrudApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAExC;;;;;;;;;GASG;AACH,qBAAa,iBAAiB,CAC5B,SAAS,EACT,OAAO,EACP,OAAO,SAAS;IAAE,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,GAAG,OAAO,GAAG;IAAE,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,EACzF,MAAM,SAAS,SAAS,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC,CAC1D,SAAQ,WAAW,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC;gBAC5C,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM;IAI/C;;;OAGG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;IAIzE;;;OAGG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;CAG5E"}
|
|
@@ -14,8 +14,6 @@ import { BaseCrudApi } from "./BaseCrudApi.mjs";
|
|
|
14
14
|
var ArchivableCrudApi = class extends BaseCrudApi {
|
|
15
15
|
constructor(client, basePath) {
|
|
16
16
|
super(client, basePath);
|
|
17
|
-
this.archive = this.archive.bind(this);
|
|
18
|
-
this.unarchive = this.unarchive.bind(this);
|
|
19
17
|
}
|
|
20
18
|
/**
|
|
21
19
|
* Archives a resource (soft-delete) by setting `archivedAt` to the current time.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ArchivableCrudApi.mjs","names":[],"sources":["../../src/core/ArchivableCrudApi.ts"],"sourcesContent":["import type { ApiClient } from './ApiClient'\nimport { BaseCrudApi } from './BaseCrudApi'\nimport type { ListQuery } from './types'\n\n/**\n * CRUD base for resources that support soft-delete via an `archivedAt` timestamp\n * (PUT `${basePath}/${id}` with `{ archivedAt }`). Adds `archive`/`unarchive` on\n * top of {@link BaseCrudApi}.\n *\n * Only extend this for resources whose archive write mechanism is `archivedAt`.\n * Resources that archive through a different field (e.g. cards use `isArchived`)\n * or a dedicated endpoint (e.g. ticket-topics POST `/archive`) must NOT use this\n * base and should implement `archive`/`unarchive` themselves.\n */\nexport class ArchivableCrudApi<\n TResponse,\n TCreate,\n TUpdate extends { archivedAt?: string | null } = TCreate & { archivedAt?: string | null },\n TQuery extends ListQuery<TResponse> = ListQuery<TResponse>,\n> extends BaseCrudApi<TResponse, TCreate, TUpdate, TQuery> {\n constructor(client: ApiClient, basePath: string) {\n super(client, basePath)\n
|
|
1
|
+
{"version":3,"file":"ArchivableCrudApi.mjs","names":[],"sources":["../../src/core/ArchivableCrudApi.ts"],"sourcesContent":["import type { ApiClient } from './ApiClient'\nimport { BaseCrudApi } from './BaseCrudApi'\nimport type { ListQuery } from './types'\n\n/**\n * CRUD base for resources that support soft-delete via an `archivedAt` timestamp\n * (PUT `${basePath}/${id}` with `{ archivedAt }`). Adds `archive`/`unarchive` on\n * top of {@link BaseCrudApi}.\n *\n * Only extend this for resources whose archive write mechanism is `archivedAt`.\n * Resources that archive through a different field (e.g. cards use `isArchived`)\n * or a dedicated endpoint (e.g. ticket-topics POST `/archive`) must NOT use this\n * base and should implement `archive`/`unarchive` themselves.\n */\nexport class ArchivableCrudApi<\n TResponse,\n TCreate,\n TUpdate extends { archivedAt?: string | null } = TCreate & { archivedAt?: string | null },\n TQuery extends ListQuery<TResponse> = ListQuery<TResponse>,\n> extends BaseCrudApi<TResponse, TCreate, TUpdate, TQuery> {\n constructor(client: ApiClient, basePath: string) {\n super(client, basePath)\n }\n\n /**\n * Archives a resource (soft-delete) by setting `archivedAt` to the current time.\n * @permissions $resourceName.update\n */\n archive(id: string, headers?: Record<string, string>): Promise<TResponse> {\n return this.updateById(id, { archivedAt: new Date().toISOString() } as TUpdate, headers)\n }\n\n /**\n * Restores a previously archived resource by clearing `archivedAt`.\n * @permissions $resourceName.update\n */\n unarchive(id: string, headers?: Record<string, string>): Promise<TResponse> {\n return this.updateById(id, { archivedAt: null } as TUpdate, headers)\n }\n}\n"],"mappings":";;;;;;;;;;;;;AAcA,IAAa,oBAAb,cAKU,YAAiD;CACzD,YAAY,QAAmB,UAAkB;AAC/C,QAAM,QAAQ,SAAS;;;;;;CAOzB,QAAQ,IAAY,SAAsD;AACxE,SAAO,KAAK,WAAW,IAAI,EAAE,6BAAY,IAAI,MAAM,EAAC,aAAa,EAAE,EAAa,QAAQ;;;;;;CAO1F,UAAU,IAAY,SAAsD;AAC1E,SAAO,KAAK,WAAW,IAAI,EAAE,YAAY,MAAM,EAAa,QAAQ"}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
|
|
2
|
+
const require_core_queryString = require('./queryString.cjs');
|
|
3
|
+
const require_core_bindMethods = require('./bindMethods.cjs');
|
|
4
|
+
const require_core_withQueryFormat = require('./withQueryFormat.cjs');
|
|
5
|
+
|
|
6
|
+
//#region src/core/BaseApi.ts
|
|
7
|
+
/**
|
|
8
|
+
* Base of every API class: holds the client, binds the methods to the instance (so they can be
|
|
9
|
+
* destructured) and serializes queries in the client's `queryFormat`.
|
|
10
|
+
*/
|
|
11
|
+
var BaseApi = class {
|
|
12
|
+
client;
|
|
13
|
+
constructor(client) {
|
|
14
|
+
this.client = client;
|
|
15
|
+
require_core_bindMethods.bindMethods(this);
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* Returns a copy of this API whose requests serialize queries in `format`, overriding the
|
|
19
|
+
* client's `queryFormat`. This instance is not changed.
|
|
20
|
+
*
|
|
21
|
+
* @example await contacts.withQueryFormat('qs').getMany({ where: { name: 'x' } })
|
|
22
|
+
*/
|
|
23
|
+
withQueryFormat(format) {
|
|
24
|
+
return require_core_withQueryFormat.cloneWithQueryFormat(this, format);
|
|
25
|
+
}
|
|
26
|
+
/** Serializes a list/get query in the client's `queryFormat` (`''` when there is nothing to send). */
|
|
27
|
+
toQueryString(query) {
|
|
28
|
+
return require_core_queryString.toQueryString(query, this.client.queryFormat);
|
|
29
|
+
}
|
|
30
|
+
};
|
|
31
|
+
|
|
32
|
+
//#endregion
|
|
33
|
+
exports.BaseApi = BaseApi;
|
|
34
|
+
//# sourceMappingURL=BaseApi.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"BaseApi.cjs","names":["cloneWithQueryFormat","toQueryString"],"sources":["../../src/core/BaseApi.ts"],"sourcesContent":["import type { ApiClient } from './ApiClient'\nimport { bindMethods } from './bindMethods'\nimport { toQueryString, type QueryFormat } from './queryString'\nimport { cloneWithQueryFormat } from './withQueryFormat'\n\n/**\n * Base of every API class: holds the client, binds the methods to the instance (so they can be\n * destructured) and serializes queries in the client's `queryFormat`.\n */\nexport class BaseApi {\n public readonly client: ApiClient\n\n constructor(client: ApiClient) {\n this.client = client\n bindMethods(this)\n }\n\n /**\n * Returns a copy of this API whose requests serialize queries in `format`, overriding the\n * client's `queryFormat`. This instance is not changed.\n *\n * @example await contacts.withQueryFormat('qs').getMany({ where: { name: 'x' } })\n */\n withQueryFormat(format: QueryFormat): this {\n return cloneWithQueryFormat(this, format)\n }\n\n /** Serializes a list/get query in the client's `queryFormat` (`''` when there is nothing to send). */\n protected toQueryString(query?: object | null): string {\n return toQueryString(query, this.client.queryFormat)\n }\n}\n"],"mappings":";;;;;;;;;;AASA,IAAa,UAAb,MAAqB;CACnB,AAAgB;CAEhB,YAAY,QAAmB;AAC7B,OAAK,SAAS;AACd,uCAAY,KAAK;;;;;;;;CASnB,gBAAgB,QAA2B;AACzC,SAAOA,kDAAqB,MAAM,OAAO;;;CAI3C,AAAU,cAAc,OAA+B;AACrD,SAAOC,uCAAc,OAAO,KAAK,OAAO,YAAY"}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import type { ApiClient } from './ApiClient';
|
|
2
|
+
import { type QueryFormat } from './queryString';
|
|
3
|
+
/**
|
|
4
|
+
* Base of every API class: holds the client, binds the methods to the instance (so they can be
|
|
5
|
+
* destructured) and serializes queries in the client's `queryFormat`.
|
|
6
|
+
*/
|
|
7
|
+
export declare class BaseApi {
|
|
8
|
+
readonly client: ApiClient;
|
|
9
|
+
constructor(client: ApiClient);
|
|
10
|
+
/**
|
|
11
|
+
* Returns a copy of this API whose requests serialize queries in `format`, overriding the
|
|
12
|
+
* client's `queryFormat`. This instance is not changed.
|
|
13
|
+
*
|
|
14
|
+
* @example await contacts.withQueryFormat('qs').getMany({ where: { name: 'x' } })
|
|
15
|
+
*/
|
|
16
|
+
withQueryFormat(format: QueryFormat): this;
|
|
17
|
+
/** Serializes a list/get query in the client's `queryFormat` (`''` when there is nothing to send). */
|
|
18
|
+
protected toQueryString(query?: object | null): string;
|
|
19
|
+
}
|
|
20
|
+
//# sourceMappingURL=BaseApi.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"BaseApi.d.ts","sourceRoot":"","sources":["../../src/core/BaseApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAE5C,OAAO,EAAiB,KAAK,WAAW,EAAE,MAAM,eAAe,CAAA;AAG/D;;;GAGG;AACH,qBAAa,OAAO;IAClB,SAAgB,MAAM,EAAE,SAAS,CAAA;gBAErB,MAAM,EAAE,SAAS;IAK7B;;;;;OAKG;IACH,eAAe,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI;IAI1C,sGAAsG;IACtG,SAAS,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM;CAGvD"}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { toQueryString } from "./queryString.mjs";
|
|
2
|
+
import { bindMethods } from "./bindMethods.mjs";
|
|
3
|
+
import { cloneWithQueryFormat } from "./withQueryFormat.mjs";
|
|
4
|
+
|
|
5
|
+
//#region src/core/BaseApi.ts
|
|
6
|
+
/**
|
|
7
|
+
* Base of every API class: holds the client, binds the methods to the instance (so they can be
|
|
8
|
+
* destructured) and serializes queries in the client's `queryFormat`.
|
|
9
|
+
*/
|
|
10
|
+
var BaseApi = class {
|
|
11
|
+
client;
|
|
12
|
+
constructor(client) {
|
|
13
|
+
this.client = client;
|
|
14
|
+
bindMethods(this);
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* Returns a copy of this API whose requests serialize queries in `format`, overriding the
|
|
18
|
+
* client's `queryFormat`. This instance is not changed.
|
|
19
|
+
*
|
|
20
|
+
* @example await contacts.withQueryFormat('qs').getMany({ where: { name: 'x' } })
|
|
21
|
+
*/
|
|
22
|
+
withQueryFormat(format) {
|
|
23
|
+
return cloneWithQueryFormat(this, format);
|
|
24
|
+
}
|
|
25
|
+
/** Serializes a list/get query in the client's `queryFormat` (`''` when there is nothing to send). */
|
|
26
|
+
toQueryString(query) {
|
|
27
|
+
return toQueryString(query, this.client.queryFormat);
|
|
28
|
+
}
|
|
29
|
+
};
|
|
30
|
+
|
|
31
|
+
//#endregion
|
|
32
|
+
export { BaseApi };
|
|
33
|
+
//# sourceMappingURL=BaseApi.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"BaseApi.mjs","names":[],"sources":["../../src/core/BaseApi.ts"],"sourcesContent":["import type { ApiClient } from './ApiClient'\nimport { bindMethods } from './bindMethods'\nimport { toQueryString, type QueryFormat } from './queryString'\nimport { cloneWithQueryFormat } from './withQueryFormat'\n\n/**\n * Base of every API class: holds the client, binds the methods to the instance (so they can be\n * destructured) and serializes queries in the client's `queryFormat`.\n */\nexport class BaseApi {\n public readonly client: ApiClient\n\n constructor(client: ApiClient) {\n this.client = client\n bindMethods(this)\n }\n\n /**\n * Returns a copy of this API whose requests serialize queries in `format`, overriding the\n * client's `queryFormat`. This instance is not changed.\n *\n * @example await contacts.withQueryFormat('qs').getMany({ where: { name: 'x' } })\n */\n withQueryFormat(format: QueryFormat): this {\n return cloneWithQueryFormat(this, format)\n }\n\n /** Serializes a list/get query in the client's `queryFormat` (`''` when there is nothing to send). */\n protected toQueryString(query?: object | null): string {\n return toQueryString(query, this.client.queryFormat)\n }\n}\n"],"mappings":";;;;;;;;;AASA,IAAa,UAAb,MAAqB;CACnB,AAAgB;CAEhB,YAAY,QAAmB;AAC7B,OAAK,SAAS;AACd,cAAY,KAAK;;;;;;;;CASnB,gBAAgB,QAA2B;AACzC,SAAO,qBAAqB,MAAM,OAAO;;;CAI3C,AAAU,cAAc,OAA+B;AACrD,SAAO,cAAc,OAAO,KAAK,OAAO,YAAY"}
|
|
@@ -1,13 +1,16 @@
|
|
|
1
1
|
Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
|
|
2
2
|
const require_core_errors = require('./errors.cjs');
|
|
3
|
+
const require_core_queryString = require('./queryString.cjs');
|
|
3
4
|
|
|
4
5
|
//#region src/core/BaseApiClient.ts
|
|
5
6
|
var BaseApiClient = class {
|
|
6
7
|
baseUrl;
|
|
7
8
|
accessToken = null;
|
|
8
|
-
|
|
9
|
+
queryFormat;
|
|
10
|
+
constructor(baseUrl, accessToken, options = {}) {
|
|
9
11
|
this.baseUrl = baseUrl.replace(/\/$/, "");
|
|
10
12
|
this.accessToken = accessToken || null;
|
|
13
|
+
this.queryFormat = options.queryFormat ?? require_core_queryString.DEFAULT_QUERY_FORMAT;
|
|
11
14
|
}
|
|
12
15
|
setAccessToken(accessToken) {
|
|
13
16
|
this.accessToken = accessToken;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BaseApiClient.cjs","names":["ApiConnectionError","ApiError"],"sources":["../../src/core/BaseApiClient.ts"],"sourcesContent":["import type { ApiClient, HttpMethod } from './ApiClient'\nimport { ApiConnectionError, ApiError } from './errors'\n\nexport class BaseApiClient implements ApiClient {\n protected readonly baseUrl: string\n protected accessToken: string | null = null\n\n constructor(baseUrl: string, accessToken?: string) {\n this.baseUrl = baseUrl.replace(/\\/$/, '')\n this.accessToken = accessToken || null\n }\n\n setAccessToken(accessToken: string): this {\n this.accessToken = accessToken\n return this\n }\n\n async request<TResponse = unknown, TBody = unknown>(\n method: HttpMethod,\n endpoint: string,\n body?: TBody,\n headers?: Record<string, string>,\n ): Promise<TResponse> {\n const url = `${this.baseUrl}/${endpoint.replace(/^\\//, '')}`\n const init: RequestInit = {\n method,\n headers: {\n 'Content-Type': 'application/json',\n ...(this.accessToken && { Authorization: `Bearer ${this.accessToken}` }),\n ...headers,\n },\n ...(body !== undefined && { body: JSON.stringify(body) }),\n }\n\n let response: Response\n try {\n response = await fetch(url, init)\n } catch (error) {\n const reason = error instanceof Error ? error.message : String(error)\n throw new ApiConnectionError(`Request to ${method} ${url} failed: ${reason}`, {\n cause: error,\n })\n }\n\n return this.handleResponse<TResponse>(response)\n }\n\n protected async handleResponse<TResponse>(response: Response): Promise<TResponse> {\n if (!response.ok) {\n throw ApiError.fromResponse(\n response.status,\n response.statusText,\n response.headers,\n await this.readErrorBody(response),\n )\n }\n\n // 204 No Content never has a body; short-circuit before reading the stream.\n if (response.status === 204) {\n return undefined as unknown as TResponse\n }\n\n // Read body as text once and treat an empty body as \"no content\" regardless of\n // Content-Type. Servers sometimes return 200 with Content-Type: application/json\n // and an empty body (e.g. POST endpoints whose framework keeps the default JSON\n // content-type even when nothing is written). `response.json()` would throw\n // \"Unexpected end of input\" in that case.\n const text = await response.text()\n if (!text) {\n return undefined as unknown as TResponse\n }\n\n const contentType = response.headers.get('Content-Type')\n const isJson = contentType?.includes('application/json') ?? false\n\n if (isJson) {\n return JSON.parse(text) as TResponse\n }\n\n try {\n return JSON.parse(text) as TResponse\n } catch {\n return text as unknown as TResponse\n }\n }\n\n /** Reads an error body: parsed JSON when possible, the raw text otherwise, `undefined` when empty. */\n protected async readErrorBody(response: Response): Promise<unknown> {\n let text: string\n try {\n text = await response.text()\n } catch {\n return undefined\n }\n if (!text) {\n return undefined\n }\n try {\n return JSON.parse(text)\n } catch {\n return text\n }\n }\n\n get<TResponse = unknown>(endpoint: string, headers?: Record<string, string>): Promise<TResponse> {\n return this.request<TResponse>('GET', endpoint, undefined, headers)\n }\n\n post<TResponse = unknown, TBody = unknown>(\n endpoint: string,\n body?: TBody,\n headers?: Record<string, string>,\n ): Promise<TResponse> {\n return this.request<TResponse, TBody>('POST', endpoint, body, headers)\n }\n\n put<TResponse = unknown, TBody = unknown>(\n endpoint: string,\n body?: TBody,\n headers?: Record<string, string>,\n ): Promise<TResponse> {\n return this.request<TResponse, TBody>('PUT', endpoint, body, headers)\n }\n\n patch<TResponse = unknown, TBody = unknown>(\n endpoint: string,\n body?: TBody,\n headers?: Record<string, string>,\n ): Promise<TResponse> {\n return this.request<TResponse, TBody>('PATCH', endpoint, body, headers)\n }\n\n delete<TResponse = unknown>(\n endpoint: string,\n headers?: Record<string, string>,\n ): Promise<TResponse> {\n return this.request<TResponse>('DELETE', endpoint, undefined, headers)\n }\n}\n"],"mappings":"
|
|
1
|
+
{"version":3,"file":"BaseApiClient.cjs","names":["DEFAULT_QUERY_FORMAT","ApiConnectionError","ApiError"],"sources":["../../src/core/BaseApiClient.ts"],"sourcesContent":["import type { ApiClient, HttpMethod } from './ApiClient'\nimport { ApiConnectionError, ApiError } from './errors'\nimport { DEFAULT_QUERY_FORMAT, type QueryFormat } from './queryString'\n\nexport interface BaseApiClientOptions {\n /** How list/get queries are serialized in the URL. Defaults to `'json'`. */\n queryFormat?: QueryFormat\n}\n\nexport class BaseApiClient implements ApiClient {\n protected readonly baseUrl: string\n protected accessToken: string | null = null\n public readonly queryFormat: QueryFormat\n\n constructor(baseUrl: string, accessToken?: string, options: BaseApiClientOptions = {}) {\n this.baseUrl = baseUrl.replace(/\\/$/, '')\n this.accessToken = accessToken || null\n this.queryFormat = options.queryFormat ?? DEFAULT_QUERY_FORMAT\n }\n\n setAccessToken(accessToken: string): this {\n this.accessToken = accessToken\n return this\n }\n\n async request<TResponse = unknown, TBody = unknown>(\n method: HttpMethod,\n endpoint: string,\n body?: TBody,\n headers?: Record<string, string>,\n ): Promise<TResponse> {\n const url = `${this.baseUrl}/${endpoint.replace(/^\\//, '')}`\n const init: RequestInit = {\n method,\n headers: {\n 'Content-Type': 'application/json',\n ...(this.accessToken && { Authorization: `Bearer ${this.accessToken}` }),\n ...headers,\n },\n ...(body !== undefined && { body: JSON.stringify(body) }),\n }\n\n let response: Response\n try {\n response = await fetch(url, init)\n } catch (error) {\n const reason = error instanceof Error ? error.message : String(error)\n throw new ApiConnectionError(`Request to ${method} ${url} failed: ${reason}`, {\n cause: error,\n })\n }\n\n return this.handleResponse<TResponse>(response)\n }\n\n protected async handleResponse<TResponse>(response: Response): Promise<TResponse> {\n if (!response.ok) {\n throw ApiError.fromResponse(\n response.status,\n response.statusText,\n response.headers,\n await this.readErrorBody(response),\n )\n }\n\n // 204 No Content never has a body; short-circuit before reading the stream.\n if (response.status === 204) {\n return undefined as unknown as TResponse\n }\n\n // Read body as text once and treat an empty body as \"no content\" regardless of\n // Content-Type. Servers sometimes return 200 with Content-Type: application/json\n // and an empty body (e.g. POST endpoints whose framework keeps the default JSON\n // content-type even when nothing is written). `response.json()` would throw\n // \"Unexpected end of input\" in that case.\n const text = await response.text()\n if (!text) {\n return undefined as unknown as TResponse\n }\n\n const contentType = response.headers.get('Content-Type')\n const isJson = contentType?.includes('application/json') ?? false\n\n if (isJson) {\n return JSON.parse(text) as TResponse\n }\n\n try {\n return JSON.parse(text) as TResponse\n } catch {\n return text as unknown as TResponse\n }\n }\n\n /** Reads an error body: parsed JSON when possible, the raw text otherwise, `undefined` when empty. */\n protected async readErrorBody(response: Response): Promise<unknown> {\n let text: string\n try {\n text = await response.text()\n } catch {\n return undefined\n }\n if (!text) {\n return undefined\n }\n try {\n return JSON.parse(text)\n } catch {\n return text\n }\n }\n\n get<TResponse = unknown>(endpoint: string, headers?: Record<string, string>): Promise<TResponse> {\n return this.request<TResponse>('GET', endpoint, undefined, headers)\n }\n\n post<TResponse = unknown, TBody = unknown>(\n endpoint: string,\n body?: TBody,\n headers?: Record<string, string>,\n ): Promise<TResponse> {\n return this.request<TResponse, TBody>('POST', endpoint, body, headers)\n }\n\n put<TResponse = unknown, TBody = unknown>(\n endpoint: string,\n body?: TBody,\n headers?: Record<string, string>,\n ): Promise<TResponse> {\n return this.request<TResponse, TBody>('PUT', endpoint, body, headers)\n }\n\n patch<TResponse = unknown, TBody = unknown>(\n endpoint: string,\n body?: TBody,\n headers?: Record<string, string>,\n ): Promise<TResponse> {\n return this.request<TResponse, TBody>('PATCH', endpoint, body, headers)\n }\n\n delete<TResponse = unknown>(\n endpoint: string,\n headers?: Record<string, string>,\n ): Promise<TResponse> {\n return this.request<TResponse>('DELETE', endpoint, undefined, headers)\n }\n}\n"],"mappings":";;;;;AASA,IAAa,gBAAb,MAAgD;CAC9C,AAAmB;CACnB,AAAU,cAA6B;CACvC,AAAgB;CAEhB,YAAY,SAAiB,aAAsB,UAAgC,EAAE,EAAE;AACrF,OAAK,UAAU,QAAQ,QAAQ,OAAO,GAAG;AACzC,OAAK,cAAc,eAAe;AAClC,OAAK,cAAc,QAAQ,eAAeA;;CAG5C,eAAe,aAA2B;AACxC,OAAK,cAAc;AACnB,SAAO;;CAGT,MAAM,QACJ,QACA,UACA,MACA,SACoB;EACpB,MAAM,MAAM,GAAG,KAAK,QAAQ,GAAG,SAAS,QAAQ,OAAO,GAAG;EAC1D,MAAM,OAAoB;GACxB;GACA,SAAS;IACP,gBAAgB;IAChB,GAAI,KAAK,eAAe,EAAE,eAAe,UAAU,KAAK,eAAe;IACvE,GAAG;IACJ;GACD,GAAI,SAAS,UAAa,EAAE,MAAM,KAAK,UAAU,KAAK,EAAE;GACzD;EAED,IAAI;AACJ,MAAI;AACF,cAAW,MAAM,MAAM,KAAK,KAAK;WAC1B,OAAO;AAEd,SAAM,IAAIC,uCAAmB,cAAc,OAAO,GAAG,IAAI,WAD1C,iBAAiB,QAAQ,MAAM,UAAU,OAAO,MAAM,IACS,EAC5E,OAAO,OACR,CAAC;;AAGJ,SAAO,KAAK,eAA0B,SAAS;;CAGjD,MAAgB,eAA0B,UAAwC;AAChF,MAAI,CAAC,SAAS,GACZ,OAAMC,6BAAS,aACb,SAAS,QACT,SAAS,YACT,SAAS,SACT,MAAM,KAAK,cAAc,SAAS,CACnC;AAIH,MAAI,SAAS,WAAW,IACtB;EAQF,MAAM,OAAO,MAAM,SAAS,MAAM;AAClC,MAAI,CAAC,KACH;AAMF,MAHoB,SAAS,QAAQ,IAAI,eAAe,EAC5B,SAAS,mBAAmB,IAAI,MAG1D,QAAO,KAAK,MAAM,KAAK;AAGzB,MAAI;AACF,UAAO,KAAK,MAAM,KAAK;UACjB;AACN,UAAO;;;;CAKX,MAAgB,cAAc,UAAsC;EAClE,IAAI;AACJ,MAAI;AACF,UAAO,MAAM,SAAS,MAAM;UACtB;AACN;;AAEF,MAAI,CAAC,KACH;AAEF,MAAI;AACF,UAAO,KAAK,MAAM,KAAK;UACjB;AACN,UAAO;;;CAIX,IAAyB,UAAkB,SAAsD;AAC/F,SAAO,KAAK,QAAmB,OAAO,UAAU,QAAW,QAAQ;;CAGrE,KACE,UACA,MACA,SACoB;AACpB,SAAO,KAAK,QAA0B,QAAQ,UAAU,MAAM,QAAQ;;CAGxE,IACE,UACA,MACA,SACoB;AACpB,SAAO,KAAK,QAA0B,OAAO,UAAU,MAAM,QAAQ;;CAGvE,MACE,UACA,MACA,SACoB;AACpB,SAAO,KAAK,QAA0B,SAAS,UAAU,MAAM,QAAQ;;CAGzE,OACE,UACA,SACoB;AACpB,SAAO,KAAK,QAAmB,UAAU,UAAU,QAAW,QAAQ"}
|
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
import type { ApiClient, HttpMethod } from './ApiClient';
|
|
2
|
+
import { type QueryFormat } from './queryString';
|
|
3
|
+
export interface BaseApiClientOptions {
|
|
4
|
+
/** How list/get queries are serialized in the URL. Defaults to `'json'`. */
|
|
5
|
+
queryFormat?: QueryFormat;
|
|
6
|
+
}
|
|
2
7
|
export declare class BaseApiClient implements ApiClient {
|
|
3
8
|
protected readonly baseUrl: string;
|
|
4
9
|
protected accessToken: string | null;
|
|
5
|
-
|
|
10
|
+
readonly queryFormat: QueryFormat;
|
|
11
|
+
constructor(baseUrl: string, accessToken?: string, options?: BaseApiClientOptions);
|
|
6
12
|
setAccessToken(accessToken: string): this;
|
|
7
13
|
request<TResponse = unknown, TBody = unknown>(method: HttpMethod, endpoint: string, body?: TBody, headers?: Record<string, string>): Promise<TResponse>;
|
|
8
14
|
protected handleResponse<TResponse>(response: Response): Promise<TResponse>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BaseApiClient.d.ts","sourceRoot":"","sources":["../../src/core/BaseApiClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;
|
|
1
|
+
{"version":3,"file":"BaseApiClient.d.ts","sourceRoot":"","sources":["../../src/core/BaseApiClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAExD,OAAO,EAAwB,KAAK,WAAW,EAAE,MAAM,eAAe,CAAA;AAEtE,MAAM,WAAW,oBAAoB;IACnC,4EAA4E;IAC5E,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B;AAED,qBAAa,aAAc,YAAW,SAAS;IAC7C,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IAClC,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAO;IAC3C,SAAgB,WAAW,EAAE,WAAW,CAAA;gBAE5B,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,OAAO,GAAE,oBAAyB;IAMrF,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;IAKnC,OAAO,CAAC,SAAS,GAAG,OAAO,EAAE,KAAK,GAAG,OAAO,EAChD,MAAM,EAAE,UAAU,EAClB,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,KAAK,EACZ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC;cAyBL,cAAc,CAAC,SAAS,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC;IAuCjF,sGAAsG;cACtF,aAAa,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAiBnE,GAAG,CAAC,SAAS,GAAG,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;IAIhG,IAAI,CAAC,SAAS,GAAG,OAAO,EAAE,KAAK,GAAG,OAAO,EACvC,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,KAAK,EACZ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC;IAIrB,GAAG,CAAC,SAAS,GAAG,OAAO,EAAE,KAAK,GAAG,OAAO,EACtC,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,KAAK,EACZ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC;IAIrB,KAAK,CAAC,SAAS,GAAG,OAAO,EAAE,KAAK,GAAG,OAAO,EACxC,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,KAAK,EACZ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC;IAIrB,MAAM,CAAC,SAAS,GAAG,OAAO,EACxB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,SAAS,CAAC;CAGtB"}
|
|
@@ -1,12 +1,15 @@
|
|
|
1
1
|
import { ApiConnectionError, ApiError } from "./errors.mjs";
|
|
2
|
+
import { DEFAULT_QUERY_FORMAT } from "./queryString.mjs";
|
|
2
3
|
|
|
3
4
|
//#region src/core/BaseApiClient.ts
|
|
4
5
|
var BaseApiClient = class {
|
|
5
6
|
baseUrl;
|
|
6
7
|
accessToken = null;
|
|
7
|
-
|
|
8
|
+
queryFormat;
|
|
9
|
+
constructor(baseUrl, accessToken, options = {}) {
|
|
8
10
|
this.baseUrl = baseUrl.replace(/\/$/, "");
|
|
9
11
|
this.accessToken = accessToken || null;
|
|
12
|
+
this.queryFormat = options.queryFormat ?? DEFAULT_QUERY_FORMAT;
|
|
10
13
|
}
|
|
11
14
|
setAccessToken(accessToken) {
|
|
12
15
|
this.accessToken = accessToken;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BaseApiClient.mjs","names":[],"sources":["../../src/core/BaseApiClient.ts"],"sourcesContent":["import type { ApiClient, HttpMethod } from './ApiClient'\nimport { ApiConnectionError, ApiError } from './errors'\n\nexport class BaseApiClient implements ApiClient {\n protected readonly baseUrl: string\n protected accessToken: string | null = null\n\n constructor(baseUrl: string, accessToken?: string) {\n this.baseUrl = baseUrl.replace(/\\/$/, '')\n this.accessToken = accessToken || null\n }\n\n setAccessToken(accessToken: string): this {\n this.accessToken = accessToken\n return this\n }\n\n async request<TResponse = unknown, TBody = unknown>(\n method: HttpMethod,\n endpoint: string,\n body?: TBody,\n headers?: Record<string, string>,\n ): Promise<TResponse> {\n const url = `${this.baseUrl}/${endpoint.replace(/^\\//, '')}`\n const init: RequestInit = {\n method,\n headers: {\n 'Content-Type': 'application/json',\n ...(this.accessToken && { Authorization: `Bearer ${this.accessToken}` }),\n ...headers,\n },\n ...(body !== undefined && { body: JSON.stringify(body) }),\n }\n\n let response: Response\n try {\n response = await fetch(url, init)\n } catch (error) {\n const reason = error instanceof Error ? error.message : String(error)\n throw new ApiConnectionError(`Request to ${method} ${url} failed: ${reason}`, {\n cause: error,\n })\n }\n\n return this.handleResponse<TResponse>(response)\n }\n\n protected async handleResponse<TResponse>(response: Response): Promise<TResponse> {\n if (!response.ok) {\n throw ApiError.fromResponse(\n response.status,\n response.statusText,\n response.headers,\n await this.readErrorBody(response),\n )\n }\n\n // 204 No Content never has a body; short-circuit before reading the stream.\n if (response.status === 204) {\n return undefined as unknown as TResponse\n }\n\n // Read body as text once and treat an empty body as \"no content\" regardless of\n // Content-Type. Servers sometimes return 200 with Content-Type: application/json\n // and an empty body (e.g. POST endpoints whose framework keeps the default JSON\n // content-type even when nothing is written). `response.json()` would throw\n // \"Unexpected end of input\" in that case.\n const text = await response.text()\n if (!text) {\n return undefined as unknown as TResponse\n }\n\n const contentType = response.headers.get('Content-Type')\n const isJson = contentType?.includes('application/json') ?? false\n\n if (isJson) {\n return JSON.parse(text) as TResponse\n }\n\n try {\n return JSON.parse(text) as TResponse\n } catch {\n return text as unknown as TResponse\n }\n }\n\n /** Reads an error body: parsed JSON when possible, the raw text otherwise, `undefined` when empty. */\n protected async readErrorBody(response: Response): Promise<unknown> {\n let text: string\n try {\n text = await response.text()\n } catch {\n return undefined\n }\n if (!text) {\n return undefined\n }\n try {\n return JSON.parse(text)\n } catch {\n return text\n }\n }\n\n get<TResponse = unknown>(endpoint: string, headers?: Record<string, string>): Promise<TResponse> {\n return this.request<TResponse>('GET', endpoint, undefined, headers)\n }\n\n post<TResponse = unknown, TBody = unknown>(\n endpoint: string,\n body?: TBody,\n headers?: Record<string, string>,\n ): Promise<TResponse> {\n return this.request<TResponse, TBody>('POST', endpoint, body, headers)\n }\n\n put<TResponse = unknown, TBody = unknown>(\n endpoint: string,\n body?: TBody,\n headers?: Record<string, string>,\n ): Promise<TResponse> {\n return this.request<TResponse, TBody>('PUT', endpoint, body, headers)\n }\n\n patch<TResponse = unknown, TBody = unknown>(\n endpoint: string,\n body?: TBody,\n headers?: Record<string, string>,\n ): Promise<TResponse> {\n return this.request<TResponse, TBody>('PATCH', endpoint, body, headers)\n }\n\n delete<TResponse = unknown>(\n endpoint: string,\n headers?: Record<string, string>,\n ): Promise<TResponse> {\n return this.request<TResponse>('DELETE', endpoint, undefined, headers)\n }\n}\n"],"mappings":"
|
|
1
|
+
{"version":3,"file":"BaseApiClient.mjs","names":[],"sources":["../../src/core/BaseApiClient.ts"],"sourcesContent":["import type { ApiClient, HttpMethod } from './ApiClient'\nimport { ApiConnectionError, ApiError } from './errors'\nimport { DEFAULT_QUERY_FORMAT, type QueryFormat } from './queryString'\n\nexport interface BaseApiClientOptions {\n /** How list/get queries are serialized in the URL. Defaults to `'json'`. */\n queryFormat?: QueryFormat\n}\n\nexport class BaseApiClient implements ApiClient {\n protected readonly baseUrl: string\n protected accessToken: string | null = null\n public readonly queryFormat: QueryFormat\n\n constructor(baseUrl: string, accessToken?: string, options: BaseApiClientOptions = {}) {\n this.baseUrl = baseUrl.replace(/\\/$/, '')\n this.accessToken = accessToken || null\n this.queryFormat = options.queryFormat ?? DEFAULT_QUERY_FORMAT\n }\n\n setAccessToken(accessToken: string): this {\n this.accessToken = accessToken\n return this\n }\n\n async request<TResponse = unknown, TBody = unknown>(\n method: HttpMethod,\n endpoint: string,\n body?: TBody,\n headers?: Record<string, string>,\n ): Promise<TResponse> {\n const url = `${this.baseUrl}/${endpoint.replace(/^\\//, '')}`\n const init: RequestInit = {\n method,\n headers: {\n 'Content-Type': 'application/json',\n ...(this.accessToken && { Authorization: `Bearer ${this.accessToken}` }),\n ...headers,\n },\n ...(body !== undefined && { body: JSON.stringify(body) }),\n }\n\n let response: Response\n try {\n response = await fetch(url, init)\n } catch (error) {\n const reason = error instanceof Error ? error.message : String(error)\n throw new ApiConnectionError(`Request to ${method} ${url} failed: ${reason}`, {\n cause: error,\n })\n }\n\n return this.handleResponse<TResponse>(response)\n }\n\n protected async handleResponse<TResponse>(response: Response): Promise<TResponse> {\n if (!response.ok) {\n throw ApiError.fromResponse(\n response.status,\n response.statusText,\n response.headers,\n await this.readErrorBody(response),\n )\n }\n\n // 204 No Content never has a body; short-circuit before reading the stream.\n if (response.status === 204) {\n return undefined as unknown as TResponse\n }\n\n // Read body as text once and treat an empty body as \"no content\" regardless of\n // Content-Type. Servers sometimes return 200 with Content-Type: application/json\n // and an empty body (e.g. POST endpoints whose framework keeps the default JSON\n // content-type even when nothing is written). `response.json()` would throw\n // \"Unexpected end of input\" in that case.\n const text = await response.text()\n if (!text) {\n return undefined as unknown as TResponse\n }\n\n const contentType = response.headers.get('Content-Type')\n const isJson = contentType?.includes('application/json') ?? false\n\n if (isJson) {\n return JSON.parse(text) as TResponse\n }\n\n try {\n return JSON.parse(text) as TResponse\n } catch {\n return text as unknown as TResponse\n }\n }\n\n /** Reads an error body: parsed JSON when possible, the raw text otherwise, `undefined` when empty. */\n protected async readErrorBody(response: Response): Promise<unknown> {\n let text: string\n try {\n text = await response.text()\n } catch {\n return undefined\n }\n if (!text) {\n return undefined\n }\n try {\n return JSON.parse(text)\n } catch {\n return text\n }\n }\n\n get<TResponse = unknown>(endpoint: string, headers?: Record<string, string>): Promise<TResponse> {\n return this.request<TResponse>('GET', endpoint, undefined, headers)\n }\n\n post<TResponse = unknown, TBody = unknown>(\n endpoint: string,\n body?: TBody,\n headers?: Record<string, string>,\n ): Promise<TResponse> {\n return this.request<TResponse, TBody>('POST', endpoint, body, headers)\n }\n\n put<TResponse = unknown, TBody = unknown>(\n endpoint: string,\n body?: TBody,\n headers?: Record<string, string>,\n ): Promise<TResponse> {\n return this.request<TResponse, TBody>('PUT', endpoint, body, headers)\n }\n\n patch<TResponse = unknown, TBody = unknown>(\n endpoint: string,\n body?: TBody,\n headers?: Record<string, string>,\n ): Promise<TResponse> {\n return this.request<TResponse, TBody>('PATCH', endpoint, body, headers)\n }\n\n delete<TResponse = unknown>(\n endpoint: string,\n headers?: Record<string, string>,\n ): Promise<TResponse> {\n return this.request<TResponse>('DELETE', endpoint, undefined, headers)\n }\n}\n"],"mappings":";;;;AASA,IAAa,gBAAb,MAAgD;CAC9C,AAAmB;CACnB,AAAU,cAA6B;CACvC,AAAgB;CAEhB,YAAY,SAAiB,aAAsB,UAAgC,EAAE,EAAE;AACrF,OAAK,UAAU,QAAQ,QAAQ,OAAO,GAAG;AACzC,OAAK,cAAc,eAAe;AAClC,OAAK,cAAc,QAAQ,eAAe;;CAG5C,eAAe,aAA2B;AACxC,OAAK,cAAc;AACnB,SAAO;;CAGT,MAAM,QACJ,QACA,UACA,MACA,SACoB;EACpB,MAAM,MAAM,GAAG,KAAK,QAAQ,GAAG,SAAS,QAAQ,OAAO,GAAG;EAC1D,MAAM,OAAoB;GACxB;GACA,SAAS;IACP,gBAAgB;IAChB,GAAI,KAAK,eAAe,EAAE,eAAe,UAAU,KAAK,eAAe;IACvE,GAAG;IACJ;GACD,GAAI,SAAS,UAAa,EAAE,MAAM,KAAK,UAAU,KAAK,EAAE;GACzD;EAED,IAAI;AACJ,MAAI;AACF,cAAW,MAAM,MAAM,KAAK,KAAK;WAC1B,OAAO;AAEd,SAAM,IAAI,mBAAmB,cAAc,OAAO,GAAG,IAAI,WAD1C,iBAAiB,QAAQ,MAAM,UAAU,OAAO,MAAM,IACS,EAC5E,OAAO,OACR,CAAC;;AAGJ,SAAO,KAAK,eAA0B,SAAS;;CAGjD,MAAgB,eAA0B,UAAwC;AAChF,MAAI,CAAC,SAAS,GACZ,OAAM,SAAS,aACb,SAAS,QACT,SAAS,YACT,SAAS,SACT,MAAM,KAAK,cAAc,SAAS,CACnC;AAIH,MAAI,SAAS,WAAW,IACtB;EAQF,MAAM,OAAO,MAAM,SAAS,MAAM;AAClC,MAAI,CAAC,KACH;AAMF,MAHoB,SAAS,QAAQ,IAAI,eAAe,EAC5B,SAAS,mBAAmB,IAAI,MAG1D,QAAO,KAAK,MAAM,KAAK;AAGzB,MAAI;AACF,UAAO,KAAK,MAAM,KAAK;UACjB;AACN,UAAO;;;;CAKX,MAAgB,cAAc,UAAsC;EAClE,IAAI;AACJ,MAAI;AACF,UAAO,MAAM,SAAS,MAAM;UACtB;AACN;;AAEF,MAAI,CAAC,KACH;AAEF,MAAI;AACF,UAAO,KAAK,MAAM,KAAK;UACjB;AACN,UAAO;;;CAIX,IAAyB,UAAkB,SAAsD;AAC/F,SAAO,KAAK,QAAmB,OAAO,UAAU,QAAW,QAAQ;;CAGrE,KACE,UACA,MACA,SACoB;AACpB,SAAO,KAAK,QAA0B,QAAQ,UAAU,MAAM,QAAQ;;CAGxE,IACE,UACA,MACA,SACoB;AACpB,SAAO,KAAK,QAA0B,OAAO,UAAU,MAAM,QAAQ;;CAGvE,MACE,UACA,MACA,SACoB;AACpB,SAAO,KAAK,QAA0B,SAAS,UAAU,MAAM,QAAQ;;CAGzE,OACE,UACA,SACoB;AACpB,SAAO,KAAK,QAAmB,UAAU,UAAU,QAAW,QAAQ"}
|
|
@@ -1,24 +1,15 @@
|
|
|
1
1
|
Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
|
|
2
|
-
const
|
|
3
|
-
let qs = require("qs");
|
|
4
|
-
qs = require_chunk.__toESM(qs);
|
|
2
|
+
const require_core_BaseApi = require('./BaseApi.cjs');
|
|
5
3
|
|
|
6
4
|
//#region src/core/BaseCrudApi.ts
|
|
7
|
-
var BaseCrudApi = class {
|
|
8
|
-
client;
|
|
5
|
+
var BaseCrudApi = class extends require_core_BaseApi.BaseApi {
|
|
9
6
|
basePath;
|
|
10
7
|
constructor(client, basePath) {
|
|
11
|
-
|
|
8
|
+
super(client);
|
|
12
9
|
this.basePath = basePath.replace(/\/$/, "");
|
|
13
|
-
this.getMany = this.getMany.bind(this);
|
|
14
|
-
this.getOne = this.getOne.bind(this);
|
|
15
|
-
this.getById = this.getById.bind(this);
|
|
16
|
-
this.create = this.create.bind(this);
|
|
17
|
-
this.updateById = this.updateById.bind(this);
|
|
18
|
-
this.deleteById = this.deleteById.bind(this);
|
|
19
10
|
}
|
|
20
11
|
getMany(query, headers) {
|
|
21
|
-
const queryString =
|
|
12
|
+
const queryString = this.toQueryString(query);
|
|
22
13
|
return this.client.get(`${this.basePath}${queryString}`, headers);
|
|
23
14
|
}
|
|
24
15
|
/**
|
|
@@ -31,15 +22,14 @@ var BaseCrudApi = class {
|
|
|
31
22
|
...query,
|
|
32
23
|
limit: 1,
|
|
33
24
|
paginate: false
|
|
34
|
-
}, headers))[0] ?? null;
|
|
25
|
+
}, headers))?.[0] ?? null;
|
|
35
26
|
}
|
|
36
27
|
/**
|
|
37
28
|
* Returns a single resource by ID.
|
|
38
29
|
* @permissions $resourceName.view
|
|
39
30
|
*/
|
|
40
31
|
getById(id, query, headers) {
|
|
41
|
-
|
|
42
|
-
return this.client.get(`${this.basePath}/${id}${queryString}`, headers);
|
|
32
|
+
return this.client.get(`${this.basePath}/${id}${this.toQueryString(query)}`, headers);
|
|
43
33
|
}
|
|
44
34
|
/**
|
|
45
35
|
* Creates a new resource.
|