@edraj/tsdmart 1.0.8 → 1.0.10

package/README.md

@@ -4,7 +4,8 @@ A TypeScript implementation of the Dmart that depends on axios.
 
 ## APIs
 
-* `login(shortname: string, password: string) -> Promise<ApiResponse>` - Performs a login action.
+* `login(shortname: string, password: string) -> Promise<ApiResponse>` - Performs a login action (shortname).
+* `loginBy(credentials: dict, password: string) -> Promise<ApiResponse>` - Performs a login action but altering the default identifier that you can customise.
 * `logout() -> Promise<ApiResponse>` - Performs a logout action.
 * `create_user(request: any) -> Promise<ActionResponse>` - Creates a new user.
 * `update_user(request: any) -> Promise<ActionResponse>` - Updates an existing user.

package/index.ts

@@ -8,7 +8,7 @@ export enum Status {
     failed = "failed",
 }
 
-type Error = {
+export type Error = {
     type: string;
     code: number;
     message: string;
@@ -29,19 +29,19 @@ export type ApiResponse = {
     records: Array<ApiResponseRecord>;
 };
 
-type Translation = {
+export type Translation = {
     ar: string;
     en: string;
     kd: string;
 };
 
-enum UserType {
+export enum UserType {
     web = "web",
     mobile = "mobile",
     bot = "bot",
 }
 
-type LoginResponseRecord = ApiResponseRecord & {
+export type LoginResponseRecord = ApiResponseRecord & {
     attributes: {
         access_token: string;
         type: UserType;
@@ -51,14 +51,14 @@ type LoginResponseRecord = ApiResponseRecord & {
 
 // type LoginResponse = ApiResponse  & { records : Array<LoginResponseRecord> };
 
-type Permission = {
+export type Permission = {
     allowed_actions: Array<ActionType>;
     conditions: Array<string>;
     restricted_fields: Array<any>;
     allowed_fields_values: Map<string, any>;
 };
 
-enum Language {
+export enum Language {
     arabic = "arabic",
     english = "engligh",
     kurdish = "kurdish",
@@ -66,7 +66,7 @@ enum Language {
     turkish = "turkish",
 }
 
-type ProfileResponseRecord = ApiResponseRecord & {
+export type ProfileResponseRecord = ApiResponseRecord & {
     attributes: {
         email: string;
         displayname: Translation;
@@ -121,6 +121,8 @@ export enum QueryType {
     spaces = "spaces",
     counters = "counters",
     reports = "reports",
+    attachments = "attachments",
+    attachments_aggregation = "attachments_aggregation"
 }
 
 export enum SortyType {
@@ -233,7 +235,7 @@ export enum ContentTypeMedia {
     video = "video",
 }
 
-type Payload = {
+export type Payload = {
     content_type: ContentType;
     schema_shortname?: string;
     checksum: string;
@@ -242,7 +244,7 @@ type Payload = {
     validation_status: "valid" | "invalid";
 };
 
-type MetaExtended = {
+export type MetaExtended = {
     email: string;
     msisdn: string;
     is_email_verified: boolean;
@@ -300,7 +302,7 @@ export type ActionResponse = ApiResponse & {
     >;
 };
 
-type ActionRequestRecord = {
+export type ActionRequestRecord = {
     resource_type: ResourceType;
     uuid?: string;
     shortname: string;
@@ -316,7 +318,7 @@ export type ActionRequest = {
 };
 
 
-type ApiQueryResponse = ApiResponse & {
+export type ApiQueryResponse = ApiResponse & {
     attributes: { total: number; returned: number };
 };
 
@@ -327,12 +329,13 @@ export default class Dmart {
         const {data} = await axios.post<
             ApiResponse & { records: Array<LoginResponseRecord> }
         >(this.baseURL + "/user/login", {shortname, password}, {headers});
-        //console.log(JSON.stringify(data, null, 2));
-        // FIXME settins Authorization is only needed when the code is running on the server
-        /*headers.Authorization = "";
-        if (data.status == Status.success && data.records.length > 0) {
-          headers.Authorization = "Bearer " + data.records[0].attributes.access_token;
-        }*/
+        return data;
+    }
+
+    public static async loginBy(credentials: any, password: string) {
+        const {data} = await axios.post<
+            ApiResponse & { records: Array<LoginResponseRecord> }
+        >(this.baseURL + "/user/login", {...credentials, password}, {headers});
         return data;
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edraj/tsdmart",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "description": "A TypeScript implementation of the Dmart that depends on axios.",
   "author": "Kefah T. Issa",
   "email": "kefah.issa@gmail.com",
@@ -21,6 +21,6 @@
     "typescript": "^5.4.2"
   },
   "dependencies": {
-    "axios": "^1.6.8"
+    "axios": "^1.7.9"
   }
 }