@edraj/tsdmart 2.1.1 → 2.2.0

package/client.ts

@@ -0,0 +1,112 @@
+import axios, { AxiosInstance, CreateAxiosDefaults } from "axios";
+import { Config } from "./config";
+import {
+    ActionRequest,
+    ClientError,
+    ContentType,
+    QueryRequest,
+    ResourceType,
+} from "./dmart.model";
+import { get_profile, login, logout } from "./services/auth";
+import { query, retrieve_entry } from "./services/query";
+import { request, submit } from "./services/request";
+import { upload_with_payload } from "./services/upload";
+
+export class DmartClient {
+  client: AxiosInstance;
+
+  constructor(config: CreateAxiosDefaults) {
+    this.client = axios.create({ ...Config, ...config });
+
+    this.client.interceptors.response.use(null, function (error) {
+      // need error.code (enum), error.status (same), error.message (axios)
+      // error.response.data (dmart), error.response.config. method, url,
+      const err: ClientError = {
+        code: error.code,
+        status: error.status,
+        message: error.message,
+        request: {
+          url: error.response?.config?.url,
+          method: error.response?.config?.method,
+        },
+        response: error.response?.data,
+      };
+      return Promise.reject(err);
+    });
+  }
+
+  async login(shortname: string, password: string) {
+    return login(shortname, password, this.client);
+  }
+
+  async get_profile() {
+    return get_profile(this.client);
+  }
+
+  async logout() {
+    return logout(this.client);
+  }
+
+  async query(q: QueryRequest, scope: string = "managed") {
+    return query(this.client, q, scope);
+  }
+
+  async retrieve_entry(
+    resource_type: ResourceType,
+    space_name: string,
+    subpath: string,
+    shortname: string,
+    retrieve_json_payload: boolean = false,
+    retrieve_attachments: boolean = false,
+    validate_schema: boolean = true,
+    scope: string = "managed"
+  ) {
+    return retrieve_entry(
+      this.client,
+      resource_type,
+      space_name,
+      subpath,
+      shortname,
+      retrieve_json_payload,
+      retrieve_attachments,
+      validate_schema,
+      scope
+    );
+  }
+
+  async upload_with_payload(
+    space_name: string,
+    subpath: string,
+    shortname: string,
+    resource_type: ResourceType,
+    payload_file: File,
+    content_type?: ContentType,
+    schema_shortname?: string,
+    scope: string = "managed"
+  ) {
+    return upload_with_payload(
+      this.client,
+      space_name,
+      subpath,
+      shortname,
+      resource_type,
+      payload_file,
+      content_type,
+      schema_shortname,
+      scope
+    );
+  }
+
+  async request(action: ActionRequest) {
+    return request(this.client, action);
+  }
+
+  async submit(
+    spaceName: string,
+    schemaShortname: string,
+    subpath: string,
+    record: any
+  ) {
+    return submit(this.client, spaceName, schemaShortname, subpath, record);
+  }
+}

package/config.ts

@@ -0,0 +1,9 @@
+
+export const Config = {
+  baseURL: "http://localhost:8282",
+  headers: {
+    "Content-type": "application/json",
+    "Authorization": "",
+  },
+};
+

package/dmart.model.ts

@@ -38,7 +38,7 @@ export type ApiResponse = {
 export type Translation = {
   ar: string;
   en: string;
-  kd: string;
+  ku: string;
 };
 
 export enum UserType {

package/dmart.service.ts

@@ -27,9 +27,12 @@ axios.interceptors.response.use(null, function (error) {
     code: error.code,
     status: error.status,
     message: error.message,
-    request: {url: error.response?.config?.url, method: error.response?.config?.method},
-    response: error.response?.data
-  }
+    request: {
+      url: error.response?.config?.url,
+      method: error.response?.config?.method,
+    },
+    response: error.response?.data,
+  };
   return Promise.reject(err);
 });
 export const dmartClient = axios;
@@ -38,21 +41,17 @@ export class Dmart {
   //   static baseURL = "http://localhost:8282";
 
   public static async login(shortname: string, password: string) {
-    try {
-      const response = await axios.post<LoginResponse>(
-        `user/login`,
-        { shortname, password },
-        { headers }
-      );
-      const data: LoginResponse = response.data;
-      if (data.status == Status.success && data.records.length > 0) {
-        headers["Authorization"] =
-          "Bearer " + data.records[0]?.attributes.access_token;
-      }
-      return data;
-    } catch (error: any) {
-      throw error;
+    const response = await axios.post<LoginResponse>(
+      `user/login`,
+      { shortname, password },
+      { headers }
+    );
+    const data: LoginResponse = response.data;
+    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) {
@@ -358,6 +357,7 @@ export class Dmart {
     }
   }
 
+  // TODO: update to enums
   public static async get_attachment_content(
     resource_type: string,
     space_name: string,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edraj/tsdmart",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "description": "A TypeScript implementation of the Dmart that depends on axios.",
   "author": "Kefah T. Issa",
   "email": "kefah.issa@gmail.com",

package/services/auth.ts

@@ -0,0 +1,45 @@
+import { AxiosInstance } from "axios";
+import { Config } from '../config';
+import {
+  ApiResponse,
+  headers,
+  LoginResponse,
+  ProfileResponse,
+  Status,
+} from "../dmart.model";
+
+export const login = async (
+  shortname: string,
+  password: string,
+  client: AxiosInstance
+) => {
+  // use which client? defaultAxios if what?
+  const response = await client.post<LoginResponse>(
+    `user/login`,
+    { shortname, password },
+    { headers: Config.headers }
+  );
+  const data: LoginResponse = response.data;
+  if (data.status == Status.success && data.records.length > 0) {
+    headers["Authorization"] =
+      "Bearer " + data.records[0]?.attributes.access_token;
+  }
+  return data;
+};
+
+export const get_profile = async (client: AxiosInstance) => {
+  const { data } = await client.get<ProfileResponse>(`user/profile`, {
+    headers: Config.headers,
+  });
+  
+  return data;
+};
+
+export const logout = async (client: AxiosInstance) => {
+  const { data } = await client.post<ApiResponse>(
+    `user/logout`,
+    {},
+    { headers: Config.headers }
+  );
+  return data;
+};

package/services/query.ts

@@ -0,0 +1,53 @@
+import { AxiosInstance } from "axios";
+import { Config } from '../config';
+import {
+  ApiQueryResponse,
+  QueryRequest,
+  QueryType,
+  ResourceType,
+  ResponseEntry,
+  SortyType,
+} from "../dmart.model";
+
+export const query = async (
+  client: AxiosInstance,
+  query: QueryRequest,
+  scope: string = "managed"
+): Promise<ApiQueryResponse | null> => {
+  if (query.type !== QueryType.spaces) {
+    query.sort_type = query.sort_type || SortyType.ascending;
+    query.sort_by = query.sort_by || "created_at";
+  }
+
+  // bad!
+  query.subpath = query.subpath.replace(/\/+/g, "/");
+  const { data } = await client.post<ApiQueryResponse>(
+    `${scope}/query`,
+    query,
+    {
+      headers: Config.headers,
+      timeout: 3000,
+    }
+  );
+  return data;
+};
+
+export const retrieve_entry = async (
+  client: AxiosInstance,
+  resource_type: ResourceType,
+  space_name: string,
+  subpath: string,
+  shortname: string,
+  retrieve_json_payload: boolean = false,
+  retrieve_attachments: boolean = false,
+  validate_schema: boolean = true,
+  scope: string = "managed"
+): Promise<ResponseEntry | null> => {
+  if (!subpath || subpath == "/") subpath = "__root__";
+  const url = `${scope}/entry/${resource_type}/${space_name}/${subpath}/${shortname}?retrieve_json_payload=${retrieve_json_payload}&retrieve_attachments=${retrieve_attachments}&validate_schema=${validate_schema}`;
+  const { data } = await client.get<ResponseEntry>(
+    `${url.replace(/\/+/g, "/")}`,
+    { headers: Config.headers }
+  );
+  return data;
+};

package/services/request.ts

@@ -0,0 +1,29 @@
+import { AxiosInstance } from "axios";
+import { Config } from '../config';
+import { ActionRequest, ActionResponse } from "../dmart.model";
+
+export const request = async (
+  client: AxiosInstance,
+  action: ActionRequest
+): Promise<ActionResponse> => {
+  const res = await client.post<ActionResponse>(`managed/request`, action, {
+    headers: Config.headers,
+  });
+  return res?.data;
+};
+
+// this is useless
+export const submit = async (
+  client: AxiosInstance,
+  spaceName: string,
+  schemaShortname: string,
+  subpath: string,
+  record: any
+) => {
+  const { data } = await client.post(
+    `public/submit/${spaceName}/${schemaShortname}/${subpath}`,
+    record,
+    { headers: Config.headers }
+  );
+  return data;
+};

package/services/upload.ts

@@ -0,0 +1,46 @@
+import { AxiosInstance } from "axios";
+import { ApiResponse, ContentType, ResourceType } from "../dmart.model";
+
+export const upload_with_payload = async (
+  client: AxiosInstance,
+  space_name: string,
+  subpath: string,
+  shortname: string,
+  resource_type: ResourceType,
+  payload_file: File,
+  content_type?: ContentType,
+  schema_shortname?: string,
+  scope: string = "managed"
+): Promise<ApiResponse> => {
+  const request_record_body: any = {
+    resource_type,
+    subpath,
+    shortname,
+    attributes: { is_active: true, payload: { body: {} } },
+  };
+  if (content_type) {
+    request_record_body.attributes.payload.content_type = content_type;
+  }
+  if (schema_shortname) {
+    request_record_body.attributes.payload.schema_shortname = schema_shortname;
+  }
+
+  const request_record = new Blob([JSON.stringify(request_record_body)], {
+    type: "application/json",
+  });
+
+  const form_data = new FormData();
+  form_data.append("space_name", space_name);
+  form_data.append("request_record", request_record);
+  form_data.append("payload_file", payload_file);
+
+  const headers = { "Content-Type": "multipart/form-data" };
+
+  const { data } = await client.post<ApiResponse>(
+    `${scope}/resource_with_payload`,
+    form_data,
+    { headers }
+  );
+
+  return data;
+};

package/services/user.ts

@@ -0,0 +1,12 @@
+import { AxiosInstance } from 'axios';
+import { Config } from '../config';
+import { ApiResponse } from '../dmart.model';
+
+export const create_user = async (client: AxiosInstance) => {
+  const { data } = await client.post<ApiResponse>(
+    `user/logout`,
+    {},
+    { headers: Config.headers }
+  );
+  return data;
+};

package/test.ts

@@ -1,46 +1,70 @@
-import Dmart from "./index";
-
-
-Dmart.baseURL = 'http://localhost:8282';
-
-const r = await Dmart.login('dmart', 'Test1234')
-console.log({r});
-const request:any = {
-  space_name: "management",
-  request_type: "update",
-  records: [
-    {
-      resource_type: "user",
-      shortname: "zainebfrontend",
-      subpath: "/users",
-      attributes: {
-        description: {
-          ar: "desc ar",
-          en: "HelloWorld en",
-          ku: "desc ku"
-        },
-        displayname: {
-          ar: "name ar",
-          en: "myName en",
-          ku: "name ku"
-        },
-        is_active: true,
-        invitation: "",
-        payload: {
-          body: {
-            email: "zainebb@gmail.com",
-            first_name: "Jo",
-            last_name: "Do",
-            mobile: "792211703",
-            language: "english"
-          },
-          content_type: "json",
-          // schema_shortname: "user"
-        },
-        tags: []
-      }
-    }
-  ]
-};
-const u = await Dmart.request(request);
-console.log({u});
+
+
+
+// Dmart.baseURL = 'http://localhost:8282';
+//
+// const r = await Dmart.login('dmart', 'Test1234')
+// console.log({r});
+// const request:any = {
+//   space_name: "management",
+//   request_type: "update",
+//   records: [
+//     {
+//       resource_type: "user",
+//       shortname: "zainebfrontend",
+//       subpath: "/users",
+//       attributes: {
+//         description: {
+//           ar: "desc ar",
+//           en: "HelloWorld en",
+//           ku: "desc ku"
+//         },
+//         displayname: {
+//           ar: "name ar",
+//           en: "myName en",
+//           ku: "name ku"
+//         },
+//         is_active: true,
+//         invitation: "",
+//         payload: {
+//           body: {
+//             email: "zainebb@gmail.com",
+//             first_name: "Jo",
+//             last_name: "Do",
+//             mobile: "792211703",
+//             language: "english"
+//           },
+//           content_type: "json",
+//           // schema_shortname: "user"
+//         },
+//         tags: []
+//       }
+//     }
+//   ]
+// };
+// const u = await Dmart.request(request);
+// console.log({u});
+
+import {Dmart, dmartClient} from "./dmart.service";
+import {ContentType, ResourceType} from "./dmart.model";
+import * as fs from "node:fs";
+
+dmartClient.defaults.baseURL = 'https://nova.imx.sh/dmart';
+
+Dmart.login('dmart', 'NdFVYdcsoo1M5u08').then(r => {
+    const myPDFBuffer = fs.readFileSync('/home/splimter/projects/zain/vvv/testpdf.pdf');
+    const myPDF = new File([myPDFBuffer], "testpdf.pdf", { type: "application/pdf" });
+
+
+    Dmart.upload_with_payload(
+        "referrals", `candidates/30304cab`, "auto",
+        ResourceType.media, myPDF, ContentType.pdf,
+        null, 'public'
+    ).then(r=> {
+        console.log({r})
+    }).catch(e=> {
+        console.log({e})
+    })
+});
+
+