index.ts

packages/plinth-client/src/index.ts

1. export {
2. READ_METHODS,
3. FORBIDDEN_METHODS,
4. PlinthForbiddenMethodError,
5. assertReadMethod,
6. type ReadMethod,
7. GET_ORDERS_PARAMS,
8. PlinthUnknownParamError,
9. assertKnownParams,
10. phpCollection,
11. num,
12. str,
13. toPlinthDate,
14. readError,
15. isEmptyOrInvalid,
16. AMBIGUOUS_ERRORS,
17. } from './hazards.js'
19. export {
20. ORDER_FIELDS,
21. ORDER_IDENTITY_FIELDS,
22. PRODUCT_FIELDS,
23. DROPPED_FIELDS,
24. projectOrder,
25. projectProduct,
26. } from './projection.js'
28. export { PLINTH_BASE_URL, PLINTH_RATE_LIMIT } from './constants.js'
29. export { UNASSIGNED_VALUES, assignedPerson } from './assignment-values.js'
30. export { PlinthClient, PlinthError, PlinthRateLimitError, type PlinthOptions } from './http.js'
31. export {
32. OrdersResource,
33. type OrderLine,
34. type OrderWindow,
35. type AssignmentFieldCoverage,
36. } from './resources/orders.js'
37. export { displayOrderNumber, isDisplayOrderNumber } from './order-number.js'
38. export {
39. PRODUCT_STATUSES,
40. ORDER_STATUSES,
41. classifyOrder,
42. isOrderDesignQueue,
43. isKnownOrderStatus,
44. CLASS_LABELS,
45. classifyProduct,
46. isDesignQueue,
47. classifyLine,
48. isLineDesignQueue,
49. isOrderPastFulfilment,
50. type WorkClass,
51. type StatusRule,
52. } from './status-taxonomy.js'
54. export function plinthClientFromEnv(env: Record<string, string | undefined>) {
55. const token = env.PLINTH_API_KEY
56. if (!token) {
57. // One source of truth for credentials: the shell profile.
58. throw new Error(
59. 'PLINTH_API_KEY is not set. Credentials come from the shell profile; this repo has ' +
60. 'no .env reader. See credentials.example.sh, then open a NEW terminal; an ' +
61. 'existing one keeps the old environment.',
62. )
63. }
64. return token
65. }