@edraj/tsdmart 3.0.0 → 4.0.1

package/README.md

@@ -19,31 +19,194 @@ make sure you define `axiosDmartInstance` with your axios instance before import
 * `login(shortname: string, password: string) -> Promise<LoginResponse>` - Performs a login action (shortname).
 * `loginBy(credentials: dict, password: string) -> Promise<LoginResponse>` - Performs a login action but altering the default identifier that you can customise.
 * `logout() -> Promise<ApiResponse>` - Performs a logout action.
-* `otp_request(request: SendOTPRequest,acceptLanguage: string | null = null)  -> Promise<ApiResponse | null>` - Requests an OTP (One Time Password) for login.
-* `otp_request_login(request: SendOTPRequest,acceptLanguage: string | null = null) -> Promise<ApiResponse | null>` - Requests an OTP for login and returns a login response.
-* `password_reset_request(request: PasswordResetRequest) -> Promise<ApiResponse | null>` - Requests a password reset.
-* `confirm_otp(request: ConfirmOTPRequest) -> Promise<ApiResponse | null>` - Confirms the OTP (One Time Password) for login or password reset.
-* `user_reset(shortname: string) -> Promise<ApiResponse | null>` - Resets the user password by sending an OTP to the user's email.
-* `validate_password(password: string) -> Promise<ApiResponse | null>` - Validates the password.
-* `create_user(request: any) -> Promise<ActionResponse>` - Creates a new user.
-* `update_user(request: any) -> Promise<ActionResponse>` - Updates an existing user.
-* `check_existing(prop: string, value: string) -> Promise<ResponseEntry | null>` - Checks if a user exists.
-* `get_profile() -> Promise<ProfileResponse | null>` - Gets the profile of the current user.
+* `otpRequest(request: SendOTPRequest, acceptLanguage: string | null = null) -> Promise<ApiResponse>` - Requests an OTP (One Time Password) for login.
+* `otpRequestLogin(request: SendOTPRequest, acceptLanguage: string | null = null) -> Promise<ApiResponse>` - Requests an OTP for login and returns a login response.
+* `passwordResetRequest(request: PasswordResetRequest) -> Promise<ApiResponse>` - Requests a password reset.
+* `confirmOtp(request: ConfirmOTPRequest) -> Promise<ApiResponse>` - Confirms the OTP (One Time Password) for login or password reset.
+* `userReset(shortname: string) -> Promise<ApiResponse>` - Resets the user password by sending an OTP to the user's email.
+* `validatePassword(password: string) -> Promise<ApiResponse>` - Validates the password.
+* `createUser(request: ActionRequestRecord) -> Promise<ActionResponse>` - Creates a new user.
+* `updateUser(request: ActionRequestRecord) -> Promise<ActionResponse>` - Updates an existing user.
+* `checkExisting(prop: string, value: string) -> Promise<ResponseEntry>` - Checks if a user exists.
+* `getProfile() -> Promise<ProfileResponse>` - Gets the profile of the current user.
 * `query(query: QueryRequest) -> Promise<ApiQueryResponse | null>` - Performs a query action.
 * `csv(query: any) -> Promise<ApiQueryResponse>` - Query the entries as csv file.
 * `space(action: ActionRequest) -> Promise<ActionResponse>` - Performs actions on spaces.
 * `request(action: ActionRequest) -> Promise<ActionResponse>` - Performs a request action.
-* `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) -> Promise<ResponseEntry|null>` - Performs a retrieve action.
-* `upload_with_payload(space_name: string, subpath: string, shortname: string, resource_type: ResourceType, payload_file: File, content_type?: ContentType, schema_shortname?: string) -> Promise<ApiResponse>` - Uploads a file with a payload.
-* `fetchDataAsset(resourceType: string, dataAssetType: string, spaceName: string, subpath: string, shortname: string, query_string?: string, filter_data_assets?: string[], branch_name?: string) -> Promise<any>` - Fetches a data asset.
-* `get_spaces() -> Promise<ApiResponse | null>` - Gets the spaces (user query).
-* `get_children(space_name: string, subpath: string, limit: number = 20, offset: number = 0, restrict_types: Array<ResourceType> = []) -> Promise<ApiResponse | null>` - Gets the children of a space (user query).
-* `get_attachment_url(resource_type: ResourceType, space_name: string, subpath: string, parent_shortname: string, shortname: string, ext: string) -> string` - Constructs the URL of an attachment.
-* `get_space_health(space_name: string) -> Promise<ApiQueryResponse & { attributes: { folders_report: Object } }>` - Gets the health check of a space.
-* `get_attachment_content(resource_type: string, space_name: string, subpath: string, shortname: string) -> Promise<any>` - Gets the content of an attachment.
-* `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.
+* `retrieveEntry(request: RetrieveEntryRequest, scope: string = "managed") -> Promise<ResponseEntry | null>` - Performs a retrieve action.
+* `uploadWithPayload(request: UploadWithPayloadRequest, scope: string = "managed") -> Promise<ApiResponse>` - Uploads a file with a payload.
+* `fetchDataAsset(request: FetchDataAssetRequest) -> Promise<any>` - Fetches a data asset.
+* `getSpaces() -> Promise<ApiResponse | null>` - Gets the spaces (user query).
+* `getChildren(request: GetChildrenRequest) -> Promise<ApiResponse | null>` - Gets the children of a space (user query).
+* `getAttachmentUrl(request: GetAttachmentURLRequest, scope: string = "managed") -> string` - Constructs the URL of an attachment.
+* `getSpaceHealth(space_name: string) -> Promise<ApiQueryResponse & { attributes: { folders_report: Object } }>` - Gets the health check of a space.
+* `getPayload(request: GetPayloadRequest, scope: string = "managed") -> Promise<any>` - Gets the payload of a resource.
+* `progressTicket(request: ProgressTicketRequest) -> Promise<ApiQueryResponse & { attributes: { folders_report: Object } }>` - Performs a progress ticket action.
+* `submit(request: SubmitRequest) -> Promise<any>` - Submits a record (log/feedback) to Dmart.
+* `getManifest() -> Promise<any>` - Gets the manifest of the current instance.
+* `getSettings() -> Promise<any>` - Gets the settings of the current instance.
+
+# Usage
+
+* Initialize the Dmart instance:
+```js
+export const dmartAxios = axios.create({
+    baseURL: backendURL,
+    withCredentials: true,
+});
+Dmart.setAxiosInstance(dmartAxios);
+```
+
+## Manage user
+
+* Create user
+```ts
+const createUserRequest: ActionRequest = {
+    space_name: 'users',
+    request_type: RequestType.create,
+    records: [
+        {
+            resource_type: ResourceType.user,
+            shortname: 'john_doe', // auto: for auto-generated shortname
+            attributes: {
+                password: 'my-password',
+                is_active: true,
+                // email, msisdn, displayname are optional
+                email: 'john_doe@example.com',
+                msisdn: '1234567890',
+                password: 'securePassword123',
+                displayname: {en: 'John Doe'},
+                // roles is optional
+                roles: ['store_manager'],
+                // is_msisdn_verified, is_email_verified are optional
+                is_msisdn_verified: true,
+                is_email_verified: true,
+                // is force_password_change is optional
+                is_force_password_change: false,
+                // payload is optional
+                payload: {
+                    content_type: 'json',
+                    body: {
+                        additional_info: 'This is some additional information about the user.'
+                    }
+                }
+            }
+        }
+    ]
+};
+
+const response = await Dmart.createUser(createUserRequest.records[0]);
+```
+
+* Login with credentials
+
+```ts
+const response = await Dmart.login('john_doe', 'securePassword123');
+
+loginBy({email: 'john_doe@example.com'}, 'securePassword123');
+
+loginBy({msisdn: '1234567890'}, 'securePassword123');
+```
+
+* Get user profile
+
+```ts
+const profileResponse = await Dmart.getProfile();
+```
+
+* Update user
+
+```ts
+const updateUserRequest: ActionRequest = {
+    space_name: 'users',
+    request_type: RequestType.update,
+    records: [
+        {
+            resource_type: ResourceType.user,
+            shortname: 'john_doe',
+            attributes: {
+                payload: {
+                    content_type: 'json',
+                    body: {
+                        'rotation': 'bi-weekly'
+                    }
+                }
+            }
+        }
+    ]
+};
+
+const response = await Dmart.updateUser(updateUserRequest.records[0]);
+```
+
+## Managing entries
+
+* Create entry
+
+```ts
+const createRequest: ActionRequest = {
+    space_name: 'test_space',
+    request_type: RequestType.create,
+    records: [
+        {
+            resource_type: ResourceType.content,
+            subpath: '/dummies',
+            shortname: 'dummy_001',
+            attributes: {
+                payload: {
+                    content_type: 'json',
+                    body: {
+                        title: 'Test Dummy Entry',
+                        description: 'This is a test dummy entry',
+                        status: 'active'
+                    }
+                }
+            }
+        }
+    ]
+};
+const response = await Dmart.request(createRequest);
+```
+
+* Update entry
+
+```ts
+const updateRequest: ActionRequest = {
+    space_name: 'test_space',
+    request_type: RequestType.update,
+    records: [
+        {
+            resource_type: ResourceType.content,
+            subpath: '/dummies',
+            shortname: 'dummy_001',
+            attributes: {
+                payload: {
+                    content_type: 'json',
+                    body: {
+                        status: 'unactive'
+                    }
+                }
+            }
+        }
+    ]
+};
+const response = await Dmart.request(createRequest);
+```
+
+* Delete entry
+
+```ts
+const deleteRequest: ActionRequest = {
+    space_name: 'test_space',
+    request_type: RequestType.delete,
+    records: [
+        {
+            resource_type: ResourceType.content,
+            subpath: '/dummies',
+            shortname: 'dummy_001',
+            attributes: {}
+        }
+    ]
+};
+const response = await Dmart.request(createRequest);
+```

package/dmart.model.ts

@@ -52,6 +52,11 @@ export interface SendOTPRequest {
   email?: string;
 }
 
+export enum DmartScope {
+    managed = "managed",
+    public = "public",
+}
+
 export interface PasswordResetRequest {
   msisdn?: string;
   shortname?: string;
@@ -344,3 +349,88 @@ export type ActionRequest = {
 export type ApiQueryResponse = ApiResponse & {
   attributes: { total: number; returned: number };
 };
+
+export interface ResourcesFromCSVRequest {
+    space_name: string,
+    subpath: string,
+    resourceType: ResourceType,
+    schema: string,
+    payload: File,
+}
+
+export interface RetrieveEntryRequest {
+    resource_type: ResourceType,
+    space_name: string,
+    subpath: string,
+    shortname: string,
+    retrieve_json_payload: boolean,
+    retrieve_attachments: boolean,
+    validate_schema: boolean|null,
+}
+
+export interface UploadWithPayloadRequest {
+    space_name: string,
+    subpath: string,
+    shortname: string,
+    resource_type: ResourceType,
+    payload_file: File,
+    attributes?: Record<string, any> | null,
+}
+
+export interface FetchDataAssetRequest {
+    resourceType: string,
+    dataAssetType: string,
+    spaceName: string,
+    subpath: string,
+    shortname: string,
+    query_string?: string,
+    filter_data_assets?: string[]
+}
+
+export interface GetChildrenRequest {
+    space_name: string,
+    subpath: string,
+    search: string,
+    limit: number|null,
+    offset: number|null,
+    restrict_types: Array<ResourceType>|null
+}
+
+export interface GetAttachmentURLRequest {
+    resource_type: ResourceType,
+    space_name: string,
+    subpath: string,
+    parent_shortname: string,
+    shortname: string,
+    ext: string | null,
+}
+
+export interface GetPayloadRequest {
+    resource_type: ResourceType,
+    space_name: string,
+    subpath: string,
+    shortname: string,
+    schemaShortname: string | null,
+    ext: string,
+}
+
+export interface ProgressTicketRequest {
+    space_name: string,
+    subpath: string,
+    shortname: string,
+    action: string,
+    resolution?: string,
+    comment?: string
+}
+
+export interface SubmitRequest {
+    spaceName: string,
+    schemaShortname: string,
+    subpath: string,
+    record: any,
+    resourceType?: string,
+    workflowShortname?: string,
+}
+
+
+