@edraj/tsdmart 1.0.4 → 1.0.6

package/README.md

@@ -2,7 +2,7 @@
 
 A TypeScript implementation of the Dmart that depends on axios.
 
-## APIs 
+## APIs
 
 * `login(shortname: string, password: string) -> Promise<ApiResponse>` - Performs a login action.
 * `logout() -> Promise<ApiResponse>` - Performs a logout action.
@@ -25,5 +25,6 @@ A TypeScript implementation of the Dmart that depends on axios.
 * `get_payload(resource_type: string, space_name: string, subpath: string, shortname: string, ext: string = ".json") -> Promise<any>` - Gets the payload of a resource.
 * `get_payload_content(resource_type: string, space_name: string, subpath: string, shortname: string, ext: string = ".json") -> Promise<any>` - Gets the content of a payload.
 * `progress_ticket(space_name: string, subpath: string, shortname: string, action: string, resolution?: string, comment?: string) -> Promise<ApiQueryResponse & { attributes: { folders_report: Object } }>` - Performs a progress ticket action.
+* `submit(spaceName: string,  schemaShortname: string,  subpath: string,  record: any)  -> Promise<any>`  - Submits a record (log/feedback) to Dmart.
 * `get_manifest() -> Promise<any>` - Gets the manifest of the current instance.
 * `get_settings() -> Promise<any>` - Gets the settings of the current instance.

package/index.ts

@@ -1,6 +1,6 @@
 import axios from "axios";
 
-let baseURL = "http://localhost:8282";
+
 
 axios.defaults.withCredentials = true;
 
@@ -163,6 +163,8 @@ export enum RequestType {
     replace = "replace",
     delete = "delete",
     move = "move",
+    updateACL = "update_acl",
+    assign = "assign",
 }
 
 export enum ResourceAttachmentType {
@@ -319,10 +321,12 @@ type ApiQueryResponse = ApiResponse & {
 };
 
 export default class Dmart {
+    static baseURL = "http://localhost:8282";
+
     public static async login(shortname: string, password: string) {
         const { data } = await axios.post<
             ApiResponse & { records: Array<LoginResponseRecord> }
-        >(baseURL + "/user/login", { shortname, password }, { headers });
+        >(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 = "";
@@ -334,7 +338,7 @@ export default class Dmart {
 
     public static async logout() {
         const { data } = await axios.post<ApiResponse>(
-            baseURL + "/user/logout",
+            this.baseURL + "/user/logout",
             {},
             { headers }
         );
@@ -344,7 +348,7 @@ export default class Dmart {
     public static async create_user(request: any) {
         try {
             const { data } = await axios.post<ActionResponse>(
-                baseURL + "/user/create",
+                this.baseURL + "/user/create",
                 request,
                 { headers }
             );
@@ -357,7 +361,7 @@ export default class Dmart {
     public static async update_user(request: any) {
         try {
             const { data } = await axios.post<ActionResponse>(
-                baseURL + "/user/profile",
+                this.baseURL + "/user/profile",
                 request,
                 { headers }
             );
@@ -370,8 +374,7 @@ export default class Dmart {
     public static async check_existing(prop: string, value: string) {
         try {
             const { data } = await axios.get<ResponseEntry>(
-                baseURL +
-                `/user/check-existing?${prop}=${value}`,
+                `${this.baseURL}/user/check-existing?${prop}=${value}`,
                 { headers }
             );
             return data;
@@ -383,7 +386,7 @@ export default class Dmart {
     public static async get_profile() {
         try {
             const { data } = await axios.get<ProfileResponse>(
-                baseURL + "/user/profile",
+                this.baseURL + "/user/profile",
                 {
                     headers,
                 }
@@ -412,7 +415,7 @@ export default class Dmart {
             }
             query.subpath = query.subpath.replace(/\/+/g, "/");
             const { data } = await axios.post<ApiQueryResponse>(
-                baseURL + "/managed/query",
+                this.baseURL + "/managed/query",
                 query,
                 { headers , timeout: 3000 }
             );
@@ -428,7 +431,7 @@ export default class Dmart {
             query.sort_by = "created_at";
             query.subpath = query.subpath.replace(/\/+/g, "/");
             const { data } = await axios.post<ApiQueryResponse>(
-                baseURL + "/managed/csv",
+                this.baseURL + "/managed/csv",
                 query,
                 { headers }
             );
@@ -441,7 +444,7 @@ export default class Dmart {
     public static async space(action: ActionRequest): Promise<ActionResponse> {
         try {
             const { data } = await axios.post<ActionResponse>(
-                baseURL + "/managed/space",
+                this.baseURL + "/managed/space",
                 action,
                 { headers }
             );
@@ -454,7 +457,7 @@ export default class Dmart {
     public static async request(action: ActionRequest): Promise<ActionResponse> {
         try {
             const { data } = await axios.post<ActionResponse>(
-                baseURL + "/managed/request",
+                this.baseURL + "/managed/request",
                 action,
                 { headers }
             );
@@ -476,8 +479,7 @@ export default class Dmart {
         try {
             if (!subpath || subpath == "/") subpath = "__root__";
             const { data } = await axios.get<ResponseEntry>(
-                baseURL +
-                `/managed/entry/${resource_type}/${space_name}/${subpath}/${shortname}?retrieve_json_payload=${retrieve_json_payload}&retrieve_attachments=${retrieve_attachments}&validate_schema=${validate_schema}`.replace(
+                `${this.baseURL}/managed/entry/${resource_type}/${space_name}/${subpath}/${shortname}?retrieve_json_payload=${retrieve_json_payload}&retrieve_attachments=${retrieve_attachments}&validate_schema=${validate_schema}`.replace(
                     /\/+/g,
                     "/"
                 ),
@@ -526,7 +528,7 @@ export default class Dmart {
         const headers = { "Content-Type": "multipart/form-data" };
 
         const { data } = await axios.post<ApiResponse>(
-            baseURL + "/managed/resource_with_payload",
+            this.baseURL + "/managed/resource_with_payload",
             form_data,
             { headers }
         );
@@ -546,8 +548,7 @@ export default class Dmart {
         branch_name?: string
     ) {
         try {
-            const endpoint = "/managed/data-asset";
-            const url = `${baseURL}${endpoint}`;
+            const url = `${this.baseURL}/managed/data-asset`;
             const { data } = await axios.post(
                 url,
                 {
@@ -562,7 +563,6 @@ export default class Dmart {
                 },
                 { headers }
             );
-
             return data;
         } catch (error: any) {
             return error;
@@ -598,7 +598,7 @@ export default class Dmart {
         });
     }
 
-    public get_attachment_url(
+    public static get_attachment_url(
         resource_type: ResourceType,
         space_name: string,
         subpath: string,
@@ -607,8 +607,7 @@ export default class Dmart {
         ext: string
     ) {
         return (
-            baseURL +
-            `/managed/payload/${resource_type}/${space_name}/${subpath.replace(
+            `${this.baseURL}/managed/payload/${resource_type}/${space_name}/${subpath.replace(
                 /\/+$/,
                 ""
             )}/${parent_shortname}/${shortname}.${ext}`.replaceAll("..", ".")
@@ -618,7 +617,7 @@ export default class Dmart {
     public static async get_space_health(space_name: string) {
         const { data } = await axios.get<
             ApiQueryResponse & { attributes: { folders_report: Object } }
-        >(baseURL + `/managed/health/${space_name}`, { headers });
+        >(this.baseURL + `/managed/health/${space_name}`, { headers });
         return data;
     }
 
@@ -629,8 +628,7 @@ export default class Dmart {
         shortname: string,
     ) {
         const { data } = await axios.get<any>(
-            baseURL +
-            `/managed/payload/${resource_type}/${space_name}/${subpath}/${shortname}`,
+            `${this.baseURL}/managed/payload/${resource_type}/${space_name}/${subpath}/${shortname}`,
             { headers }
         );
         return data;
@@ -643,8 +641,7 @@ export default class Dmart {
         ext: string = ".json"
     ) {
         const { data } = await axios.get<any>(
-            baseURL +
-            `/managed/payload/${resource_type}/${space_name}/${subpath}/${shortname}${ext}`,
+            `${this.baseURL}/managed/payload/${resource_type}/${space_name}/${subpath}/${shortname}${ext}`,
             { headers }
         );
         return data;
@@ -657,8 +654,7 @@ export default class Dmart {
         ext: string = ".json"
     ) {
         const { data } = await axios.get<any>(
-            baseURL +
-            `/managed/payload/${resource_type}/${space_name}/${subpath}/${shortname}${ext}`,
+            `${this.baseURL}/managed/payload/${resource_type}/${space_name}/${subpath}/${shortname}${ext}`,
             { headers }
         );
         return data;
@@ -683,8 +679,7 @@ export default class Dmart {
             const { data } = await axios.put<
                 ApiQueryResponse & { attributes: { folders_report: Object } }
             >(
-                baseURL +
-                `/managed/progress-ticket/${space_name}/${subpath}/${shortname}/${action}`,
+                `${this.baseURL}/managed/progress-ticket/${space_name}/${subpath}/${shortname}/${action}`,
                 payload,
                 { headers }
             );
@@ -694,18 +689,35 @@ export default class Dmart {
         }
     }
 
+    public static async submit(
+        spaceName: string,
+        schemaShortname: string,
+        subpath: string,
+        record: any // More general than Map<String, dynamic>
+    ){
+        try {
+            const {data} = await axios.post(
+                `${this.baseURL}/public/submit/${spaceName}/${schemaShortname}/${subpath}`,
+                record,
+                {headers}
+            );
+            return data;
+        } catch (error: any) {
+            return error.response.data;
+        }
+    }
+
     public static async get_manifest() {
-        const { data } = await axios.get<any>(baseURL + `/info/manifest`, {
+        const { data } = await axios.get<any>(this.baseURL + `/info/manifest`, {
             headers,
         });
         return data;
     }
 
     public static async get_settings() {
-        const { data } = await axios.get<any>(baseURL + `/info/settings`, {
+        const { data } = await axios.get<any>(this.baseURL + `/info/settings`, {
             headers,
         });
         return data;
     }
 }
-// 23 funcs

package/package.json

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