@asteby/metacore-runtime-react 53.25.0 → 53.26.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/CHANGELOG.md +11 -0
- package/dist/action-modal-dispatcher.d.ts +3 -3
- package/dist/action-modal-dispatcher.js +31 -31
- package/dist/action-priority.d.ts +1 -1
- package/dist/activity-diff.d.ts +1 -1
- package/dist/activity-diff.js +1 -1
- package/dist/activity-timeline.d.ts +2 -2
- package/dist/activity-timeline.js +3 -3
- package/dist/activity-value-renderer.d.ts +1 -1
- package/dist/activity-value-renderer.js +3 -3
- package/dist/addon-loader.d.ts +1 -1
- package/dist/addon-loader.js +3 -3
- package/dist/addon-page-host.js +1 -1
- package/dist/addon-page-loader.d.ts +2 -2
- package/dist/addon-page-loader.js +3 -3
- package/dist/api-context.js +4 -4
- package/dist/approval-gate.d.ts +1 -1
- package/dist/approval-gate.js +5 -5
- package/dist/assist-interview.d.ts +1 -1
- package/dist/assist-interview.js +1 -1
- package/dist/attention/index.d.ts +3 -3
- package/dist/attention/index.js +3 -3
- package/dist/attention/use-nav-badges.js +2 -2
- package/dist/attribute-classes.d.ts +1 -1
- package/dist/audit-info.d.ts +1 -1
- package/dist/audit-info.js +5 -5
- package/dist/bulk-image-dialog.d.ts +1 -1
- package/dist/bulk-image-dialog.js +5 -5
- package/dist/bulk-image-import.d.ts +2 -2
- package/dist/bulk-image-import.js +1 -1
- package/dist/bulk-image-target.d.ts +1 -1
- package/dist/bulk-image-target.js +1 -1
- package/dist/bulk-image-wizard.d.ts +1 -1
- package/dist/bulk-image-wizard.js +5 -5
- package/dist/business/catalog-product-search.d.ts +1 -1
- package/dist/business/customer-picker.js +4 -4
- package/dist/business/document-editor-model.d.ts +3 -3
- package/dist/business/document-editor-model.js +4 -4
- package/dist/business/document-editor-panels.d.ts +3 -3
- package/dist/business/document-editor-panels.js +1 -1
- package/dist/business/document-editor.d.ts +2 -2
- package/dist/business/document-editor.js +22 -22
- package/dist/business/document-lines.d.ts +2 -2
- package/dist/business/document-lines.js +3 -3
- package/dist/business/field-errors.d.ts +1 -1
- package/dist/business/field-errors.js +1 -1
- package/dist/business/format.js +1 -1
- package/dist/business/index.d.ts +29 -29
- package/dist/business/index.js +29 -29
- package/dist/business/inspection-checklist.d.ts +1 -1
- package/dist/business/inspection-checklist.js +2 -2
- package/dist/business/inspection.d.ts +1 -1
- package/dist/business/inspection.js +2 -2
- package/dist/business/line-items-editor.d.ts +3 -3
- package/dist/business/line-items-editor.js +5 -5
- package/dist/business/line-items.d.ts +1 -1
- package/dist/business/line-items.js +2 -2
- package/dist/business/line-product-cell.d.ts +2 -2
- package/dist/business/line-product-cell.js +2 -2
- package/dist/business/payment-allocator.d.ts +1 -1
- package/dist/business/payment-allocator.js +2 -2
- package/dist/business/payment-capture.d.ts +1 -1
- package/dist/business/payment-capture.js +3 -3
- package/dist/business/payment.js +1 -1
- package/dist/business/print-send-dialog.js +1 -1
- package/dist/business/product-display.d.ts +1 -1
- package/dist/business/product-options.d.ts +1 -1
- package/dist/business/product-options.js +4 -4
- package/dist/business/product-picker.d.ts +1 -1
- package/dist/business/product-picker.js +3 -3
- package/dist/business/product-search.d.ts +2 -2
- package/dist/business/product-search.js +1 -1
- package/dist/business/refund-destination.d.ts +1 -1
- package/dist/business/refund-destination.js +2 -2
- package/dist/business/refund.js +1 -1
- package/dist/business/relate-documents.js +1 -1
- package/dist/business/return-wizard.d.ts +2 -2
- package/dist/business/return-wizard.js +4 -4
- package/dist/business/return.d.ts +2 -2
- package/dist/business/return.js +2 -2
- package/dist/business/vehicle-picker.js +3 -3
- package/dist/cache-coherence.js +3 -3
- package/dist/capability-providers/index.d.ts +3 -3
- package/dist/capability-providers/index.js +3 -3
- package/dist/capability-providers/provider-sortable-list.d.ts +1 -1
- package/dist/capability-providers/provider-sortable-list.js +1 -1
- package/dist/collection-cell.js +1 -1
- package/dist/column-filter-field.d.ts +1 -1
- package/dist/column-visibility.d.ts +1 -1
- package/dist/custom-stages.d.ts +2 -2
- package/dist/custom-stages.js +1 -1
- package/dist/dashboard-grid.d.ts +1 -1
- package/dist/dashboard-grid.js +3 -3
- package/dist/dialogs/create-record-dialog.d.ts +1 -1
- package/dist/dialogs/create-record-dialog.js +1 -1
- package/dist/dialogs/dynamic-record.d.ts +5 -5
- package/dist/dialogs/dynamic-record.js +41 -41
- package/dist/dialogs/export.d.ts +1 -1
- package/dist/dialogs/export.js +2 -2
- package/dist/dialogs/import.d.ts +1 -1
- package/dist/dialogs/import.js +3 -3
- package/dist/dialogs/inline-relation-rows.d.ts +3 -3
- package/dist/dialogs/inline-relation-rows.js +3 -3
- package/dist/dialogs/inline-relations.d.ts +3 -3
- package/dist/dialogs/inline-relations.js +3 -3
- package/dist/dialogs/normalize-submit.d.ts +1 -1
- package/dist/dialogs/normalize-submit.js +3 -3
- package/dist/dialogs/use-inline-relations.d.ts +1 -1
- package/dist/dialogs/use-inline-relations.js +3 -3
- package/dist/dialogs/view-record-dialog.d.ts +1 -1
- package/dist/dialogs/view-record-dialog.js +1 -1
- package/dist/display-value.js +1 -1
- package/dist/document/action-bar.d.ts +1 -1
- package/dist/document/action-bar.js +1 -1
- package/dist/document/document-header.d.ts +2 -2
- package/dist/document/document-header.js +2 -2
- package/dist/document/document-page.d.ts +3 -3
- package/dist/document/document-page.js +9 -9
- package/dist/document/document-timeline.d.ts +2 -2
- package/dist/document/document-timeline.js +2 -2
- package/dist/document/evaluate.d.ts +1 -1
- package/dist/document/evaluate.js +1 -1
- package/dist/document/format.d.ts +1 -1
- package/dist/document/index.d.ts +13 -13
- package/dist/document/index.js +13 -13
- package/dist/document/registry.d.ts +1 -1
- package/dist/document/secondary-bar.js +2 -2
- package/dist/document/smart-buttons.js +1 -1
- package/dist/document/status-badge.d.ts +1 -1
- package/dist/document/use-document-sources.d.ts +1 -1
- package/dist/document/use-document-sources.js +2 -2
- package/dist/document-form-dialog.d.ts +2 -2
- package/dist/document-form-dialog.js +16 -16
- package/dist/document-template-editor.js +1 -1
- package/dist/dynamic-columns-shim.d.ts +1 -1
- package/dist/dynamic-columns.d.ts +3 -3
- package/dist/dynamic-columns.js +19 -19
- package/dist/dynamic-crud-page.d.ts +2 -2
- package/dist/dynamic-crud-page.js +13 -13
- package/dist/dynamic-date-field.d.ts +1 -1
- package/dist/dynamic-date-field.js +1 -1
- package/dist/dynamic-form-schema.d.ts +2 -2
- package/dist/dynamic-form-schema.js +4 -4
- package/dist/dynamic-form.d.ts +10 -10
- package/dist/dynamic-form.js +24 -24
- package/dist/dynamic-icon.js +1 -1
- package/dist/dynamic-kanban.d.ts +3 -3
- package/dist/dynamic-kanban.js +25 -25
- package/dist/dynamic-line-items.d.ts +1 -1
- package/dist/dynamic-line-items.js +6 -6
- package/dist/dynamic-multi-select-field.d.ts +1 -1
- package/dist/dynamic-multi-select-field.js +7 -7
- package/dist/dynamic-relation-helpers.d.ts +1 -1
- package/dist/dynamic-relation-helpers.js +2 -2
- package/dist/dynamic-relation.d.ts +2 -2
- package/dist/dynamic-relation.js +15 -15
- package/dist/dynamic-relations.d.ts +2 -2
- package/dist/dynamic-relations.js +1 -1
- package/dist/dynamic-row-actions.d.ts +1 -1
- package/dist/dynamic-row-actions.js +5 -5
- package/dist/dynamic-select-field.d.ts +3 -3
- package/dist/dynamic-select-field.js +11 -11
- package/dist/dynamic-table.d.ts +2 -2
- package/dist/dynamic-table.js +24 -24
- package/dist/dynamic-view.d.ts +4 -4
- package/dist/dynamic-view.js +7 -7
- package/dist/entity-select.js +4 -4
- package/dist/field-validation-ui.d.ts +2 -2
- package/dist/field-widget-registry.d.ts +1 -1
- package/dist/form-layout-ui.d.ts +1 -1
- package/dist/form-layout.d.ts +1 -1
- package/dist/form-layout.js +1 -1
- package/dist/genui/index.d.ts +1 -1
- package/dist/genui/index.js +1 -1
- package/dist/genui/settings-block.d.ts +1 -1
- package/dist/genui/settings-block.js +3 -3
- package/dist/host-api-client.d.ts +11 -1
- package/dist/host-api-client.d.ts.map +1 -1
- package/dist/host-api-client.js +21 -14
- package/dist/host-api.d.ts +9 -1
- package/dist/host-api.d.ts.map +1 -1
- package/dist/host-api.js +57 -2
- package/dist/hotswap-reload-policy.d.ts +1 -1
- package/dist/hotswap-reload-policy.js +1 -1
- package/dist/icon-picker-field.d.ts +1 -1
- package/dist/icon-picker-field.js +3 -3
- package/dist/icon-resolvers.d.ts +1 -1
- package/dist/icon-resolvers.js +1 -1
- package/dist/icon-spec.js +1 -1
- package/dist/index.d.ts +165 -165
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +148 -148
- package/dist/license/index.d.ts +6 -6
- package/dist/license/index.js +6 -6
- package/dist/license/license-expiry-banner.d.ts +1 -1
- package/dist/license/license-expiry-banner.js +3 -3
- package/dist/license/license-gate.d.ts +1 -1
- package/dist/license/license-gate.js +5 -5
- package/dist/license/license-status-badge.d.ts +1 -1
- package/dist/license/license-status-badge.js +1 -1
- package/dist/license/use-license-t.d.ts +1 -1
- package/dist/license/use-license-t.js +1 -1
- package/dist/license/view.d.ts +1 -1
- package/dist/license/view.js +1 -1
- package/dist/list-include.d.ts +1 -1
- package/dist/manifest-hotswap-subscriber.d.ts +1 -1
- package/dist/manifest-hotswap-subscriber.js +1 -1
- package/dist/metadata-cache.d.ts +1 -1
- package/dist/metadata-cache.js +1 -1
- package/dist/model-action-toolbar.d.ts +1 -1
- package/dist/model-action-toolbar.js +7 -7
- package/dist/nav-permissions.d.ts +1 -1
- package/dist/nav-permissions.js +1 -1
- package/dist/navigation-builder.d.ts +1 -1
- package/dist/navigation-builder.js +1 -1
- package/dist/option-display.d.ts +1 -1
- package/dist/option-display.js +2 -2
- package/dist/option-filter.d.ts +1 -1
- package/dist/option-when.d.ts +1 -1
- package/dist/org-runtime-provider.d.ts +2 -2
- package/dist/org-runtime-provider.js +2 -2
- package/dist/permissions-context.d.ts +1 -1
- package/dist/permissions-manager.js +4 -4
- package/dist/primitives/aging.js +1 -1
- package/dist/primitives/allocation.js +1 -1
- package/dist/primitives/approvals.d.ts +1 -1
- package/dist/primitives/contributions.js +1 -1
- package/dist/primitives/document-kinds.d.ts +1 -1
- package/dist/primitives/index.d.ts +7 -7
- package/dist/primitives/index.js +7 -7
- package/dist/primitives/panels.d.ts +1 -1
- package/dist/primitives/use-contributions.d.ts +2 -2
- package/dist/primitives/use-contributions.js +2 -2
- package/dist/print-document-button.d.ts +1 -1
- package/dist/print-document-button.js +1 -1
- package/dist/provenance.js +3 -3
- package/dist/query-batch.d.ts +1 -1
- package/dist/query-batch.js +1 -1
- package/dist/record-actions.d.ts +2 -2
- package/dist/record-actions.js +2 -2
- package/dist/record-history.d.ts +2 -2
- package/dist/record-history.js +3 -3
- package/dist/record-picker-dialog.js +3 -3
- package/dist/record-picker-option.d.ts +1 -1
- package/dist/record-picker-option.js +1 -1
- package/dist/record-picker.js +2 -2
- package/dist/record-prefill-bar.js +1 -1
- package/dist/relation-gallery.js +1 -1
- package/dist/requires-addon.d.ts +1 -1
- package/dist/rich-cells.js +2 -2
- package/dist/rich-url.js +1 -1
- package/dist/row-actions-menu.js +5 -5
- package/dist/server-error.js +2 -2
- package/dist/setup/addon-config-surface.d.ts +3 -3
- package/dist/setup/addon-config-surface.js +10 -10
- package/dist/setup/connector-blocks-model.d.ts +1 -1
- package/dist/setup/connector-blocks.d.ts +1 -1
- package/dist/setup/connector-blocks.js +6 -6
- package/dist/setup/flow-model.d.ts +1 -1
- package/dist/setup/health-card.d.ts +1 -1
- package/dist/setup/health-card.js +2 -2
- package/dist/setup/index.d.ts +12 -12
- package/dist/setup/index.js +12 -12
- package/dist/setup/records-table.d.ts +1 -1
- package/dist/setup/records-table.js +2 -2
- package/dist/setup/setup-flow.d.ts +1 -1
- package/dist/setup/setup-flow.js +7 -7
- package/dist/setup/setup-form-step.d.ts +1 -1
- package/dist/setup/setup-form-step.js +4 -4
- package/dist/setup/step-status-badge.d.ts +1 -1
- package/dist/setup/step-status-badge.js +2 -2
- package/dist/setup/tone.d.ts +1 -1
- package/dist/setup/types.d.ts +2 -2
- package/dist/sidebar-layout-manager.d.ts +1 -1
- package/dist/sidebar-layout-manager.js +2 -2
- package/dist/slot.js +1 -1
- package/dist/slots/addon-slot.js +4 -4
- package/dist/slots/index.d.ts +2 -2
- package/dist/slots/index.js +2 -2
- package/dist/stage-automations.d.ts +2 -2
- package/dist/stage-automations.js +1 -1
- package/dist/stage-layout.js +1 -1
- package/dist/stage-overrides.d.ts +1 -1
- package/dist/stage-overrides.js +1 -1
- package/dist/supervised-action.js +1 -1
- package/dist/testing.d.ts +1 -1
- package/dist/testing.js +1 -1
- package/dist/tri-state-boolean.d.ts +2 -2
- package/dist/tri-state-boolean.js +1 -1
- package/dist/types.d.ts +1 -1
- package/dist/upload-field.d.ts +1 -1
- package/dist/upload-field.js +4 -4
- package/dist/use-addon-installed-probe.js +3 -3
- package/dist/use-addon-settings.d.ts +1 -1
- package/dist/use-addon-settings.js +1 -1
- package/dist/use-dynamic-filters.d.ts +2 -2
- package/dist/use-dynamic-filters.js +6 -6
- package/dist/use-edge-device.d.ts +1 -1
- package/dist/use-edge-device.js +2 -2
- package/dist/use-facet-loaders.d.ts +1 -1
- package/dist/use-facet-loaders.js +1 -1
- package/dist/use-flip-animation.d.ts +1 -1
- package/dist/use-flip-animation.js +1 -1
- package/dist/use-host-api-client.d.ts +2 -2
- package/dist/use-host-api-client.d.ts.map +1 -1
- package/dist/use-host-api-client.js +6 -4
- package/dist/use-option-ids.d.ts +1 -1
- package/dist/use-option-ids.js +2 -2
- package/dist/use-options-resolver.d.ts +2 -2
- package/dist/use-options-resolver.js +4 -4
- package/dist/use-org-document-templates.js +1 -1
- package/dist/use-print-document.js +1 -1
- package/dist/use-record-mutation-tick.js +1 -1
- package/dist/validator.d.ts +2 -2
- package/dist/validator.js +1 -1
- package/dist/view-system/card-spec.d.ts +1 -1
- package/dist/view-system/cards-view.d.ts +1 -1
- package/dist/view-system/cards-view.js +2 -2
- package/dist/view-system/index.d.ts +9 -9
- package/dist/view-system/index.js +9 -9
- package/dist/view-system/model-view.d.ts +3 -3
- package/dist/view-system/model-view.js +7 -7
- package/dist/view-system/saved-views.d.ts +1 -1
- package/dist/view-system/use-view-mode.d.ts +1 -1
- package/dist/view-system/view-state.d.ts +1 -1
- package/dist/view-system/view-switcher.d.ts +1 -1
- package/dist/view-system/view-toolbar.d.ts +1 -1
- package/dist/view-system/view-toolbar.js +2 -2
- package/dist/views/calendar-view.d.ts +1 -1
- package/dist/views/calendar-view.js +2 -2
- package/dist/views/chart-view.d.ts +2 -2
- package/dist/views/chart-view.js +2 -2
- package/dist/views/data-source.d.ts +2 -2
- package/dist/views/index.d.ts +3 -3
- package/dist/views/index.js +2 -2
- package/dist/views/map-view.d.ts +1 -1
- package/dist/views/map-view.js +3 -3
- package/dist/views/panels.d.ts +1 -1
- package/dist/views/panels.js +3 -3
- package/dist/views/registry.d.ts +2 -2
- package/dist/views/registry.js +12 -12
- package/dist/views/split-view.d.ts +1 -1
- package/dist/views/split-view.js +4 -4
- package/dist/views/timeline-view.d.ts +1 -1
- package/dist/views/timeline-view.js +3 -3
- package/dist/views/types.d.ts +2 -2
- package/dist/widgets/charts.d.ts +1 -1
- package/dist/widgets/charts.js +2 -2
- package/dist/widgets/lazy-charts.d.ts +1 -1
- package/dist/widgets/lazy-charts.js +2 -2
- package/dist/widgets/renderers.d.ts +2 -2
- package/dist/widgets/renderers.js +2 -2
- package/dist/widgets/widget-card.d.ts +1 -1
- package/dist/widgets/widget-card.js +2 -2
- package/dist/widgets/widget-renderer.d.ts +1 -1
- package/dist/widgets/widget-renderer.js +4 -4
- package/package.json +9 -9
- package/src/__tests__/host-api-client.test.tsx +16 -0
- package/src/__tests__/host-api.test.ts +50 -0
- package/src/host-api-client.ts +31 -14
- package/src/host-api.ts +54 -1
- package/src/index.ts +2 -1
- package/src/use-host-api-client.ts +5 -3
package/src/host-api-client.ts
CHANGED
|
@@ -22,6 +22,17 @@ export { ApiError, isAbortError }
|
|
|
22
22
|
export interface HostRequestConfig {
|
|
23
23
|
params?: HostApiParams
|
|
24
24
|
signal?: AbortSignal
|
|
25
|
+
/**
|
|
26
|
+
* Extra headers for this call (e.g. `X-Correlation-ID`), merged over the
|
|
27
|
+
* client's `defaultHeaders`. The host drops Authorization, X-Organization-ID
|
|
28
|
+
* and the other headers it owns; they can never be overridden from here.
|
|
29
|
+
*/
|
|
30
|
+
headers?: Record<string, string>
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
export interface HostApiClientOptions {
|
|
34
|
+
/** Headers sent on every call; per-call `headers` win over them. */
|
|
35
|
+
defaultHeaders?: Record<string, string>
|
|
25
36
|
}
|
|
26
37
|
|
|
27
38
|
/** Minimal axios-like surface (what DynamicSelectField & co. call). */
|
|
@@ -83,7 +94,13 @@ function toApiError(e: unknown, signal?: AbortSignal): Error {
|
|
|
83
94
|
}
|
|
84
95
|
|
|
85
96
|
/** Build the client over the host-injected {@link HostApi}. */
|
|
86
|
-
export function createHostApiClient(api: HostApi): HostApiClient {
|
|
97
|
+
export function createHostApiClient(api: HostApi, options: HostApiClientOptions = {}): HostApiClient {
|
|
98
|
+
const defaults = options.defaultHeaders
|
|
99
|
+
// Additive: without defaults or per-call headers the config is untouched.
|
|
100
|
+
const cfg = <C extends HostRequestConfig | undefined>(c: C): C => {
|
|
101
|
+
if (!defaults) return c
|
|
102
|
+
return { ...(c ?? {}), headers: { ...defaults, ...(c?.headers ?? {}) } } as C
|
|
103
|
+
}
|
|
87
104
|
const run = async <R,>(p: () => Promise<R>, signal?: AbortSignal): Promise<R> => {
|
|
88
105
|
try {
|
|
89
106
|
return await p()
|
|
@@ -95,15 +112,15 @@ export function createHostApiClient(api: HostApi): HostApiClient {
|
|
|
95
112
|
run(async () => unwrapEnvelope<T>(await p()), signal)
|
|
96
113
|
|
|
97
114
|
const client: HostApiClient = {
|
|
98
|
-
get: (path, c) => body(() => api.get(path, c), c?.signal),
|
|
99
|
-
post: (path, b, c) => body(() => api.post(path, b, c), c?.signal),
|
|
100
|
-
put: (path, b, c) => body(() => api.put(path, b, c), c?.signal),
|
|
101
|
-
patch: (path, b, c) => body(() => api.patch(path, b, c), c?.signal),
|
|
102
|
-
delete: (path, c) => body(() => api.delete(path, c), c?.signal),
|
|
115
|
+
get: (path, c) => body(() => api.get(path, cfg(c)), c?.signal),
|
|
116
|
+
post: (path, b, c) => body(() => api.post(path, b, cfg(c)), c?.signal),
|
|
117
|
+
put: (path, b, c) => body(() => api.put(path, b, cfg(c)), c?.signal),
|
|
118
|
+
patch: (path, b, c) => body(() => api.patch(path, b, cfg(c)), c?.signal),
|
|
119
|
+
delete: (path, c) => body(() => api.delete(path, cfg(c)), c?.signal),
|
|
103
120
|
list: (path, c) =>
|
|
104
|
-
run(async () => unwrapList(await api.get(path, c)), c?.signal),
|
|
121
|
+
run(async () => unwrapList(await api.get(path, cfg(c))), c?.signal),
|
|
105
122
|
blob: (path, c) =>
|
|
106
|
-
run(() => api.get<Blob>(path, { ...c, responseType: 'blob' }), c?.signal),
|
|
123
|
+
run(() => api.get<Blob>(path, { ...cfg(c), responseType: 'blob' }), c?.signal),
|
|
107
124
|
upload: (path, file, fields, opts) => {
|
|
108
125
|
let form: FormData
|
|
109
126
|
if (typeof FormData !== 'undefined' && file instanceof FormData) {
|
|
@@ -113,7 +130,7 @@ export function createHostApiClient(api: HostApi): HostApiClient {
|
|
|
113
130
|
form.append(opts?.fileField ?? 'file', file as Blob)
|
|
114
131
|
for (const [k, v] of Object.entries(fields ?? {})) form.append(k, v)
|
|
115
132
|
}
|
|
116
|
-
return body(() => api.post(path, form, opts?.signal ? { signal: opts.signal } : undefined), opts?.signal)
|
|
133
|
+
return body(() => api.post(path, form, cfg(opts?.signal ? { signal: opts.signal } : undefined)), opts?.signal)
|
|
117
134
|
},
|
|
118
135
|
axiosLike: () => {
|
|
119
136
|
// Envelope kept (the runtime-react fields unwrap it themselves),
|
|
@@ -125,11 +142,11 @@ export function createHostApiClient(api: HostApi): HostApiClient {
|
|
|
125
142
|
return { data }
|
|
126
143
|
}, signal)
|
|
127
144
|
return {
|
|
128
|
-
get: (u, c) => raw(() => api.get(u, c), c?.signal),
|
|
129
|
-
post: (u, b, c) => raw(() => api.post(u, b, c), c?.signal),
|
|
130
|
-
put: (u, b, c) => raw(() => api.put(u, b, c), c?.signal),
|
|
131
|
-
patch: (u, b, c) => raw(() => api.patch(u, b, c), c?.signal),
|
|
132
|
-
delete: (u, c) => raw(() => api.delete(u, c), c?.signal),
|
|
145
|
+
get: (u, c) => raw(() => api.get(u, cfg(c)), c?.signal),
|
|
146
|
+
post: (u, b, c) => raw(() => api.post(u, b, cfg(c)), c?.signal),
|
|
147
|
+
put: (u, b, c) => raw(() => api.put(u, b, cfg(c)), c?.signal),
|
|
148
|
+
patch: (u, b, c) => raw(() => api.patch(u, b, cfg(c)), c?.signal),
|
|
149
|
+
delete: (u, c) => raw(() => api.delete(u, cfg(c)), c?.signal),
|
|
133
150
|
}
|
|
134
151
|
},
|
|
135
152
|
}
|
package/src/host-api.ts
CHANGED
|
@@ -77,12 +77,64 @@ function safeData(data: unknown): unknown {
|
|
|
77
77
|
}
|
|
78
78
|
}
|
|
79
79
|
|
|
80
|
+
/**
|
|
81
|
+
* Headers the host owns. A remote may add headers but never set these: they
|
|
82
|
+
* carry the credentials, the tenant scope or transport framing. Compared
|
|
83
|
+
* lowercase.
|
|
84
|
+
*/
|
|
85
|
+
export const PROTECTED_HOST_HEADERS: ReadonlySet<string> = new Set([
|
|
86
|
+
'authorization',
|
|
87
|
+
'proxy-authorization',
|
|
88
|
+
'cookie',
|
|
89
|
+
'x-organization-id',
|
|
90
|
+
'x-org-id',
|
|
91
|
+
'x-branch-id',
|
|
92
|
+
'accept-language',
|
|
93
|
+
'host',
|
|
94
|
+
'content-length',
|
|
95
|
+
'content-type',
|
|
96
|
+
'transfer-encoding',
|
|
97
|
+
'origin',
|
|
98
|
+
'referer',
|
|
99
|
+
// Reenvio / identidad de origen: el backend arma URLs publicas y decide
|
|
100
|
+
// tenant a partir de ellas.
|
|
101
|
+
'x-forwarded-host',
|
|
102
|
+
'x-forwarded-proto',
|
|
103
|
+
'x-forwarded-for',
|
|
104
|
+
'x-forwarded-port',
|
|
105
|
+
'forwarded',
|
|
106
|
+
'x-real-ip',
|
|
107
|
+
'x-storefront-domain',
|
|
108
|
+
'x-api-key',
|
|
109
|
+
'x-http-method-override',
|
|
110
|
+
])
|
|
111
|
+
const PROTECTED_HEADER_PREFIXES = ['proxy-']
|
|
112
|
+
|
|
113
|
+
/** Drop protected / malformed headers; returns undefined when none remain. */
|
|
114
|
+
export function sanitizeRemoteHeaders(
|
|
115
|
+
headers: Record<string, string> | undefined,
|
|
116
|
+
): Record<string, string> | undefined {
|
|
117
|
+
if (!headers || typeof headers !== 'object') return undefined
|
|
118
|
+
const out: Record<string, string> = {}
|
|
119
|
+
for (const [name, value] of Object.entries(headers)) {
|
|
120
|
+
if (typeof value !== 'string') continue
|
|
121
|
+
if (!/^[A-Za-z0-9!#$%&'*+.^_`|~-]+$/.test(name)) continue
|
|
122
|
+
if (/[\r\n]/.test(value)) continue
|
|
123
|
+
const lower = name.toLowerCase()
|
|
124
|
+
if (PROTECTED_HOST_HEADERS.has(lower) || PROTECTED_HEADER_PREFIXES.some((p) => lower.startsWith(p))) continue
|
|
125
|
+
out[name] = value
|
|
126
|
+
}
|
|
127
|
+
return Object.keys(out).length ? out : undefined
|
|
128
|
+
}
|
|
129
|
+
|
|
80
130
|
function toConfig(opts?: HostApiRequestOptions): Record<string, unknown> | undefined {
|
|
81
131
|
if (!opts) return undefined
|
|
82
132
|
const config: Record<string, unknown> = {}
|
|
83
133
|
if (opts.params) config.params = opts.params
|
|
84
134
|
if (opts.signal) config.signal = opts.signal
|
|
85
135
|
if (opts.responseType === 'blob') config.responseType = 'blob'
|
|
136
|
+
const headers = sanitizeRemoteHeaders(opts.headers)
|
|
137
|
+
if (headers) config.headers = headers
|
|
86
138
|
return config
|
|
87
139
|
}
|
|
88
140
|
|
|
@@ -131,7 +183,8 @@ export function createHostApi(client: ApiClient, options: CreateHostApiOptions =
|
|
|
131
183
|
return Object.freeze({
|
|
132
184
|
get: <T,>(path: string, opts?: HostApiRequestOptions) => {
|
|
133
185
|
const args = withConfig([path], opts) as [string, { params?: Record<string, unknown> }?]
|
|
134
|
-
|
|
186
|
+
// A GET with per-call headers cannot share a POST /q: it goes on its own.
|
|
187
|
+
const batch = options.batchGets && opts?.responseType !== 'blob' && !sanitizeRemoteHeaders(opts?.headers)
|
|
135
188
|
return bodyOf<T>(batch ? batchGet(client, ...args) : client.get(...args), opts)
|
|
136
189
|
},
|
|
137
190
|
post: <T,>(path: string, body?: unknown, opts?: HostApiRequestOptions) =>
|
package/src/index.ts
CHANGED
|
@@ -304,11 +304,12 @@ export {
|
|
|
304
304
|
type PageChromeState,
|
|
305
305
|
type PageChromeStore,
|
|
306
306
|
} from './addon-page-host'
|
|
307
|
-
export { createHostApi, toHostApiError, type CreateHostApiOptions } from './host-api'
|
|
307
|
+
export { createHostApi, toHostApiError, sanitizeRemoteHeaders, PROTECTED_HOST_HEADERS, type CreateHostApiOptions } from './host-api'
|
|
308
308
|
export { HostApiProvider, type HostApiProviderProps } from './host-api-context'
|
|
309
309
|
export {
|
|
310
310
|
createHostApiClient,
|
|
311
311
|
type HostApiClient,
|
|
312
|
+
type HostApiClientOptions,
|
|
312
313
|
type HostRequestConfig,
|
|
313
314
|
type AxiosLikeClient,
|
|
314
315
|
} from './host-api-client'
|
|
@@ -1,13 +1,15 @@
|
|
|
1
1
|
import { useMemo } from 'react'
|
|
2
2
|
import { useHostApi } from './addon-page-host'
|
|
3
|
-
import { createHostApiClient, type HostApiClient } from './host-api-client'
|
|
3
|
+
import { createHostApiClient, type HostApiClient, type HostApiClientOptions } from './host-api-client'
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
6
|
* The addon's HTTP client, built over the host-injected HostApi. Works inside
|
|
7
7
|
* <AddonPageHost> (pages) and <HostApiProvider> (modals, pickers). Without a
|
|
8
8
|
* host it throws a clear error: there is no localStorage / fetch fallback.
|
|
9
9
|
*/
|
|
10
|
-
export function useHostApiClient(): HostApiClient {
|
|
10
|
+
export function useHostApiClient(options?: HostApiClientOptions): HostApiClient {
|
|
11
11
|
const api = useHostApi()
|
|
12
|
-
|
|
12
|
+
const key = options?.defaultHeaders ? JSON.stringify(options.defaultHeaders) : ''
|
|
13
|
+
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
14
|
+
return useMemo(() => createHostApiClient(api, options), [api, key])
|
|
13
15
|
}
|