@b-jones-rfd/qualtrics-api-tasks 0.3.5 → 0.3.7

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @b-jones-rfd/qualtrics-api-tasks
 
+## 0.3.7
+
+### Patch Changes
+
+- abe7e92: Update package deployment
+
+## 0.3.6
+
+### Patch Changes
+
+- 3bb9e4f: Revert list distributions params change
+
 ## 0.3.5
 
 ### Patch Changes

package/README.md

@@ -341,9 +341,9 @@ Implements [List Distributions](https://api.qualtrics.com/234bb6b16cf6d-list-dis
 
 | Property                | Type    | Description                     | Required | Default |
 | ----------------------- | ------- | ------------------------------- | -------- | ------- |
+| surveyId                | string  | Quatrics Survey ID              | Y        |         |
 | sendStartDate           | Date    | Export start date and time      | Y        |         |
 | sendEndDate             | Date    | Export end date and time        | Y        |         |
-| surveyId                | string  | Quatrics Survey ID              | N        |         |
 | mailingListId           | string  | Mailing List ID                 | N        |         |
 | distributionRequestType | string  | Distribution Request Type       | N        |         |
 | skipToken               | string  | Pagination offset               | N        |         |

package/dist/index.d.mts

@@ -120,7 +120,7 @@ type Connection = {
     listDistributions: Action<{
         sendStartDate: Date;
         sendEndDate: Date;
-        surveyId?: string;
+        surveyId: string;
         distributionRequestType?: DistributionRequestType;
         mailingListId?: string;
         skipToken?: string;
@@ -431,9 +431,9 @@ declare const importContacts: ActionFactory<StartContactsImportOptions, Contacts
  * @see https://api.qualtrics.com/234bb6b16cf6d-list-distributions
  */
 declare const listDistributions: ActionFactory<{
+    surveyId: string;
     sendStartDate: Date;
     sendEndDate: Date;
-    surveyId?: string;
     distributionRequestType?: DistributionRequestType;
     mailingListId?: string;
     skipToken?: string;

package/dist/index.d.ts

@@ -120,7 +120,7 @@ type Connection = {
     listDistributions: Action<{
         sendStartDate: Date;
         sendEndDate: Date;
-        surveyId?: string;
+        surveyId: string;
         distributionRequestType?: DistributionRequestType;
         mailingListId?: string;
         skipToken?: string;
@@ -431,9 +431,9 @@ declare const importContacts: ActionFactory<StartContactsImportOptions, Contacts
  * @see https://api.qualtrics.com/234bb6b16cf6d-list-distributions
  */
 declare const listDistributions: ActionFactory<{
+    surveyId: string;
     sendStartDate: Date;
     sendEndDate: Date;
-    surveyId?: string;
     distributionRequestType?: DistributionRequestType;
     mailingListId?: string;
     skipToken?: string;

package/dist/index.js

@@ -18,8 +18,8 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
   createConnection: () => createConnection,
   createDistribution: () => createDistribution,
   createMailingList: () => createMailingList,
@@ -39,7 +39,7 @@ __export(src_exports, {
   startResponseExport: () => startResponseExport,
   testConnection: () => testConnection
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 
 // src/utils/index.ts
 function success(data) {
@@ -394,8 +394,7 @@ var importContacts = (connectionOptions) => async (importOptions) => {
   try {
     const startImportAction = startContactsImport(connectionOptions);
     const startResponse = await startImportAction(importOptions);
-    if (!startResponse.success)
-      return failure(startResponse.error);
+    if (!startResponse.success) return failure(startResponse.error);
     const importProgressAction = getContactsImportStatus(connectionOptions);
     const progressResponse = await poll({
       fn: async () => await importProgressAction({
@@ -408,8 +407,7 @@ var importContacts = (connectionOptions) => async (importOptions) => {
       interval: 1,
       maxAttempts: 60
     });
-    if (!progressResponse.success)
-      return failure(progressResponse.error);
+    if (!progressResponse.success) return failure(progressResponse.error);
     const getContactImportSummaryAction = getContactsImportSummary(connectionOptions);
     const fileResponse = await getContactImportSummaryAction({
       directoryId: importOptions.directoryId,
@@ -435,8 +433,7 @@ var distributeSurveys = (connectionOptions) => async (options) => {
       prioritizeListMetadata: options.prioritizeListMetadata,
       bearerToken: options.bearerToken
     });
-    if (!startResponse.success)
-      return failure(startResponse.error);
+    if (!startResponse.success) return failure(startResponse.error);
     const importContactsAction = importContacts(connectionOptions);
     const importResponse = await importContactsAction({
       directoryId: options.directoryId,
@@ -445,8 +442,7 @@ var distributeSurveys = (connectionOptions) => async (options) => {
       transactionMeta: options.transactionMeta,
       bearerToken: options.bearerToken
     });
-    if (!importResponse.success)
-      return failure(importResponse.error);
+    if (!importResponse.success) return failure(importResponse.error);
     const createDistributionAction = createDistribution(connectionOptions);
     const distributionResponse = await createDistributionAction({
       libraryId: options.libraryId,
@@ -479,8 +475,7 @@ var distributeSurveys = (connectionOptions) => async (options) => {
       sendDate: options.reminderSendDate,
       bearerToken: options.bearerToken
     });
-    if (!reminderResponse.success)
-      return failure(reminderResponse.error);
+    if (!reminderResponse.success) return failure(reminderResponse.error);
     return success(reminderResponse.data);
   } catch (error) {
     const message = getErrorMessage(error);
@@ -566,8 +561,7 @@ var exportResponses = (connectionOptions) => async (responseOptions) => {
   try {
     const startResponseAction = startResponseExport(connectionOptions);
     const startResponse = await startResponseAction(responseOptions);
-    if (!startResponse.success)
-      return failure(startResponse.error);
+    if (!startResponse.success) return failure(startResponse.error);
     const exportProgressAction = getResponseExportProgress(connectionOptions);
     const progressResponse = await poll({
       fn: async () => await exportProgressAction({
@@ -579,8 +573,7 @@ var exportResponses = (connectionOptions) => async (responseOptions) => {
       interval: 1,
       maxAttempts: 60
     });
-    if (!progressResponse.success)
-      return failure(progressResponse.error);
+    if (!progressResponse.success) return failure(progressResponse.error);
     const getFileResponseAction = getResponseExportFile(connectionOptions);
     const fileResponse = await getFileResponseAction({
       surveyId: responseOptions.surveyId,
@@ -656,21 +649,17 @@ var listDistributions = (connectionOptions) => async ({
   try {
     const headers = getAuthHeaders(connectionOptions.apiToken, bearerToken);
     const qs = new URLSearchParams({
+      surveyId,
       sendStartDate: sendStartDate.toISOString(),
       sendEndDate: sendEndDate.toISOString()
     });
-    if (surveyId)
-      qs.append("surveyId", surveyId);
-    if (mailingListId)
-      qs.append("mailingListId", mailingListId);
+    if (mailingListId) qs.append("mailingListId", mailingListId);
     if (distributionRequestType)
       qs.append("distributionRequestType", distributionRequestType);
-    if (skipToken)
-      qs.append("skipToken", skipToken);
+    if (skipToken) qs.append("skipToken", skipToken);
     if (useNewPaginationScheme)
       qs.append("useNewPaginationScheme", useNewPaginationScheme.toString());
-    if (pageSize)
-      qs.append("pageSize", pageSize.toString());
+    if (pageSize) qs.append("pageSize", pageSize.toString());
     const route = `/API/v3/distributions?${qs.toString()}`;
     const config = {
       datacenterId: connectionOptions.datacenterId,
@@ -693,10 +682,8 @@ var listLibraryMessages = (connectionOptions) => async ({ libraryId, category, o
   try {
     const headers = getAuthHeaders(connectionOptions.apiToken, bearerToken);
     const qs = new URLSearchParams();
-    if (category)
-      qs.append("category", category);
-    if (offset)
-      qs.append("offset", offset.toString());
+    if (category) qs.append("category", category);
+    if (offset) qs.append("offset", offset.toString());
     const config = {
       datacenterId: connectionOptions.datacenterId,
       route: qs.size > 0 ? route + "?" + qs.toString() : route,

package/dist/index.mjs

@@ -351,8 +351,7 @@ var importContacts = (connectionOptions) => async (importOptions) => {
   try {
     const startImportAction = startContactsImport(connectionOptions);
     const startResponse = await startImportAction(importOptions);
-    if (!startResponse.success)
-      return failure(startResponse.error);
+    if (!startResponse.success) return failure(startResponse.error);
     const importProgressAction = getContactsImportStatus(connectionOptions);
     const progressResponse = await poll({
       fn: async () => await importProgressAction({
@@ -365,8 +364,7 @@ var importContacts = (connectionOptions) => async (importOptions) => {
       interval: 1,
       maxAttempts: 60
     });
-    if (!progressResponse.success)
-      return failure(progressResponse.error);
+    if (!progressResponse.success) return failure(progressResponse.error);
     const getContactImportSummaryAction = getContactsImportSummary(connectionOptions);
     const fileResponse = await getContactImportSummaryAction({
       directoryId: importOptions.directoryId,
@@ -392,8 +390,7 @@ var distributeSurveys = (connectionOptions) => async (options) => {
       prioritizeListMetadata: options.prioritizeListMetadata,
       bearerToken: options.bearerToken
     });
-    if (!startResponse.success)
-      return failure(startResponse.error);
+    if (!startResponse.success) return failure(startResponse.error);
     const importContactsAction = importContacts(connectionOptions);
     const importResponse = await importContactsAction({
       directoryId: options.directoryId,
@@ -402,8 +399,7 @@ var distributeSurveys = (connectionOptions) => async (options) => {
       transactionMeta: options.transactionMeta,
       bearerToken: options.bearerToken
     });
-    if (!importResponse.success)
-      return failure(importResponse.error);
+    if (!importResponse.success) return failure(importResponse.error);
     const createDistributionAction = createDistribution(connectionOptions);
     const distributionResponse = await createDistributionAction({
       libraryId: options.libraryId,
@@ -436,8 +432,7 @@ var distributeSurveys = (connectionOptions) => async (options) => {
       sendDate: options.reminderSendDate,
       bearerToken: options.bearerToken
     });
-    if (!reminderResponse.success)
-      return failure(reminderResponse.error);
+    if (!reminderResponse.success) return failure(reminderResponse.error);
     return success(reminderResponse.data);
   } catch (error) {
     const message = getErrorMessage(error);
@@ -523,8 +518,7 @@ var exportResponses = (connectionOptions) => async (responseOptions) => {
   try {
     const startResponseAction = startResponseExport(connectionOptions);
     const startResponse = await startResponseAction(responseOptions);
-    if (!startResponse.success)
-      return failure(startResponse.error);
+    if (!startResponse.success) return failure(startResponse.error);
     const exportProgressAction = getResponseExportProgress(connectionOptions);
     const progressResponse = await poll({
       fn: async () => await exportProgressAction({
@@ -536,8 +530,7 @@ var exportResponses = (connectionOptions) => async (responseOptions) => {
       interval: 1,
       maxAttempts: 60
     });
-    if (!progressResponse.success)
-      return failure(progressResponse.error);
+    if (!progressResponse.success) return failure(progressResponse.error);
     const getFileResponseAction = getResponseExportFile(connectionOptions);
     const fileResponse = await getFileResponseAction({
       surveyId: responseOptions.surveyId,
@@ -613,21 +606,17 @@ var listDistributions = (connectionOptions) => async ({
   try {
     const headers = getAuthHeaders(connectionOptions.apiToken, bearerToken);
     const qs = new URLSearchParams({
+      surveyId,
       sendStartDate: sendStartDate.toISOString(),
       sendEndDate: sendEndDate.toISOString()
     });
-    if (surveyId)
-      qs.append("surveyId", surveyId);
-    if (mailingListId)
-      qs.append("mailingListId", mailingListId);
+    if (mailingListId) qs.append("mailingListId", mailingListId);
     if (distributionRequestType)
       qs.append("distributionRequestType", distributionRequestType);
-    if (skipToken)
-      qs.append("skipToken", skipToken);
+    if (skipToken) qs.append("skipToken", skipToken);
     if (useNewPaginationScheme)
       qs.append("useNewPaginationScheme", useNewPaginationScheme.toString());
-    if (pageSize)
-      qs.append("pageSize", pageSize.toString());
+    if (pageSize) qs.append("pageSize", pageSize.toString());
     const route = `/API/v3/distributions?${qs.toString()}`;
     const config = {
       datacenterId: connectionOptions.datacenterId,
@@ -650,10 +639,8 @@ var listLibraryMessages = (connectionOptions) => async ({ libraryId, category, o
   try {
     const headers = getAuthHeaders(connectionOptions.apiToken, bearerToken);
     const qs = new URLSearchParams();
-    if (category)
-      qs.append("category", category);
-    if (offset)
-      qs.append("offset", offset.toString());
+    if (category) qs.append("category", category);
+    if (offset) qs.append("offset", offset.toString());
     const config = {
       datacenterId: connectionOptions.datacenterId,
       route: qs.size > 0 ? route + "?" + qs.toString() : route,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@b-jones-rfd/qualtrics-api-tasks",
-  "version": "0.3.5",
+  "version": "0.3.7",
   "description": "Perform common tasks using the Qualtrics API",
   "private": false,
   "main": "./dist/index.js",
@@ -9,6 +9,16 @@
   "keywords": [],
   "author": "B-Jones-RFD",
   "license": "MIT",
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/B-Jones-RFD/qualtrics-api-tasks.git"
+  },
   "devDependencies": {
     "@changesets/cli": "^2.27.1",
     "@types/node": "^20.11.20",
@@ -17,15 +27,12 @@
     "typescript": "^5.3.3",
     "vitest": "^1.3.1"
   },
-  "engines": {
-    "node": ">=18"
-  },
   "scripts": {
     "dev": "vitest",
     "test": "vitest run",
     "build": "tsup src/index.ts --format cjs,esm --dts",
     "lint": "tsc",
     "ci": "pnpm run lint && pnpm run test && pnpm run build",
-    "release": "pnpm run lint && pnpm run test && pnpm run build && changeset publish"
+    "release": "pnpm run build && pnpm publish -r --no-git-checks"
   }
 }

package/pnpm-workspace.yaml

@@ -0,0 +1 @@
+git-checks: false