@knowledge-stack/ksapi 1.119.0 → 1.120.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.
Files changed (63) hide show
  1. package/.openapi-generator/FILES +6 -0
  2. package/README.md +5 -2
  3. package/dist/esm/models/CommonFileExclusionReason.d.ts +29 -0
  4. package/dist/esm/models/CommonFileExclusionReason.js +47 -0
  5. package/dist/esm/models/CreateWorkflowDefinitionRequest.d.ts +6 -0
  6. package/dist/esm/models/CreateWorkflowDefinitionRequest.js +6 -0
  7. package/dist/esm/models/ExcludedCommonFile.d.ts +58 -0
  8. package/dist/esm/models/ExcludedCommonFile.js +49 -0
  9. package/dist/esm/models/InputOrigin.d.ts +30 -0
  10. package/dist/esm/models/InputOrigin.js +48 -0
  11. package/dist/esm/models/InputSnapshot.d.ts +7 -0
  12. package/dist/esm/models/InputSnapshot.js +3 -0
  13. package/dist/esm/models/UpdateWorkflowDefinitionRequest.d.ts +6 -0
  14. package/dist/esm/models/UpdateWorkflowDefinitionRequest.js +6 -0
  15. package/dist/esm/models/WorkflowDefinitionResponse.d.ts +6 -0
  16. package/dist/esm/models/WorkflowDefinitionResponse.js +2 -0
  17. package/dist/esm/models/WorkflowRunResponse.d.ts +7 -0
  18. package/dist/esm/models/WorkflowRunResponse.js +3 -0
  19. package/dist/esm/models/WorkflowRunSnapshot.d.ts +7 -0
  20. package/dist/esm/models/WorkflowRunSnapshot.js +3 -0
  21. package/dist/esm/models/index.d.ts +3 -0
  22. package/dist/esm/models/index.js +3 -0
  23. package/dist/models/CommonFileExclusionReason.d.ts +29 -0
  24. package/dist/models/CommonFileExclusionReason.js +55 -0
  25. package/dist/models/CreateWorkflowDefinitionRequest.d.ts +6 -0
  26. package/dist/models/CreateWorkflowDefinitionRequest.js +6 -0
  27. package/dist/models/ExcludedCommonFile.d.ts +58 -0
  28. package/dist/models/ExcludedCommonFile.js +57 -0
  29. package/dist/models/InputOrigin.d.ts +30 -0
  30. package/dist/models/InputOrigin.js +56 -0
  31. package/dist/models/InputSnapshot.d.ts +7 -0
  32. package/dist/models/InputSnapshot.js +3 -0
  33. package/dist/models/UpdateWorkflowDefinitionRequest.d.ts +6 -0
  34. package/dist/models/UpdateWorkflowDefinitionRequest.js +6 -0
  35. package/dist/models/WorkflowDefinitionResponse.d.ts +6 -0
  36. package/dist/models/WorkflowDefinitionResponse.js +2 -0
  37. package/dist/models/WorkflowRunResponse.d.ts +7 -0
  38. package/dist/models/WorkflowRunResponse.js +3 -0
  39. package/dist/models/WorkflowRunSnapshot.d.ts +7 -0
  40. package/dist/models/WorkflowRunSnapshot.js +3 -0
  41. package/dist/models/index.d.ts +3 -0
  42. package/dist/models/index.js +3 -0
  43. package/docs/CommonFileExclusionReason.md +33 -0
  44. package/docs/CreateWorkflowDefinitionRequest.md +2 -0
  45. package/docs/ExcludedCommonFile.md +37 -0
  46. package/docs/FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.md +4 -0
  47. package/docs/InputOrigin.md +33 -0
  48. package/docs/InputSnapshot.md +2 -0
  49. package/docs/UpdateWorkflowDefinitionRequest.md +2 -0
  50. package/docs/WorkflowDefinitionResponse.md +2 -0
  51. package/docs/WorkflowRunResponse.md +2 -0
  52. package/docs/WorkflowRunSnapshot.md +2 -0
  53. package/package.json +1 -1
  54. package/src/models/CommonFileExclusionReason.ts +57 -0
  55. package/src/models/CreateWorkflowDefinitionRequest.ts +12 -0
  56. package/src/models/ExcludedCommonFile.ts +106 -0
  57. package/src/models/InputOrigin.ts +58 -0
  58. package/src/models/InputSnapshot.ts +16 -0
  59. package/src/models/UpdateWorkflowDefinitionRequest.ts +12 -0
  60. package/src/models/WorkflowDefinitionResponse.ts +8 -0
  61. package/src/models/WorkflowRunResponse.ts +15 -0
  62. package/src/models/WorkflowRunSnapshot.ts +15 -0
  63. package/src/models/index.ts +3 -0
@@ -0,0 +1,29 @@
1
+ /**
2
+ * Knowledge Stack API
3
+ * Knowledge Stack backend API for authentication and knowledge management
4
+ *
5
+ * The version of the OpenAPI document: 0.1.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Why a definition common file was left out of a run at Start.
14
+ *
15
+ * Common files resolve resiliently (record-and-continue): an unresolvable
16
+ * one is excluded with one of these reasons rather than failing the run.
17
+ * @export
18
+ */
19
+ export declare const CommonFileExclusionReason: {
20
+ readonly NotFound: "NOT_FOUND";
21
+ readonly NoAccess: "NO_ACCESS";
22
+ readonly Unresolvable: "UNRESOLVABLE";
23
+ };
24
+ export type CommonFileExclusionReason = typeof CommonFileExclusionReason[keyof typeof CommonFileExclusionReason];
25
+ export declare function instanceOfCommonFileExclusionReason(value: any): boolean;
26
+ export declare function CommonFileExclusionReasonFromJSON(json: any): CommonFileExclusionReason;
27
+ export declare function CommonFileExclusionReasonFromJSONTyped(json: any, ignoreDiscriminator: boolean): CommonFileExclusionReason;
28
+ export declare function CommonFileExclusionReasonToJSON(value?: CommonFileExclusionReason | null): any;
29
+ export declare function CommonFileExclusionReasonToJSONTyped(value: any, ignoreDiscriminator: boolean): CommonFileExclusionReason;
@@ -0,0 +1,55 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Knowledge Stack API
6
+ * Knowledge Stack backend API for authentication and knowledge management
7
+ *
8
+ * The version of the OpenAPI document: 0.1.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.CommonFileExclusionReason = void 0;
17
+ exports.instanceOfCommonFileExclusionReason = instanceOfCommonFileExclusionReason;
18
+ exports.CommonFileExclusionReasonFromJSON = CommonFileExclusionReasonFromJSON;
19
+ exports.CommonFileExclusionReasonFromJSONTyped = CommonFileExclusionReasonFromJSONTyped;
20
+ exports.CommonFileExclusionReasonToJSON = CommonFileExclusionReasonToJSON;
21
+ exports.CommonFileExclusionReasonToJSONTyped = CommonFileExclusionReasonToJSONTyped;
22
+ /**
23
+ * Why a definition common file was left out of a run at Start.
24
+ *
25
+ * Common files resolve resiliently (record-and-continue): an unresolvable
26
+ * one is excluded with one of these reasons rather than failing the run.
27
+ * @export
28
+ */
29
+ exports.CommonFileExclusionReason = {
30
+ NotFound: 'NOT_FOUND',
31
+ NoAccess: 'NO_ACCESS',
32
+ Unresolvable: 'UNRESOLVABLE'
33
+ };
34
+ function instanceOfCommonFileExclusionReason(value) {
35
+ for (const key in exports.CommonFileExclusionReason) {
36
+ if (Object.prototype.hasOwnProperty.call(exports.CommonFileExclusionReason, key)) {
37
+ if (exports.CommonFileExclusionReason[key] === value) {
38
+ return true;
39
+ }
40
+ }
41
+ }
42
+ return false;
43
+ }
44
+ function CommonFileExclusionReasonFromJSON(json) {
45
+ return CommonFileExclusionReasonFromJSONTyped(json, false);
46
+ }
47
+ function CommonFileExclusionReasonFromJSONTyped(json, ignoreDiscriminator) {
48
+ return json;
49
+ }
50
+ function CommonFileExclusionReasonToJSON(value) {
51
+ return value;
52
+ }
53
+ function CommonFileExclusionReasonToJSONTyped(value, ignoreDiscriminator) {
54
+ return value;
55
+ }
@@ -61,6 +61,12 @@ export interface CreateWorkflowDefinitionRequest {
61
61
  * @memberof CreateWorkflowDefinitionRequest
62
62
  */
63
63
  isTemplate?: boolean;
64
+ /**
65
+ * Optional path_part ids of common files (DOCUMENT / FOLDER / DATA_SOURCE / API_CONNECTION) attached to every run of this workflow — e.g. an output template. Merged with each run's own inputs at Start. The caller must be able to read each one.
66
+ * @type {Array<string>}
67
+ * @memberof CreateWorkflowDefinitionRequest
68
+ */
69
+ commonFilePathPartIds?: Array<string>;
64
70
  }
65
71
  export declare const CreateWorkflowDefinitionRequestPropertyValidationAttributesMap: {
66
72
  [property: string]: {
@@ -29,6 +29,10 @@ exports.CreateWorkflowDefinitionRequestPropertyValidationAttributesMap = {
29
29
  minimum: 60,
30
30
  exclusiveMinimum: false,
31
31
  },
32
+ commonFilePathPartIds: {
33
+ maxItems: 20,
34
+ uniqueItems: false,
35
+ },
32
36
  };
33
37
  /**
34
38
  * Check if a given object implements the CreateWorkflowDefinitionRequest interface.
@@ -57,6 +61,7 @@ function CreateWorkflowDefinitionRequestFromJSONTyped(json, ignoreDiscriminator)
57
61
  'instructionPathPartId': json['instruction_path_part_id'] == null ? undefined : json['instruction_path_part_id'],
58
62
  'approvalRequired': json['approval_required'],
59
63
  'isTemplate': json['is_template'] == null ? undefined : json['is_template'],
64
+ 'commonFilePathPartIds': json['common_file_path_part_ids'] == null ? undefined : json['common_file_path_part_ids'],
60
65
  };
61
66
  }
62
67
  function CreateWorkflowDefinitionRequestToJSON(json) {
@@ -74,5 +79,6 @@ function CreateWorkflowDefinitionRequestToJSONTyped(value, ignoreDiscriminator =
74
79
  'instruction_path_part_id': value['instructionPathPartId'],
75
80
  'approval_required': value['approvalRequired'],
76
81
  'is_template': value['isTemplate'],
82
+ 'common_file_path_part_ids': value['commonFilePathPartIds'],
77
83
  };
78
84
  }
@@ -0,0 +1,58 @@
1
+ /**
2
+ * Knowledge Stack API
3
+ * Knowledge Stack backend API for authentication and knowledge management
4
+ *
5
+ * The version of the OpenAPI document: 0.1.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { CommonFileExclusionReason } from './CommonFileExclusionReason';
13
+ /**
14
+ * A definition common file that could not be applied to a run at Start.
15
+ *
16
+ * Common files resolve resiliently (record-and-continue): one that is
17
+ * missing/deleted or unreadable by the run-starter is recorded here rather
18
+ * than failing the run, so the exclusion is auditable and visible to the FE.
19
+ * @export
20
+ * @interface ExcludedCommonFile
21
+ */
22
+ export interface ExcludedCommonFile {
23
+ /**
24
+ * The common file's path_part id, as set on the definition
25
+ * @type {string}
26
+ * @memberof ExcludedCommonFile
27
+ */
28
+ pathPartId: string;
29
+ /**
30
+ *
31
+ * @type {CommonFileExclusionReason}
32
+ * @memberof ExcludedCommonFile
33
+ */
34
+ reason: CommonFileExclusionReason;
35
+ }
36
+ export declare const ExcludedCommonFilePropertyValidationAttributesMap: {
37
+ [property: string]: {
38
+ maxLength?: number;
39
+ minLength?: number;
40
+ pattern?: string;
41
+ maximum?: number;
42
+ exclusiveMaximum?: boolean;
43
+ minimum?: number;
44
+ exclusiveMinimum?: boolean;
45
+ multipleOf?: number;
46
+ maxItems?: number;
47
+ minItems?: number;
48
+ uniqueItems?: boolean;
49
+ };
50
+ };
51
+ /**
52
+ * Check if a given object implements the ExcludedCommonFile interface.
53
+ */
54
+ export declare function instanceOfExcludedCommonFile(value: object): value is ExcludedCommonFile;
55
+ export declare function ExcludedCommonFileFromJSON(json: any): ExcludedCommonFile;
56
+ export declare function ExcludedCommonFileFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExcludedCommonFile;
57
+ export declare function ExcludedCommonFileToJSON(json: any): ExcludedCommonFile;
58
+ export declare function ExcludedCommonFileToJSONTyped(value?: ExcludedCommonFile | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,57 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Knowledge Stack API
6
+ * Knowledge Stack backend API for authentication and knowledge management
7
+ *
8
+ * The version of the OpenAPI document: 0.1.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.ExcludedCommonFilePropertyValidationAttributesMap = void 0;
17
+ exports.instanceOfExcludedCommonFile = instanceOfExcludedCommonFile;
18
+ exports.ExcludedCommonFileFromJSON = ExcludedCommonFileFromJSON;
19
+ exports.ExcludedCommonFileFromJSONTyped = ExcludedCommonFileFromJSONTyped;
20
+ exports.ExcludedCommonFileToJSON = ExcludedCommonFileToJSON;
21
+ exports.ExcludedCommonFileToJSONTyped = ExcludedCommonFileToJSONTyped;
22
+ const CommonFileExclusionReason_1 = require("./CommonFileExclusionReason");
23
+ exports.ExcludedCommonFilePropertyValidationAttributesMap = {};
24
+ /**
25
+ * Check if a given object implements the ExcludedCommonFile interface.
26
+ */
27
+ function instanceOfExcludedCommonFile(value) {
28
+ if (!('pathPartId' in value) || value['pathPartId'] === undefined)
29
+ return false;
30
+ if (!('reason' in value) || value['reason'] === undefined)
31
+ return false;
32
+ return true;
33
+ }
34
+ function ExcludedCommonFileFromJSON(json) {
35
+ return ExcludedCommonFileFromJSONTyped(json, false);
36
+ }
37
+ function ExcludedCommonFileFromJSONTyped(json, ignoreDiscriminator) {
38
+ if (json == null) {
39
+ return json;
40
+ }
41
+ return {
42
+ 'pathPartId': json['path_part_id'],
43
+ 'reason': (0, CommonFileExclusionReason_1.CommonFileExclusionReasonFromJSON)(json['reason']),
44
+ };
45
+ }
46
+ function ExcludedCommonFileToJSON(json) {
47
+ return ExcludedCommonFileToJSONTyped(json, false);
48
+ }
49
+ function ExcludedCommonFileToJSONTyped(value, ignoreDiscriminator = false) {
50
+ if (value == null) {
51
+ return value;
52
+ }
53
+ return {
54
+ 'path_part_id': value['pathPartId'],
55
+ 'reason': (0, CommonFileExclusionReason_1.CommonFileExclusionReasonToJSON)(value['reason']),
56
+ };
57
+ }
@@ -0,0 +1,30 @@
1
+ /**
2
+ * Knowledge Stack API
3
+ * Knowledge Stack backend API for authentication and knowledge management
4
+ *
5
+ * The version of the OpenAPI document: 0.1.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Where a run-snapshot input came from, for auditability.
14
+ *
15
+ * A run's pinned inputs are merged from three sources at Start; this tags
16
+ * each so an auditor / the FE can tell a definition-mandated common file
17
+ * apart from a file the run's creator chose.
18
+ * @export
19
+ */
20
+ export declare const InputOrigin: {
21
+ readonly DefinitionCommon: "DEFINITION_COMMON";
22
+ readonly RunReference: "RUN_REFERENCE";
23
+ readonly RunUpload: "RUN_UPLOAD";
24
+ };
25
+ export type InputOrigin = typeof InputOrigin[keyof typeof InputOrigin];
26
+ export declare function instanceOfInputOrigin(value: any): boolean;
27
+ export declare function InputOriginFromJSON(json: any): InputOrigin;
28
+ export declare function InputOriginFromJSONTyped(json: any, ignoreDiscriminator: boolean): InputOrigin;
29
+ export declare function InputOriginToJSON(value?: InputOrigin | null): any;
30
+ export declare function InputOriginToJSONTyped(value: any, ignoreDiscriminator: boolean): InputOrigin;
@@ -0,0 +1,56 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Knowledge Stack API
6
+ * Knowledge Stack backend API for authentication and knowledge management
7
+ *
8
+ * The version of the OpenAPI document: 0.1.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.InputOrigin = void 0;
17
+ exports.instanceOfInputOrigin = instanceOfInputOrigin;
18
+ exports.InputOriginFromJSON = InputOriginFromJSON;
19
+ exports.InputOriginFromJSONTyped = InputOriginFromJSONTyped;
20
+ exports.InputOriginToJSON = InputOriginToJSON;
21
+ exports.InputOriginToJSONTyped = InputOriginToJSONTyped;
22
+ /**
23
+ * Where a run-snapshot input came from, for auditability.
24
+ *
25
+ * A run's pinned inputs are merged from three sources at Start; this tags
26
+ * each so an auditor / the FE can tell a definition-mandated common file
27
+ * apart from a file the run's creator chose.
28
+ * @export
29
+ */
30
+ exports.InputOrigin = {
31
+ DefinitionCommon: 'DEFINITION_COMMON',
32
+ RunReference: 'RUN_REFERENCE',
33
+ RunUpload: 'RUN_UPLOAD'
34
+ };
35
+ function instanceOfInputOrigin(value) {
36
+ for (const key in exports.InputOrigin) {
37
+ if (Object.prototype.hasOwnProperty.call(exports.InputOrigin, key)) {
38
+ if (exports.InputOrigin[key] === value) {
39
+ return true;
40
+ }
41
+ }
42
+ }
43
+ return false;
44
+ }
45
+ function InputOriginFromJSON(json) {
46
+ return InputOriginFromJSONTyped(json, false);
47
+ }
48
+ function InputOriginFromJSONTyped(json, ignoreDiscriminator) {
49
+ return json;
50
+ }
51
+ function InputOriginToJSON(value) {
52
+ return value;
53
+ }
54
+ function InputOriginToJSONTyped(value, ignoreDiscriminator) {
55
+ return value;
56
+ }
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { InputOrigin } from './InputOrigin';
12
13
  /**
13
14
  * One entry of a run's input scope, self-describing its pin semantics.
14
15
  *
@@ -52,6 +53,12 @@ export interface InputSnapshot {
52
53
  * @memberof InputSnapshot
53
54
  */
54
55
  partType: InputSnapshotPartTypeEnum;
56
+ /**
57
+ *
58
+ * @type {InputOrigin}
59
+ * @memberof InputSnapshot
60
+ */
61
+ origin?: InputOrigin;
55
62
  }
56
63
  /**
57
64
  * @export
@@ -19,6 +19,7 @@ exports.InputSnapshotFromJSON = InputSnapshotFromJSON;
19
19
  exports.InputSnapshotFromJSONTyped = InputSnapshotFromJSONTyped;
20
20
  exports.InputSnapshotToJSON = InputSnapshotToJSON;
21
21
  exports.InputSnapshotToJSONTyped = InputSnapshotToJSONTyped;
22
+ const InputOrigin_1 = require("./InputOrigin");
22
23
  /**
23
24
  * @export
24
25
  */
@@ -52,6 +53,7 @@ function InputSnapshotFromJSONTyped(json, ignoreDiscriminator) {
52
53
  'pathPartId': json['path_part_id'],
53
54
  'materializedPath': json['materialized_path'],
54
55
  'partType': json['part_type'],
56
+ 'origin': json['origin'] == null ? undefined : (0, InputOrigin_1.InputOriginFromJSON)(json['origin']),
55
57
  };
56
58
  }
57
59
  function InputSnapshotToJSON(json) {
@@ -65,5 +67,6 @@ function InputSnapshotToJSONTyped(value, ignoreDiscriminator = false) {
65
67
  'path_part_id': value['pathPartId'],
66
68
  'materialized_path': value['materializedPath'],
67
69
  'part_type': value['partType'],
70
+ 'origin': (0, InputOrigin_1.InputOriginToJSON)(value['origin']),
68
71
  };
69
72
  }
@@ -57,6 +57,12 @@ export interface UpdateWorkflowDefinitionRequest {
57
57
  * @memberof UpdateWorkflowDefinitionRequest
58
58
  */
59
59
  approvalRequired: boolean;
60
+ /**
61
+ * Common files attached to every run (DOCUMENT / FOLDER / DATA_SOURCE / API_CONNECTION path_part ids). Like ``instruction_path_part_id``, this is the exception to PUT semantics: null (or omit) retains the stored list; pass [] to clear; pass a list to replace it wholesale. The caller must be able to read each one.
62
+ * @type {Array<string>}
63
+ * @memberof UpdateWorkflowDefinitionRequest
64
+ */
65
+ commonFilePathPartIds?: Array<string> | null;
60
66
  }
61
67
  export declare const UpdateWorkflowDefinitionRequestPropertyValidationAttributesMap: {
62
68
  [property: string]: {
@@ -29,6 +29,10 @@ exports.UpdateWorkflowDefinitionRequestPropertyValidationAttributesMap = {
29
29
  minimum: 60,
30
30
  exclusiveMinimum: false,
31
31
  },
32
+ commonFilePathPartIds: {
33
+ maxItems: 20,
34
+ uniqueItems: false,
35
+ },
32
36
  };
33
37
  /**
34
38
  * Check if a given object implements the UpdateWorkflowDefinitionRequest interface.
@@ -57,6 +61,7 @@ function UpdateWorkflowDefinitionRequestFromJSONTyped(json, ignoreDiscriminator)
57
61
  'parentPathPartId': json['parent_path_part_id'] == null ? undefined : json['parent_path_part_id'],
58
62
  'isActive': json['is_active'],
59
63
  'approvalRequired': json['approval_required'],
64
+ 'commonFilePathPartIds': json['common_file_path_part_ids'] == null ? undefined : json['common_file_path_part_ids'],
60
65
  };
61
66
  }
62
67
  function UpdateWorkflowDefinitionRequestToJSON(json) {
@@ -74,5 +79,6 @@ function UpdateWorkflowDefinitionRequestToJSONTyped(value, ignoreDiscriminator =
74
79
  'parent_path_part_id': value['parentPathPartId'],
75
80
  'is_active': value['isActive'],
76
81
  'approval_required': value['approvalRequired'],
82
+ 'common_file_path_part_ids': value['commonFilePathPartIds'],
77
83
  };
78
84
  }
@@ -102,6 +102,12 @@ export interface WorkflowDefinitionResponse {
102
102
  * @memberof WorkflowDefinitionResponse
103
103
  */
104
104
  isTemplate: boolean;
105
+ /**
106
+ * Common files attached to every run (path_part ids). The FE renders these as 'attached to every run' on the workflow page.
107
+ * @type {Array<string>}
108
+ * @memberof WorkflowDefinitionResponse
109
+ */
110
+ commonFilePathPartIds?: Array<string>;
105
111
  /**
106
112
  * Source definition this workflow was copied from (a template or any other workflow); null if hand-authored.
107
113
  * @type {string}
@@ -88,6 +88,7 @@ function WorkflowDefinitionResponseFromJSONTyped(json, ignoreDiscriminator) {
88
88
  'isActive': json['is_active'],
89
89
  'approvalRequired': json['approval_required'],
90
90
  'isTemplate': json['is_template'],
91
+ 'commonFilePathPartIds': json['common_file_path_part_ids'] == null ? undefined : json['common_file_path_part_ids'],
91
92
  'createdFromId': json['created_from_id'],
92
93
  'copyCount': json['copy_count'] == null ? undefined : json['copy_count'],
93
94
  'approvalState': (0, PathPartApprovalState_1.PathPartApprovalStateFromJSON)(json['approval_state']),
@@ -118,6 +119,7 @@ function WorkflowDefinitionResponseToJSONTyped(value, ignoreDiscriminator = fals
118
119
  'is_active': value['isActive'],
119
120
  'approval_required': value['approvalRequired'],
120
121
  'is_template': value['isTemplate'],
122
+ 'common_file_path_part_ids': value['commonFilePathPartIds'],
121
123
  'created_from_id': value['createdFromId'],
122
124
  'copy_count': value['copyCount'],
123
125
  'approval_state': (0, PathPartApprovalState_1.PathPartApprovalStateToJSON)(value['approvalState']),
@@ -12,6 +12,7 @@
12
12
  import type { ItemPermissions } from './ItemPermissions';
13
13
  import type { WorkflowRunSnapshot } from './WorkflowRunSnapshot';
14
14
  import type { WorkflowExecutionState } from './WorkflowExecutionState';
15
+ import type { ExcludedCommonFile } from './ExcludedCommonFile';
15
16
  import type { PathPartApprovalState } from './PathPartApprovalState';
16
17
  import type { UserInfo } from './UserInfo';
17
18
  /**
@@ -162,6 +163,12 @@ export interface WorkflowRunResponse {
162
163
  * @memberof WorkflowRunResponse
163
164
  */
164
165
  outputsPathPartIds: Array<string>;
166
+ /**
167
+ * Definition common files that were excluded from this run at Start (deleted or unreadable by the starter). Empty until Start builds the snapshot, and empty for the common happy path.
168
+ * @type {Array<ExcludedCommonFile>}
169
+ * @memberof WorkflowRunResponse
170
+ */
171
+ excludedCommonFiles?: Array<ExcludedCommonFile>;
165
172
  /**
166
173
  * The run's primary chat thread (1:1). NULL while NOT_STARTED; set by Start. The FE opens the run by opening this thread.
167
174
  * @type {string}
@@ -22,6 +22,7 @@ exports.WorkflowRunResponseToJSONTyped = WorkflowRunResponseToJSONTyped;
22
22
  const ItemPermissions_1 = require("./ItemPermissions");
23
23
  const WorkflowRunSnapshot_1 = require("./WorkflowRunSnapshot");
24
24
  const WorkflowExecutionState_1 = require("./WorkflowExecutionState");
25
+ const ExcludedCommonFile_1 = require("./ExcludedCommonFile");
25
26
  const PathPartApprovalState_1 = require("./PathPartApprovalState");
26
27
  const UserInfo_1 = require("./UserInfo");
27
28
  /**
@@ -109,6 +110,7 @@ function WorkflowRunResponseFromJSONTyped(json, ignoreDiscriminator) {
109
110
  'discussionsPathPartId': json['discussions_path_part_id'],
110
111
  'inputPathPartIds': json['input_path_part_ids'] == null ? undefined : json['input_path_part_ids'],
111
112
  'outputsPathPartIds': json['outputs_path_part_ids'],
113
+ 'excludedCommonFiles': json['excluded_common_files'] == null ? undefined : (json['excluded_common_files'].map(ExcludedCommonFile_1.ExcludedCommonFileFromJSON)),
112
114
  'runThreadId': json['run_thread_id'] == null ? undefined : json['run_thread_id'],
113
115
  'owner': json['owner'] == null ? undefined : (0, UserInfo_1.UserInfoFromJSON)(json['owner']),
114
116
  'createdAt': (new Date(json['created_at'])),
@@ -146,6 +148,7 @@ function WorkflowRunResponseToJSONTyped(value, ignoreDiscriminator = false) {
146
148
  'discussions_path_part_id': value['discussionsPathPartId'],
147
149
  'input_path_part_ids': value['inputPathPartIds'],
148
150
  'outputs_path_part_ids': value['outputsPathPartIds'],
151
+ 'excluded_common_files': value['excludedCommonFiles'] == null ? undefined : (value['excludedCommonFiles'].map(ExcludedCommonFile_1.ExcludedCommonFileToJSON)),
149
152
  'run_thread_id': value['runThreadId'],
150
153
  'owner': (0, UserInfo_1.UserInfoToJSON)(value['owner']),
151
154
  'created_at': value['createdAt'].toISOString(),
@@ -10,6 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { InputSnapshot } from './InputSnapshot';
13
+ import type { ExcludedCommonFile } from './ExcludedCommonFile';
13
14
  import type { InstructionSnapshot } from './InstructionSnapshot';
14
15
  /**
15
16
  * Frozen workflow configuration captured at trigger time.
@@ -49,6 +50,12 @@ export interface WorkflowRunSnapshot {
49
50
  * @memberof WorkflowRunSnapshot
50
51
  */
51
52
  inputs: Array<InputSnapshot>;
53
+ /**
54
+ * Definition common files left out of this run at Start (deleted or unreadable by the starter), each with its exclusion reason. Empty for the common happy path; pre-feature snapshots default to empty.
55
+ * @type {Array<ExcludedCommonFile>}
56
+ * @memberof WorkflowRunSnapshot
57
+ */
58
+ excludedCommonFiles?: Array<ExcludedCommonFile>;
52
59
  /**
53
60
  * Optional free-text message the caller supplied at Start. Pinned here so the runner injects it into the agent's first user turn and it survives retry, redrive, and workflow-thread follow-ups (all of which re-assemble the prompt from this snapshot).
54
61
  * @type {string}
@@ -20,6 +20,7 @@ exports.WorkflowRunSnapshotFromJSONTyped = WorkflowRunSnapshotFromJSONTyped;
20
20
  exports.WorkflowRunSnapshotToJSON = WorkflowRunSnapshotToJSON;
21
21
  exports.WorkflowRunSnapshotToJSONTyped = WorkflowRunSnapshotToJSONTyped;
22
22
  const InputSnapshot_1 = require("./InputSnapshot");
23
+ const ExcludedCommonFile_1 = require("./ExcludedCommonFile");
23
24
  const InstructionSnapshot_1 = require("./InstructionSnapshot");
24
25
  exports.WorkflowRunSnapshotPropertyValidationAttributesMap = {
25
26
  userMessage: {
@@ -52,6 +53,7 @@ function WorkflowRunSnapshotFromJSONTyped(json, ignoreDiscriminator) {
52
53
  'maxRunDurationSeconds': json['max_run_duration_seconds'],
53
54
  'instruction': (0, InstructionSnapshot_1.InstructionSnapshotFromJSON)(json['instruction']),
54
55
  'inputs': (json['inputs'].map(InputSnapshot_1.InputSnapshotFromJSON)),
56
+ 'excludedCommonFiles': json['excluded_common_files'] == null ? undefined : (json['excluded_common_files'].map(ExcludedCommonFile_1.ExcludedCommonFileFromJSON)),
55
57
  'userMessage': json['user_message'] == null ? undefined : json['user_message'],
56
58
  };
57
59
  }
@@ -67,6 +69,7 @@ function WorkflowRunSnapshotToJSONTyped(value, ignoreDiscriminator = false) {
67
69
  'max_run_duration_seconds': value['maxRunDurationSeconds'],
68
70
  'instruction': (0, InstructionSnapshot_1.InstructionSnapshotToJSON)(value['instruction']),
69
71
  'inputs': (value['inputs'].map(InputSnapshot_1.InputSnapshotToJSON)),
72
+ 'excluded_common_files': value['excludedCommonFiles'] == null ? undefined : (value['excludedCommonFiles'].map(ExcludedCommonFile_1.ExcludedCommonFileToJSON)),
70
73
  'user_message': value['userMessage'],
71
74
  };
72
75
  }
@@ -45,6 +45,7 @@ export * from './ClearVersionContentsResponse';
45
45
  export * from './CloneWorkflowRunRequest';
46
46
  export * from './ColumnConfig';
47
47
  export * from './ColumnReference';
48
+ export * from './CommonFileExclusionReason';
48
49
  export * from './ConnectionConfig';
49
50
  export * from './CreateApiConnectionRequest';
50
51
  export * from './CreateApiKeyRequest';
@@ -106,6 +107,7 @@ export * from './EnrichedCitation';
106
107
  export * from './EnrichedThreadMessageContent';
107
108
  export * from './ErrorResponse';
108
109
  export * from './EventResponse';
110
+ export * from './ExcludedCommonFile';
109
111
  export * from './ExtractRequest';
110
112
  export * from './ExtractResponse';
111
113
  export * from './FeaturesResponse';
@@ -131,6 +133,7 @@ export * from './ImageTaxonomy';
131
133
  export * from './InformationStatistics';
132
134
  export * from './IngestDocumentResponse';
133
135
  export * from './IngestionMode';
136
+ export * from './InputOrigin';
134
137
  export * from './InputSnapshot';
135
138
  export * from './InstantiateWorkflowTemplateRequest';
136
139
  export * from './InstructionSnapshot';
@@ -63,6 +63,7 @@ __exportStar(require("./ClearVersionContentsResponse"), exports);
63
63
  __exportStar(require("./CloneWorkflowRunRequest"), exports);
64
64
  __exportStar(require("./ColumnConfig"), exports);
65
65
  __exportStar(require("./ColumnReference"), exports);
66
+ __exportStar(require("./CommonFileExclusionReason"), exports);
66
67
  __exportStar(require("./ConnectionConfig"), exports);
67
68
  __exportStar(require("./CreateApiConnectionRequest"), exports);
68
69
  __exportStar(require("./CreateApiKeyRequest"), exports);
@@ -124,6 +125,7 @@ __exportStar(require("./EnrichedCitation"), exports);
124
125
  __exportStar(require("./EnrichedThreadMessageContent"), exports);
125
126
  __exportStar(require("./ErrorResponse"), exports);
126
127
  __exportStar(require("./EventResponse"), exports);
128
+ __exportStar(require("./ExcludedCommonFile"), exports);
127
129
  __exportStar(require("./ExtractRequest"), exports);
128
130
  __exportStar(require("./ExtractResponse"), exports);
129
131
  __exportStar(require("./FeaturesResponse"), exports);
@@ -149,6 +151,7 @@ __exportStar(require("./ImageTaxonomy"), exports);
149
151
  __exportStar(require("./InformationStatistics"), exports);
150
152
  __exportStar(require("./IngestDocumentResponse"), exports);
151
153
  __exportStar(require("./IngestionMode"), exports);
154
+ __exportStar(require("./InputOrigin"), exports);
152
155
  __exportStar(require("./InputSnapshot"), exports);
153
156
  __exportStar(require("./InstantiateWorkflowTemplateRequest"), exports);
154
157
  __exportStar(require("./InstructionSnapshot"), exports);
@@ -0,0 +1,33 @@
1
+
2
+ # CommonFileExclusionReason
3
+
4
+ Why a definition common file was left out of a run at Start. Common files resolve resiliently (record-and-continue): an unresolvable one is excluded with one of these reasons rather than failing the run.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { CommonFileExclusionReason } from '@knowledge-stack/ksapi'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ } satisfies CommonFileExclusionReason
19
+
20
+ console.log(example)
21
+
22
+ // Convert the instance to a JSON string
23
+ const exampleJSON: string = JSON.stringify(example)
24
+ console.log(exampleJSON)
25
+
26
+ // Parse the JSON string back to an object
27
+ const exampleParsed = JSON.parse(exampleJSON) as CommonFileExclusionReason
28
+ console.log(exampleParsed)
29
+ ```
30
+
31
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
32
+
33
+
@@ -14,6 +14,7 @@ Name | Type
14
14
  `instructionPathPartId` | string
15
15
  `approvalRequired` | boolean
16
16
  `isTemplate` | boolean
17
+ `commonFilePathPartIds` | Array&lt;string&gt;
17
18
 
18
19
  ## Example
19
20
 
@@ -29,6 +30,7 @@ const example = {
29
30
  "instructionPathPartId": null,
30
31
  "approvalRequired": null,
31
32
  "isTemplate": null,
33
+ "commonFilePathPartIds": null,
32
34
  } satisfies CreateWorkflowDefinitionRequest
33
35
 
34
36
  console.log(example)