@connectreport/connectreport-js 2.81.0-beta.5 → 2.81.0-beta.6

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 (8) hide show
  1. package/api.ts +24 -4
  2. package/dist/index.cjs +7 -0
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.cts +25 -5
  5. package/dist/index.d.ts +25 -5
  6. package/dist/index.js +6 -0
  7. package/dist/index.js.map +1 -1
  8. package/package.json +2 -2
package/dist/index.d.cts CHANGED
@@ -133,17 +133,29 @@ interface CycleConfig {
133
133
  */
134
134
  configType: CycleConfigConfigTypeEnum;
135
135
  /**
136
- * Data connector name (case-insensitive)
136
+ * Data source type - \'connector\' for external data connector, \'parameterSheet\' for worksheet in the template
137
137
  * @type {string}
138
138
  * @memberof CycleConfig
139
139
  */
140
- connector: string;
140
+ cycleSource?: CycleConfigCycleSourceEnum;
141
141
  /**
142
- * Data source document ID
142
+ * Name of the worksheet to read parameter rows from (required when cycleSource is \'parameterSheet\')
143
143
  * @type {string}
144
144
  * @memberof CycleConfig
145
145
  */
146
- docId: string;
146
+ parameterSheetName?: string;
147
+ /**
148
+ * Data connector name (case-insensitive, required when cycleSource is \'connector\')
149
+ * @type {string}
150
+ * @memberof CycleConfig
151
+ */
152
+ connector?: string;
153
+ /**
154
+ * Data source document ID (required when cycleSource is \'connector\')
155
+ * @type {string}
156
+ * @memberof CycleConfig
157
+ */
158
+ docId?: string;
147
159
  /**
148
160
  * Columns to query - defines what data to fetch (each row creates a child task)
149
161
  * @type {Array<FieldInfo>}
@@ -231,6 +243,14 @@ declare enum CycleConfigConfigTypeEnum {
231
243
  Filters = "filters",
232
244
  Recipients = "recipients"
233
245
  }
246
+ /**
247
+ * @export
248
+ * @enum {string}
249
+ */
250
+ declare enum CycleConfigCycleSourceEnum {
251
+ Connector = "connector",
252
+ ParameterSheet = "parameterSheet"
253
+ }
234
254
  /**
235
255
  * Field metadata from data source
236
256
  * @export
@@ -3644,4 +3664,4 @@ declare class ConnectReport {
3644
3664
  constructor(config: Pick<Configuration, "apiKey" | "basePath" | "formDataCtor" | "httpsAgent">);
3645
3665
  }
3646
3666
 
3647
- export { BaseTemplatesApi, BaseTemplatesApiAxiosParamCreator, BaseTemplatesApiFactory, BaseTemplatesApiFp, ConnectReport, type CycleConfig, CycleConfigConfigTypeEnum, DocumentsApi, DocumentsApiAxiosParamCreator, DocumentsApiFactory, DocumentsApiFp, type FieldInfo, type FilterCycle, type FilterCycleAllOf, type FilterCycleAllOfFieldInfo, type FilterCycleAllOfFieldValues, FilterCycleEmailEnum, FilterCycleFrequencyEnum, FilterCyclesApi, FilterCyclesApiAxiosParamCreator, FilterCyclesApiFactory, FilterCyclesApiFp, type FilterMapping, ImagesApi, ImagesApiAxiosParamCreator, ImagesApiFactory, ImagesApiFp, type InlineResponse200, type InlineResponse2001, type InlineResponse2002, type InlineResponse2003, type InlineResponse2004, type Job, type JobResponse, JobsApi, JobsApiAxiosParamCreator, JobsApiFactory, JobsApiFp, type ModelError, type Report, type ReportTask, type ReportTaskCustomSelection, ReportTaskEmailEnum, type ReportTaskErrors, type ReportTaskFieldValues, type ReportTaskFilterSets, ReportTaskFrequencyEnum, type ReportTaskGroupsToShareWith, type ReportTaskMappings, type ReportTaskRequest, type ReportTaskRequestAllOf, type ReportTaskRequestAllOfUsersToShareWith, ReportTaskRequestEmailEnum, ReportTaskRequestFrequencyEnum, type ReportTaskResponse, type ReportTaskResponseAllOf, type ReportTaskResponseAllOfGroupsSharedWith, type ReportTaskResponseAllOfUsersToShareWith, ReportTaskResponseEmailEnum, ReportTaskResponseFrequencyEnum, type ReportTaskScope, type ReportTaskScopeObjects, type ReportTaskTags, type ReportTaskTo, type ReportTaskVariables, ReportTasksApi, ReportTasksApiAxiosParamCreator, ReportTasksApiFactory, ReportTasksApiFp, ReportTypeEnum, ReportsApi, ReportsApiAxiosParamCreator, ReportsApiFactory, ReportsApiFp, type RowExclusion, type RowExclusionFieldValues, type Template, TemplateTypeEnum, TemplatesApi, TemplatesApiAxiosParamCreator, TemplatesApiFactory, TemplatesApiFp, type Visualization, VisualizationApi, VisualizationApiAxiosParamCreator, VisualizationApiFactory, VisualizationApiFp, type VisualizationSelections };
3667
+ export { BaseTemplatesApi, BaseTemplatesApiAxiosParamCreator, BaseTemplatesApiFactory, BaseTemplatesApiFp, ConnectReport, type CycleConfig, CycleConfigConfigTypeEnum, CycleConfigCycleSourceEnum, DocumentsApi, DocumentsApiAxiosParamCreator, DocumentsApiFactory, DocumentsApiFp, type FieldInfo, type FilterCycle, type FilterCycleAllOf, type FilterCycleAllOfFieldInfo, type FilterCycleAllOfFieldValues, FilterCycleEmailEnum, FilterCycleFrequencyEnum, FilterCyclesApi, FilterCyclesApiAxiosParamCreator, FilterCyclesApiFactory, FilterCyclesApiFp, type FilterMapping, ImagesApi, ImagesApiAxiosParamCreator, ImagesApiFactory, ImagesApiFp, type InlineResponse200, type InlineResponse2001, type InlineResponse2002, type InlineResponse2003, type InlineResponse2004, type Job, type JobResponse, JobsApi, JobsApiAxiosParamCreator, JobsApiFactory, JobsApiFp, type ModelError, type Report, type ReportTask, type ReportTaskCustomSelection, ReportTaskEmailEnum, type ReportTaskErrors, type ReportTaskFieldValues, type ReportTaskFilterSets, ReportTaskFrequencyEnum, type ReportTaskGroupsToShareWith, type ReportTaskMappings, type ReportTaskRequest, type ReportTaskRequestAllOf, type ReportTaskRequestAllOfUsersToShareWith, ReportTaskRequestEmailEnum, ReportTaskRequestFrequencyEnum, type ReportTaskResponse, type ReportTaskResponseAllOf, type ReportTaskResponseAllOfGroupsSharedWith, type ReportTaskResponseAllOfUsersToShareWith, ReportTaskResponseEmailEnum, ReportTaskResponseFrequencyEnum, type ReportTaskScope, type ReportTaskScopeObjects, type ReportTaskTags, type ReportTaskTo, type ReportTaskVariables, ReportTasksApi, ReportTasksApiAxiosParamCreator, ReportTasksApiFactory, ReportTasksApiFp, ReportTypeEnum, ReportsApi, ReportsApiAxiosParamCreator, ReportsApiFactory, ReportsApiFp, type RowExclusion, type RowExclusionFieldValues, type Template, TemplateTypeEnum, TemplatesApi, TemplatesApiAxiosParamCreator, TemplatesApiFactory, TemplatesApiFp, type Visualization, VisualizationApi, VisualizationApiAxiosParamCreator, VisualizationApiFactory, VisualizationApiFp, type VisualizationSelections };
package/dist/index.d.ts CHANGED
@@ -133,17 +133,29 @@ interface CycleConfig {
133
133
  */
134
134
  configType: CycleConfigConfigTypeEnum;
135
135
  /**
136
- * Data connector name (case-insensitive)
136
+ * Data source type - \'connector\' for external data connector, \'parameterSheet\' for worksheet in the template
137
137
  * @type {string}
138
138
  * @memberof CycleConfig
139
139
  */
140
- connector: string;
140
+ cycleSource?: CycleConfigCycleSourceEnum;
141
141
  /**
142
- * Data source document ID
142
+ * Name of the worksheet to read parameter rows from (required when cycleSource is \'parameterSheet\')
143
143
  * @type {string}
144
144
  * @memberof CycleConfig
145
145
  */
146
- docId: string;
146
+ parameterSheetName?: string;
147
+ /**
148
+ * Data connector name (case-insensitive, required when cycleSource is \'connector\')
149
+ * @type {string}
150
+ * @memberof CycleConfig
151
+ */
152
+ connector?: string;
153
+ /**
154
+ * Data source document ID (required when cycleSource is \'connector\')
155
+ * @type {string}
156
+ * @memberof CycleConfig
157
+ */
158
+ docId?: string;
147
159
  /**
148
160
  * Columns to query - defines what data to fetch (each row creates a child task)
149
161
  * @type {Array<FieldInfo>}
@@ -231,6 +243,14 @@ declare enum CycleConfigConfigTypeEnum {
231
243
  Filters = "filters",
232
244
  Recipients = "recipients"
233
245
  }
246
+ /**
247
+ * @export
248
+ * @enum {string}
249
+ */
250
+ declare enum CycleConfigCycleSourceEnum {
251
+ Connector = "connector",
252
+ ParameterSheet = "parameterSheet"
253
+ }
234
254
  /**
235
255
  * Field metadata from data source
236
256
  * @export
@@ -3644,4 +3664,4 @@ declare class ConnectReport {
3644
3664
  constructor(config: Pick<Configuration, "apiKey" | "basePath" | "formDataCtor" | "httpsAgent">);
3645
3665
  }
3646
3666
 
3647
- export { BaseTemplatesApi, BaseTemplatesApiAxiosParamCreator, BaseTemplatesApiFactory, BaseTemplatesApiFp, ConnectReport, type CycleConfig, CycleConfigConfigTypeEnum, DocumentsApi, DocumentsApiAxiosParamCreator, DocumentsApiFactory, DocumentsApiFp, type FieldInfo, type FilterCycle, type FilterCycleAllOf, type FilterCycleAllOfFieldInfo, type FilterCycleAllOfFieldValues, FilterCycleEmailEnum, FilterCycleFrequencyEnum, FilterCyclesApi, FilterCyclesApiAxiosParamCreator, FilterCyclesApiFactory, FilterCyclesApiFp, type FilterMapping, ImagesApi, ImagesApiAxiosParamCreator, ImagesApiFactory, ImagesApiFp, type InlineResponse200, type InlineResponse2001, type InlineResponse2002, type InlineResponse2003, type InlineResponse2004, type Job, type JobResponse, JobsApi, JobsApiAxiosParamCreator, JobsApiFactory, JobsApiFp, type ModelError, type Report, type ReportTask, type ReportTaskCustomSelection, ReportTaskEmailEnum, type ReportTaskErrors, type ReportTaskFieldValues, type ReportTaskFilterSets, ReportTaskFrequencyEnum, type ReportTaskGroupsToShareWith, type ReportTaskMappings, type ReportTaskRequest, type ReportTaskRequestAllOf, type ReportTaskRequestAllOfUsersToShareWith, ReportTaskRequestEmailEnum, ReportTaskRequestFrequencyEnum, type ReportTaskResponse, type ReportTaskResponseAllOf, type ReportTaskResponseAllOfGroupsSharedWith, type ReportTaskResponseAllOfUsersToShareWith, ReportTaskResponseEmailEnum, ReportTaskResponseFrequencyEnum, type ReportTaskScope, type ReportTaskScopeObjects, type ReportTaskTags, type ReportTaskTo, type ReportTaskVariables, ReportTasksApi, ReportTasksApiAxiosParamCreator, ReportTasksApiFactory, ReportTasksApiFp, ReportTypeEnum, ReportsApi, ReportsApiAxiosParamCreator, ReportsApiFactory, ReportsApiFp, type RowExclusion, type RowExclusionFieldValues, type Template, TemplateTypeEnum, TemplatesApi, TemplatesApiAxiosParamCreator, TemplatesApiFactory, TemplatesApiFp, type Visualization, VisualizationApi, VisualizationApiAxiosParamCreator, VisualizationApiFactory, VisualizationApiFp, type VisualizationSelections };
3667
+ export { BaseTemplatesApi, BaseTemplatesApiAxiosParamCreator, BaseTemplatesApiFactory, BaseTemplatesApiFp, ConnectReport, type CycleConfig, CycleConfigConfigTypeEnum, CycleConfigCycleSourceEnum, DocumentsApi, DocumentsApiAxiosParamCreator, DocumentsApiFactory, DocumentsApiFp, type FieldInfo, type FilterCycle, type FilterCycleAllOf, type FilterCycleAllOfFieldInfo, type FilterCycleAllOfFieldValues, FilterCycleEmailEnum, FilterCycleFrequencyEnum, FilterCyclesApi, FilterCyclesApiAxiosParamCreator, FilterCyclesApiFactory, FilterCyclesApiFp, type FilterMapping, ImagesApi, ImagesApiAxiosParamCreator, ImagesApiFactory, ImagesApiFp, type InlineResponse200, type InlineResponse2001, type InlineResponse2002, type InlineResponse2003, type InlineResponse2004, type Job, type JobResponse, JobsApi, JobsApiAxiosParamCreator, JobsApiFactory, JobsApiFp, type ModelError, type Report, type ReportTask, type ReportTaskCustomSelection, ReportTaskEmailEnum, type ReportTaskErrors, type ReportTaskFieldValues, type ReportTaskFilterSets, ReportTaskFrequencyEnum, type ReportTaskGroupsToShareWith, type ReportTaskMappings, type ReportTaskRequest, type ReportTaskRequestAllOf, type ReportTaskRequestAllOfUsersToShareWith, ReportTaskRequestEmailEnum, ReportTaskRequestFrequencyEnum, type ReportTaskResponse, type ReportTaskResponseAllOf, type ReportTaskResponseAllOfGroupsSharedWith, type ReportTaskResponseAllOfUsersToShareWith, ReportTaskResponseEmailEnum, ReportTaskResponseFrequencyEnum, type ReportTaskScope, type ReportTaskScopeObjects, type ReportTaskTags, type ReportTaskTo, type ReportTaskVariables, ReportTasksApi, ReportTasksApiAxiosParamCreator, ReportTasksApiFactory, ReportTasksApiFp, ReportTypeEnum, ReportsApi, ReportsApiAxiosParamCreator, ReportsApiFactory, ReportsApiFp, type RowExclusion, type RowExclusionFieldValues, type Template, TemplateTypeEnum, TemplatesApi, TemplatesApiAxiosParamCreator, TemplatesApiFactory, TemplatesApiFp, type Visualization, VisualizationApi, VisualizationApiAxiosParamCreator, VisualizationApiFactory, VisualizationApiFp, type VisualizationSelections };
package/dist/index.js CHANGED
@@ -145,6 +145,11 @@ var CycleConfigConfigTypeEnum = /* @__PURE__ */ ((CycleConfigConfigTypeEnum2) =>
145
145
  CycleConfigConfigTypeEnum2["Recipients"] = "recipients";
146
146
  return CycleConfigConfigTypeEnum2;
147
147
  })(CycleConfigConfigTypeEnum || {});
148
+ var CycleConfigCycleSourceEnum = /* @__PURE__ */ ((CycleConfigCycleSourceEnum2) => {
149
+ CycleConfigCycleSourceEnum2["Connector"] = "connector";
150
+ CycleConfigCycleSourceEnum2["ParameterSheet"] = "parameterSheet";
151
+ return CycleConfigCycleSourceEnum2;
152
+ })(CycleConfigCycleSourceEnum || {});
148
153
  var FilterCycleFrequencyEnum = /* @__PURE__ */ ((FilterCycleFrequencyEnum2) => {
149
154
  FilterCycleFrequencyEnum2["Monthly"] = "Monthly";
150
155
  FilterCycleFrequencyEnum2["OnceNow"] = "Once - now";
@@ -3074,6 +3079,7 @@ export {
3074
3079
  BaseTemplatesApiFp,
3075
3080
  ConnectReport,
3076
3081
  CycleConfigConfigTypeEnum,
3082
+ CycleConfigCycleSourceEnum,
3077
3083
  DocumentsApi,
3078
3084
  DocumentsApiAxiosParamCreator,
3079
3085
  DocumentsApiFactory,