idea-aws 4.4.3 → 4.4.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "idea-aws",
-  "version": "4.4.3",
+  "version": "4.4.4",
   "description": "AWS wrappers to use in IDEA's back-ends",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/.prettierrc

@@ -1,9 +0,0 @@
-{
-  "printWidth": 120,
-  "tabWidth": 2,
-  "semi": true,
-  "singleQuote": true,
-  "arrowParens": "avoid",
-  "trailingComma": "none",
-  "jsxBracketSameLine": false
-}

package/.vscode/settings.json

@@ -1,26 +0,0 @@
-// Place your settings in this file to overwrite the default settings
-{
-  "editor.tabSize": 2,
-  "editor.rulers": [120],
-  "editor.wordWrapColumn": 120,
-  "editor.wordWrap": "bounded",
-  "files.eol": "\n",
-  "files.exclude": {
-    "**/.git": true,
-    "**/.svn": true,
-    "**/.hg": true,
-    "**/.DS_Store": true,
-    "**/*.map": true,
-    "node_modules": true,
-    "npm-debug.log": true,
-    "www": true,
-    ".vs": true
-  },
-  "files.trimTrailingWhitespace": true,
-  "git.confirmSync": false,
-  "editor.renderLineHighlight": "all",
-  "workbench.iconTheme": "vs-seti",
-  "window.zoomLevel": 0,
-  "extensions.ignoreRecommendations": false,
-  "editor.guides.indentation": true
-}

package/HOW-TO-RELEASE.md

@@ -1,8 +0,0 @@
-# Release a new version on npm
-
-1. `npm run build` to compile Typescript, check for errors and update the docs.
-1. Pull request of the branch with the changes (GitHub).
-1. When the pull is confirmed and the code is merged, update the versions in the files (find and replace, e.g. 0.0.1 -> 0.0.2).
-1. Commit the files changed in the previous point and commit them using the name of the version
-   as commit description (e.g. v0.0.2).
-1. Release the new version on npm with `npm run publishPackage`.

package/build.sh

@@ -1,21 +0,0 @@
-#!/bin/bash
-
-# other parameters
-SRC_FOLDER='./src'
-C='\033[4;32m' # color
-NC='\033[0m'   # reset (no color)
-
-# set the script to exit in case of errors
-set -o errexit
-
-# lint the code in search for errors
-echo -e "${C}Linting...${NC}"
-npm run lint ${SRC_FOLDER} 1>/dev/null
-
-# compile the project's typescript code
-echo -e "${C}Compiling...${NC}"
-npm run compile 1>/dev/null
-
-# generate documentation
-echo -e "${C}Documenting...${NC}"
-npm run docs 1>/dev/null

package/dist/src/attachments.d.ts

@@ -1,27 +0,0 @@
-import { SignedURL } from 'idea-toolbox';
-import { DynamoDB } from './dynamoDB';
-import { S3 } from './s3';
-/**
- * A custom class that takes advantage of DynamoDB and S3 to easily manage attachments.
- */
-export declare class Attachments {
-    protected ddb: DynamoDB;
-    protected s3: S3;
-    /**
-     * The bucket where from to retrieve the attachments. Fallback to IDEA's default one.
-     */
-    protected S3_ATTACHMENTS_BUCKET: string;
-    /**
-     * The prefix for attachment IDs. Fallback to IDEA's default one.
-     */
-    protected IUID_ATTACHMENTS_PREFIX: string;
-    constructor(ddb: DynamoDB, s3: S3);
-    /**
-     * Get a signedURL to put an attachment.
-     */
-    put(project: string, teamId: string): Promise<SignedURL>;
-    /**
-     * Get a signedURL to retrieve an attachment.
-     */
-    get(attachmentId: string): Promise<SignedURL>;
-}

package/dist/src/attachments.js

@@ -1,39 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Attachments = void 0;
-/**
- * A custom class that takes advantage of DynamoDB and S3 to easily manage attachments.
- */
-class Attachments {
-    constructor(ddb, s3) {
-        this.ddb = ddb;
-        this.s3 = s3;
-        /**
-         * The bucket where from to retrieve the attachments. Fallback to IDEA's default one.
-         */
-        this.S3_ATTACHMENTS_BUCKET = process.env.S3_ATTACHMENTS_BUCKET ?? 'idea-attachments';
-        /**
-         * The prefix for attachment IDs. Fallback to IDEA's default one.
-         */
-        this.IUID_ATTACHMENTS_PREFIX = process.env.IUID_ATTACHMENTS_PREFIX ?? 'ATT';
-    }
-    /**
-     * Get a signedURL to put an attachment.
-     */
-    async put(project, teamId) {
-        const attachmentIdPrefix = this.IUID_ATTACHMENTS_PREFIX.concat('_', project, '_', teamId);
-        const attachmentId = await this.ddb.IUNID(attachmentIdPrefix);
-        const signedURL = await this.s3.signedURLPut(this.S3_ATTACHMENTS_BUCKET, attachmentId);
-        signedURL.id = attachmentId;
-        return signedURL;
-    }
-    /**
-     * Get a signedURL to retrieve an attachment.
-     */
-    async get(attachmentId) {
-        const signedURL = await this.s3.signedURLGet(this.S3_ATTACHMENTS_BUCKET, attachmentId);
-        signedURL.id = attachmentId;
-        return signedURL;
-    }
-}
-exports.Attachments = Attachments;

package/dist/src/cognito.d.ts

@@ -1,177 +0,0 @@
-import * as CognitoIP from '@aws-sdk/client-cognito-identity-provider';
-import { CognitoUser } from 'idea-toolbox';
-/**
- * A wrapper for AWS Cognito.
- */
-export declare class Cognito {
-    protected cognito: CognitoIP.CognitoIdentityProviderClient;
-    constructor(options?: {
-        region?: string;
-    });
-    /**
-     * Change the region in which to find the user pool.
-     * Default: the runner's (e.g. Lambda function) region.
-     */
-    setRegion(region: string): void;
-    /**
-     * Get the attributes of the user, from the authorizer claims.
-     * @param claims authorizer claims
-     * @return user's data
-     * @deprecated use idea-toolbox's CognitoUser instead
-     */
-    getUserByClaims(claims: Record<string, any>): CognitoUserGeneric;
-    /**
-     * Map the complex structure returned by Cognito for a user's attributes in a simple key-value object.
-     */
-    private mapCognitoUserAttributesAsPlainObject;
-    /**
-     * Identify a user by its email address, returning its attributes.
-     */
-    getUserByEmail(email: string, userPoolId: string): Promise<CognitoUserGeneric>;
-    /**
-     * Identify a user by its userId (sub), returning its attributes.
-     */
-    getUserBySub(sub: string, userPoolId: string): Promise<CognitoUserGeneric>;
-    /**
-     * List all the users of the pool.
-     */
-    listUsers(userPoolId: string, options?: {
-        pagination?: string;
-        users: CognitoUser[];
-    }): Promise<CognitoUser[]>;
-    /**
-     * List all the users of the pool, including the information about the groups they're in.
-     * Note: it's slower than the alternative `getAllUsers`: use it only when needed.
-     */
-    listUsersWithGroupsDetail(cognitoUserPoolId: string): Promise<CognitoUser[]>;
-    /**
-     * Create a new user (by its email) in the pool specified.
-     * @return userId of the new user
-     */
-    createUser(cognitoUserOrEmail: CognitoUser | string, userPoolId: string, options?: CreateUserOptions): Promise<string>;
-    /**
-     * Resend the password to a user who never logged in.
-     */
-    resendPassword(email: string, userPoolId: string, options?: CreateUserOptions): Promise<void>;
-    /**
-     * Set a new password for a specific user identified by its email (admin-only).
-     * If not specified, the password is generated randomly, and the user must change it at the first login.
-     */
-    setPassword(email: string, userPoolId: string, options?: {
-        password?: string;
-        permanent?: boolean;
-    }): Promise<void>;
-    /**
-     * Delete a user by its email (username), in the pool specified.
-     */
-    deleteUser(email: string, userPoolId: string): Promise<void>;
-    /**
-     * Sign in a user of a specific pool through username and password.
-     */
-    signIn(email: string, password: string, userPoolId: string, userPoolClientId: string): Promise<CognitoIP.AuthenticationResultType>;
-    /**
-     * Given a username and a refresh token (and pool data), refresh the session and return the new tokens.
-     */
-    refreshSession(email: string, refreshToken: string, userPoolId: string, userPoolClientId: string): Promise<CognitoIP.AuthenticationResultType>;
-    /**
-     * Change the email address (== username) associated to a user.
-     */
-    updateEmail(email: string, newEmail: string, userPoolId: string): Promise<void>;
-    /**
-     * Change the password to sign in for a user.
-     */
-    updatePassword(email: string, oldPassword: string, newPassword: string, userPoolId: string, userPoolClientId: string): Promise<void>;
-    /**
-     * Send to a user the instructions to change the password.
-     */
-    forgotPassword(email: string, userPoolClientId: string): Promise<CognitoIP.CodeDeliveryDetailsType>;
-    /**
-     * Complete the flow of a password forgot.
-     */
-    confirmForgotPassword(email: string, newPassword: string, confirmationCode: string, userPoolClientId: string): Promise<void>;
-    /**
-     * Update a (Cognito)User's attributes, excluding the attributes that require specific methods.
-     */
-    updateUser(user: CognitoUser, userPoolId: string): Promise<void>;
-    /**
-     * Sign out the user from all devices.
-     */
-    globalSignOut(email: string, userPoolId: string): Promise<void>;
-    /**
-     * Confirm and conclude a registration, usign a confirmation code.
-     */
-    confirmSignUp(email: string, confirmationCode: string, userPoolClientId: string): Promise<void>;
-    /**
-     * List the groups of the user pool.
-     */
-    listGroups(userPoolId: string, options?: {
-        pagination?: string;
-        groups: CognitoGroup[];
-    }): Promise<CognitoGroup[]>;
-    /**
-     * Create a new group in the user pool.
-     */
-    createGroup(groupName: string, userPoolId: string): Promise<void>;
-    /**
-     * Delete a group from the user pool.
-     */
-    deleteGroup(groupName: string, userPoolId: string): Promise<void>;
-    /**
-     * List the users part of a group in the user pool.
-     */
-    listUsersInGroup(group: string, userPoolId: string, options?: {
-        pagination?: string;
-        users: CognitoUser[];
-    }): Promise<CognitoUser[]>;
-    /**
-     * Add a user (by email) to a group in the user pool.
-     */
-    addUserToGroup(email: string, group: string, userPoolId: string): Promise<void>;
-    /**
-     * Remove a user (by email) from a group in the user pool.
-     */
-    removeUserFromGroup(email: string, group: string, userPoolId: string): Promise<void>;
-}
-/**
- * The attributes of a generic Cognito user of which we don't know the custom attributes.
- */
-export interface CognitoUserGeneric {
-    /**
-     * The user id (sub).
-     */
-    userId: string;
-    /**
-     * The email (=== username).
-     */
-    email: string;
-    /**
-     * Cognito can have custom attributes.
-     */
-    [attribute: string]: string;
-}
-/**
- * Options when creating a new user.
- */
-export interface CreateUserOptions {
-    /**
-     * Uf true, don't send the default Cognito email notification
-     */
-    skipNotification?: boolean;
-    /**
-     * If null, randomly generated
-     */
-    temporaryPassword?: string;
-}
-/**
- * The attributes of a Cognito group.
- */
-export interface CognitoGroup {
-    /**
-     * The name (and id) of the group.
-     */
-    name: string;
-    /**
-     * The description of the group.
-     */
-    description: string;
-}