@helebba/sdk 0.1.4 → 0.1.6
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 +5 -3
- package/dist/index.mjs +51 -15
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
Cliente minimo para leer inventario desde aplicaciones externas.
|
|
4
4
|
|
|
5
5
|
```ts
|
|
6
|
-
import { createHelebbaClient } from '@
|
|
6
|
+
import { createHelebbaClient } from '@helebba/sdk';
|
|
7
7
|
|
|
8
8
|
const helebba = createHelebbaClient({
|
|
9
9
|
apiKey: process.env.HELEBBA_API_KEY!,
|
|
@@ -14,8 +14,10 @@ const brands = await helebba.brands.list();
|
|
|
14
14
|
const categories = await helebba.categories.list();
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
El SDK intercambia la API key por un token Bearer temporal de forma transparente.
|
|
18
|
+
|
|
19
|
+
Para desarrollo, la API key debe incluir organizacion:
|
|
18
20
|
|
|
19
21
|
```txt
|
|
20
|
-
DEV_API_KEYS="hlb_dev_xxxxxxxxxxxxxxxxxxxx:id=sdk-dev,organizationId=<org-id>,
|
|
22
|
+
DEV_API_KEYS="hlb_dev_xxxxxxxxxxxxxxxxxxxx:id=sdk-dev,organizationId=<org-id>,products=GSDK"
|
|
21
23
|
```
|
package/dist/index.mjs
CHANGED
|
@@ -14,33 +14,69 @@ var appendQuery = (url, query) => {
|
|
|
14
14
|
if (query.limit !== void 0) url.searchParams.set("limit", String(query.limit));
|
|
15
15
|
if (query.search) url.searchParams.set("search", query.search);
|
|
16
16
|
};
|
|
17
|
+
var readBody = async (response) => {
|
|
18
|
+
const contentType = response.headers.get("content-type") ?? "";
|
|
19
|
+
return contentType.includes("application/json") ? await response.json() : await response.text();
|
|
20
|
+
};
|
|
21
|
+
var assertOk = async (response) => {
|
|
22
|
+
const body = await readBody(response);
|
|
23
|
+
if (!response.ok) {
|
|
24
|
+
const message = typeof body === "object" && body && "message" in body ? String(body.message) : `Helebba API request failed with status ${response.status}`;
|
|
25
|
+
throw createHelebbaApiError(message, response.status, body);
|
|
26
|
+
}
|
|
27
|
+
return body;
|
|
28
|
+
};
|
|
17
29
|
var createHttpClient = (options) => {
|
|
18
30
|
if (!options.apiKey) throw new Error("Helebba SDK requires apiKey");
|
|
19
31
|
const apiKey = options.apiKey;
|
|
20
32
|
const baseUrl = trimTrailingSlash(options.baseUrl ?? DEFAULT_BASE_URL);
|
|
21
33
|
const fetcher = options.fetcher ?? fetch;
|
|
34
|
+
let cachedToken = null;
|
|
35
|
+
let tokenRequest = null;
|
|
36
|
+
const requestAccessToken = async () => {
|
|
37
|
+
if (cachedToken && cachedToken.expiresAt > Date.now()) return cachedToken.accessToken;
|
|
38
|
+
if (tokenRequest) return tokenRequest;
|
|
39
|
+
tokenRequest = (async () => {
|
|
40
|
+
try {
|
|
41
|
+
const tokenUrl = new URL(`${baseUrl}/sdk/token`);
|
|
42
|
+
const timestamp = Date.now().toString();
|
|
43
|
+
const response = await fetcher(tokenUrl, {
|
|
44
|
+
method: "POST",
|
|
45
|
+
headers: {
|
|
46
|
+
"api-key": apiKey,
|
|
47
|
+
"x-timestamp": timestamp,
|
|
48
|
+
"x-path": tokenUrl.pathname,
|
|
49
|
+
"x-client-user-agent": "GSDK/0.1.0 (node)",
|
|
50
|
+
Accept: "application/json"
|
|
51
|
+
}
|
|
52
|
+
});
|
|
53
|
+
const token = await assertOk(response);
|
|
54
|
+
const safetyWindowSeconds = 30;
|
|
55
|
+
cachedToken = {
|
|
56
|
+
accessToken: token.accessToken,
|
|
57
|
+
expiresAt: Date.now() + Math.max(0, token.expiresIn - safetyWindowSeconds) * 1e3
|
|
58
|
+
};
|
|
59
|
+
return cachedToken.accessToken;
|
|
60
|
+
} finally {
|
|
61
|
+
tokenRequest = null;
|
|
62
|
+
}
|
|
63
|
+
})();
|
|
64
|
+
return tokenRequest;
|
|
65
|
+
};
|
|
22
66
|
return {
|
|
23
67
|
get: async (path, options2 = {}) => {
|
|
24
68
|
const url = new URL(`${baseUrl}${path}`);
|
|
25
69
|
appendQuery(url, options2.query);
|
|
26
|
-
const
|
|
70
|
+
const accessToken = await requestAccessToken();
|
|
27
71
|
const response = await fetcher(url, {
|
|
28
72
|
method: "GET",
|
|
29
73
|
headers: {
|
|
30
|
-
|
|
31
|
-
"x-timestamp": timestamp,
|
|
32
|
-
"x-path": url.pathname,
|
|
74
|
+
Authorization: `Bearer ${accessToken}`,
|
|
33
75
|
"x-client-user-agent": "GSDK/0.1.0 (node)",
|
|
34
76
|
Accept: "application/json"
|
|
35
77
|
}
|
|
36
78
|
});
|
|
37
|
-
|
|
38
|
-
const body = contentType.includes("application/json") ? await response.json() : await response.text();
|
|
39
|
-
if (!response.ok) {
|
|
40
|
-
const message = typeof body === "object" && body && "message" in body ? String(body.message) : `Helebba API request failed with status ${response.status}`;
|
|
41
|
-
throw createHelebbaApiError(message, response.status, body);
|
|
42
|
-
}
|
|
43
|
-
return body;
|
|
79
|
+
return await assertOk(response);
|
|
44
80
|
}
|
|
45
81
|
};
|
|
46
82
|
};
|
|
@@ -50,14 +86,14 @@ var createHelebbaClient = (options) => {
|
|
|
50
86
|
const http = createHttpClient(options);
|
|
51
87
|
return {
|
|
52
88
|
products: {
|
|
53
|
-
list: (params = {}) => http.get("/
|
|
54
|
-
get: (productId) => http.get(`/
|
|
89
|
+
list: (params = {}) => http.get("/products", { query: params }),
|
|
90
|
+
get: (productId) => http.get(`/products/${encodeURIComponent(productId)}`)
|
|
55
91
|
},
|
|
56
92
|
brands: {
|
|
57
|
-
list: (params = {}) => http.get("/
|
|
93
|
+
list: (params = {}) => http.get("/brands", { query: params })
|
|
58
94
|
},
|
|
59
95
|
categories: {
|
|
60
|
-
list: (params = {}) => http.get("/
|
|
96
|
+
list: (params = {}) => http.get("/categories", { query: params })
|
|
61
97
|
}
|
|
62
98
|
};
|
|
63
99
|
};
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/http.ts","../src/client.ts"],"sourcesContent":["import type { HelebbaClientOptions, ListParams } from './types';\n\ntype RequestOptions = {\n query?: ListParams;\n};\n\nexport type HelebbaApiError = Error & {\n status: number;\n body: unknown;\n};\n\nexport const createHelebbaApiError = (\n message: string,\n status: number,\n body: unknown,\n): HelebbaApiError => {\n const error = new Error(message) as HelebbaApiError;\n error.name = 'HelebbaApiError';\n error.status = status;\n error.body = body;\n return error;\n};\n\nconst trimTrailingSlash = (value: string) => value.replace(/\\/+$/, '');\nconst DEFAULT_BASE_URL = 'https://api.helebba.com/api/v1';\n\nconst appendQuery = (url: URL, query: ListParams | undefined) => {\n if (!query) return;\n\n if (query.page !== undefined) url.searchParams.set('page', String(query.page));\n if (query.limit !== undefined) url.searchParams.set('limit', String(query.limit));\n if (query.search) url.searchParams.set('search', query.search);\n};\n\nexport type HttpClient = {\n get: <T>(path: string, options?: RequestOptions) => Promise<T>;\n};\n\nexport const createHttpClient = (options: HelebbaClientOptions): HttpClient => {\n if (!options.apiKey) throw new Error('Helebba SDK requires apiKey');\n\n const apiKey = options.apiKey;\n const baseUrl = trimTrailingSlash(options.baseUrl ?? DEFAULT_BASE_URL);\n const fetcher = options.fetcher ?? fetch;\n
|
|
1
|
+
{"version":3,"sources":["../src/http.ts","../src/client.ts"],"sourcesContent":["import type { HelebbaClientOptions, ListParams } from './types';\n\ntype RequestOptions = {\n query?: ListParams;\n};\n\ntype TokenResponse = {\n accessToken: string;\n tokenType: 'Bearer';\n expiresIn: number;\n};\n\nexport type HelebbaApiError = Error & {\n status: number;\n body: unknown;\n};\n\nexport const createHelebbaApiError = (\n message: string,\n status: number,\n body: unknown,\n): HelebbaApiError => {\n const error = new Error(message) as HelebbaApiError;\n error.name = 'HelebbaApiError';\n error.status = status;\n error.body = body;\n return error;\n};\n\nconst trimTrailingSlash = (value: string) => value.replace(/\\/+$/, '');\nconst DEFAULT_BASE_URL = 'https://api.helebba.com/api/v1';\n\nconst appendQuery = (url: URL, query: ListParams | undefined) => {\n if (!query) return;\n\n if (query.page !== undefined) url.searchParams.set('page', String(query.page));\n if (query.limit !== undefined) url.searchParams.set('limit', String(query.limit));\n if (query.search) url.searchParams.set('search', query.search);\n};\n\nexport type HttpClient = {\n get: <T>(path: string, options?: RequestOptions) => Promise<T>;\n};\n\nconst readBody = async (response: Response) => {\n const contentType = response.headers.get('content-type') ?? '';\n return contentType.includes('application/json') ? await response.json() : await response.text();\n};\n\nconst assertOk = async (response: Response) => {\n const body = await readBody(response);\n\n if (!response.ok) {\n const message =\n typeof body === 'object' && body && 'message' in body\n ? String((body as { message: unknown }).message)\n : `Helebba API request failed with status ${response.status}`;\n\n throw createHelebbaApiError(message, response.status, body);\n }\n\n return body;\n};\n\nexport const createHttpClient = (options: HelebbaClientOptions): HttpClient => {\n if (!options.apiKey) throw new Error('Helebba SDK requires apiKey');\n\n const apiKey = options.apiKey;\n const baseUrl = trimTrailingSlash(options.baseUrl ?? DEFAULT_BASE_URL);\n const fetcher = options.fetcher ?? fetch;\n let cachedToken: { accessToken: string; expiresAt: number } | null = null;\n let tokenRequest: Promise<string> | null = null;\n\n const requestAccessToken = async () => {\n if (cachedToken && cachedToken.expiresAt > Date.now()) return cachedToken.accessToken;\n if (tokenRequest) return tokenRequest;\n\n tokenRequest = (async () => {\n try {\n const tokenUrl = new URL(`${baseUrl}/sdk/token`);\n const timestamp = Date.now().toString();\n const response = await fetcher(tokenUrl, {\n method: 'POST',\n headers: {\n 'api-key': apiKey,\n 'x-timestamp': timestamp,\n 'x-path': tokenUrl.pathname,\n 'x-client-user-agent': 'GSDK/0.1.0 (node)',\n Accept: 'application/json',\n },\n });\n const token = (await assertOk(response)) as TokenResponse;\n const safetyWindowSeconds = 30;\n\n cachedToken = {\n accessToken: token.accessToken,\n expiresAt: Date.now() + Math.max(0, token.expiresIn - safetyWindowSeconds) * 1000,\n };\n\n return cachedToken.accessToken;\n } finally {\n tokenRequest = null;\n }\n })();\n\n return tokenRequest;\n };\n\n return {\n get: async <T>(path: string, options: RequestOptions = {}): Promise<T> => {\n const url = new URL(`${baseUrl}${path}`);\n appendQuery(url, options.query);\n const accessToken = await requestAccessToken();\n\n const response = await fetcher(url, {\n method: 'GET',\n headers: {\n Authorization: `Bearer ${accessToken}`,\n 'x-client-user-agent': 'GSDK/0.1.0 (node)',\n Accept: 'application/json',\n },\n });\n\n return (await assertOk(response)) as T;\n },\n };\n};\n","import { createHttpClient } from './http';\nimport type {\n Category,\n HelebbaClient,\n HelebbaClientOptions,\n InventoryBrand,\n OffsetPaginatedResult,\n Product,\n} from './types';\n\nexport const createHelebbaClient = (options: HelebbaClientOptions): HelebbaClient => {\n const http = createHttpClient(options);\n\n return {\n products: {\n list: (params = {}) =>\n http.get<OffsetPaginatedResult<Product>>('/products', { query: params }),\n get: (productId) => http.get<Product>(`/products/${encodeURIComponent(productId)}`),\n },\n brands: {\n list: (params = {}) =>\n http.get<OffsetPaginatedResult<InventoryBrand>>('/brands', { query: params }),\n },\n categories: {\n list: (params = {}) =>\n http.get<OffsetPaginatedResult<Category>>('/categories', { query: params }),\n },\n };\n};\n"],"mappings":";AAiBO,IAAM,wBAAwB,CACnC,SACA,QACA,SACoB;AACpB,QAAM,QAAQ,IAAI,MAAM,OAAO;AAC/B,QAAM,OAAO;AACb,QAAM,SAAS;AACf,QAAM,OAAO;AACb,SAAO;AACT;AAEA,IAAM,oBAAoB,CAAC,UAAkB,MAAM,QAAQ,QAAQ,EAAE;AACrE,IAAM,mBAAmB;AAEzB,IAAM,cAAc,CAAC,KAAU,UAAkC;AAC/D,MAAI,CAAC,MAAO;AAEZ,MAAI,MAAM,SAAS,OAAW,KAAI,aAAa,IAAI,QAAQ,OAAO,MAAM,IAAI,CAAC;AAC7E,MAAI,MAAM,UAAU,OAAW,KAAI,aAAa,IAAI,SAAS,OAAO,MAAM,KAAK,CAAC;AAChF,MAAI,MAAM,OAAQ,KAAI,aAAa,IAAI,UAAU,MAAM,MAAM;AAC/D;AAMA,IAAM,WAAW,OAAO,aAAuB;AAC7C,QAAM,cAAc,SAAS,QAAQ,IAAI,cAAc,KAAK;AAC5D,SAAO,YAAY,SAAS,kBAAkB,IAAI,MAAM,SAAS,KAAK,IAAI,MAAM,SAAS,KAAK;AAChG;AAEA,IAAM,WAAW,OAAO,aAAuB;AAC7C,QAAM,OAAO,MAAM,SAAS,QAAQ;AAEpC,MAAI,CAAC,SAAS,IAAI;AAChB,UAAM,UACJ,OAAO,SAAS,YAAY,QAAQ,aAAa,OAC7C,OAAQ,KAA8B,OAAO,IAC7C,0CAA0C,SAAS,MAAM;AAE/D,UAAM,sBAAsB,SAAS,SAAS,QAAQ,IAAI;AAAA,EAC5D;AAEA,SAAO;AACT;AAEO,IAAM,mBAAmB,CAAC,YAA8C;AAC7E,MAAI,CAAC,QAAQ,OAAQ,OAAM,IAAI,MAAM,6BAA6B;AAElE,QAAM,SAAS,QAAQ;AACvB,QAAM,UAAU,kBAAkB,QAAQ,WAAW,gBAAgB;AACrE,QAAM,UAAU,QAAQ,WAAW;AACnC,MAAI,cAAiE;AACrE,MAAI,eAAuC;AAE3C,QAAM,qBAAqB,YAAY;AACrC,QAAI,eAAe,YAAY,YAAY,KAAK,IAAI,EAAG,QAAO,YAAY;AAC1E,QAAI,aAAc,QAAO;AAEzB,oBAAgB,YAAY;AAC1B,UAAI;AACF,cAAM,WAAW,IAAI,IAAI,GAAG,OAAO,YAAY;AAC/C,cAAM,YAAY,KAAK,IAAI,EAAE,SAAS;AACtC,cAAM,WAAW,MAAM,QAAQ,UAAU;AAAA,UACvC,QAAQ;AAAA,UACR,SAAS;AAAA,YACP,WAAW;AAAA,YACX,eAAe;AAAA,YACf,UAAU,SAAS;AAAA,YACnB,uBAAuB;AAAA,YACvB,QAAQ;AAAA,UACV;AAAA,QACF,CAAC;AACD,cAAM,QAAS,MAAM,SAAS,QAAQ;AACtC,cAAM,sBAAsB;AAE5B,sBAAc;AAAA,UACZ,aAAa,MAAM;AAAA,UACnB,WAAW,KAAK,IAAI,IAAI,KAAK,IAAI,GAAG,MAAM,YAAY,mBAAmB,IAAI;AAAA,QAC/E;AAEA,eAAO,YAAY;AAAA,MACrB,UAAE;AACA,uBAAe;AAAA,MACjB;AAAA,IACF,GAAG;AAEH,WAAO;AAAA,EACT;AAEA,SAAO;AAAA,IACL,KAAK,OAAU,MAAcA,WAA0B,CAAC,MAAkB;AACxE,YAAM,MAAM,IAAI,IAAI,GAAG,OAAO,GAAG,IAAI,EAAE;AACvC,kBAAY,KAAKA,SAAQ,KAAK;AAC9B,YAAM,cAAc,MAAM,mBAAmB;AAE7C,YAAM,WAAW,MAAM,QAAQ,KAAK;AAAA,QAClC,QAAQ;AAAA,QACR,SAAS;AAAA,UACP,eAAe,UAAU,WAAW;AAAA,UACpC,uBAAuB;AAAA,UACvB,QAAQ;AAAA,QACV;AAAA,MACF,CAAC;AAED,aAAQ,MAAM,SAAS,QAAQ;AAAA,IACjC;AAAA,EACF;AACF;;;ACpHO,IAAM,sBAAsB,CAAC,YAAiD;AACnF,QAAM,OAAO,iBAAiB,OAAO;AAErC,SAAO;AAAA,IACL,UAAU;AAAA,MACR,MAAM,CAAC,SAAS,CAAC,MACf,KAAK,IAAoC,aAAa,EAAE,OAAO,OAAO,CAAC;AAAA,MACzE,KAAK,CAAC,cAAc,KAAK,IAAa,aAAa,mBAAmB,SAAS,CAAC,EAAE;AAAA,IACpF;AAAA,IACA,QAAQ;AAAA,MACN,MAAM,CAAC,SAAS,CAAC,MACf,KAAK,IAA2C,WAAW,EAAE,OAAO,OAAO,CAAC;AAAA,IAChF;AAAA,IACA,YAAY;AAAA,MACV,MAAM,CAAC,SAAS,CAAC,MACf,KAAK,IAAqC,eAAe,EAAE,OAAO,OAAO,CAAC;AAAA,IAC9E;AAAA,EACF;AACF;","names":["options"]}
|