@or-sdk/flows 2.7.3-beta.4036.0 → 2.7.3-beta.4040.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.
@@ -1,20 +1,63 @@
1
1
  import type { Token } from '@or-sdk/base';
2
2
  export type { Token };
3
3
  export type FlowsConfigBase = {
4
+ /**
5
+ * OneReach authentication token
6
+ */
4
7
  token: Token;
8
+ /**
9
+ * Account id for cross-account requests (super admin only)
10
+ */
5
11
  accountId?: string;
12
+ /**
13
+ * Allows to define custom feature for using with DataHubSvc API
14
+ */
6
15
  feature?: string;
7
16
  };
8
17
  export type FlowsConfigWithDiscovery = FlowsConfigBase & {
18
+ /**
19
+ * URL of OneReach service discovery API.
20
+ *
21
+ * Allows to fetch URLs of needed API's instead of defining them in the constructor.
22
+ */
9
23
  discoveryUrl: string;
24
+ /**
25
+ * URL of OneReach DataHubSvc API.
26
+ *
27
+ * Not needed if {@link FlowsConfig.discoveryUrl} is defined.
28
+ */
10
29
  dataHubSvcUrl?: never;
30
+ /**
31
+ * URL of OneReach Deployer API.
32
+ *
33
+ * Not needed if {@link FlowsConfig.discoveryUrl} is defined.
34
+ */
11
35
  deployerUrl?: never;
36
+ /**
37
+ * URL of OneReach Files API.
38
+ *
39
+ * Not needed if {@link FlowsConfig.discoveryUrl} is defined.
40
+ */
12
41
  filesApiUrl?: never;
13
42
  };
14
43
  export type FlowsConfigWithExplicitUrls = FlowsConfigBase & {
44
+ /**
45
+ * URL of OneReach DataHubSvc API.
46
+ */
15
47
  dataHubSvcUrl: string;
48
+ /**
49
+ * URL of OneReach Deployer API.
50
+ */
16
51
  deployerUrl: string;
52
+ /**
53
+ * URL of OneReach Files API.
54
+ */
17
55
  filesApiUrl: string;
56
+ /**
57
+ * URL of OneReach service discovery API.
58
+ *
59
+ * Not needed if API URLs are explicitly defined.
60
+ */
18
61
  discoveryUrl?: never;
19
62
  };
20
63
  export type FlowsConfig = FlowsConfigWithDiscovery | FlowsConfigWithExplicitUrls;
@@ -1 +1 @@
1
- {"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../src/types/base.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAE1C,YAAY,EAAE,KAAK,EAAE,CAAC;AAEtB,MAAM,MAAM,eAAe,GAAG;IAI5B,KAAK,EAAE,KAAK,CAAC;IAKb,SAAS,CAAC,EAAE,MAAM,CAAC;IAKnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG,eAAe,GAAG;IAMvD,YAAY,EAAE,MAAM,CAAC;IAOrB,aAAa,CAAC,EAAE,KAAK,CAAC;IAOtB,WAAW,CAAC,EAAE,KAAK,CAAC;IAOpB,WAAW,CAAC,EAAE,KAAK,CAAC;CACrB,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG,eAAe,GAAG;IAI1D,aAAa,EAAE,MAAM,CAAC;IAKtB,WAAW,EAAE,MAAM,CAAC;IAKpB,WAAW,EAAE,MAAM,CAAC;IAOpB,YAAY,CAAC,EAAE,KAAK,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,wBAAwB,GAAG,2BAA2B,CAAC"}
1
+ {"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../src/types/base.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAE1C,YAAY,EAAE,KAAK,EAAE,CAAC;AAEtB,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG,eAAe,GAAG;IACvD;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC;IAEtB;;;;OAIG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC;IAEpB;;;;OAIG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC;CACrB,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG,eAAe,GAAG;IAC1D;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,wBAAwB,GAAG,2BAA2B,CAAC"}
@@ -1,6 +1,14 @@
1
1
  import { FlowEntity, ModelAttributes, ModelWhereAttributes } from './services/data-hub-svc';
2
2
  export type ListFlowsParams = {
3
+ /**
4
+ * Include deleted flows in result
5
+ * @default false
6
+ */
3
7
  includeDeleted?: boolean;
8
+ /**
9
+ * Include active (not deleted) flows in result
10
+ * @default true
11
+ */
4
12
  includeExisting?: boolean;
5
13
  query?: ModelWhereAttributes<FlowEntity>;
6
14
  includesStep?: boolean;
@@ -1 +1 @@
1
- {"version":3,"file":"flows.d.ts","sourceRoot":"","sources":["../../../src/types/flows.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAE5F,MAAM,MAAM,eAAe,GAAG;IAK5B,cAAc,CAAC,EAAE,OAAO,CAAC;IAMzB,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,KAAK,CAAC,EAAE,oBAAoB,CAAC,UAAU,CAAC,CAAC;IAEzC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,UAAU,CAAC,EAAE;QACX,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IAEF,UAAU,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC;IACzC,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,UAAU,CAAC,CAAC;IAChC,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,CAAC,EAAE;QACN,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,CAAC,EAAE;QACN,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,UAAU,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;KACd,EAAE,CAAA;CACJ,CAAC"}
1
+ {"version":3,"file":"flows.d.ts","sourceRoot":"","sources":["../../../src/types/flows.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAE5F,MAAM,MAAM,eAAe,GAAG;IAC5B;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,KAAK,CAAC,EAAE,oBAAoB,CAAC,UAAU,CAAC,CAAC;IAEzC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,UAAU,CAAC,EAAE;QACX,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IAEF,UAAU,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC;IACzC,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,UAAU,CAAC,CAAC;IAChC,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,CAAC,EAAE;QACN,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,CAAC,EAAE;QACN,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,UAAU,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;KACd,EAAE,CAAA;CACJ,CAAC"}
@@ -14,18 +14,39 @@ export type DownloadTemplateResult = {
14
14
  };
15
15
  };
16
16
  export type ListStepTemplateParams = {
17
+ /** Flow id */
17
18
  id: string;
19
+ /**
20
+ * If set step template records will have only fields from this list
21
+ * (e.g. `['id', 'label', 'outputExample.custom']` )
22
+ */
18
23
  projection?: ModelAttributes<StepTemplateEntity>;
19
24
  };
20
25
  export type ListFlowsByStepTemplateParams = {
26
+ /** Search criteria for step templates */
21
27
  query?: ModelWhereAttributes<StepTemplateEntity>;
28
+ /**
29
+ * If set flow records will have only fields from this list
30
+ * (e.g. `['id', 'data.label', 'data.deploy.role']` )
31
+ */
22
32
  projection?: ModelAttributes<FlowEntity>;
33
+ /**
34
+ * If `true` would return flows that have step template(s) found via query,
35
+ * otherwise flows that do not have them. Default `true`.
36
+ */
23
37
  includesStep?: boolean;
38
+ /** If `true` search for step templates in the library, otherwise in the current account. Default `false`. */
24
39
  sandbox?: boolean;
25
40
  };
26
41
  export type ListFlowsByStepTemplateGlobalParams = {
42
+ /** Search criteria for step templates */
27
43
  query: ModelWhereAttributes<Pick<StepTemplateEntity, 'id' | 'version'>>;
44
+ /**
45
+ * If set flow records will have only fields from this list
46
+ * (e.g. `['id', 'data.label', 'data.deploy.role']` )
47
+ */
28
48
  projection?: ModelAttributes<FlowEntity>;
49
+ /** If `true` would return flows that have stem template(s), otherwise flows that do not have them. Default `true`. */
29
50
  includesStep?: boolean;
30
51
  };
31
52
  //# sourceMappingURL=step-templates.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"step-templates.d.ts","sourceRoot":"","sources":["../../../src/types/step-templates.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,kBAAkB,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAErH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IAEnC,EAAE,EAAE,MAAM,CAAC;IAMX,UAAU,CAAC,EAAE,eAAe,CAAC,kBAAkB,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAE1C,KAAK,CAAC,EAAE,oBAAoB,CAAC,kBAAkB,CAAC,CAAC;IAMjD,UAAU,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC;IAMzC,YAAY,CAAC,EAAE,OAAO,CAAC;IAGvB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,mCAAmC,GAAG;IAEhD,KAAK,EAAE,oBAAoB,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC;IAMxE,UAAU,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC;IAGzC,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAA"}
1
+ {"version":3,"file":"step-templates.d.ts","sourceRoot":"","sources":["../../../src/types/step-templates.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,kBAAkB,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAErH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,cAAc;IACd,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,CAAC,EAAE,eAAe,CAAC,kBAAkB,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,yCAAyC;IACzC,KAAK,CAAC,EAAE,oBAAoB,CAAC,kBAAkB,CAAC,CAAC;IAEjD;;;OAGG;IACH,UAAU,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC;IAEzC;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,6GAA6G;IAC7G,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,mCAAmC,GAAG;IAChD,yCAAyC;IACzC,KAAK,EAAE,oBAAoB,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC;IAExE;;;OAGG;IACH,UAAU,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC;IAEzC,sHAAsH;IACtH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAA"}
@@ -1,5 +1,12 @@
1
1
  import type { Flow } from '@or-sdk/deployer';
2
2
  import type { StepTemplateToDelete } from '../types';
3
- declare function deleteUnusedStepTemplates(source: Flow, stepTemplates?: StepTemplateToDelete[]): Flow;
3
+ /**
4
+ * Delete unused step templates from the flow source
5
+ */
6
+ declare function deleteUnusedStepTemplates(
7
+ /** Flow source to delete unused step templates from */
8
+ source: Flow,
9
+ /** List of specific step templates to delete. If not set of empty array delete all unused step templates. */
10
+ stepTemplates?: StepTemplateToDelete[]): Flow;
4
11
  export default deleteUnusedStepTemplates;
5
12
  //# sourceMappingURL=deleteUnusedStepTemplates.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"deleteUnusedStepTemplates.d.ts","sourceRoot":"","sources":["../../../src/utils/deleteUnusedStepTemplates.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAE7C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAMrD,iBAAS,yBAAyB,CAEhC,MAAM,EAAE,IAAI,EAGZ,aAAa,CAAC,EAAE,oBAAoB,EAAE,GACrC,IAAI,CAkBN;AAED,eAAe,yBAAyB,CAAC"}
1
+ {"version":3,"file":"deleteUnusedStepTemplates.d.ts","sourceRoot":"","sources":["../../../src/utils/deleteUnusedStepTemplates.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAE7C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAGrD;;GAEG;AACH,iBAAS,yBAAyB;AAChC,uDAAuD;AACvD,MAAM,EAAE,IAAI;AAEZ,6GAA6G;AAC7G,aAAa,CAAC,EAAE,oBAAoB,EAAE,GACrC,IAAI,CAkBN;AAED,eAAe,yBAAyB,CAAC"}
@@ -1,3 +1,6 @@
1
+ /**
2
+ * @internal
3
+ */
1
4
  export { default as listUnusedStepTemplates } from './listUnusedStepTemplates';
2
5
  export { default as deleteUnusedStepTemplates } from './deleteUnusedStepTemplates';
3
6
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,IAAI,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAC/E,OAAO,EAAE,OAAO,IAAI,yBAAyB,EAAE,MAAM,6BAA6B,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,OAAO,IAAI,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAC/E,OAAO,EAAE,OAAO,IAAI,yBAAyB,EAAE,MAAM,6BAA6B,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@or-sdk/flows",
3
- "version": "2.7.3-beta.4036.0",
3
+ "version": "2.7.3-beta.4040.0",
4
4
  "license": "Apache-2.0",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",
@@ -21,7 +21,7 @@
21
21
  "@or-sdk/base": "^0.44.0",
22
22
  "@or-sdk/data-hub-svc": "^2.3.1",
23
23
  "@or-sdk/deployer": "^1.7.1",
24
- "@or-sdk/files": "^3.11.1-beta.4036.0",
24
+ "@or-sdk/files": "^3.11.1-beta.4040.0",
25
25
  "@or-sdk/tags": "^1.1.1"
26
26
  },
27
27
  "devDependencies": {