@managespace/sdk 0.1.185 → 0.1.186
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/dist/extensions/host-bridge.d.ts +166 -0
- package/dist/extensions/host-bridge.d.ts.map +1 -0
- package/dist/extensions/host-bridge.js +259 -0
- package/dist/extensions/index.d.ts +40 -0
- package/dist/extensions/index.d.ts.map +1 -0
- package/dist/extensions/index.js +55 -0
- package/dist/extensions/types.d.ts +111 -0
- package/dist/extensions/types.d.ts.map +1 -0
- package/dist/extensions/types.js +2 -0
- package/dist/generated/apis/default-api.d.ts +1 -19
- package/dist/generated/apis/default-api.d.ts.map +1 -1
- package/dist/generated/apis/default-api.js +0 -66
- package/dist/generated/apis/extensions-api.d.ts +98 -0
- package/dist/generated/apis/extensions-api.d.ts.map +1 -0
- package/dist/generated/apis/extensions-api.js +295 -0
- package/dist/generated/models/contact.d.ts +12 -0
- package/dist/generated/models/contact.d.ts.map +1 -1
- package/dist/generated/models/contact.js +8 -0
- package/dist/generated/models/custom-create-contact.d.ts +12 -0
- package/dist/generated/models/custom-create-contact.d.ts.map +1 -1
- package/dist/generated/models/custom-create-contact.js +4 -0
- package/dist/generated/models/custom-create-customer.d.ts +17 -17
- package/dist/generated/models/custom-create-customer.d.ts.map +1 -1
- package/dist/generated/models/custom-create-customer.js +6 -6
- package/dist/generated/models/custom-update-contact.d.ts +12 -0
- package/dist/generated/models/custom-update-contact.d.ts.map +1 -1
- package/dist/generated/models/custom-update-contact.js +4 -0
- package/dist/generated/models/customer.d.ts +18 -0
- package/dist/generated/models/customer.d.ts.map +1 -1
- package/dist/generated/models/customer.js +12 -0
- package/dist/generated/models/document-status.d.ts +9 -0
- package/dist/generated/models/document-status.d.ts.map +1 -1
- package/dist/generated/models/document-status.js +2 -0
- package/dist/generated/models/extension-org.d.ts +64 -0
- package/dist/generated/models/extension-org.d.ts.map +1 -0
- package/dist/generated/models/extension-org.js +70 -0
- package/dist/generated/models/extension.d.ts +106 -0
- package/dist/generated/models/extension.d.ts.map +1 -0
- package/dist/generated/models/extension.js +98 -0
- package/dist/generated/models/field-type.d.ts +2 -0
- package/dist/generated/models/field-type.d.ts.map +1 -1
- package/dist/generated/models/field-type.js +2 -0
- package/dist/generated/models/index.d.ts +0 -1
- package/dist/generated/models/index.d.ts.map +1 -1
- package/dist/generated/models/index.js +0 -1
- package/dist/generated/models/template-field.d.ts +12 -0
- package/dist/generated/models/template-field.d.ts.map +1 -1
- package/dist/generated/models/template-field.js +4 -0
- package/dist/generated/models/update-document-type.d.ts +43 -0
- package/dist/generated/models/update-document-type.d.ts.map +1 -0
- package/dist/generated/models/update-document-type.js +61 -0
- package/package.deploy.json +8 -4
- package/package.json +4 -3
- package/src/generated/.openapi-generator/FILES +0 -1
- package/src/generated/apis/default-api.ts +0 -98
- package/src/generated/models/contact.ts +18 -0
- package/src/generated/models/custom-create-contact.ts +16 -0
- package/src/generated/models/custom-create-customer.ts +23 -23
- package/src/generated/models/custom-update-contact.ts +16 -0
- package/src/generated/models/customer.ts +27 -0
- package/src/generated/models/document-status.ts +8 -0
- package/src/generated/models/field-type.ts +2 -0
- package/src/generated/models/index.ts +0 -1
- package/src/generated/models/template-field.ts +16 -0
- package/dist/generated/models/financial-summary-report-filters.d.ts +0 -45
- package/dist/generated/models/financial-summary-report-filters.d.ts.map +0 -1
- package/dist/generated/models/financial-summary-report-filters.js +0 -57
- package/src/generated/models/financial-summary-report-filters.ts +0 -84
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
import type { EntityEventHandler, ExtensionContext } from './types';
|
|
2
|
+
/**
|
|
3
|
+
* Get the extension context from the ManageSpace host.
|
|
4
|
+
*
|
|
5
|
+
* This returns a promise that resolves when the context is received from the host.
|
|
6
|
+
* Call this early in your extension's lifecycle to get authentication and org context.
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* ```typescript
|
|
10
|
+
* import { getContext } from '@managespace/sdk/extensions';
|
|
11
|
+
*
|
|
12
|
+
* const context = await getContext();
|
|
13
|
+
* console.log('Org ID:', context.orgId);
|
|
14
|
+
* console.log('API URL:', context.apiBaseUrl);
|
|
15
|
+
* ```
|
|
16
|
+
*/
|
|
17
|
+
export declare function getContext(): Promise<ExtensionContext>;
|
|
18
|
+
/**
|
|
19
|
+
* Get the current context synchronously.
|
|
20
|
+
*
|
|
21
|
+
* Returns null if the context has not yet been received from the host.
|
|
22
|
+
* Prefer using `getContext()` which waits for the context to be available.
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* ```typescript
|
|
26
|
+
* import { getCurrentContext } from '@managespace/sdk/extensions';
|
|
27
|
+
*
|
|
28
|
+
* const context = getCurrentContext();
|
|
29
|
+
* if (context) {
|
|
30
|
+
* console.log('Already have context:', context.orgId);
|
|
31
|
+
* }
|
|
32
|
+
* ```
|
|
33
|
+
*/
|
|
34
|
+
export declare function getCurrentContext(): ExtensionContext | null;
|
|
35
|
+
/**
|
|
36
|
+
* Navigate the ManageSpace host application to a specific path.
|
|
37
|
+
*
|
|
38
|
+
* Use this to navigate users to pages within ManageSpace, such as
|
|
39
|
+
* customer profiles, asset details, or other views.
|
|
40
|
+
*
|
|
41
|
+
* @param path - The path to navigate to (e.g., "/customer/123")
|
|
42
|
+
*
|
|
43
|
+
* @example
|
|
44
|
+
* ```typescript
|
|
45
|
+
* import { navigate } from '@managespace/sdk/extensions';
|
|
46
|
+
*
|
|
47
|
+
* // Navigate to a customer profile
|
|
48
|
+
* navigate('/customer/abc-123');
|
|
49
|
+
*
|
|
50
|
+
* // Navigate to the assets page
|
|
51
|
+
* navigate('/assets');
|
|
52
|
+
* ```
|
|
53
|
+
*/
|
|
54
|
+
export declare function navigate(path: string): void;
|
|
55
|
+
/**
|
|
56
|
+
* Show a toast notification in the ManageSpace host application.
|
|
57
|
+
*
|
|
58
|
+
* Use this for user feedback after actions complete.
|
|
59
|
+
*
|
|
60
|
+
* @param message - The message to display
|
|
61
|
+
* @param variant - The toast type: 'success' or 'error' (default: 'success')
|
|
62
|
+
*
|
|
63
|
+
* @example
|
|
64
|
+
* ```typescript
|
|
65
|
+
* import { showToast } from '@managespace/sdk/extensions';
|
|
66
|
+
*
|
|
67
|
+
* // Success notification
|
|
68
|
+
* showToast('Customer updated successfully');
|
|
69
|
+
*
|
|
70
|
+
* // Error notification
|
|
71
|
+
* showToast('Failed to save changes', 'error');
|
|
72
|
+
* ```
|
|
73
|
+
*/
|
|
74
|
+
export declare function showToast(message: string, variant?: 'success' | 'error'): void;
|
|
75
|
+
/**
|
|
76
|
+
* Signal to the ManageSpace host that the extension is ready to receive context.
|
|
77
|
+
*
|
|
78
|
+
* Call this after your extension has loaded and set up its message listeners.
|
|
79
|
+
* The host will respond with a CONTEXT_INIT message containing the ExtensionContext.
|
|
80
|
+
*
|
|
81
|
+
* @example
|
|
82
|
+
* ```typescript
|
|
83
|
+
* import { signalReady, getContext } from '@managespace/sdk/extensions';
|
|
84
|
+
*
|
|
85
|
+
* // Signal ready and wait for context
|
|
86
|
+
* signalReady();
|
|
87
|
+
* const context = await getContext();
|
|
88
|
+
* ```
|
|
89
|
+
*/
|
|
90
|
+
export declare function signalReady(): void;
|
|
91
|
+
/**
|
|
92
|
+
* Subscribe to entity events from the ManageSpace host.
|
|
93
|
+
*
|
|
94
|
+
* The host sends events when entities (customers, assets, etc.) are
|
|
95
|
+
* created, updated, or deleted. Use this to keep your extension in sync.
|
|
96
|
+
*
|
|
97
|
+
* @param handler - Callback function to handle entity events
|
|
98
|
+
* @returns Unsubscribe function to remove the handler
|
|
99
|
+
*
|
|
100
|
+
* @example
|
|
101
|
+
* ```typescript
|
|
102
|
+
* import { onEntityEvent } from '@managespace/sdk/extensions';
|
|
103
|
+
*
|
|
104
|
+
* const unsubscribe = onEntityEvent((event) => {
|
|
105
|
+
* if (event.entityType === 'customer' && event.action === 'updated') {
|
|
106
|
+
* console.log('Customer updated:', event.entityId);
|
|
107
|
+
* refreshCustomerData();
|
|
108
|
+
* }
|
|
109
|
+
* });
|
|
110
|
+
*
|
|
111
|
+
* // Later, to stop listening:
|
|
112
|
+
* unsubscribe();
|
|
113
|
+
* ```
|
|
114
|
+
*/
|
|
115
|
+
export declare function onEntityEvent(handler: EntityEventHandler): () => void;
|
|
116
|
+
/**
|
|
117
|
+
* Create a configured fetch function for calling the ManageSpace API.
|
|
118
|
+
*
|
|
119
|
+
* This returns a fetch wrapper that automatically includes credentials
|
|
120
|
+
* and sets the correct headers for API calls.
|
|
121
|
+
*
|
|
122
|
+
* @param context - The extension context from getContext()
|
|
123
|
+
* @returns A fetch function configured for ManageSpace API calls
|
|
124
|
+
*
|
|
125
|
+
* @example
|
|
126
|
+
* ```typescript
|
|
127
|
+
* import { getContext, createApiFetch } from '@managespace/sdk/extensions';
|
|
128
|
+
*
|
|
129
|
+
* const context = await getContext();
|
|
130
|
+
* const apiFetch = createApiFetch(context);
|
|
131
|
+
*
|
|
132
|
+
* // Fetch customers
|
|
133
|
+
* const response = await apiFetch('/api/crm/customers/queries', {
|
|
134
|
+
* method: 'POST',
|
|
135
|
+
* body: JSON.stringify({
|
|
136
|
+
* pageOptions: { offset: 0, limit: 20 }
|
|
137
|
+
* })
|
|
138
|
+
* });
|
|
139
|
+
* const data = await response.json();
|
|
140
|
+
* ```
|
|
141
|
+
*/
|
|
142
|
+
export declare function createApiFetch(context: ExtensionContext): (path: string, options?: RequestInit) => Promise<Response>;
|
|
143
|
+
/**
|
|
144
|
+
* Create a configured fetch function for calling your extension's BFF.
|
|
145
|
+
*
|
|
146
|
+
* This returns a fetch wrapper that forwards credentials to your BFF,
|
|
147
|
+
* allowing it to make authenticated calls to the ManageSpace API.
|
|
148
|
+
*
|
|
149
|
+
* @param context - The extension context from getContext()
|
|
150
|
+
* @returns A fetch function configured for BFF calls, or null if no BFF is configured
|
|
151
|
+
*
|
|
152
|
+
* @example
|
|
153
|
+
* ```typescript
|
|
154
|
+
* import { getContext, createBffFetch } from '@managespace/sdk/extensions';
|
|
155
|
+
*
|
|
156
|
+
* const context = await getContext();
|
|
157
|
+
* const bffFetch = createBffFetch(context);
|
|
158
|
+
*
|
|
159
|
+
* if (bffFetch) {
|
|
160
|
+
* const response = await bffFetch('/api/enriched-customers');
|
|
161
|
+
* const data = await response.json();
|
|
162
|
+
* }
|
|
163
|
+
* ```
|
|
164
|
+
*/
|
|
165
|
+
export declare function createBffFetch(context: ExtensionContext): ((path: string, options?: RequestInit) => Promise<Response>) | null;
|
|
166
|
+
//# sourceMappingURL=host-bridge.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"host-bridge.d.ts","sourceRoot":"","sources":["../../src/extensions/host-bridge.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,kBAAkB,EAClB,gBAAgB,EAGnB,MAAM,SAAS,CAAC;AAiCjB;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,UAAU,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAQtD;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,iBAAiB,IAAI,gBAAgB,GAAG,IAAI,CAE3D;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAM3C;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,SAAS,CACrB,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,SAAS,GAAG,OAAmB,GACzC,IAAI,CAMN;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,WAAW,IAAI,IAAI,CAGlC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,kBAAkB,GAAG,MAAM,IAAI,CAKrE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,cAAc,CAC1B,OAAO,EAAE,gBAAgB,GAC1B,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAY5D;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,cAAc,CAC1B,OAAO,EAAE,gBAAgB,GAC1B,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC,GAAG,IAAI,CAgBrE"}
|
|
@@ -0,0 +1,259 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.getContext = getContext;
|
|
4
|
+
exports.getCurrentContext = getCurrentContext;
|
|
5
|
+
exports.navigate = navigate;
|
|
6
|
+
exports.showToast = showToast;
|
|
7
|
+
exports.signalReady = signalReady;
|
|
8
|
+
exports.onEntityEvent = onEntityEvent;
|
|
9
|
+
exports.createApiFetch = createApiFetch;
|
|
10
|
+
exports.createBffFetch = createBffFetch;
|
|
11
|
+
let contextResolve = null;
|
|
12
|
+
let currentContext = null;
|
|
13
|
+
const entityEventHandlers = new Set();
|
|
14
|
+
// Set up message listener when this module loads
|
|
15
|
+
if (typeof window !== 'undefined') {
|
|
16
|
+
window.addEventListener('message', (event) => {
|
|
17
|
+
if (!event.data?.type)
|
|
18
|
+
return;
|
|
19
|
+
switch (event.data.type) {
|
|
20
|
+
case 'CONTEXT_INIT':
|
|
21
|
+
currentContext = event.data.payload;
|
|
22
|
+
if (contextResolve) {
|
|
23
|
+
contextResolve(event.data.payload);
|
|
24
|
+
contextResolve = null;
|
|
25
|
+
}
|
|
26
|
+
break;
|
|
27
|
+
case 'ENTITY_EVENT':
|
|
28
|
+
for (const handler of entityEventHandlers) {
|
|
29
|
+
try {
|
|
30
|
+
handler(event.data.payload);
|
|
31
|
+
}
|
|
32
|
+
catch (error) {
|
|
33
|
+
console.error('Entity event handler error:', error);
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
break;
|
|
37
|
+
}
|
|
38
|
+
});
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* Get the extension context from the ManageSpace host.
|
|
42
|
+
*
|
|
43
|
+
* This returns a promise that resolves when the context is received from the host.
|
|
44
|
+
* Call this early in your extension's lifecycle to get authentication and org context.
|
|
45
|
+
*
|
|
46
|
+
* @example
|
|
47
|
+
* ```typescript
|
|
48
|
+
* import { getContext } from '@managespace/sdk/extensions';
|
|
49
|
+
*
|
|
50
|
+
* const context = await getContext();
|
|
51
|
+
* console.log('Org ID:', context.orgId);
|
|
52
|
+
* console.log('API URL:', context.apiBaseUrl);
|
|
53
|
+
* ```
|
|
54
|
+
*/
|
|
55
|
+
function getContext() {
|
|
56
|
+
if (currentContext) {
|
|
57
|
+
return Promise.resolve(currentContext);
|
|
58
|
+
}
|
|
59
|
+
return new Promise((resolve) => {
|
|
60
|
+
contextResolve = resolve;
|
|
61
|
+
});
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* Get the current context synchronously.
|
|
65
|
+
*
|
|
66
|
+
* Returns null if the context has not yet been received from the host.
|
|
67
|
+
* Prefer using `getContext()` which waits for the context to be available.
|
|
68
|
+
*
|
|
69
|
+
* @example
|
|
70
|
+
* ```typescript
|
|
71
|
+
* import { getCurrentContext } from '@managespace/sdk/extensions';
|
|
72
|
+
*
|
|
73
|
+
* const context = getCurrentContext();
|
|
74
|
+
* if (context) {
|
|
75
|
+
* console.log('Already have context:', context.orgId);
|
|
76
|
+
* }
|
|
77
|
+
* ```
|
|
78
|
+
*/
|
|
79
|
+
function getCurrentContext() {
|
|
80
|
+
return currentContext;
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* Navigate the ManageSpace host application to a specific path.
|
|
84
|
+
*
|
|
85
|
+
* Use this to navigate users to pages within ManageSpace, such as
|
|
86
|
+
* customer profiles, asset details, or other views.
|
|
87
|
+
*
|
|
88
|
+
* @param path - The path to navigate to (e.g., "/customer/123")
|
|
89
|
+
*
|
|
90
|
+
* @example
|
|
91
|
+
* ```typescript
|
|
92
|
+
* import { navigate } from '@managespace/sdk/extensions';
|
|
93
|
+
*
|
|
94
|
+
* // Navigate to a customer profile
|
|
95
|
+
* navigate('/customer/abc-123');
|
|
96
|
+
*
|
|
97
|
+
* // Navigate to the assets page
|
|
98
|
+
* navigate('/assets');
|
|
99
|
+
* ```
|
|
100
|
+
*/
|
|
101
|
+
function navigate(path) {
|
|
102
|
+
const message = {
|
|
103
|
+
type: 'NAVIGATE',
|
|
104
|
+
payload: { path },
|
|
105
|
+
};
|
|
106
|
+
window.parent.postMessage(message, '*');
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* Show a toast notification in the ManageSpace host application.
|
|
110
|
+
*
|
|
111
|
+
* Use this for user feedback after actions complete.
|
|
112
|
+
*
|
|
113
|
+
* @param message - The message to display
|
|
114
|
+
* @param variant - The toast type: 'success' or 'error' (default: 'success')
|
|
115
|
+
*
|
|
116
|
+
* @example
|
|
117
|
+
* ```typescript
|
|
118
|
+
* import { showToast } from '@managespace/sdk/extensions';
|
|
119
|
+
*
|
|
120
|
+
* // Success notification
|
|
121
|
+
* showToast('Customer updated successfully');
|
|
122
|
+
*
|
|
123
|
+
* // Error notification
|
|
124
|
+
* showToast('Failed to save changes', 'error');
|
|
125
|
+
* ```
|
|
126
|
+
*/
|
|
127
|
+
function showToast(message, variant = 'success') {
|
|
128
|
+
const msg = {
|
|
129
|
+
type: 'SHOW_TOAST',
|
|
130
|
+
payload: { message, variant },
|
|
131
|
+
};
|
|
132
|
+
window.parent.postMessage(msg, '*');
|
|
133
|
+
}
|
|
134
|
+
/**
|
|
135
|
+
* Signal to the ManageSpace host that the extension is ready to receive context.
|
|
136
|
+
*
|
|
137
|
+
* Call this after your extension has loaded and set up its message listeners.
|
|
138
|
+
* The host will respond with a CONTEXT_INIT message containing the ExtensionContext.
|
|
139
|
+
*
|
|
140
|
+
* @example
|
|
141
|
+
* ```typescript
|
|
142
|
+
* import { signalReady, getContext } from '@managespace/sdk/extensions';
|
|
143
|
+
*
|
|
144
|
+
* // Signal ready and wait for context
|
|
145
|
+
* signalReady();
|
|
146
|
+
* const context = await getContext();
|
|
147
|
+
* ```
|
|
148
|
+
*/
|
|
149
|
+
function signalReady() {
|
|
150
|
+
const message = { type: 'READY' };
|
|
151
|
+
window.parent.postMessage(message, '*');
|
|
152
|
+
}
|
|
153
|
+
/**
|
|
154
|
+
* Subscribe to entity events from the ManageSpace host.
|
|
155
|
+
*
|
|
156
|
+
* The host sends events when entities (customers, assets, etc.) are
|
|
157
|
+
* created, updated, or deleted. Use this to keep your extension in sync.
|
|
158
|
+
*
|
|
159
|
+
* @param handler - Callback function to handle entity events
|
|
160
|
+
* @returns Unsubscribe function to remove the handler
|
|
161
|
+
*
|
|
162
|
+
* @example
|
|
163
|
+
* ```typescript
|
|
164
|
+
* import { onEntityEvent } from '@managespace/sdk/extensions';
|
|
165
|
+
*
|
|
166
|
+
* const unsubscribe = onEntityEvent((event) => {
|
|
167
|
+
* if (event.entityType === 'customer' && event.action === 'updated') {
|
|
168
|
+
* console.log('Customer updated:', event.entityId);
|
|
169
|
+
* refreshCustomerData();
|
|
170
|
+
* }
|
|
171
|
+
* });
|
|
172
|
+
*
|
|
173
|
+
* // Later, to stop listening:
|
|
174
|
+
* unsubscribe();
|
|
175
|
+
* ```
|
|
176
|
+
*/
|
|
177
|
+
function onEntityEvent(handler) {
|
|
178
|
+
entityEventHandlers.add(handler);
|
|
179
|
+
return () => {
|
|
180
|
+
entityEventHandlers.delete(handler);
|
|
181
|
+
};
|
|
182
|
+
}
|
|
183
|
+
/**
|
|
184
|
+
* Create a configured fetch function for calling the ManageSpace API.
|
|
185
|
+
*
|
|
186
|
+
* This returns a fetch wrapper that automatically includes credentials
|
|
187
|
+
* and sets the correct headers for API calls.
|
|
188
|
+
*
|
|
189
|
+
* @param context - The extension context from getContext()
|
|
190
|
+
* @returns A fetch function configured for ManageSpace API calls
|
|
191
|
+
*
|
|
192
|
+
* @example
|
|
193
|
+
* ```typescript
|
|
194
|
+
* import { getContext, createApiFetch } from '@managespace/sdk/extensions';
|
|
195
|
+
*
|
|
196
|
+
* const context = await getContext();
|
|
197
|
+
* const apiFetch = createApiFetch(context);
|
|
198
|
+
*
|
|
199
|
+
* // Fetch customers
|
|
200
|
+
* const response = await apiFetch('/api/crm/customers/queries', {
|
|
201
|
+
* method: 'POST',
|
|
202
|
+
* body: JSON.stringify({
|
|
203
|
+
* pageOptions: { offset: 0, limit: 20 }
|
|
204
|
+
* })
|
|
205
|
+
* });
|
|
206
|
+
* const data = await response.json();
|
|
207
|
+
* ```
|
|
208
|
+
*/
|
|
209
|
+
function createApiFetch(context) {
|
|
210
|
+
return (path, options = {}) => {
|
|
211
|
+
const url = `${context.apiBaseUrl}${path}`;
|
|
212
|
+
return fetch(url, {
|
|
213
|
+
...options,
|
|
214
|
+
credentials: 'include',
|
|
215
|
+
headers: {
|
|
216
|
+
'Content-Type': 'application/json',
|
|
217
|
+
...options.headers,
|
|
218
|
+
},
|
|
219
|
+
});
|
|
220
|
+
};
|
|
221
|
+
}
|
|
222
|
+
/**
|
|
223
|
+
* Create a configured fetch function for calling your extension's BFF.
|
|
224
|
+
*
|
|
225
|
+
* This returns a fetch wrapper that forwards credentials to your BFF,
|
|
226
|
+
* allowing it to make authenticated calls to the ManageSpace API.
|
|
227
|
+
*
|
|
228
|
+
* @param context - The extension context from getContext()
|
|
229
|
+
* @returns A fetch function configured for BFF calls, or null if no BFF is configured
|
|
230
|
+
*
|
|
231
|
+
* @example
|
|
232
|
+
* ```typescript
|
|
233
|
+
* import { getContext, createBffFetch } from '@managespace/sdk/extensions';
|
|
234
|
+
*
|
|
235
|
+
* const context = await getContext();
|
|
236
|
+
* const bffFetch = createBffFetch(context);
|
|
237
|
+
*
|
|
238
|
+
* if (bffFetch) {
|
|
239
|
+
* const response = await bffFetch('/api/enriched-customers');
|
|
240
|
+
* const data = await response.json();
|
|
241
|
+
* }
|
|
242
|
+
* ```
|
|
243
|
+
*/
|
|
244
|
+
function createBffFetch(context) {
|
|
245
|
+
if (!context.bffUrl) {
|
|
246
|
+
return null;
|
|
247
|
+
}
|
|
248
|
+
return (path, options = {}) => {
|
|
249
|
+
const url = `${context.bffUrl}${path}`;
|
|
250
|
+
return fetch(url, {
|
|
251
|
+
...options,
|
|
252
|
+
credentials: 'include',
|
|
253
|
+
headers: {
|
|
254
|
+
'Content-Type': 'application/json',
|
|
255
|
+
...options.headers,
|
|
256
|
+
},
|
|
257
|
+
});
|
|
258
|
+
};
|
|
259
|
+
}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* ManageSpace Extension SDK
|
|
3
|
+
*
|
|
4
|
+
* This module provides utilities for building extensions that run within
|
|
5
|
+
* the ManageSpace platform. Extensions are loaded in iframes and communicate
|
|
6
|
+
* with the host application via postMessage.
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* ```typescript
|
|
10
|
+
* import {
|
|
11
|
+
* getContext,
|
|
12
|
+
* signalReady,
|
|
13
|
+
* navigate,
|
|
14
|
+
* showToast,
|
|
15
|
+
* createApiFetch,
|
|
16
|
+
* } from '@managespace/sdk/extensions';
|
|
17
|
+
*
|
|
18
|
+
* // Signal ready and get context
|
|
19
|
+
* signalReady();
|
|
20
|
+
* const context = await getContext();
|
|
21
|
+
*
|
|
22
|
+
* // Create API client
|
|
23
|
+
* const apiFetch = createApiFetch(context);
|
|
24
|
+
*
|
|
25
|
+
* // Fetch data
|
|
26
|
+
* const response = await apiFetch('/api/crm/customers/queries', {
|
|
27
|
+
* method: 'POST',
|
|
28
|
+
* body: JSON.stringify({ pageOptions: { offset: 0, limit: 20 } })
|
|
29
|
+
* });
|
|
30
|
+
*
|
|
31
|
+
* // Navigate and show feedback
|
|
32
|
+
* navigate('/customer/123');
|
|
33
|
+
* showToast('Customer loaded');
|
|
34
|
+
* ```
|
|
35
|
+
*
|
|
36
|
+
* @module extensions
|
|
37
|
+
*/
|
|
38
|
+
export * from './types';
|
|
39
|
+
export * from './host-bridge';
|
|
40
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/extensions/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAEH,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC"}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* ManageSpace Extension SDK
|
|
4
|
+
*
|
|
5
|
+
* This module provides utilities for building extensions that run within
|
|
6
|
+
* the ManageSpace platform. Extensions are loaded in iframes and communicate
|
|
7
|
+
* with the host application via postMessage.
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```typescript
|
|
11
|
+
* import {
|
|
12
|
+
* getContext,
|
|
13
|
+
* signalReady,
|
|
14
|
+
* navigate,
|
|
15
|
+
* showToast,
|
|
16
|
+
* createApiFetch,
|
|
17
|
+
* } from '@managespace/sdk/extensions';
|
|
18
|
+
*
|
|
19
|
+
* // Signal ready and get context
|
|
20
|
+
* signalReady();
|
|
21
|
+
* const context = await getContext();
|
|
22
|
+
*
|
|
23
|
+
* // Create API client
|
|
24
|
+
* const apiFetch = createApiFetch(context);
|
|
25
|
+
*
|
|
26
|
+
* // Fetch data
|
|
27
|
+
* const response = await apiFetch('/api/crm/customers/queries', {
|
|
28
|
+
* method: 'POST',
|
|
29
|
+
* body: JSON.stringify({ pageOptions: { offset: 0, limit: 20 } })
|
|
30
|
+
* });
|
|
31
|
+
*
|
|
32
|
+
* // Navigate and show feedback
|
|
33
|
+
* navigate('/customer/123');
|
|
34
|
+
* showToast('Customer loaded');
|
|
35
|
+
* ```
|
|
36
|
+
*
|
|
37
|
+
* @module extensions
|
|
38
|
+
*/
|
|
39
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
40
|
+
if (k2 === undefined) k2 = k;
|
|
41
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
42
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
43
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
44
|
+
}
|
|
45
|
+
Object.defineProperty(o, k2, desc);
|
|
46
|
+
}) : (function(o, m, k, k2) {
|
|
47
|
+
if (k2 === undefined) k2 = k;
|
|
48
|
+
o[k2] = m[k];
|
|
49
|
+
}));
|
|
50
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
51
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
52
|
+
};
|
|
53
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
54
|
+
__exportStar(require("./types"), exports);
|
|
55
|
+
__exportStar(require("./host-bridge"), exports);
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Extension context injected by the ManageSpace host application.
|
|
3
|
+
* This is received via postMessage when the extension loads.
|
|
4
|
+
*/
|
|
5
|
+
export interface ExtensionContext {
|
|
6
|
+
/**
|
|
7
|
+
* Authentication token for API calls.
|
|
8
|
+
* Note: When calling the ManageSpace API, use `credentials: 'include'` instead
|
|
9
|
+
* of passing this token directly. The token is provided for BFF authentication.
|
|
10
|
+
*/
|
|
11
|
+
token: string;
|
|
12
|
+
/** The organisation ID the user is currently viewing */
|
|
13
|
+
orgId: string;
|
|
14
|
+
/** The authenticated user's ID */
|
|
15
|
+
userId: string;
|
|
16
|
+
/** The site ID the user is currently viewing (may be empty if at org level) */
|
|
17
|
+
siteId: string;
|
|
18
|
+
/** List of permission strings the user has */
|
|
19
|
+
permissions: Array<string>;
|
|
20
|
+
/**
|
|
21
|
+
* Base URL for ManageSpace API calls.
|
|
22
|
+
* Example: "http://localhost:5173/gateway"
|
|
23
|
+
*/
|
|
24
|
+
apiBaseUrl: string;
|
|
25
|
+
/**
|
|
26
|
+
* BFF URL from the extension manifest, if configured.
|
|
27
|
+
* Use this to call your extension's backend.
|
|
28
|
+
*/
|
|
29
|
+
bffUrl?: string;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Messages sent from the ManageSpace host to the extension.
|
|
33
|
+
*/
|
|
34
|
+
export type HostMessage = {
|
|
35
|
+
type: 'CONTEXT_INIT';
|
|
36
|
+
payload: ExtensionContext;
|
|
37
|
+
} | {
|
|
38
|
+
type: 'ENTITY_EVENT';
|
|
39
|
+
payload: {
|
|
40
|
+
entityType: string;
|
|
41
|
+
entityId: string;
|
|
42
|
+
action: 'created' | 'updated' | 'deleted';
|
|
43
|
+
};
|
|
44
|
+
};
|
|
45
|
+
/**
|
|
46
|
+
* Messages sent from the extension to the ManageSpace host.
|
|
47
|
+
*/
|
|
48
|
+
export type ExtensionMessage = {
|
|
49
|
+
type: 'NAVIGATE';
|
|
50
|
+
payload: {
|
|
51
|
+
path: string;
|
|
52
|
+
};
|
|
53
|
+
} | {
|
|
54
|
+
type: 'SHOW_TOAST';
|
|
55
|
+
payload: {
|
|
56
|
+
message: string;
|
|
57
|
+
variant: 'success' | 'error';
|
|
58
|
+
};
|
|
59
|
+
} | {
|
|
60
|
+
type: 'READY';
|
|
61
|
+
};
|
|
62
|
+
/**
|
|
63
|
+
* Extension manifest format.
|
|
64
|
+
* This file (manifest.json) must be included in your extension bundle.
|
|
65
|
+
*/
|
|
66
|
+
export interface ExtensionManifest {
|
|
67
|
+
/** Display name of the extension */
|
|
68
|
+
name: string;
|
|
69
|
+
/** Semantic version (e.g., "1.0.0") */
|
|
70
|
+
version: string;
|
|
71
|
+
/** Author or company name */
|
|
72
|
+
author: string;
|
|
73
|
+
/** Short description of what the extension does */
|
|
74
|
+
description?: string;
|
|
75
|
+
/** Label shown in the navigation menu */
|
|
76
|
+
navLabel: string;
|
|
77
|
+
/**
|
|
78
|
+
* Icon name for the navigation menu.
|
|
79
|
+
* Use Lucide icon names (e.g., "Users", "Settings", "BarChart")
|
|
80
|
+
*/
|
|
81
|
+
navIcon: string;
|
|
82
|
+
/**
|
|
83
|
+
* Route path for the extension (e.g., "/extensions/my-extension").
|
|
84
|
+
* Must start with "/extensions/"
|
|
85
|
+
*/
|
|
86
|
+
navRoute: string;
|
|
87
|
+
/** Entry point HTML file (usually "index.html") */
|
|
88
|
+
entryPoint: string;
|
|
89
|
+
/** Optional BFF (Backend for Frontend) configuration */
|
|
90
|
+
bff?: {
|
|
91
|
+
/** URL of the BFF server */
|
|
92
|
+
url: string;
|
|
93
|
+
};
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* Entity event payload received when ManageSpace entities change.
|
|
97
|
+
* Subscribe to these events to react to changes in the host application.
|
|
98
|
+
*/
|
|
99
|
+
export interface EntityEvent {
|
|
100
|
+
/** Type of entity (e.g., "customer", "asset", "subscription") */
|
|
101
|
+
entityType: string;
|
|
102
|
+
/** ID of the affected entity */
|
|
103
|
+
entityId: string;
|
|
104
|
+
/** What happened to the entity */
|
|
105
|
+
action: 'created' | 'updated' | 'deleted';
|
|
106
|
+
}
|
|
107
|
+
/**
|
|
108
|
+
* Callback type for entity event handlers.
|
|
109
|
+
*/
|
|
110
|
+
export type EntityEventHandler = (event: EntityEvent) => void;
|
|
111
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/extensions/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,wDAAwD;IACxD,KAAK,EAAE,MAAM,CAAC;IAEd,kCAAkC;IAClC,MAAM,EAAE,MAAM,CAAC;IAEf,+EAA+E;IAC/E,MAAM,EAAE,MAAM,CAAC;IAEf,8CAA8C;IAC9C,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GACjB;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,OAAO,EAAE,gBAAgB,CAAA;CAAE,GACnD;IACI,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE;QACL,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;KAC7C,CAAC;CACL,CAAC;AAER;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACtB;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GAC/C;IACI,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,SAAS,GAAG,OAAO,CAAA;KAAE,CAAC;CAC9D,GACD;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,CAAC;AAExB;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,oCAAoC;IACpC,IAAI,EAAE,MAAM,CAAC;IAEb,uCAAuC;IACvC,OAAO,EAAE,MAAM,CAAC;IAEhB,6BAA6B;IAC7B,MAAM,EAAE,MAAM,CAAC;IAEf,mDAAmD;IACnD,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,yCAAyC;IACzC,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAC;IAEnB,wDAAwD;IACxD,GAAG,CAAC,EAAE;QACF,4BAA4B;QAC5B,GAAG,EAAE,MAAM,CAAC;KACf,CAAC;CACL;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IACxB,iEAAiE;IACjE,UAAU,EAAE,MAAM,CAAC;IAEnB,gCAAgC;IAChC,QAAQ,EAAE,MAAM,CAAC;IAEjB,kCAAkC;IAClC,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;CAC7C;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,CAAC"}
|