@dbos-inc/dbos-cloud 1.0.2 → 1.1.5-preview

package/dist/src/utils.js

@@ -1,51 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.findPackageRoot = exports.sleep = exports.readFileSync = void 0;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-/*
- * Use the node.js `fs` module to read the content of a file
- * Handles cases where:
- * - the file does not exist
- * - the file is not a valid file
- **/
-function readFileSync(path, encoding = "utf8") {
-    // First, check the file
-    fs_1.default.stat(path, (error, stats) => {
-        if (error) {
-            throw new Error(`checking on ${path}. ${error.code}: ${error.errno}`);
-        }
-        else if (!stats.isFile()) {
-            throw new Error(`config file ${path} is not a file`);
-        }
-    });
-    // Then, read its content
-    const fileContent = fs_1.default.readFileSync(path, { encoding });
-    return fileContent;
-}
-exports.readFileSync = readFileSync;
-const sleep = (ms) => new Promise((r) => setTimeout(r, ms));
-exports.sleep = sleep;
-// Adapated and translated from from: https://github.com/junosuarez/find-root
-function findPackageRoot(start) {
-    if (typeof start === 'string') {
-        if (!start.endsWith(path_1.default.sep)) {
-            start += path_1.default.sep;
-        }
-        start = start.split(path_1.default.sep);
-    }
-    if (start.length === 0) {
-        throw new Error('package.json not found in path');
-    }
-    start.pop();
-    const dir = start.join(path_1.default.sep);
-    if (fs_1.default.existsSync(path_1.default.join(dir, 'package.json'))) {
-        return dir;
-    }
-    return findPackageRoot(start);
-}
-exports.findPackageRoot = findPackageRoot;
-//# sourceMappingURL=utils.js.map

package/dist/src/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../src/utils.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAoB;AACpB,gDAAwB;AAExB;;;;;IAKI;AACJ,SAAgB,YAAY,CAAC,IAAY,EAAE,WAA2B,MAAM;IAC1E,wBAAwB;IACxB,YAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,KAAmC,EAAE,KAAe,EAAE,EAAE;QACrE,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CAAC,eAAe,IAAI,KAAK,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;QACxE,CAAC;aAAM,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,eAAe,IAAI,gBAAgB,CAAC,CAAC;QACvD,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,yBAAyB;IACzB,MAAM,WAAW,GAAW,YAAE,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAE,CAAC;IACjE,OAAO,WAAW,CAAC;AACrB,CAAC;AAbD,oCAaC;AAEM,MAAM,KAAK,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;AAA9D,QAAA,KAAK,SAAyD;AAI3E,6EAA6E;AAC7E,SAAgB,eAAe,CAAC,KAAwB;IACpD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC5B,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,cAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5B,KAAK,IAAI,cAAI,CAAC,GAAG,CAAC;QACtB,CAAC;QACD,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,cAAI,CAAC,GAAG,CAAC,CAAC;IAClC,CAAC;IAED,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,GAAG,EAAE,CAAC;IACZ,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,cAAI,CAAC,GAAG,CAAC,CAAC;IAEjC,IAAI,YAAE,CAAC,UAAU,CAAC,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC;QAChD,OAAO,GAAG,CAAC;IACf,CAAC;IAED,OAAO,eAAe,CAAC,KAAK,CAAC,CAAC;AAClC,CAAC;AApBD,0CAoBC"}

package/login.ts

@@ -1,146 +0,0 @@
-import axios, { AxiosError } from "axios";
-import jwt, { JwtPayload } from 'jsonwebtoken';
-import jwksClient from 'jwks-rsa';
-import { DBOSCloudCredentials, getLogger, handleAPIErrors, isCloudAPIErrorResponse, sleep, writeCredentials } from "./cloudutils";
-import { Logger } from "winston";
-
-const DBOSCloudHost = process.env.DBOS_DOMAIN || "cloud.dbos.dev";
-const productionEnvironment = DBOSCloudHost === "cloud.dbos.dev";
-const Auth0Domain = productionEnvironment ? 'login.dbos.dev' : 'dbos-inc.us.auth0.com';
-const DBOSClientID = productionEnvironment ? '6p7Sjxf13cyLMkdwn14MxlH7JdhILled' : 'G38fLmVErczEo9ioCFjVIHea6yd0qMZu';
-const DBOSCloudIdentifier = 'dbos-cloud-api';
-
-interface DeviceCodeResponse {
-  device_code: string;
-  user_code: string;
-  verification_uri: string;
-  verification_uri_complete: string;
-  expires_in: number;
-  interval: number;
-}
-
-interface TokenResponse {
-  access_token: string;
-  token_type: string;
-  expires_in: number;
-}
-
-const client = jwksClient({
-  jwksUri: `https://${Auth0Domain}/.well-known/jwks.json`
-});
-
-async function getSigningKey(kid: string): Promise<string> {
-  const key = await client.getSigningKey(kid);
-  return key.getPublicKey();
-}
-
-async function verifyToken(token: string): Promise<JwtPayload> {
-  const decoded = jwt.decode(token, { complete: true });
-
-  if (!decoded || typeof decoded === 'string' || !decoded.header.kid) {
-    throw new Error('Invalid token');
-  }
-
-  const signingKey = await getSigningKey(decoded.header.kid);
-
-  return new Promise((resolve, reject) => {
-    jwt.verify(token, signingKey, { algorithms: ['RS256'] }, (err, verifiedToken) => {
-      if (err) {
-        reject(err);
-      } else {
-        resolve(verifiedToken as JwtPayload);
-      }
-    });
-  });
-}
-
-// Redirect a user to auth0 to authenticate, retrieving a JWT bearer token
-export async function authenticate(logger: Logger): Promise<string | null> {
-  logger.info(`Please authenticate with DBOS Cloud!`);
-
-  const deviceCodeRequest = {
-    method: 'POST',
-    url: `https://${Auth0Domain}/oauth/device/code`,
-    headers: { 'content-type': 'application/x-www-form-urlencoded' },
-    data: { client_id: DBOSClientID, scope: 'sub', audience: DBOSCloudIdentifier }
-  };
-  let deviceCodeResponse: DeviceCodeResponse | undefined;
-  try {
-    const response = await axios.request(deviceCodeRequest);
-    deviceCodeResponse = response.data as DeviceCodeResponse;
-  } catch (e) {
-    (e as Error).message = `failed to log in: ${(e as Error).message}`;
-    logger.error(e);
-  }
-  if (!deviceCodeResponse) {
-    return null;
-  }
-  console.log(`Login URL: ${deviceCodeResponse.verification_uri_complete}`);
-
-  const tokenRequest = {
-    method: 'POST',
-    url: `https://${Auth0Domain}/oauth/token`,
-    headers: { 'content-type': 'application/x-www-form-urlencoded' },
-    data: new URLSearchParams({
-      grant_type: 'urn:ietf:params:oauth:grant-type:device_code',
-      device_code: deviceCodeResponse.device_code,
-      client_id: DBOSClientID
-    })
-  };
-  let tokenResponse: TokenResponse | undefined;
-  let elapsedTimeSec = 0;
-  while (elapsedTimeSec < deviceCodeResponse.expires_in) {
-    try {
-      await sleep(deviceCodeResponse.interval * 1000)
-      elapsedTimeSec += deviceCodeResponse.interval;
-      const response = await axios.request(tokenRequest);
-      tokenResponse = response.data as TokenResponse;
-      break;
-    } catch (e) {
-      logger.info(`Waiting for login...`);
-    }
-  }
-  if (!tokenResponse) {
-    return null;
-  }
-
-  await verifyToken(tokenResponse.access_token);
-  return tokenResponse.access_token
-}
-
-export async function login(host: string): Promise<number> {
-  const logger = getLogger();
-  const token = await authenticate(logger)
-  if (token === null) {
-    return 1;
-  }
-  const bearerToken = "Bearer " + token;
-  try {
-    const response = await axios.get(
-      `https://${host}/v1alpha1/user`,
-      {
-        headers: {
-          "Content-Type": "application/json",
-          Authorization: bearerToken,
-        },
-      }
-    );
-    const username = response.data as string;
-    const credentials: DBOSCloudCredentials = {
-      token: token,
-      userName: username,
-    };
-    writeCredentials(credentials)
-    logger.info(`Successfully logged in as ${credentials.userName}!`);
-  } catch (e) {
-    const errorLabel = `Failed to login`;
-    const axiosError = e as AxiosError;
-    if (isCloudAPIErrorResponse(axiosError.response?.data)) {
-      handleAPIErrors(errorLabel, axiosError);
-    } else {
-      logger.error(`${errorLabel}: ${(e as Error).message}`);
-    }
-    return 1;
-  }
-  return 0;
-}

package/register.ts

@@ -1,89 +0,0 @@
-import axios, { AxiosError } from "axios";
-import { handleAPIErrors, getCloudCredentials, getLogger, isCloudAPIErrorResponse, credentialsExist, DBOSCloudCredentials, writeCredentials, deleteCredentials } from "./cloudutils";
-import readline from 'readline';
-import { authenticate } from "./login";
-import * as validator from 'validator';
-
-const rl = readline.createInterface({
-  input: process.stdin,
-  output: process.stdout
-});
-
-function isValidUsername(username: string): boolean {
-  if (username.length < 3 || username.length > 30) {
-    return false;
-  }
-  return validator.matches(username, "^[a-z0-9_]+$");
-}
-
-export async function registerUser(username: string, host: string): Promise<number> {
-  const logger = getLogger();
-  let givenName = "";
-  let familyName = "";
-  let company = "";
-  if (!isValidUsername(username)) {
-    logger.error("Invalid username. Usernames must be between 3 and 30 characters long and contain only lowercase letters, underscores, and numbers.")
-    return 1
-  }
-  if (!credentialsExist()) {
-    logger.info("Welcome to DBOS Cloud!")
-    logger.info("Before creating an account, please tell us a bit about yourself!")
-    const prompt = (query: string) => new Promise<string>((resolve) => rl.question(query, resolve));
-    givenName = await prompt("Enter First/Given Name: ");
-    familyName = await prompt("Enter Last/Family Name: ");
-    company = await prompt("Enter Company: ");
-    const bearerToken = await authenticate(logger);
-    if (bearerToken === null) {
-      return 1
-    }
-    const credentials: DBOSCloudCredentials = {
-      token: bearerToken,
-      userName: username,
-    };
-    writeCredentials(credentials)
-  } else {
-    const userCredentials = getCloudCredentials();
-    if (userCredentials.userName !== username) {
-      logger.error(`You are trying to register ${username}, but are currently authenticated as ${userCredentials.userName}. Please run "npx dbos-cloud logout".`)
-      return 1;
-    } else {
-      logger.info(`You are currently authenticated as ${userCredentials.userName}.  Registering ${userCredentials.userName} with DBOS Cloud...`)
-    }
-  }
-
-  const userCredentials = getCloudCredentials();
-  const bearerToken = "Bearer " + userCredentials.token;
-  const loginName = userCredentials.userName;
-  try {
-    // Register the user in DBOS Cloud
-    await axios.put(
-      `https://${host}/v1alpha1/user`,
-      {
-        name: loginName,
-        given_name: givenName,
-        family_name: familyName,
-        company: company,
-      },
-      {
-        headers: {
-          "Content-Type": "application/json",
-          Authorization: bearerToken,
-        },
-      }
-    );
-    logger.info(`${username} successfully registered!`);
-  } catch (e) {
-    const errorLabel = `Failed to register user ${loginName}`;
-    const axiosError = e as AxiosError;
-    if (isCloudAPIErrorResponse(axiosError.response?.data)) {
-      handleAPIErrors(errorLabel, axiosError);
-    } else {
-      logger.error(`${errorLabel}: ${(e as Error).message}`);
-    }
-    if (credentialsExist()) {
-      deleteCredentials();
-    }
-    return 1;
-  }
-  return 0;
-}

package/tsconfig.json

@@ -1,22 +0,0 @@
-/* Visit https://aka.ms/tsconfig to read more about this file */
-{
-  "compilerOptions": {
-    "target": "esnext",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
-    "experimentalDecorators": true,                      /* Enable experimental support for legacy experimental decorators. */
-    "emitDecoratorMetadata": true,                       /* Emit design-type metadata for decorated declarations in source files. */
-    "module": "commonjs",                                /* Specify what module code is generated. */
-    "declaration": true,                                 /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
-    "declarationMap": true,                              /* Create sourcemaps for d.ts files. */
-    "sourceMap": true,                                   /* Create source map files for emitted JavaScript files. */
-    "outDir": "./dist",                                  /* Specify an output folder for all emitted files. */
-    "newLine": "lf",                                     /* Set the newline character for emitting files. */
-    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
-    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
-    "strict": true,                                      /* Enable all strict type-checking options. */
-    "skipLibCheck": true,                                /* Skip type checking all .d.ts files. */
-  },
-  "include": [                                         /* Specifies an array of filenames or patterns to include in the program. */
-    ".",
-    "applications"
-  ],
-}

package/userdb.ts

@@ -1,191 +0,0 @@
-import axios, { AxiosError } from "axios";
-import { isCloudAPIErrorResponse, handleAPIErrors, getCloudCredentials, getLogger } from "./cloudutils";
-import { sleep } from "../../src/utils";
-
-export interface UserDBInstance {
-  readonly PostgresInstanceName: string;
-  readonly Status: string;
-  readonly HostName: string;
-  readonly Port: number;
-  readonly AdminUsername: string; /* TODO: Remove */
-  readonly DatabaseUsername: string;
-}
-
-export async function createUserDb(host: string, dbName: string, appDBUsername: string, appDBPassword: string, sync: boolean) {
-  const logger = getLogger();
-  const userCredentials = getCloudCredentials();
-  const bearerToken = "Bearer " + userCredentials.token;
-
-  try {
-    await axios.post(
-      `https://${host}/v1alpha1/${userCredentials.userName}/databases/userdb`,
-      { Name: dbName, AdminName: appDBUsername, AdminPassword: appDBPassword },
-      {
-        headers: {
-          "Content-Type": "application/json",
-          Authorization: bearerToken,
-        },
-      }
-    );
-
-    logger.info(`Successfully started provisioning database: ${dbName}`);
-
-    if (sync) {
-      let status = "";
-      while (status != "available" && status != "backing-up") {
-        await sleep(30000);
-        const userDBInfo = await getUserDBInfo(host, dbName);
-        logger.info(userDBInfo);
-        status = userDBInfo.Status;
-      }
-    }
-    logger.info(`Database successfully provisioned!`)
-    return 0;
-  } catch (e) {
-    const errorLabel = `Failed to create database ${dbName}`;
-    const axiosError = e as AxiosError;
-    if (isCloudAPIErrorResponse(axiosError.response?.data)) {
-        handleAPIErrors(errorLabel, axiosError);
-    } else {
-      logger.error(`${errorLabel}: ${(e as Error).message}`);
-    }
-    return 1;
-  }
-}
-
-export async function deleteUserDb(host: string, dbName: string) {
-  const logger = getLogger();
-  const userCredentials = getCloudCredentials();
-  const bearerToken = "Bearer " + userCredentials.token;
-
-  try {
-    await axios.delete(`https://${host}/v1alpha1/${userCredentials.userName}/databases/userdb/${dbName}`, {
-      headers: {
-        "Content-Type": "application/json",
-        Authorization: bearerToken,
-      },
-    });
-    logger.info(`Database deleted: ${dbName}`);
-    return 0;
-  } catch (e) {
-    const errorLabel = `Failed to delete database ${dbName}`;
-    const axiosError = e as AxiosError;
-    if (isCloudAPIErrorResponse(axiosError.response?.data)) {
-        handleAPIErrors(errorLabel, axiosError);
-    } else {
-      logger.error(`${errorLabel}: ${(e as Error).message}`);
-    }
-    return 1;
-  }
-}
-
-export async function getUserDb(host: string, dbName: string, json: boolean) {
-  const logger = getLogger();
-
-  try {
-    const userDBInfo = await getUserDBInfo(host, dbName);
-    if (json) {
-      console.log(JSON.stringify(userDBInfo));
-    } else {
-      console.log(`Postgres Instance Name: ${userDBInfo.PostgresInstanceName}`);
-      console.log(`Status: ${userDBInfo.Status}`);
-      console.log(`Host Name: ${userDBInfo.HostName}`);
-      console.log(`Port: ${userDBInfo.Port}`);
-      console.log(`Database Username: ${userDBInfo.AdminUsername}`); /* TODO: DatabaseUsername */
-    }
-    return 0;
-  } catch (e) {
-    const errorLabel = `Failed to retrieve database record ${dbName}`;
-    const axiosError = e as AxiosError;
-    if (isCloudAPIErrorResponse(axiosError.response?.data)) {
-        handleAPIErrors(errorLabel, axiosError);
-    } else {
-      logger.error(`${errorLabel}: ${(e as Error).message}`);
-    }
-    return 1;
-  }
-}
-
-export async function listUserDB(host: string, json: boolean) {
-  const logger = getLogger();
-
-  try {
-    const userCredentials = getCloudCredentials();
-    const bearerToken = "Bearer " + userCredentials.token;
-  
-    const res = await axios.get(`https://${host}/v1alpha1/${userCredentials.userName}/databases`, {
-      headers: {
-        "Content-Type": "application/json",
-        Authorization: bearerToken,
-      },
-    });
-
-    const userDBs = res.data as UserDBInstance[];
-    if (json) {
-      console.log(JSON.stringify(userDBs));
-    } else {
-      if (userDBs.length === 0) {
-        logger.info("No database instances found");
-      }
-      userDBs.forEach(userDBInfo => {
-        console.log(`Postgres Instance Name: ${userDBInfo.PostgresInstanceName}`);
-        console.log(`Status: ${userDBInfo.Status}`);
-        console.log(`Host Name: ${userDBInfo.HostName}`);
-        console.log(`Port: ${userDBInfo.Port}`);
-        console.log(`Database Username: ${userDBInfo.AdminUsername}`); /* TODO: DatabaseUsername */
-      });
-    }
-    return 0;
-  } catch (e) {
-    const errorLabel = `Failed to retrieve info`;
-    const axiosError = e as AxiosError;
-    if (isCloudAPIErrorResponse(axiosError.response?.data)) {
-        handleAPIErrors(errorLabel, axiosError);
-    } else {
-      logger.error(`${errorLabel}: ${(e as Error).message}`);
-    }
-    return 1;
-  }
-}
-
-export async function getUserDBInfo(host: string, dbName: string): Promise<UserDBInstance> {
-  const userCredentials = getCloudCredentials();
-  const bearerToken = "Bearer " + userCredentials.token;
-
-  const res = await axios.get(`https://${host}/v1alpha1/${userCredentials.userName}/databases/userdb/info/${dbName}`, {
-    headers: {
-      "Content-Type": "application/json",
-      Authorization: bearerToken,
-    },
-  });
-
-  return res.data as UserDBInstance;
-}
-
-export async function resetDBCredentials(host: string, dbName: string, appDBPassword: string) {
-  const logger = getLogger();
-  const userCredentials = getCloudCredentials();
-  const bearerToken = "Bearer " + userCredentials.token;
-
-  try {
-    await axios.post(`https://${host}/v1alpha1/${userCredentials.userName}/databases/userdb/${dbName}/credentials`,
-    { Name: dbName, Password: appDBPassword },
-    {
-      headers: {
-        "Content-Type": "application/json",
-        Authorization: bearerToken,
-      },
-    });
-    logger.info(`Successfully reset user password for database: ${dbName}`);
-    return 0;
-  } catch (e) {
-    const errorLabel = `Failed to reset user password for database ${dbName}`;
-    const axiosError = e as AxiosError;
-    if (isCloudAPIErrorResponse(axiosError.response?.data)) {
-        handleAPIErrors(errorLabel, axiosError);
-    } else {
-      logger.error(`${errorLabel}: ${(e as Error).message}`);
-    }
-    return 1;
-  }
-}