@baadal-sdk/dapi 0.28.4 → 0.31.0

package/dist/types/aws/db.d.ts

@@ -1,15 +1,267 @@
 /**
+ * Examples:
+ * Ref: https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/dynamodb-examples.html
+ *
  * Partition key vs Composite primary key:
  * Ref: https://aws.amazon.com/premiumsupport/knowledge-center/primary-key-dynamodb-table/
  */
 import { StringIndexable } from '../common/common.model';
-export declare const init: (region: string) => boolean;
-export declare const status: () => string | null;
-export declare const writeItemForce: <T = any>(table: string, data: T, key?: string) => Promise<T | null>;
-export declare const writeItem: (table: string, data: StringIndexable) => Promise<true | null>;
-export declare const updateItem: (table: string, key: StringIndexable, update: string, attr: StringIndexable, attrNames?: StringIndexable<any> | undefined) => Promise<true | null>;
-export declare const readItem: <T = any>(table: string, key: StringIndexable, projection?: string | undefined, attrNames?: StringIndexable<any> | undefined) => Promise<T | null>;
-export declare const queryItems: (table: string, indexName: string, cond: string, attr: StringIndexable, projection?: string, desc?: boolean) => Promise<StringIndexable<any>[] | null>;
-export declare const scanItems: (table: string, projection?: string) => Promise<StringIndexable<any>[] | null>;
-export declare const deleteItem: (table: string, key: StringIndexable) => Promise<boolean | null>;
+export interface WriteItemForceInput<T = any> {
+    table: string;
+    item: T;
+    key?: string;
+}
+/**
+ * Write an item to a DynamoDB table, retry in case of key conflict
+ * @param input input command object
+ * @returns the created item, null in case of error
+ *
+ * ```js
+ * writeItemForce({
+ *   table: 'lesson_list',
+ *   item: { title: 'My Lesson' },
+ *   key: 'id',
+ * });
+ *
+ * interface WriteItemForceInput<T = any> {
+ *   table: string;
+ *   item: T;
+ *   key?: string; // default: `id`
+ * }
+ * ```
+ */
+export declare const writeItemForce: <T = any>(input: WriteItemForceInput<T>) => Promise<T | null>;
+export interface WriteItemInput {
+    table: string;
+    item: StringIndexable;
+}
+/**
+ * Write an item to a DynamoDB table
+ * @param input input command object
+ * @returns true if successful, null in case of error
+ *
+ * ```js
+ * writeItem({
+ *   table: 'lesson_list',
+ *   item: { id: 'id_001', title: 'My Lesson' },
+ * });
+ *
+ * interface WriteItemInput {
+ *   table: string;
+ *   item: StringIndexable;
+ * }
+ * ```
+ */
+export declare const writeItem: (input: WriteItemInput) => Promise<true | null>;
+export interface WriteItemsAllInput {
+    table: string;
+    items: StringIndexable[];
+}
+/**
+ * Write an list of items to a DynamoDB table
+ * @param input input command object
+ * @returns true if successful, null in case of error
+ *
+ * ```js
+ * writeItemsAll({
+ *   table: 'lesson_list',
+ *   items: [{ id: 'id_001', title: 'My Lesson' }, { id: 'id_002', title: 'My Lesson 2' }],
+ * });
+ *
+ * interface WriteItemInput {
+ *   table: string;
+ *   items: StringIndexable[];
+ * }
+ * ```
+ */
+export declare const writeItemsAll: (input: WriteItemsAllInput) => Promise<boolean | null>;
+export interface UpdateItemInput {
+    table: string;
+    key: StringIndexable;
+    update: string;
+    attr: StringIndexable;
+    attrNames?: StringIndexable;
+}
+/**
+ * Update an item in DynamoDB table
+ * @param input input command object
+ * @returns true if successful, null in case of error
+ *
+ * ```js
+ * updateItem({
+ *   table: 'lesson_list',
+ *   key: { id: 'id_001' },
+ *   update: 'SET status = :status, #rev = 10',
+ *   attr: { ':status': 'completed' },
+ *   attrNames: { '#rev': 'revision' },
+ * });
+ *
+ * interface UpdateItemInput {
+ *   table: string;
+ *   key: StringIndexable;
+ *   update: string;
+ *   attr: StringIndexable;
+ *   attrNames?: StringIndexable;
+ * }
+ * ```
+ */
+export declare const updateItem: (input: UpdateItemInput) => Promise<true | null>;
+export interface ReadItemInput {
+    table: string;
+    key: StringIndexable;
+    projection?: string;
+    attrNames?: StringIndexable;
+}
+/**
+ * Read an item from DynamoDB table
+ * @param input input command object
+ * @returns item contents, null in case of error
+ *
+ * ```js
+ * readItem({
+ *   table: 'lesson_list',
+ *   key: { id: 'id_001' },
+ *   projection: 'id, lesson, status',
+ * });
+ *
+ * interface ReadItemInput {
+ *   table: string;
+ *   key: StringIndexable;
+ *   projection?: string;
+ *   attrNames?: StringIndexable;
+ * }
+ * ```
+ */
+export declare const readItem: <T = any>(input: ReadItemInput) => Promise<T | null>;
+export interface ReadItemsAllInput {
+    table: string;
+    keys: StringIndexable[];
+    projection?: string;
+    attrNames?: StringIndexable;
+}
+/**
+ * Read a list of items from DynamoDB table
+ * Note: ordering of items in result may not be same as that in `keys`
+ * @param input input command object
+ * @returns list of contents for items, null in case of error
+ *
+ * ```js
+ * readItemsAll({
+ *   table: 'lesson_list',
+ *   keys: [{ id: 'id_001' }, { id: 'id_002' }],
+ *   projection: 'id, lesson, status',
+ * });
+ *
+ * interface ReadItemsAllInput {
+ *   table: string;
+ *   keys: StringIndexable[];
+ *   projection?: string;
+ *   attrNames?: StringIndexable;
+ * }
+ * ```
+ */
+export declare const readItemsAll: <T = any>(input: ReadItemsAllInput) => Promise<StringIndexable<T>[] | null>;
+export interface QueryItemsInput {
+    table: string;
+    indexName?: string;
+    cond: string;
+    attr: StringIndexable;
+    attrNames?: StringIndexable;
+    projection?: string;
+    desc?: boolean;
+}
+/**
+ * Query items from a DynamoDB table based on some condition
+ * @param input input command object
+ * @returns query results array, null in case of error
+ *
+ * ```js
+ * dbQueryItems({
+ *   table: 'lesson_list',
+ *   indexName: 'status-revision-index',
+ *   cond: 'status = :comp AND #rev >= :rev',
+ *   attr: { ':comp': 'completed', ':rev': 9 },
+ *   attrNames: { '#rev': 'revision' },
+ *   projection: 'id, lesson, status, revision',
+ * });
+ *
+ * interface QueryItemsInput {
+ *   table: string;
+ *   indexName?: string;
+ *   cond: string;
+ *   attr: StringIndexable;
+ *   attrNames?: StringIndexable;
+ *   projection?: string;
+ *   desc?: boolean;
+ * }
+ * ```
+ */
+export declare const queryItems: (input: QueryItemsInput) => Promise<StringIndexable<any>[] | null>;
+export interface ScanItemsInput {
+    table: string;
+    projection?: string;
+}
+/**
+ * Scan all items in a DynamoDB table
+ * Note: avoid using this method in favour of `queryItems` method due to performance reasons
+ * @param input input command object
+ * @returns results of the scan query, null in case of error
+ *
+ * ```js
+ * scanItems({
+ *   table: 'lesson_list',
+ *   projection: 'id, status',
+ * });
+ *
+ * interface ScanItemsInput {
+ *   table: string;
+ *   projection?: string;
+ * }
+ * ```
+ */
+export declare const scanItems: (input: ScanItemsInput) => Promise<StringIndexable<any>[] | null>;
+export interface DeleteItemInput {
+    table: string;
+    key: StringIndexable;
+}
+/**
+ * Delete an item in a DynamoDB table
+ * @param input input command object
+ * @returns true if successful, null in case of error
+ *
+ * ```js
+ * deleteItem({
+ *   table: 'lesson_list',
+ *   key: { id: 'id_001' },
+ * });
+ *
+ * interface DeleteItemInput {
+ *   table: string;
+ *   key: StringIndexable;
+ * }
+ * ```
+ */
+export declare const deleteItem: (input: DeleteItemInput) => Promise<true | null>;
+export interface DeleteItemsAllInput {
+    table: string;
+    keys: StringIndexable[];
+}
+/**
+ * Delete a list of items in a DynamoDB table
+ * @param input input command object
+ * @returns true if successful, null in case of error
+ *
+ * ```js
+ * deleteItemsAll({
+ *   table: 'lesson_list',
+ *   keys: [{ id: 'id_001' }, { id: 'id_002' }],
+ * });
+ *
+ * interface DeleteItemsAllInput {
+ *   table: string;
+ *   keys: StringIndexable[];
+ * }
+ * ```
+ */
+export declare const deleteItemsAll: (input: DeleteItemsAllInput) => Promise<boolean | null>;
 //# sourceMappingURL=db.d.ts.map

package/dist/types/aws/db.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"db.d.ts","sourceRoot":"","sources":["../../../src/aws/db.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAqBH,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAKzD,eAAO,MAAM,IAAI,WAAY,MAAM,YAUlC,CAAC;AAEF,eAAO,MAAM,MAAM,qBAAoB,CAAC;AA+CxC,eAAO,MAAM,cAAc,mBAA0B,MAAM,6CAE1D,CAAC;AAEF,eAAO,MAAM,SAAS,UAAiB,MAAM,QAAQ,eAAe,yBAkBnE,CAAC;AAEF,eAAO,MAAM,UAAU,UACd,MAAM,OACR,eAAe,UACZ,MAAM,QACR,eAAe,uEA0BtB,CAAC;AAEF,eAAO,MAAM,QAAQ,mBACZ,MAAM,OACR,eAAe,qGA+BrB,CAAC;AAEF,eAAO,MAAM,UAAU,UACd,MAAM,aACF,MAAM,QACX,MAAM,QACN,eAAe,gFAwCtB,CAAC;AAEF,eAAO,MAAM,SAAS,UAAiB,MAAM,gEA8B5C,CAAC;AAEF,eAAO,MAAM,UAAU,UAAiB,MAAM,OAAO,eAAe,4BAkBnE,CAAC"}
+{"version":3,"file":"db.d.ts","sourceRoot":"","sources":["../../../src/aws/db.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AA0BH,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAsEzD,MAAM,WAAW,mBAAmB,CAAC,CAAC,GAAG,GAAG;IAC1C,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,CAAC,CAAC;IACR,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,cAAc,+DAG1B,CAAC;AAEF,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,eAAe,CAAC;CACvB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,SAAS,UAAiB,cAAc,yBAkBpD,CAAC;AA8BF,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,eAAe,EAAE,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa,UAAiB,kBAAkB,4BAsB5D,CAAC;AAEF,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,eAAe,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,eAAe,CAAC;IACtB,SAAS,CAAC,EAAE,eAAe,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,UAAU,UAAiB,eAAe,yBAwBtD,CAAC;AAEF,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,eAAe,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,eAAe,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,QAAQ,mBAA0B,aAAa,sBA6B3D,CAAC;AA6CF,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,eAAe,EAAE,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,eAAe,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,YAAY,mBAA0B,iBAAiB,yCA8BnE,CAAC;AAEF,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,eAAe,CAAC;IACtB,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,UAAU,UAAiB,eAAe,2CAyCtD,CAAC;AAEF,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,SAAS,UAAiB,cAAc,2CAoCpD,CAAC;AAEF,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,eAAe,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,UAAU,UAAiB,eAAe,yBAkBtD,CAAC;AA+BF,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,eAAe,EAAE,CAAC;CACzB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,cAAc,UAAiB,mBAAmB,4BAsB9D,CAAC"}

package/dist/types/aws/index.d.ts

@@ -1,13 +1,12 @@
-declare const db: {
-    writeItemForce: <T = any>(table: string, data: T, key?: string) => Promise<T | null>;
-    writeItem: (table: string, data: import("../common/common.model").StringIndexable<any>) => Promise<true | null>;
-    updateItem: (table: string, key: import("../common/common.model").StringIndexable<any>, update: string, attr: import("../common/common.model").StringIndexable<any>, attrNames?: import("../common/common.model").StringIndexable<any> | undefined) => Promise<true | null>;
-    readItem: <T_1 = any>(table: string, key: import("../common/common.model").StringIndexable<any>, projection?: string | undefined, attrNames?: import("../common/common.model").StringIndexable<any> | undefined) => Promise<T_1 | null>;
-    queryItems: (table: string, indexName: string, cond: string, attr: import("../common/common.model").StringIndexable<any>, projection?: string, desc?: boolean) => Promise<import("../common/common.model").StringIndexable<any>[] | null>;
-    scanItems: (table: string, projection?: string) => Promise<import("../common/common.model").StringIndexable<any>[] | null>;
-    deleteItem: (table: string, key: import("../common/common.model").StringIndexable<any>) => Promise<boolean | null>;
+import * as db from './db';
+import * as s3 from './s3';
+/**
+ * @deprecated explicit init deprecated!
+ */
+export declare const init: (region: string) => boolean;
+export declare const status: () => {
+    db: string | null;
+    s3: string | null;
 };
-declare const init: (region: string) => boolean;
-declare const status: () => string | null;
-export { db, init, status };
+export { db, s3 };
 //# sourceMappingURL=index.d.ts.map

package/dist/types/aws/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/aws/index.ts"],"names":[],"mappings":"AAGA,QAAA,MAA2C,EAAE;;;;;;;;CAAU,CAAC;AAExD,QAAA,MAAM,IAAI,WAAY,MAAM,YAO3B,CAAC;AAEF,QAAA,MAAM,MAAM,qBAEX,CAAC;AAEF,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/aws/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,MAAM,CAAC;AAC3B,OAAO,KAAK,EAAE,MAAM,MAAM,CAAC;AAS3B;;GAEG;AACH,eAAO,MAAM,IAAI,WAAY,MAAM,YAUlC,CAAC;AAEF,eAAO,MAAM,MAAM;;;CAKlB,CAAC;AAEF,OAAO,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC"}

package/dist/types/aws/s3.d.ts

@@ -0,0 +1,90 @@
+/**
+ * Examples:
+ * Ref: https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/s3-examples.html
+ */
+import { StringIndexable } from 'src/common/common.model';
+/**
+ * Create a new file in S3 bucket
+ * @param bucket S3 bucket name
+ * @param s3path S3 path to be created
+ * @param contents contents of the file to be created
+ * @returns true if the write is successful, null in case of error
+ */
+export declare const putObject: (bucket: string, s3path: string, contents: string) => Promise<true | null>;
+/**
+ * Upload a file to S3 bucket
+ * @param bucket S3 bucket name
+ * @param file (local) path of the file to upload
+ * @param s3path [optional] S3 path to be created, if not provided then derived from `file` path
+ * @returns true if the write is successful, null in case of error
+ */
+export declare const uploadFile: (bucket: string, file: string, s3path?: string | undefined) => Promise<true | null>;
+/**
+ * Upload a list of files to S3 bucket
+ * @param bucket S3 bucket name
+ * @param files (local) list of file paths to upload
+ * @param s3paths [optional] S3 path to be created, if not provided then derived from `file` path
+ * @returns true if the write is successful, null in case of error
+ */
+export declare const uploadFilesAll: (bucket: string, files: string[], s3paths?: string[] | undefined) => Promise<boolean | null>;
+/**
+ * Get the contents of a file in S3 bucket
+ * @param bucket S3 bucket name
+ * @param s3path S3 path of the file to be read
+ * @returns contents of the file, null in case of error
+ */
+export declare const getObject: (bucket: string, s3path: string) => Promise<string | null>;
+/**
+ * Download a file from S3 bucket
+ * @param bucket S3 bucket name
+ * @param s3path S3 path of the file to be downloaded
+ * @param outPath [optional] path where the downloaded file is written, if not provided then derived from `s3path`
+ * @returns true if download is successful, null in case of error
+ */
+export declare const downloadFile: (bucket: string, s3path: string, outPath?: string | undefined) => Promise<true | null>;
+/**
+ * List objects in a S3 bucket
+ * @param bucket S3 bucket name
+ * @param prefix [optional] prefix for object names in the bucket
+ * @returns list of objects in the S3 bucket (optionally starting with the given prefix), null in case of error
+ */
+export declare const listObjects: (bucket: string, prefix?: string | undefined) => Promise<string[] | null>;
+/**
+ * Get head content for a file in S3 bucket
+ * @param bucket S3 bucket name
+ * @param s3path S3 path of the file
+ * @returns head content for the given file, null in case of error
+ */
+export declare const getObjectHead: (bucket: string, s3path: string) => Promise<HeadObject | null>;
+/**
+ * Get head contents for a list of files in S3 bucket
+ * @param bucket S3 bucket name
+ * @param s3paths list of S3 paths of the files
+ * @returns head contents for the given files, null in case of error
+ */
+export declare const getObjectHeadsAll: (bucket: string, s3paths: string[]) => Promise<(HeadObject | null)[] | null>;
+/**
+ * Delete a file in S3 bucket
+ * @param bucket S3 bucket name
+ * @param s3path S3 file path to be deleted
+ * @returns true if delete is successful, null in case of error
+ */
+export declare const deleteObject: (bucket: string, s3path: string) => Promise<true | null>;
+/**
+ * Delete a list of files in S3 bucket
+ * @param bucket S3 bucket name
+ * @param s3paths list of S3 file paths to be deleted
+ * @returns true if all deletes are successful, null in case of error
+ */
+export declare const deleteObjectsAll: (bucket: string, s3paths: string[]) => Promise<boolean | null>;
+export interface HeadObject {
+    Key: string;
+    ContentLength?: number;
+    ContentType?: string;
+    ETag?: string;
+    CacheControl?: string;
+    Expires?: Date;
+    LastModified?: Date;
+    Metadata?: StringIndexable;
+}
+//# sourceMappingURL=s3.d.ts.map

package/dist/types/aws/s3.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3.d.ts","sourceRoot":"","sources":["../../../src/aws/s3.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAwBH,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AA6C1D;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,WAAkB,MAAM,UAAU,MAAM,YAAY,MAAM,yBA4B/E,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,WAAkB,MAAM,QAAQ,MAAM,sDAiD5D,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,WAAkB,MAAM,SAAS,MAAM,EAAE,4DAuBnE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,SAAS,WAAkB,MAAM,UAAU,MAAM,2BAkC7D,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,WAAkB,MAAM,UAAU,MAAM,uDAkChE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,WAAkB,MAAM,0DA+B/C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,WAAkB,MAAM,UAAU,MAAM,+BA0BjE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,WAAkB,MAAM,WAAW,MAAM,EAAE,0CAuBxE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,WAAkB,MAAM,UAAU,MAAM,yBAkBhE,CAAC;AAwBF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,WAAkB,MAAM,WAAW,MAAM,EAAE,4BAsBvE,CAAC;AAEF,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,YAAY,CAAC,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,EAAE,eAAe,CAAC;CAC5B"}

package/dist/types/common/const.d.ts

@@ -0,0 +1,3 @@
+export declare const BATCH_SIZE = 20;
+export declare const CHUNK_SIZE = 10;
+//# sourceMappingURL=const.d.ts.map

package/dist/types/common/const.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"const.d.ts","sourceRoot":"","sources":["../../../src/common/const.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,UAAU,KAAK,CAAC;AAC7B,eAAO,MAAM,UAAU,KAAK,CAAC"}

package/dist/types/fs/index.d.ts

@@ -2,16 +2,16 @@
  * Check whether a file exists
  * @param file file path
  * @param loud whether to throw errors [default: false]
- * @returns true if it exists, false otherwise
+ * @returns true if it exists, false if it doesn't, null in case of error
  */
-export declare const existsFileSync: (file: string, loud?: boolean) => boolean;
+export declare const existsFileSync: (file: string, loud?: boolean) => boolean | null;
 /**
  * Check whether a directory exists
  * @param dir directory path
  * @param loud whether to throw errors [default: false]
- * @returns true if it exists, false otherwise
+ * @returns true if it exists, false if it doesn't, null in case of error
  */
-export declare const existsDirSync: (dir: string, loud?: boolean) => boolean;
+export declare const existsDirSync: (dir: string, loud?: boolean) => boolean | null;
 /**
  * Read contents of a file
  * @param file file path
@@ -30,69 +30,73 @@ export declare const readFileSync: (file: string, warn?: boolean) => string | nu
  * Get the list of files/directories in a directory
  * @param dir directory path
  * @param warn whether to show warnings [default: false]
- * @returns an object {dirs,files} containing list of directories & files
+ * @param hiddenItems whether to include items starting with dot(.) [default: false]
+ * @returns an object {dirs,files} containing list of directories & files, null in case or error
  */
-export declare const readDir: (dir: string, warn?: boolean) => Promise<{
-    dirs: string[] | null;
-    files: string[] | null;
-}>;
+export declare const readDir: (dir: string, warn?: boolean, hiddenItems?: boolean) => Promise<{
+    dirs: string[];
+    files: string[];
+} | null>;
 /**
  * Get the list of files in a directory
  * @param dir directory path
  * @param warn whether to show warnings [default: false]
+ * @param hiddenItems whether to include items starting with dot(.) [default: false]
  * @returns list of files, null in case of error or no items
  */
-export declare const readDirFiles: (dir: string, warn?: boolean) => Promise<string[] | null>;
+export declare const readDirFiles: (dir: string, warn?: boolean, hiddenItems?: boolean) => Promise<string[] | null | undefined>;
 /**
  * Get the list of directories in a directory
  * @param dir directory path
  * @param warn whether to show warnings [default: false]
+ * @param hiddenItems whether to include items starting with dot(.) [default: false]
  * @returns list of directories, null in case of error or no items
  */
-export declare const readDirDirs: (dir: string, warn?: boolean) => Promise<string[] | null>;
+export declare const readDirDirs: (dir: string, warn?: boolean, hiddenItems?: boolean) => Promise<string[] | null | undefined>;
 /**
  * Get the (recursive) list of files in a directory
  * @param dir directory path
- * @returns complete (recursive) list of files, null in case of error or no items
+ * @param hiddenItems whether to include items starting with dot(.) [default: false]
+ * @returns complete (recursive) list of files, null in case of error
  */
-export declare const readDirFilesRec: (dir: string) => Promise<string[] | null>;
+export declare const readDirFilesRec: (dir: string, hiddenItems?: boolean) => Promise<string[] | null>;
 /**
  * Write contents to a file (creates the file path if it doesn't exist)
  * @param file file path
  * @param contents contents to write
- * @returns true if successful, false on error
+ * @returns true if successful, null in case of error
  */
-export declare const writeFile: (file: string, contents: string) => Promise<boolean>;
+export declare const writeFile: (file: string, contents: string) => Promise<true | null>;
 /**
  * Append contents to a file
  * @param file file path
  * @param contents contents to append
- * @returns true if successful, false on error
+ * @returns true if successful, null in case of error
  */
-export declare const appendToFile: (file: string, contents: string) => Promise<boolean>;
+export declare const appendToFile: (file: string, contents: string) => Promise<true | null>;
 /**
  * Rename a file
  * @param oldpath old file path
  * @param newpath new file path
- * @returns true if successful, false on error
+ * @returns true if successful, null in case of error
  */
-export declare const renameFile: (oldpath: string, newpath: string) => Promise<boolean>;
+export declare const renameFile: (oldpath: string, newpath: string) => Promise<true | null>;
 /**
  * Create a directory, if it doesn't exist
  * @param dir directory path
- * @returns true if successful, false in case of failure
+ * @returns true if successful, null in case of failure/error
  */
-export declare const createDir: (dir: string) => Promise<boolean>;
+export declare const createDir: (dir: string) => Promise<true | null>;
 /**
  * Delete a file
  * @param file file path
- * @returns true if successful, false on error
+ * @returns true if successful, null in case of error
  */
-export declare const deleteFile: (file: string) => Promise<boolean>;
+export declare const deleteFile: (file: string) => Promise<true | null>;
 /**
  * Delete a directory
  * @param dir directory path
- * @returns true if successful, false on error
+ * @returns true if successful, null in case of error
  */
-export declare const deleteDir: (dir: string) => Promise<boolean>;
+export declare const deleteDir: (dir: string) => Promise<true | null>;
 //# sourceMappingURL=index.d.ts.map

package/dist/types/fs/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/fs/index.ts"],"names":[],"mappings":"AAaA;;;;;GAKG;AACH,eAAO,MAAM,cAAc,SAAU,MAAM,4BAiB1C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,QAAS,MAAM,4BAiBxC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,SAAgB,MAAM,2CAU1C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,SAAU,MAAM,kCAUxC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,OAAO,QAAe,MAAM;UA4BL,MAAM,EAAE,GAAG,IAAI;WAAS,MAAM,EAAE,GAAG,IAAI;EAC1E,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,QAAe,MAAM,6CAI7C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,QAAe,MAAM,6CAI5C,CAAC;AAuBF;;;;GAIG;AACH,eAAO,MAAM,eAAe,QAAS,MAAM,6BAA+B,CAAC;AAE3E;;;;;GAKG;AACH,eAAO,MAAM,SAAS,SAAgB,MAAM,YAAY,MAAM,qBAY7D,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,SAAgB,MAAM,YAAY,MAAM,qBAkBhE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,YAAmB,MAAM,WAAW,MAAM,qBAWhE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,SAAS,QAAe,MAAM,qBAY1C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,UAAU,SAAgB,MAAM,qBAU5C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,SAAS,QAAe,MAAM,qBAe1C,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/fs/index.ts"],"names":[],"mappings":"AAQA;;;;;GAKG;AACH,eAAO,MAAM,cAAc,SAAU,MAAM,mCAiB1C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,QAAS,MAAM,mCAiBxC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,SAAgB,MAAM,2CAU1C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,SAAU,MAAM,kCAUxC,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,QAAe,MAAM;;;SA2BxC,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,QAAe,MAAM,gFAI7C,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,QAAe,MAAM,gFAI5C,CAAC;AA0BF;;;;;GAKG;AACH,eAAO,MAAM,eAAe,QAAe,MAAM,oDAMhD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,SAAS,SAAgB,MAAM,YAAY,MAAM,yBAY7D,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,SAAgB,MAAM,YAAY,MAAM,yBAkBhE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,YAAmB,MAAM,WAAW,MAAM,yBAWhE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,SAAS,QAAe,MAAM,yBAY1C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,UAAU,SAAgB,MAAM,yBAU5C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,SAAS,QAAe,MAAM,yBAe1C,CAAC"}

package/dist/types/index.d.ts

@@ -1,11 +1,13 @@
 import * as fs from './fs';
 import * as aws from './aws';
 import * as gh from './gh';
-export { fs, aws, gh };
+import * as utils from './utils';
+export { fs, aws, gh, utils };
 declare const _default: {
     fs: typeof fs;
     aws: typeof aws;
     gh: typeof gh;
+    utils: typeof utils;
 };
 export default _default;
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,MAAM,CAAC;AAC3B,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,EAAE,MAAM,MAAM,CAAC;AAG3B,OAAO,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC;;;;;;AACvB,wBAA+B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,MAAM,CAAC;AAC3B,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,EAAE,MAAM,MAAM,CAAC;AAC3B,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AAGjC,OAAO,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;;;;;;;AAC9B,wBAAsC"}

package/dist/types/utils/index.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="node" />
+export declare const assertPath: (p: string) => string;
+export declare const sha1Hash: (data: string) => string | null;
+export declare const sha256Hash: (data: string | Buffer) => string | null;
+export declare const fileHash: (file: string) => Promise<string | null>;
+//# sourceMappingURL=index.d.ts.map

package/dist/types/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":";AAMA,eAAO,MAAM,UAAU,MAAO,MAAM,WAGnC,CAAC;AAEF,eAAO,MAAM,QAAQ,SAAU,MAAM,kBAKpC,CAAC;AAEF,eAAO,MAAM,UAAU,SAAU,MAAM,GAAG,MAAM,kBAK/C,CAAC;AAEF,eAAO,MAAM,QAAQ,SAAgB,MAAM,2BAa1C,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@baadal-sdk/dapi",
-  "version": "0.28.4",
+  "version": "0.31.0",
   "description": "Dead-simple API wrappers",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -44,6 +44,7 @@
     "@babel/preset-env": "7.15.6",
     "@babel/preset-react": "^7.14.5",
     "@babel/preset-typescript": "7.15.0",
+    "@types/mime-types": "^2.1.1",
     "@types/node": "16.9.6",
     "@types/react": "^16.0.0",
     "@types/react-dom": "^16.0.0",
@@ -74,10 +75,13 @@
   },
   "dependencies": {
     "@aws-sdk/client-dynamodb": "^3.34.0",
+    "@aws-sdk/client-s3": "^3.36.0",
     "@aws-sdk/lib-dynamodb": "^3.34.0",
+    "@baadal-sdk/utils": "0.12.0",
     "@octokit/core": "^3.5.1",
     "chalk": "^2.4.2",
     "core-js": "^3.18.0",
+    "mime-types": "^2.1.33",
     "rimraf": "^3.0.2",
     "short-uuid": "^4.2.0"
   },

package/src/aws/client.ts

@@ -0,0 +1,18 @@
+import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';
+import { S3Client } from '@aws-sdk/client-s3';
+
+const dbDocClient: DynamoDBDocumentClient | null = null;
+const awsS3Client: S3Client | null = null;
+
+export const dbClient = { client: dbDocClient, id: null } as DBClientType;
+export const s3Client = { client: awsS3Client, id: null } as S3ClientType;
+
+export interface DBClientType {
+  client: DynamoDBDocumentClient | null;
+  id: string | null;
+}
+
+export interface S3ClientType {
+  client: S3Client | null;
+  id: string | null;
+}