@allma/core-sdk 1.0.6 → 1.0.8
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/config-validator.d.ts +26 -0
- package/dist/config-validator.d.ts.map +1 -0
- package/dist/config-validator.js +111 -0
- package/dist/config-validator.js.map +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -0
- package/dist/index.js.map +1 -1
- package/dist/s3Utils.d.ts +3 -2
- package/dist/s3Utils.d.ts.map +1 -1
- package/dist/s3Utils.js +23 -11
- package/dist/s3Utils.js.map +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { AllmaExportFormat } from '@allma/core-types';
|
|
2
|
+
/**
|
|
3
|
+
* The structured result of a validation operation.
|
|
4
|
+
*/
|
|
5
|
+
export type ValidationResult = {
|
|
6
|
+
success: true;
|
|
7
|
+
data: AllmaExportFormat;
|
|
8
|
+
} | {
|
|
9
|
+
success: false;
|
|
10
|
+
error: {
|
|
11
|
+
formErrors: string[];
|
|
12
|
+
fieldErrors: Record<string, string[]>;
|
|
13
|
+
};
|
|
14
|
+
};
|
|
15
|
+
/**
|
|
16
|
+
* Validates the raw data for an import operation with detailed, item-by-item checks.
|
|
17
|
+
* This function is centralized in the SDK to be reusable by both the CDK pre-validation
|
|
18
|
+
* step and the backend importer services. It performs in-memory hydration of flows
|
|
19
|
+
* using step definitions from the same import bundle before validation.
|
|
20
|
+
*
|
|
21
|
+
* @param rawData The raw, unparsed data from the import request.
|
|
22
|
+
* @param sourceFileName Optional name of the source file for more descriptive error messages.
|
|
23
|
+
* @returns A discriminated union indicating success with parsed data, or failure with structured errors.
|
|
24
|
+
*/
|
|
25
|
+
export declare function validateAllmaConfig(rawData: unknown, sourceFileName?: string): ValidationResult;
|
|
26
|
+
//# sourceMappingURL=config-validator.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"config-validator.d.ts","sourceRoot":"","sources":["../src/config-validator.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EAWlB,MAAM,mBAAmB,CAAC;AAI3B;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB;IAAE,OAAO,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,iBAAiB,CAAA;CAAE,GAC1C;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE;QAAE,UAAU,EAAE,MAAM,EAAE,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;KAAE,CAAA;CAAE,CAAC;AAE/F;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,gBAAgB,CA4G/F"}
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
import { StepDefinitionSchema, FlowDefinitionSchema, PromptTemplateSchema, McpConnectionSchema, AgentSchema, } from '@allma/core-types';
|
|
2
|
+
import { deepMerge } from './objectUtils.js';
|
|
3
|
+
import { z } from 'zod';
|
|
4
|
+
/**
|
|
5
|
+
* Validates the raw data for an import operation with detailed, item-by-item checks.
|
|
6
|
+
* This function is centralized in the SDK to be reusable by both the CDK pre-validation
|
|
7
|
+
* step and the backend importer services. It performs in-memory hydration of flows
|
|
8
|
+
* using step definitions from the same import bundle before validation.
|
|
9
|
+
*
|
|
10
|
+
* @param rawData The raw, unparsed data from the import request.
|
|
11
|
+
* @param sourceFileName Optional name of the source file for more descriptive error messages.
|
|
12
|
+
* @returns A discriminated union indicating success with parsed data, or failure with structured errors.
|
|
13
|
+
*/
|
|
14
|
+
export function validateAllmaConfig(rawData, sourceFileName) {
|
|
15
|
+
const filePrefix = sourceFileName ? `[${sourceFileName}] ` : '';
|
|
16
|
+
// Define a simple schema for top-level validation of the export format structure.
|
|
17
|
+
const topLevelSchema = z.object({
|
|
18
|
+
formatVersion: z.literal('1.0'),
|
|
19
|
+
exportedAt: z.string().datetime(),
|
|
20
|
+
});
|
|
21
|
+
const topLevelValidation = topLevelSchema.safeParse(rawData);
|
|
22
|
+
if (!topLevelValidation.success) {
|
|
23
|
+
return { success: false, error: topLevelValidation.error.flatten() };
|
|
24
|
+
}
|
|
25
|
+
const data = rawData;
|
|
26
|
+
const fieldErrors = {};
|
|
27
|
+
const formErrors = [];
|
|
28
|
+
// Helper to process Zod issues and build precise error paths for better feedback.
|
|
29
|
+
const processIssues = (issues, arrayName, itemIndex, itemIdentifier) => {
|
|
30
|
+
for (const issue of issues) {
|
|
31
|
+
if (issue.path.length === 0) {
|
|
32
|
+
formErrors.push(`${filePrefix}${itemIdentifier}: ${issue.message}`);
|
|
33
|
+
}
|
|
34
|
+
else {
|
|
35
|
+
const key = `${arrayName}[${itemIndex}].${issue.path.join('.')}`;
|
|
36
|
+
fieldErrors[key] = (fieldErrors[key] || []).concat(`${filePrefix}${issue.message}`);
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
};
|
|
40
|
+
// Create a map of step definitions from this import file for in-memory hydration.
|
|
41
|
+
const bundledStepMap = new Map((data.stepDefinitions || []).map(s => [s.id, s]));
|
|
42
|
+
// Validate each flow individually
|
|
43
|
+
if (data.flows && Array.isArray(data.flows)) {
|
|
44
|
+
data.flows.forEach((flow, index) => {
|
|
45
|
+
// Hydrate the flow in-memory before validation by merging referenced step definitions.
|
|
46
|
+
const hydratedFlow = JSON.parse(JSON.stringify(flow));
|
|
47
|
+
if (hydratedFlow.steps) {
|
|
48
|
+
for (const [stepId, stepInstance] of Object.entries(hydratedFlow.steps)) {
|
|
49
|
+
if (stepInstance.stepDefinitionId) {
|
|
50
|
+
const baseDef = bundledStepMap.get(stepInstance.stepDefinitionId);
|
|
51
|
+
if (baseDef) {
|
|
52
|
+
const { id, name, version, createdAt, updatedAt, ...defProps } = baseDef;
|
|
53
|
+
const merged = deepMerge(defProps, stepInstance);
|
|
54
|
+
hydratedFlow.steps[stepId] = merged;
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
const flowValidation = FlowDefinitionSchema.safeParse(hydratedFlow);
|
|
60
|
+
if (!flowValidation.success) {
|
|
61
|
+
const flowIdentifier = flow?.id ? `Flow '${flow.id}' (v${flow.version})` : `Flow at index ${index}`;
|
|
62
|
+
processIssues(flowValidation.error.issues, 'flows', index, flowIdentifier);
|
|
63
|
+
}
|
|
64
|
+
});
|
|
65
|
+
}
|
|
66
|
+
// Validate each step definition individually
|
|
67
|
+
if (data.stepDefinitions && Array.isArray(data.stepDefinitions)) {
|
|
68
|
+
data.stepDefinitions.forEach((step, index) => {
|
|
69
|
+
const stepValidation = StepDefinitionSchema.safeParse(step);
|
|
70
|
+
if (!stepValidation.success) {
|
|
71
|
+
const stepIdentifier = step?.id ? `Step Definition '${step.id}'` : `Step Definition at index ${index}`;
|
|
72
|
+
processIssues(stepValidation.error.issues, 'stepDefinitions', index, stepIdentifier);
|
|
73
|
+
}
|
|
74
|
+
});
|
|
75
|
+
}
|
|
76
|
+
// Validate each prompt template individually
|
|
77
|
+
if (data.promptTemplates && Array.isArray(data.promptTemplates)) {
|
|
78
|
+
data.promptTemplates.forEach((prompt, index) => {
|
|
79
|
+
const promptValidation = PromptTemplateSchema.safeParse(prompt);
|
|
80
|
+
if (!promptValidation.success) {
|
|
81
|
+
const promptIdentifier = prompt?.id ? `Prompt '${prompt.id}' (v${prompt.version})` : `Prompt at index ${index}`;
|
|
82
|
+
processIssues(promptValidation.error.issues, 'promptTemplates', index, promptIdentifier);
|
|
83
|
+
}
|
|
84
|
+
});
|
|
85
|
+
}
|
|
86
|
+
// Validate each MCP connection individually
|
|
87
|
+
if (data.mcpConnections && Array.isArray(data.mcpConnections)) {
|
|
88
|
+
data.mcpConnections.forEach((conn, index) => {
|
|
89
|
+
const connValidation = McpConnectionSchema.safeParse(conn);
|
|
90
|
+
if (!connValidation.success) {
|
|
91
|
+
const connIdentifier = conn?.id ? `MCP Connection '${conn.id}'` : `MCP Connection at index ${index}`;
|
|
92
|
+
processIssues(connValidation.error.issues, 'mcpConnections', index, connIdentifier);
|
|
93
|
+
}
|
|
94
|
+
});
|
|
95
|
+
}
|
|
96
|
+
// Validate each agent individually
|
|
97
|
+
if (data.agents && Array.isArray(data.agents)) {
|
|
98
|
+
data.agents.forEach((agent, index) => {
|
|
99
|
+
const agentValidation = AgentSchema.safeParse(agent);
|
|
100
|
+
if (!agentValidation.success) {
|
|
101
|
+
const agentIdentifier = agent?.id ? `Agent '${agent.id}'` : `Agent at index ${index}`;
|
|
102
|
+
processIssues(agentValidation.error.issues, 'agents', index, agentIdentifier);
|
|
103
|
+
}
|
|
104
|
+
});
|
|
105
|
+
}
|
|
106
|
+
if (formErrors.length > 0 || Object.keys(fieldErrors).length > 0) {
|
|
107
|
+
return { success: false, error: { formErrors, fieldErrors } };
|
|
108
|
+
}
|
|
109
|
+
return { success: true, data: data };
|
|
110
|
+
}
|
|
111
|
+
//# sourceMappingURL=config-validator.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"config-validator.js","sourceRoot":"","sources":["../src/config-validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,oBAAoB,EACpB,oBAAoB,EACpB,oBAAoB,EACpB,mBAAmB,EACnB,WAAW,GAMZ,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AASxB;;;;;;;;;GASG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAgB,EAAE,cAAuB;IAC3E,MAAM,UAAU,GAAG,cAAc,CAAC,CAAC,CAAC,IAAI,cAAc,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IAEhE,kFAAkF;IAClF,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;QAC5B,aAAa,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;QAC/B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KACpC,CAAC,CAAC;IACH,MAAM,kBAAkB,GAAG,cAAc,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAE7D,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,CAAC;QAChC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,kBAAkB,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;IACvE,CAAC;IAED,MAAM,IAAI,GAAG,OAAqC,CAAC;IACnD,MAAM,WAAW,GAA6B,EAAE,CAAC;IACjD,MAAM,UAAU,GAAa,EAAE,CAAC;IAEhC,kFAAkF;IAClF,MAAM,aAAa,GAAG,CAAC,MAAoB,EAAE,SAAwF,EAAE,SAAiB,EAAE,cAAsB,EAAE,EAAE;QAClL,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC5B,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,GAAG,cAAc,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YACtE,CAAC;iBAAM,CAAC;gBACN,MAAM,GAAG,GAAG,GAAG,SAAS,IAAI,SAAS,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBACjE,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,UAAU,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YACtF,CAAC;QACH,CAAC;IACH,CAAC,CAAC;IAEF,kFAAkF;IAClF,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,eAAe,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAEjF,kCAAkC;IAClC,IAAI,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YACjC,uFAAuF;YACvF,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;YACtD,IAAI,YAAY,CAAC,KAAK,EAAE,CAAC;gBACrB,KAAK,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,KAA4B,CAAC,EAAE,CAAC;oBAC7F,IAAI,YAAY,CAAC,gBAAgB,EAAE,CAAC;wBAChC,MAAM,OAAO,GAAG,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;wBAClE,IAAI,OAAO,EAAE,CAAC;4BACV,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,QAAQ,EAAE,GAAG,OAAc,CAAC;4BAChG,MAAM,MAAM,GAAG,SAAS,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;4BACjC,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;wBACxC,CAAC;oBACL,CAAC;gBACL,CAAC;YACL,CAAC;YAED,MAAM,cAAc,GAAG,oBAAoB,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;YACpE,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;gBAC5B,MAAM,cAAc,GAAI,IAAY,EAAE,EAAE,CAAC,CAAC,CAAC,SAAU,IAAY,CAAC,EAAE,OAAQ,IAAY,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,iBAAiB,KAAK,EAAE,CAAC;gBAC/H,aAAa,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;YAC7E,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,6CAA6C;IAC7C,IAAI,IAAI,CAAC,eAAe,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;QAChE,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YAC3C,MAAM,cAAc,GAAG,oBAAoB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAC5D,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;gBAC5B,MAAM,cAAc,GAAI,IAAY,EAAE,EAAE,CAAC,CAAC,CAAC,oBAAqB,IAAY,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,4BAA4B,KAAK,EAAE,CAAC;gBACzH,aAAa,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,EAAE,iBAAiB,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;YACvF,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,6CAA6C;IAC7C,IAAI,IAAI,CAAC,eAAe,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;QAChE,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;YAC7C,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YAChE,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC;gBAC9B,MAAM,gBAAgB,GAAI,MAAc,EAAE,EAAE,CAAC,CAAC,CAAC,WAAY,MAAc,CAAC,EAAE,OAAQ,MAAc,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,mBAAmB,KAAK,EAAE,CAAC;gBAC3I,aAAa,CAAC,gBAAgB,CAAC,KAAK,CAAC,MAAM,EAAE,iBAAiB,EAAE,KAAK,EAAE,gBAAgB,CAAC,CAAC;YAC3F,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,4CAA4C;IAC5C,IAAI,IAAI,CAAC,cAAc,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC;QAC9D,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YAC1C,MAAM,cAAc,GAAG,mBAAmB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAC3D,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;gBAC5B,MAAM,cAAc,GAAI,IAAY,EAAE,EAAE,CAAC,CAAC,CAAC,mBAAoB,IAAY,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,2BAA2B,KAAK,EAAE,CAAC;gBACvH,aAAa,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;YACtF,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,mCAAmC;IACnC,IAAI,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5C,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACjC,MAAM,eAAe,GAAG,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YACrD,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC;gBAC3B,MAAM,eAAe,GAAI,KAAa,EAAE,EAAE,CAAC,CAAC,CAAC,UAAW,KAAa,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,kBAAkB,KAAK,EAAE,CAAC;gBACxG,aAAa,CAAC,eAAe,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,eAAe,CAAC,CAAC;YAClF,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAED,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACjE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,WAAW,EAAE,EAAE,CAAC;IAChE,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAyB,EAAE,CAAC;AAC5D,CAAC"}
|
package/dist/index.d.ts
CHANGED
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC"}
|
package/dist/index.js
CHANGED
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC"}
|
package/dist/s3Utils.d.ts
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import type { S3OutputPointerWrapper, S3Pointer } from '@allma/core-types';
|
|
2
2
|
/**
|
|
3
3
|
* Fetches the actual data from an S3 pointer.
|
|
4
|
-
*
|
|
5
|
-
* returns
|
|
4
|
+
* It inspects the S3 object's Content-Type to determine how to process the data.
|
|
5
|
+
* - For text-based content (text/*, application/json), it returns a string or a parsed JSON object.
|
|
6
|
+
* - For binary content, it returns a Base64 encoded string.
|
|
6
7
|
*/
|
|
7
8
|
export declare function resolveS3Pointer(s3Pointer: S3Pointer, correlationId?: string): Promise<any>;
|
|
8
9
|
/**
|
package/dist/s3Utils.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"s3Utils.d.ts","sourceRoot":"","sources":["../src/s3Utils.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAa3E
|
|
1
|
+
{"version":3,"file":"s3Utils.d.ts","sourceRoot":"","sources":["../src/s3Utils.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAa3E;;;;;GAKG;AACH,wBAAsB,gBAAgB,CAAC,SAAS,EAAE,SAAS,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAoCjG;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,cAAc,CAChC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,SAAS,EACxC,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,aAAa,EAAE,MAAM,EACrB,cAAc,GAAE,MAAwC,GACzD,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,sBAAsB,GAAG,SAAS,CAAC,CAgCnE;AAGD;;;;;;;;;;GAUG;AACH,wBAAsB,6BAA6B,CAC/C,IAAI,EAAE,GAAG,EACT,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,aAAa,EAAE,MAAM,EACrB,cAAc,EAAE,MAAM,GACvB,OAAO,CAAC,GAAG,CAAC,CAqFd"}
|
package/dist/s3Utils.js
CHANGED
|
@@ -9,8 +9,9 @@ const PAYLOAD_OFFLOAD_THRESHOLD_BYTES = process.env[ENV_VAR_NAMES.MAX_CONTEXT_DA
|
|
|
9
9
|
: MAX_CONTEXT_DATA_SIZE_BYTES_DEFAULT;
|
|
10
10
|
/**
|
|
11
11
|
* Fetches the actual data from an S3 pointer.
|
|
12
|
-
*
|
|
13
|
-
* returns
|
|
12
|
+
* It inspects the S3 object's Content-Type to determine how to process the data.
|
|
13
|
+
* - For text-based content (text/*, application/json), it returns a string or a parsed JSON object.
|
|
14
|
+
* - For binary content, it returns a Base64 encoded string.
|
|
14
15
|
*/
|
|
15
16
|
export async function resolveS3Pointer(s3Pointer, correlationId) {
|
|
16
17
|
log_info('Resolving S3 data pointer', { s3Pointer }, correlationId);
|
|
@@ -19,17 +20,28 @@ export async function resolveS3Pointer(s3Pointer, correlationId) {
|
|
|
19
20
|
Bucket: s3Pointer.bucket,
|
|
20
21
|
Key: s3Pointer.key,
|
|
21
22
|
});
|
|
22
|
-
const { Body } = await s3Client.send(command);
|
|
23
|
+
const { Body, ContentType } = await s3Client.send(command);
|
|
23
24
|
if (Body) {
|
|
24
|
-
const
|
|
25
|
-
|
|
26
|
-
|
|
25
|
+
const contentType = ContentType || 'application/octet-stream';
|
|
26
|
+
const isTextContent = contentType.startsWith('text/') || contentType.includes('json') || contentType.includes('xml');
|
|
27
|
+
if (isTextContent) {
|
|
28
|
+
const content = await Body.transformToString();
|
|
29
|
+
try {
|
|
30
|
+
// This handles cases where the S3 object is a JSON document
|
|
31
|
+
// (e.g., a large context object, or an offloaded JSON API response)
|
|
32
|
+
return JSON.parse(content);
|
|
33
|
+
}
|
|
34
|
+
catch (jsonError) {
|
|
35
|
+
// This handles plain text files
|
|
36
|
+
log_debug('S3 content is text-based but not JSON, returning as raw string.', { key: s3Pointer.key, contentType }, correlationId);
|
|
37
|
+
return content;
|
|
38
|
+
}
|
|
27
39
|
}
|
|
28
|
-
|
|
29
|
-
//
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
return
|
|
40
|
+
else {
|
|
41
|
+
// This handles binary files (images, PDFs, Excel files, etc.)
|
|
42
|
+
log_debug('S3 content is binary, returning as base64 encoded string.', { key: s3Pointer.key, contentType }, correlationId);
|
|
43
|
+
const byteArray = await Body.transformToByteArray();
|
|
44
|
+
return Buffer.from(byteArray).toString('base64');
|
|
33
45
|
}
|
|
34
46
|
}
|
|
35
47
|
throw new Error('S3 object body for data pointer is empty.');
|
package/dist/s3Utils.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"s3Utils.js","sourceRoot":"","sources":["../src/s3Utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAElF,OAAO,EAAE,aAAa,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AAC5E,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,EAAE,CAAC,CAAC;AAElC,MAAM,mCAAmC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,eAAe;AACtE,MAAM,+BAA+B,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,2BAA2B,CAAC;IAC1F,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,2BAA2B,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC;IAC5E,CAAC,CAAC,mCAAmC,CAAC;AAG1C
|
|
1
|
+
{"version":3,"file":"s3Utils.js","sourceRoot":"","sources":["../src/s3Utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAElF,OAAO,EAAE,aAAa,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AAC5E,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,EAAE,CAAC,CAAC;AAElC,MAAM,mCAAmC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,eAAe;AACtE,MAAM,+BAA+B,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,2BAA2B,CAAC;IAC1F,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,2BAA2B,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC;IAC5E,CAAC,CAAC,mCAAmC,CAAC;AAG1C;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,SAAoB,EAAE,aAAsB;IAC/E,QAAQ,CAAC,2BAA2B,EAAE,EAAE,SAAS,EAAE,EAAE,aAAa,CAAC,CAAC;IACpE,IAAI,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,gBAAgB,CAAC;YACjC,MAAM,EAAE,SAAS,CAAC,MAAM;YACxB,GAAG,EAAE,SAAS,CAAC,GAAG;SACrB,CAAC,CAAC;QACH,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAE3D,IAAI,IAAI,EAAE,CAAC;YACP,MAAM,WAAW,GAAG,WAAW,IAAI,0BAA0B,CAAC;YAC9D,MAAM,aAAa,GAAG,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAErH,IAAI,aAAa,EAAE,CAAC;gBAChB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBAC/C,IAAI,CAAC;oBACD,4DAA4D;oBAC5D,oEAAoE;oBACpE,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAC/B,CAAC;gBAAC,OAAO,SAAS,EAAE,CAAC;oBACjB,gCAAgC;oBAChC,SAAS,CAAC,iEAAiE,EAAE,EAAE,GAAG,EAAE,SAAS,CAAC,GAAG,EAAE,WAAW,EAAE,EAAE,aAAa,CAAC,CAAC;oBACjI,OAAO,OAAO,CAAC;gBACnB,CAAC;YACL,CAAC;iBAAM,CAAC;gBACJ,8DAA8D;gBAC9D,SAAS,CAAC,2DAA2D,EAAE,EAAE,GAAG,EAAE,SAAS,CAAC,GAAG,EAAE,WAAW,EAAE,EAAE,aAAa,CAAC,CAAC;gBAC3H,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;gBACpD,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACrD,CAAC;QACL,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;IACjE,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QACd,SAAS,CAAC,+CAA+C,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,aAAa,CAAC,CAAC;QAC3G,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;AACL,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAChC,OAAwC,EACxC,UAAkB,EAClB,SAAiB,EACjB,aAAqB,EACrB,iBAAyB,+BAA+B;IAGxD,IAAI,CAAC,OAAO;QAAE,OAAO,SAAS,CAAC;IAE/B,IAAI,CAAC;QACD,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAC9C,MAAM,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QAE9D,SAAS,CAAC,sBAAsB,UAAU,IAAI,SAAS,KAAK,EAAE,EAAE,cAAc,EAAE,EAAE,aAAa,CAAC,CAAC;QAEjG,IAAI,WAAW,GAAG,cAAc,EAAE,CAAC;YAC/B,MAAM,KAAK,GAAG,GAAG,SAAS,IAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,OAAO,CAAC;YAC9D,QAAQ,CAAC,qBAAqB,WAAW,4BAA4B,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE,aAAa,CAAC,CAAC;YAEjH,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,gBAAgB,CAAC;gBACrC,MAAM,EAAE,UAAU;gBAClB,GAAG,EAAE,KAAK;gBACV,IAAI,EAAE,aAAa;gBACnB,WAAW,EAAE,kBAAkB;aAClC,CAAC,CAAC,CAAC;YAEJ,MAAM,SAAS,GAAc,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;YAChE,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,CAAC,CAAC,qBAAqB;QACnE,CAAC;QAED,wCAAwC;QACxC,OAAO,OAAO,CAAC;IAEnB,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QACd,SAAS,CAAC,mDAAmD,SAAS,GAAG,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,aAAa,CAAC,CAAC;QAChH,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;AACL,CAAC;AAGD;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,6BAA6B,CAC/C,IAAS,EACT,UAAkB,EAClB,SAAiB,EACjB,aAAqB,EACrB,cAAsB;IAEtB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,8CAA8C;QAC9C,OAAO,OAAO,CAAC,GAAG,CACd,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CACrB,6BAA6B,CAAC,IAAI,EAAE,UAAU,EAAE,GAAG,SAAS,IAAI,KAAK,EAAE,EAAE,aAAa,EAAE,cAAc,CAAC,CAC1G,CACJ,CAAC;IACN,CAAC;IAED,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACjB,yCAAyC;QACzC,IAAI,wBAAwB,CAAC,IAAI,CAAC,EAAE,CAAC;YACjC,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,MAAM,SAAS,GAAwB,EAAE,CAAC;QAC1C,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACrB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;gBAClD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;gBAExB,IAAI,CAAC;oBACD,wDAAwD;oBACxD,sFAAsF;oBACtF,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;wBACtB,SAAS;oBACb,CAAC;oBAED,sCAAsC;oBACtC,MAAM,WAAW,GAAG,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;oBAChF,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;oBAE1D,IAAI,SAAS,GAAG,cAAc,EAAE,CAAC;wBAC7B,8BAA8B;wBAC9B,QAAQ,CAAC,UAAU,GAAG,SAAS,SAAS,eAAe,SAAS,4BAA4B,EAAE,EAAG,EAAE,aAAa,CAAC,CAAC;wBAElH,MAAM,QAAQ,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC;wBAC3C,MAAM,KAAK,GAAG,GAAG,SAAS,IAAI,GAAG,IAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;wBAC7F,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,gBAAgB,CAAC;4BACrC,MAAM,EAAE,UAAU;4BAClB,GAAG,EAAE,KAAK;4BACV,IAAI,EAAE,WAAW;4BACjB,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,kBAAkB;yBAC5D,CAAC,CAAC,CAAC;wBAEJ,MAAM,SAAS,GAAc,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;wBAChE,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,kBAAkB,EAAE,SAAS,EAAE,CAAC;oBAEvD,CAAC;yBAAM,CAAC;wBACJ,kFAAkF;wBAClF,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,6BAA6B,CAChD,KAAK,EACL,UAAU,EACV,GAAG,SAAS,IAAI,GAAG,EAAE,EAAE,6CAA6C;wBACpE,aAAa,EACb,cAAc,CACjB,CAAC;oBACN,CAAC;gBACL,CAAC;gBAAC,OAAM,CAAM,EAAE,CAAC;oBACb,SAAS,CAAC,2BAA2B,GAAG,2DAA2D,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,aAAa,CAAC,CAAC;oBAC1I,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,cAAc,EAAE,yCAAyC,CAAC,CAAC,OAAO,EAAE,EAAC,CAAC;gBAC7F,CAAC;YACL,CAAC;QACL,CAAC;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,mDAAmD;IACnD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC3B,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACnD,IAAI,SAAS,GAAG,cAAc,EAAE,CAAC;YAC5B,QAAQ,CAAC,yBAAyB,SAAS,eAAe,SAAS,4BAA4B,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;YACpH,MAAM,KAAK,GAAG,GAAG,SAAS,IAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,MAAM,CAAC;YAC7D,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,gBAAgB,CAAC;gBACrC,MAAM,EAAE,UAAU;gBAClB,GAAG,EAAE,KAAK;gBACV,IAAI,EAAE,IAAI;gBACV,WAAW,EAAE,YAAY;aAC5B,CAAC,CAAC,CAAC;YACJ,MAAM,SAAS,GAAc,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;YAChE,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,CAAC;QAC9C,CAAC;IACL,CAAC;IAED,OAAO,IAAI,CAAC,CAAC,gCAAgC;AACjD,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@allma/core-sdk",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.8",
|
|
4
4
|
"description": "Core SDK with shared utilities (logging, auth, S3 utils) for building on the Allma serverless AI orchestration platform.",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|