@dataformer/env-service 2.4.0 → 3.0.1

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @dataformer/env-service
 
+## 3.0.1
+
+### Patch Changes
+
+- Add @dataformer/confluence-client - Confluence REST API v2 client
+
+  New package with:
+
+  - Page CRUD operations (create, read, update, delete)
+  - Space listing and discovery methods
+  - Default space configuration support
+  - Atlas Document Format (ADF) body format support
+  - Cursor-based pagination for listing operations
+
+  Also updates @dataformer/env-service with Confluence configuration methods:
+
+  - setConfluenceApiToken
+  - setConfluenceApiBaseUrl
+  - setConfluenceUserEmail
+  - setConfluenceDefaultSpaceId
+
+## 3.0.0
+
+### Major Changes
+
+- change setSearchEngineId method to setCustomSearchEngineId
+
 ## 2.4.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -2,7 +2,7 @@ declare const askQuestion: (question: string, defaultValue?: string) => Promise<
 declare function obfuscateCred(cred: string | null): string;
 declare function getEnvVar(baseSecretKey: string): Promise<string | null>;
 declare function getCustomSearchApiKey(): Promise<string>;
-declare function getSearchEngineId(): Promise<string>;
+declare function getCustomSearchEngineId(): Promise<string>;
 declare function getGcpProjectId(): Promise<string>;
 declare function setEnvVar(baseSecretKey: string, value: string): Promise<boolean>;
 declare const setLogToConsole: () => Promise<void>;
@@ -20,9 +20,14 @@ declare const setBigtableProjectId: () => Promise<void>;
 declare const setJiraApiToken: () => Promise<void>;
 declare const setJiraApiBaseUrl: () => Promise<void>;
 declare const setJiraUserEmail: () => Promise<void>;
+declare const setConfluenceApiToken: () => Promise<void>;
+declare const setConfluenceApiBaseUrl: () => Promise<void>;
+declare const setConfluenceUserEmail: () => Promise<void>;
+declare const setConfluenceDefaultSpaceId: () => Promise<void>;
 declare const setGeminiApiKey: () => Promise<void>;
 declare const setNpmToken: () => Promise<void>;
 declare const setCustomSearchApiKey: () => Promise<void>;
+declare const setCustomSearchEngineId: () => Promise<void>;
 declare const setFirestoreProjectId: () => Promise<void>;
 declare const getLogToConsole: () => Promise<string | null>;
 declare const getPostgresUser: () => Promise<string | null>;
@@ -40,10 +45,14 @@ declare const getFirestoreProjectId: () => Promise<string | null>;
 declare const getJiraApiToken: () => Promise<string | null>;
 declare const getJiraApiBaseUrl: () => Promise<string | null>;
 declare const getJiraUserEmail: () => Promise<string | null>;
+declare const getConfluenceApiToken: () => Promise<string | null>;
+declare const getConfluenceApiBaseUrl: () => Promise<string | null>;
+declare const getConfluenceUserEmail: () => Promise<string | null>;
+declare const getConfluenceDefaultSpaceId: () => Promise<string | null>;
 declare const getGeminiApiKey: () => Promise<string | null>;
 declare const getNpmToken: () => Promise<string | null>;
 declare const getProjectRoot: () => string;
 declare const printEnv: () => Promise<void>;
 declare const run: () => Promise<void>;
 
-export { askQuestion, getBigtableInstanceName, getBigtableProjectId, getBigtableTableName, getCustomSearchApiKey, getEnvVar, getFirestoreProjectId, getGcpProjectId, getGeminiApiKey, getJiraApiBaseUrl, getJiraApiToken, getJiraUserEmail, getLogToConsole, getNpmToken, getPostgresAuthType, getPostgresDatabase, getPostgresHostName, getPostgresInstanceConnectionName, getPostgresIpType, getPostgresPassword, getPostgresPoolSizeMax, getPostgresUser, getProjectRoot, getSearchEngineId, obfuscateCred, printEnv, run, setBigtableInstanceName, setBigtableProjectId, setBigtableTableName, setCustomSearchApiKey, setEnvVar, setFirestoreProjectId, setGeminiApiKey, setJiraApiBaseUrl, setJiraApiToken, setJiraUserEmail, setLogToConsole, setNpmToken, setPostgresAuthType, setPostgresDatabase, setPostgresHostName, setPostgresInstanceConnectionName, setPostgresIpType, setPostgresPassword, setPostgresPoolSizeMax, setPostgresUser };
+export { askQuestion, getBigtableInstanceName, getBigtableProjectId, getBigtableTableName, getConfluenceApiBaseUrl, getConfluenceApiToken, getConfluenceDefaultSpaceId, getConfluenceUserEmail, getCustomSearchApiKey, getCustomSearchEngineId, getEnvVar, getFirestoreProjectId, getGcpProjectId, getGeminiApiKey, getJiraApiBaseUrl, getJiraApiToken, getJiraUserEmail, getLogToConsole, getNpmToken, getPostgresAuthType, getPostgresDatabase, getPostgresHostName, getPostgresInstanceConnectionName, getPostgresIpType, getPostgresPassword, getPostgresPoolSizeMax, getPostgresUser, getProjectRoot, obfuscateCred, printEnv, run, setBigtableInstanceName, setBigtableProjectId, setBigtableTableName, setConfluenceApiBaseUrl, setConfluenceApiToken, setConfluenceDefaultSpaceId, setConfluenceUserEmail, setCustomSearchApiKey, setCustomSearchEngineId, setEnvVar, setFirestoreProjectId, setGeminiApiKey, setJiraApiBaseUrl, setJiraApiToken, setJiraUserEmail, setLogToConsole, setNpmToken, setPostgresAuthType, setPostgresDatabase, setPostgresHostName, setPostgresInstanceConnectionName, setPostgresIpType, setPostgresPassword, setPostgresPoolSizeMax, setPostgresUser };

package/dist/index.js

@@ -104,10 +104,10 @@ async function getCustomSearchApiKey() {
   }
   return apiKey;
 }
-async function getSearchEngineId() {
-  const searchEngineId = await getEnvVar("SEARCH_ENGINE_ID");
+async function getCustomSearchEngineId() {
+  const searchEngineId = await getEnvVar("CUSTOM_SEARCH_ENGINE_ID");
   if (!searchEngineId) {
-    throw new Error("SEARCH_ENGINE_ID not found in environment variables.");
+    throw new Error("CUSTOM_SEARCH_ENGINE_ID not found in environment variables.");
   }
   return searchEngineId;
 }
@@ -271,6 +271,30 @@ var setJiraUserEmail = async () => {
     await setEnvVar("JIRA_USER_EMAIL", jiraUserEmail);
   }
 };
+var setConfluenceApiToken = async () => {
+  const confluenceApiToken = await askQuestion("Enter Confluence API token", "");
+  if (confluenceApiToken) {
+    await setEnvVar("CONFLUENCE_API_TOKEN", confluenceApiToken);
+  }
+};
+var setConfluenceApiBaseUrl = async () => {
+  const confluenceApiBaseUrl = await askQuestion("Enter Confluence API Base URL (e.g., https://yoursite.atlassian.net)", "");
+  if (confluenceApiBaseUrl) {
+    await setEnvVar("CONFLUENCE_API_BASE_URL", confluenceApiBaseUrl);
+  }
+};
+var setConfluenceUserEmail = async () => {
+  const confluenceUserEmail = await askQuestion("Enter Confluence user email", "you@domain.com");
+  if (confluenceUserEmail) {
+    await setEnvVar("CONFLUENCE_USER_EMAIL", confluenceUserEmail);
+  }
+};
+var setConfluenceDefaultSpaceId = async () => {
+  const confluenceDefaultSpaceId = await askQuestion("Enter Confluence default Space ID (numeric ID from space URL)", "");
+  if (confluenceDefaultSpaceId) {
+    await setEnvVar("CONFLUENCE_DEFAULT_SPACE_ID", confluenceDefaultSpaceId);
+  }
+};
 var setGeminiApiKey = async () => {
   const apiKey = await askQuestion("Enter Gemini API key:");
   if (apiKey) await setEnvVar("GEMINI_API_KEY", apiKey);
@@ -285,6 +309,12 @@ var setCustomSearchApiKey = async () => {
     await setEnvVar("CUSTOM_SEARCH_API_KEY", customSearchApiKey);
   }
 };
+var setCustomSearchEngineId = async () => {
+  const customSearchEngineId = await askQuestion("Enter Custom Search Engine ID", "");
+  if (customSearchEngineId) {
+    await setEnvVar("CUSTOM_SEARCH_ENGINE_ID", customSearchEngineId);
+  }
+};
 var setFirestoreProjectId = async () => {
   const firestoreProjectId = await askQuestion("Enter Firestore Project ID", "dataformer-prod");
   if (firestoreProjectId) {
@@ -311,6 +341,10 @@ var getFirestoreProjectId = _getFirestoreProjectId;
 var getJiraApiToken = async () => await getEnvVar("JIRA_API_TOKEN");
 var getJiraApiBaseUrl = async () => await getEnvVar("JIRA_API_BASE_URL");
 var getJiraUserEmail = async () => await getEnvVar("JIRA_USER_EMAIL");
+var getConfluenceApiToken = async () => await getEnvVar("CONFLUENCE_API_TOKEN");
+var getConfluenceApiBaseUrl = async () => await getEnvVar("CONFLUENCE_API_BASE_URL");
+var getConfluenceUserEmail = async () => await getEnvVar("CONFLUENCE_USER_EMAIL");
+var getConfluenceDefaultSpaceId = async () => await getEnvVar("CONFLUENCE_DEFAULT_SPACE_ID");
 var getGeminiApiKey = async () => await getEnvVar("GEMINI_API_KEY");
 var getNpmToken = async () => await getEnvVar("NPM_TOKEN");
 var getProjectRoot = () => {
@@ -334,8 +368,13 @@ var printEnv = async () => {
   const jiraApiToken = await getJiraApiToken();
   const jiraApiBaseUrl = await getJiraApiBaseUrl();
   const jiraUserEmail = await getJiraUserEmail();
+  const confluenceApiToken = await getConfluenceApiToken();
+  const confluenceApiBaseUrl = await getConfluenceApiBaseUrl();
+  const confluenceUserEmail = await getConfluenceUserEmail();
+  const confluenceDefaultSpaceId = await getConfluenceDefaultSpaceId();
   const geminiApiKey = await getGeminiApiKey();
   const customSearchApiKey = await getCustomSearchApiKey();
+  const customSearchEngineId = await getCustomSearchEngineId();
   const gcpProjectIdVal = await getGcpProjectId();
   const npmToken = await getNpmToken();
   console.log(`Project Root: ${getProjectRoot()}`);
@@ -356,7 +395,12 @@ var printEnv = async () => {
   console.log(`Jira API Token: ${obfuscateCred(jiraApiToken)}`);
   console.log(`Jira API Base URL: ${jiraApiBaseUrl}`);
   console.log(`Jira User Email: ${jiraUserEmail}`);
+  console.log(`Confluence API Token: ${obfuscateCred(confluenceApiToken)}`);
+  console.log(`Confluence API Base URL: ${confluenceApiBaseUrl}`);
+  console.log(`Confluence User Email: ${confluenceUserEmail}`);
+  console.log(`Confluence Default Space ID: ${confluenceDefaultSpaceId}`);
   console.log(`Custom Search API Key: ${obfuscateCred(customSearchApiKey)}`);
+  console.log(`Custom Search Engine ID: ${customSearchEngineId}`);
   console.log(`Gemini API Key: ${obfuscateCred(geminiApiKey)}`);
   console.log(`NPM Token: ${obfuscateCred(npmToken)}`);
 };
@@ -411,6 +455,18 @@ var run = async () => {
     case "setJiraUserEmail":
       await setJiraUserEmail();
       break;
+    case "setConfluenceApiToken":
+      await setConfluenceApiToken();
+      break;
+    case "setConfluenceApiBaseUrl":
+      await setConfluenceApiBaseUrl();
+      break;
+    case "setConfluenceUserEmail":
+      await setConfluenceUserEmail();
+      break;
+    case "setConfluenceDefaultSpaceId":
+      await setConfluenceDefaultSpaceId();
+      break;
     case "setGeminiApiKey":
       await setGeminiApiKey();
       break;
@@ -420,6 +476,9 @@ var run = async () => {
     case "setCustomSearchApiKey":
       await setCustomSearchApiKey();
       break;
+    case "setCustomSearchEngineId":
+      await setCustomSearchEngineId();
+      break;
     case "printEnv":
       await printEnv();
       break;
@@ -440,7 +499,12 @@ export {
   getBigtableInstanceName,
   getBigtableProjectId,
   getBigtableTableName,
+  getConfluenceApiBaseUrl,
+  getConfluenceApiToken,
+  getConfluenceDefaultSpaceId,
+  getConfluenceUserEmail,
   getCustomSearchApiKey,
+  getCustomSearchEngineId,
   getEnvVar,
   getFirestoreProjectId,
   getGcpProjectId,
@@ -459,14 +523,18 @@ export {
   getPostgresPoolSizeMax,
   getPostgresUser,
   getProjectRoot,
-  getSearchEngineId,
   obfuscateCred,
   printEnv,
   run,
   setBigtableInstanceName,
   setBigtableProjectId,
   setBigtableTableName,
+  setConfluenceApiBaseUrl,
+  setConfluenceApiToken,
+  setConfluenceDefaultSpaceId,
+  setConfluenceUserEmail,
   setCustomSearchApiKey,
+  setCustomSearchEngineId,
   setEnvVar,
   setFirestoreProjectId,
   setGeminiApiKey,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dataformer/env-service",
-  "version": "2.4.0",
+  "version": "3.0.1",
   "description": "Environment service for Dataformer",
   "type": "module",
   "main": "dist/index.js",
@@ -11,6 +11,11 @@
       "types": "./dist/index.d.ts"
     }
   },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts --clean",
+    "dev": "tsup src/index.ts --format esm --dts --watch",
+    "prepublish": "pnpm run build"
+  },
   "dependencies": {
     "@google-cloud/secret-manager": "^5.4.0"
   },
@@ -20,10 +25,5 @@
   },
   "peerDependencies": {
     "typescript": "^5.0.0"
-  },
-  "scripts": {
-    "build": "tsup src/index.ts --format esm --dts --clean",
-    "dev": "tsup src/index.ts --format esm --dts --watch",
-    "prepublish": "pnpm run build"
   }
-}
+}

package/src/index.ts

@@ -174,10 +174,10 @@ export async function getCustomSearchApiKey(): Promise<string> {
   return apiKey;
 }
 
-export async function getSearchEngineId(): Promise<string> {
-  const searchEngineId = await getEnvVar('SEARCH_ENGINE_ID');
+export async function getCustomSearchEngineId(): Promise<string> {
+  const searchEngineId = await getEnvVar('CUSTOM_SEARCH_ENGINE_ID');
   if (!searchEngineId) {
-    throw new Error('SEARCH_ENGINE_ID not found in environment variables.');
+    throw new Error('CUSTOM_SEARCH_ENGINE_ID not found in environment variables.');
   }
   return searchEngineId;
 }
@@ -374,6 +374,34 @@ const setJiraUserEmail = async (): Promise<void> => {
   }
 };
 
+const setConfluenceApiToken = async (): Promise<void> => {
+  const confluenceApiToken = await askQuestion('Enter Confluence API token', '');
+  if (confluenceApiToken) {
+    await setEnvVar('CONFLUENCE_API_TOKEN', confluenceApiToken);
+  }
+};
+
+const setConfluenceApiBaseUrl = async (): Promise<void> => {
+  const confluenceApiBaseUrl = await askQuestion('Enter Confluence API Base URL (e.g., https://yoursite.atlassian.net)', '');
+  if (confluenceApiBaseUrl) {
+    await setEnvVar('CONFLUENCE_API_BASE_URL', confluenceApiBaseUrl);
+  }
+};
+
+const setConfluenceUserEmail = async (): Promise<void> => {
+  const confluenceUserEmail = await askQuestion('Enter Confluence user email', 'you@domain.com');
+  if (confluenceUserEmail) {
+    await setEnvVar('CONFLUENCE_USER_EMAIL', confluenceUserEmail);
+  }
+};
+
+const setConfluenceDefaultSpaceId = async (): Promise<void> => {
+  const confluenceDefaultSpaceId = await askQuestion('Enter Confluence default Space ID (numeric ID from space URL)', '');
+  if (confluenceDefaultSpaceId) {
+    await setEnvVar('CONFLUENCE_DEFAULT_SPACE_ID', confluenceDefaultSpaceId);
+  }
+};
+
 const setGeminiApiKey = async (): Promise<void> => {
   const apiKey = await askQuestion('Enter Gemini API key:');
   if (apiKey) await setEnvVar('GEMINI_API_KEY', apiKey);
@@ -391,6 +419,13 @@ const setCustomSearchApiKey = async (): Promise<void> => {
   }
 };
 
+const setCustomSearchEngineId = async (): Promise<void> => {
+  const customSearchEngineId = await askQuestion('Enter Custom Search Engine ID', '');
+  if (customSearchEngineId) {
+      await setEnvVar('CUSTOM_SEARCH_ENGINE_ID', customSearchEngineId);
+  }
+};
+
 const setFirestoreProjectId = async (): Promise<void> => {
   const firestoreProjectId = await askQuestion('Enter Firestore Project ID', 'dataformer-prod');
   if (firestoreProjectId) {
@@ -421,6 +456,10 @@ export const getFirestoreProjectId = _getFirestoreProjectId;
 const getJiraApiToken = async (): Promise<string | null> => await getEnvVar('JIRA_API_TOKEN');
 const getJiraApiBaseUrl = async (): Promise<string | null> => await getEnvVar('JIRA_API_BASE_URL');
 const getJiraUserEmail = async (): Promise<string | null> => await getEnvVar('JIRA_USER_EMAIL');
+const getConfluenceApiToken = async (): Promise<string | null> => await getEnvVar('CONFLUENCE_API_TOKEN');
+const getConfluenceApiBaseUrl = async (): Promise<string | null> => await getEnvVar('CONFLUENCE_API_BASE_URL');
+const getConfluenceUserEmail = async (): Promise<string | null> => await getEnvVar('CONFLUENCE_USER_EMAIL');
+const getConfluenceDefaultSpaceId = async (): Promise<string | null> => await getEnvVar('CONFLUENCE_DEFAULT_SPACE_ID');
 const getGeminiApiKey = async (): Promise<string | null> => await getEnvVar('GEMINI_API_KEY');
 const getNpmToken = async (): Promise<string | null> => await getEnvVar('NPM_TOKEN');
 
@@ -457,8 +496,13 @@ const printEnv = async (): Promise<void> => {
   const jiraApiToken = await getJiraApiToken();
   const jiraApiBaseUrl = await getJiraApiBaseUrl();
   const jiraUserEmail = await getJiraUserEmail();
+  const confluenceApiToken = await getConfluenceApiToken();
+  const confluenceApiBaseUrl = await getConfluenceApiBaseUrl();
+  const confluenceUserEmail = await getConfluenceUserEmail();
+  const confluenceDefaultSpaceId = await getConfluenceDefaultSpaceId();
   const geminiApiKey = await getGeminiApiKey();
   const customSearchApiKey = await getCustomSearchApiKey();
+  const customSearchEngineId = await getCustomSearchEngineId();
   const gcpProjectIdVal = await getGcpProjectId(); 
   const npmToken = await getNpmToken();
 
@@ -480,7 +524,12 @@ const printEnv = async (): Promise<void> => {
   console.log(`Jira API Token: ${obfuscateCred(jiraApiToken)}`);
   console.log(`Jira API Base URL: ${jiraApiBaseUrl}`);
   console.log(`Jira User Email: ${jiraUserEmail}`);
+  console.log(`Confluence API Token: ${obfuscateCred(confluenceApiToken)}`);
+  console.log(`Confluence API Base URL: ${confluenceApiBaseUrl}`);
+  console.log(`Confluence User Email: ${confluenceUserEmail}`);
+  console.log(`Confluence Default Space ID: ${confluenceDefaultSpaceId}`);
   console.log(`Custom Search API Key: ${obfuscateCred(customSearchApiKey)}`);
+  console.log(`Custom Search Engine ID: ${customSearchEngineId}`);
   console.log(`Gemini API Key: ${obfuscateCred(geminiApiKey)}`);
   console.log(`NPM Token: ${obfuscateCred(npmToken)}`);
 };
@@ -504,9 +553,14 @@ const run = async (): Promise<void> => {
     case 'setJiraApiToken': await setJiraApiToken(); break;
     case 'setJiraApiBaseUrl': await setJiraApiBaseUrl(); break;
     case 'setJiraUserEmail': await setJiraUserEmail(); break;
+    case 'setConfluenceApiToken': await setConfluenceApiToken(); break;
+    case 'setConfluenceApiBaseUrl': await setConfluenceApiBaseUrl(); break;
+    case 'setConfluenceUserEmail': await setConfluenceUserEmail(); break;
+    case 'setConfluenceDefaultSpaceId': await setConfluenceDefaultSpaceId(); break;
     case 'setGeminiApiKey': await setGeminiApiKey(); break;
     case 'setNpmToken': await setNpmToken(); break;
     case 'setCustomSearchApiKey': await setCustomSearchApiKey(); break;
+    case 'setCustomSearchEngineId': await setCustomSearchEngineId(); break;
     case 'printEnv': await printEnv(); break;
     default: console.log('Unknown command. Available commands: setEnv, setBearerToken, ..., printEnv');
   }
@@ -545,9 +599,14 @@ export {
   setJiraApiToken,
   setJiraApiBaseUrl,
   setJiraUserEmail,
+  setConfluenceApiToken,
+  setConfluenceApiBaseUrl,
+  setConfluenceUserEmail,
+  setConfluenceDefaultSpaceId,
   setGeminiApiKey,
   setNpmToken,
   setCustomSearchApiKey,
+  setCustomSearchEngineId,
 
   // Getters
   getLogToConsole,
@@ -565,6 +624,10 @@ export {
   getJiraApiToken,
   getJiraApiBaseUrl,
   getJiraUserEmail,
+  getConfluenceApiToken,
+  getConfluenceApiBaseUrl,
+  getConfluenceUserEmail,
+  getConfluenceDefaultSpaceId,
   getGeminiApiKey,
   getNpmToken,