DefinitelyTyped · andrewbranch · Mar 31, 2022 · Mar 25, 2022 · Mar 28, 2022 · Mar 28, 2022
diff --git a/types/happyguestmx__web-utilities/happyguestmx__web-utilities-tests.ts b/types/happyguestmx__web-utilities/happyguestmx__web-utilities-tests.ts
@@ -0,0 +1,5 @@
+import { fsp, common } from '@happyguestmx/web-utilities';
+
+new fsp.FSP([], [], true, true);
+common.isEmpty({});
+common.cleanFields({ foo: undefined });
diff --git a/types/happyguestmx__web-utilities/index.d.ts b/types/happyguestmx__web-utilities/index.d.ts
@@ -0,0 +1,311 @@
+// Type definitions for @happyguestmx/web-utilities 3.17
+// Project: https://github.com/HappyGuest/happyguestmx-web-utilities
+// Definitions by: HappyGuest <https://github.com/HappyGuest>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+import { APIGatewayProxyEvent, APIGatewayProxyResult } from 'aws-lambda';
+// shared
+export interface QueryOutput {
+    Items: any[];
+    Count: number;
+}
+
+// activityLogHandler
+export interface LogEntry {
+    type: string;
+    current: {};
+    updated: {};
+    company_uuid: string;
+    hotel_uuid: string | null | undefined;
+    category: string | null | undefined;
+    item: string | null | undefined;
+    user_uuid: string | null | undefined;
+    sourceIp: string;
+}
+export interface PutItemOutput {
+    Attributes?: { [key: string]: any };
+    ConsumedCapacity?: {};
+    ItemCollectionMetrics?: {
+        ItemCollectionKey?: { [key: string]: any };
+        SizeEstimateRangeGB?: number[];
+    };
+}
+export interface ActivityLogHandler {
+    logEntry: (params: LogEntry) => Promise<PutItemOutput>;
+}
+
+// assetsHandler
+export interface StoreImageRequestPath {
+    public: string;
+    bucket: string;
+}
+export type StoreGalleryRequestPath = StoreImageRequestPath;
+export interface StoreImageRequest {
+    image: string;
+    format: string;
+    key: string;
+    path: StoreImageRequestPath;
+}
+export interface StoreGalleryRequest {
+    photo_gallery: string[];
+    format: string;
+    path: StoreGalleryRequestPath;
+}
+export interface AmazonS3UriOutput {
+    region: string;
+    bucket: string;
+    key: string;
+}
+export interface PutObjectOutput {
+    Expiration?: string;
+    ETag?: string;
+    ChecksumCRC32?: string;
+    ChecksumCRC32C?: string;
+    ChecksumSHA1?: string;
+    ChecksumSHA256?: string;
+    ServerSideEncryption?: string;
+    VersionId?: string;
+    SSECustomerAlgorithm?: string;
+    SSECustomerKeyMD5?: string;
+    SSEKMSKeyId?: string;
+    SSEKMSEncryptionContext?: string;
+    BucketKeyEnabled?: boolean;
+    RequestCharged?: string;
+}
+export interface AssetsHandler {
+    getImage: (url: string, format: string) => Promise<string>;
+    storeImage: (request: StoreImageRequest) => Promise<PutObjectOutput>;
+    storeGallery: (request: StoreGalleryRequest) => Promise<string[]>;
+    amazonS3Uri: (url: string) => Promise<AmazonS3UriOutput>;
+}
+
+// common
+export interface Common {
+    uuidRegex: string;
+    emailRegex: string;
+    urlReGex: string;
+    base64Regex: string;
+    isURL: (string: string) => boolean;
+    cleanFields: (item: {}) => Promise<{}>;
+    notUndefined: (value: any) => boolean;
+    isEmpty: (value: {}) => boolean;
+    getCleanedString: (string: string) => string;
+    cleanedObject: (obj: {}) => Promise<{}>;
+    isBase64: (string: string) => boolean;
+}
+
+// errorsHandler
+export interface FormErrorFields {
+    label: string;
+    name: string;
+    error: any;
+}
+export interface FormError {
+    fields: { [key: string]: { fields: FormErrorFields } };
+}
+export interface FormErrorHandlerOutput {
+    message: string;
+    code: string;
+    statusCode: number;
+    full_error_message: string;
+}
+export interface ErrorsHandler {
+    caolanFormErrorHandler: (form: FormError) => FormErrorHandlerOutput;
+}
+
+// paramsHandler
+export interface ParamsHandler {
+    requestHandler: (event: APIGatewayProxyEvent) => Promise<APIGatewayProxyResult>;
+}
+
+// response
+export interface Response {
+    success: (body: {}) => APIGatewayProxyResult;
+    badRequest: (body: {}) => APIGatewayProxyResult;
+    notFound: (body: {}) => APIGatewayProxyResult;
+    failure: (body: {}) => APIGatewayProxyResult;
+}
+
+// fsp
+export interface FspPaginOutput {
+    start: number;
+    end: number;
+}
+export interface FspPaginationOutput {
+    items: any[];
+    total: number;
+    pageTop: number;
+    page: number;
+    indexBegin: number;
+    indexEnd: number;
+}
+export interface FspQuery {
+    queryString: string;
+    orderBy: string;
+    sortType: 'asc' | 'desc';
+    size: number;
+    page: number;
+}
+export interface FSP {
+    filter: boolean;
+    should_sort: boolean;
+    data: any[];
+    filterColums: any[];
+    Filter: (term: string | string[]) => boolean;
+    Sort: (orderBy: string, sortType: 'asc' | 'desc') => any[];
+    Pagin: (page: number, size: number) => FspPaginOutput;
+    FSP: (query: FspQuery) => FspPaginationOutput;
+}
+export interface FSPConstructor {
+    new(fullData: any[], filterColums: any[], filter: boolean, sort: boolean): FSP;
+}
+
+// ddbHelper
+export type ComparisonOperator =
+    | 'EQ'
+    | 'NE'
+    | 'IN'
+    | 'LE'
+    | 'LT'
+    | 'GE'
+    | 'GT'
+    | 'BETWEEN'
+    | 'NOT_NULL'
+    | 'NULL'
+    | 'CONTAINS'
+    | 'NOT_CONTAINS'
+    | 'BEGINS_WITH'
+    | string;
+export interface QueryInput {
+    TableName: string;
+    IndexName?: string;
+    Select?: string;
+    AttributesToGet?: string[];
+    Limit?: number;
+    ConsistentRead?: boolean;
+    KeyConditions?: {
+        [key: string]: {
+            AttributeValueList?: any[];
+            ComparisonOperator: ComparisonOperator;
+        };
+    };
+    QueryFilter?: {
+        [key: string]: {
+            AttributeValueList?: any[];
+            ComparisonOperator: ComparisonOperator;
+        };
+    };
+    ConditionalOperator?: 'AND' | 'OR' | string;
+    ScanIndexForward?: boolean;
+    ExclusiveStartKey?: { [key: string]: any };
+    ReturnConsumedCapacity?: 'INDEXES' | 'TOTAL' | 'NONE' | string;
+    ProjectionExpression?: string;
+    FilterExpression?: string;
+    KeyConditionExpression?: string;
+    ExpressionAttributeNames?: {
+        [key: string]: string;
+    };
+    ExpressionAttributeValues?: {
+        [key: string]: any;
+    };
+}
+export interface ScanInput {
+    TableName: string;
+    IndexName?: string;
+    AttributesToGet?: string[];
+    Limit?: number;
+    Select?: string;
+    ScanFilter?: {
+        [key: string]: {
+            AttributeValueList?: any[];
+            ComparisonOperator: ComparisonOperator;
+        };
+    };
+    ConditionalOperator?: string;
+    ExclusiveStartKey?: {
+        [key: string]: any;
+    };
+    ReturnConsumedCapacity?: string;
+    TotalSegments?: number;
+    Segment?: number;
+    ProjectionExpression?: string;
+    FilterExpression?: string;
+    ExpressionAttributeNames?: {
+        [key: string]: string;
+    };
+    ExpressionAttributeValues?: {
+        [key: string]: any;
+    };
+    ConsistentRead?: boolean;
+}
+export interface DdbHelper {
+    recursiveQuery: (
+        params: QueryInput | ScanInput,
+        method: 'query' | 'scan',
+        xray?: boolean,
+    ) => Promise<QueryOutput>;
+}
+// userHandler
+export interface User {
+    company_uuid: string;
+    name: string;
+    email: string;
+    employee_number: string;
+    picture: string;
+    uuid: string;
+    status: string;
+    last_name: string;
+    role_key: string;
+    enabled: string;
+    hotel_uuids: string;
+    locale: string;
+    notifications: string;
+    updated_at: string;
+}
+export interface AttributeType {
+    Name: string;
+    Value: any;
+}
+export interface MFAOptionType {
+    DeliveryMedium?: string;
+    AttributeName?: string;
+}
+export interface GetUserResponse {
+    Username: string;
+    UserAttributes: AttributeType[];
+    MFAOptions?: MFAOptionType[];
+    PreferredMfaSetting?: string;
+    UserMFASettingList?: string[];
+}
+export interface UserHandler {
+    getUserFromJWT: (AccessToken: string) => Promise<GetUserResponse>;
+    getCognitoUser: (AccessToken: string) => Promise<GetUserResponse>;
+    findUserInDB: (sub: string) => Promise<any>;
+    findUserInConciergeUsers: (sub: string) => Promise<QueryOutput>;
+    findUserInAdminUsers: (sub: string) => Promise<QueryOutput>;
+    findUserInCoStaffUsers: (sub: string) => Promise<QueryOutput>;
+    findUserInStaffUsers: (sub: string) => Promise<QueryOutput>;
+    permissionsValidate: (user: User, level: string, company_uuid?: string, hotel_uuid?: string) => Promise<string>;
+    cognitoAttributesToJson: (sub: AttributeType[]) => Promise<{}>;
+    findUserByEmail: (email: string) => Promise<any>;
+    findAdminUserByEmail: (email: string) => Promise<any>;
+    findCoStaffUserByEmail: (email: string) => Promise<QueryOutput>;
+    findStaffUserByEmail: (email: string) => Promise<QueryOutput>;
+    findUserByEmployeeNumber: (employee_number: string) => Promise<any>;
+    findConciergeByEmplNumber: (employee_number: string) => Promise<QueryOutput>;
+    findCoStaffUserByEmplNumber: (employee_number: string) => Promise<QueryOutput>;
+}
+
+/*************************************
+            EXPORTS
+*************************************/
+export const activityLogHandler: ActivityLogHandler;
+export const assetsHandler: AssetsHandler;
+export const common: Common;
+export const errorsHandler: ErrorsHandler;
+export const paramsHandler: ParamsHandler;
+export const response: Response;
+export const fsp: { FSP: FSPConstructor };
+export const ddbHelper: DdbHelper;
+export class WithDataError extends Error { }
+export const userHandler: UserHandler;
diff --git a/types/happyguestmx__web-utilities/tsconfig.json b/types/happyguestmx__web-utilities/tsconfig.json
@@ -0,0 +1,26 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "baseUrl": "../",
+        "typeRoots": [
+            "../"
+        ],
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true,
+        "paths": {
+            "@happyguestmx/*": ["happyguestmx__*"]
+        }
+    },
+    "files": [
+        "index.d.ts",
+        "happyguestmx__web-utilities-tests.ts"
+    ]
+}
diff --git a/types/happyguestmx__web-utilities/tslint.json b/types/happyguestmx__web-utilities/tslint.json
@@ -0,0 +1,3 @@
+{
+    "extends": "@definitelytyped/dtslint/dt.json"
+}