@edraj/tsdmart 5.2.0 → 5.3.2

package/dist/dmart.service.d.ts

@@ -0,0 +1,248 @@
+import type { AxiosInstance } from "axios";
+import { DmartScope } from "./dmart.model";
+import type { ActionRequest, ActionRequestRecord, ActionResponse, ApiQueryResponse, ApiResponse, ConfirmOTPRequest, FetchDataAssetRequest, GetAttachmentURLRequest, GetChildrenRequest, GetPayloadRequest, LoginResponse, PasswordResetRequest, ProfileResponse, ProgressTicketRequest, QueryRequest, ResourcesFromCSVRequest, ResponseEntry, RetrieveEntryRequest, SendOTPRequest, SubmitRequest, UploadWithPayloadRequest } from "./dmart.model";
+export declare class Dmart {
+    static axiosDmartInstance: AxiosInstance;
+    /**
+     * Sets the Axios instance to be used for all HTTP requests
+     * @param axiosInstance - The Axios instance to use for API calls
+     */
+    static setAxiosInstance(axiosInstance: AxiosInstance): void;
+    /**
+     * Gets the current Axios instance
+     * @returns The configured Axios instance
+     * @throws Error if no Axios instance has been set
+     */
+    static getAxiosInstance(): AxiosInstance;
+    /**
+     * Gets the current headers object used for API requests
+     * @returns The headers object containing request headers
+     */
+    static getHeaders(): {
+        [key: string]: string;
+    };
+    /**
+     * Updates the headers object with new headers
+     * @param newHeaders - Object containing headers to merge with existing headers
+     */
+    static setHeaders(newHeaders: Record<string, string>): void;
+    /**
+     * Gets the base URL from the Axios instance
+     * @returns The base URL string
+     * @throws Error if no Axios instance has been set
+     */
+    static getBaseURL(): string | undefined;
+    /**
+     * Sets the base URL for the Axios instance
+     * @param url - The base URL to set
+     */
+    static setBaseURL(url: string): void;
+    /**
+     * Gets the current authentication token
+     * @returns The token string without the "Bearer " prefix, or null if not set
+     */
+    static getToken(): string | null;
+    /**
+     * Sets the authentication token in the headers
+     * @param token - The JWT token to use for authentication
+     */
+    static setToken(token: string): void;
+    /**
+     * Authenticates a user with shortname and password
+     * @param shortname - The user's shortname (username)
+     * @param password - The user's password
+     * @returns Promise resolving to LoginResponse containing authentication data and access token
+     */
+    static login(shortname: string, password: string): Promise<LoginResponse>;
+    /**
+     * Authenticates a user with custom credentials and password
+     * @param credentials - Object containing login credentials (e.g., email, phone, etc.)
+     * @param password - The user's password
+     * @returns Promise resolving to LoginResponse containing authentication data and access token
+     */
+    static loginBy(credentials: Record<string, string>, password: string): Promise<LoginResponse>;
+    /**
+     * Logs out the current user session
+     * @returns Promise resolving to ApiResponse indicating logout status
+     */
+    static logout(): Promise<ApiResponse>;
+    /**
+     * Creates a new user account
+     * @param request - ActionRequestRecord containing user creation data
+     * @returns Promise resolving to ActionResponse with creation result
+     */
+    static createUser(request: ActionRequestRecord): Promise<ActionResponse>;
+    /**
+     * Updates an existing user's profile information
+     * @param request - ActionRequestRecord containing user update data
+     * @returns Promise resolving to ActionResponse with update result
+     */
+    static updateUser(request: ActionRequestRecord): Promise<ActionResponse>;
+    /**
+     * Checks if a user property value already exists in the system
+     * @param prop - The property name to check (e.g., 'email', 'shortname')
+     * @param value - The value to check for existence
+     * @returns Promise resolving to ResponseEntry indicating if the value exists
+     */
+    static checkExisting(prop: string, value: string): Promise<ResponseEntry>;
+    /**
+     * Retrieves the current user's profile information
+     * @returns Promise resolving to ProfileResponse containing user profile data, permissions, and roles
+     */
+    static getProfile(): Promise<ProfileResponse>;
+    /**
+     * Executes a query against the Dmart API to retrieve data
+     * @param query - QueryRequest object containing query parameters, filters, and sorting options
+     * @param scope - The scope for the query (default: DmartScope.managed)
+     * @returns Promise resolving to ApiQueryResponse with query results or null
+     */
+    static query(query: QueryRequest, scope?: DmartScope): Promise<ApiQueryResponse | null>;
+    /**
+     * Exports query results as CSV format
+     * @param query - Query object with parameters for CSV export
+     * @returns Promise resolving to ApiQueryResponse containing CSV data
+     */
+    static csv(query: QueryRequest): Promise<ApiQueryResponse>;
+    /**
+     * Creates resources from an uploaded CSV file
+     * @param request - ResourcesFromCSVRequest containing file data and resource configuration
+     * @returns Promise resolving to ApiResponse with creation results
+     */
+    static resourcesFromCsv(request: ResourcesFromCSVRequest): Promise<ApiResponse>;
+    /**
+     * Executes a general request action against the Dmart API
+     * @param action - ActionRequest containing the request details and parameters
+     * @returns Promise resolving to ActionResponse with request result
+     */
+    static request(action: ActionRequest): Promise<ActionResponse>;
+    /**
+     * Retrieves a specific entry from the Dmart system
+     * @param request - RetrieveEntryRequest containing entry identification and retrieval options
+     * @param scope - The scope for the retrieval (default: DmartScope.managed)
+     * @returns Promise resolving to ResponseEntry with entry data or null if not found
+     */
+    static retrieveEntry(request: RetrieveEntryRequest, scope?: DmartScope): Promise<ResponseEntry | null>;
+    /**
+     * Uploads a resource with an attached payload file
+     * @param request - UploadWithPayloadRequest containing resource data and payload file
+     * @param scope - The scope for the upload operation (default: DmartScope.managed)
+     * @returns Promise resolving to ApiResponse with upload result
+     */
+    static uploadWithPayload(request: UploadWithPayloadRequest, scope?: DmartScope): Promise<ApiResponse>;
+    /**
+     * Fetches data assets from the Dmart system with optional SQL query filtering
+     * @param request - FetchDataAssetRequest containing asset identification and query parameters
+     * @returns Promise resolving to data asset response
+     */
+    static fetchDataAsset(request: FetchDataAssetRequest): Promise<any>;
+    /**
+     * Retrieves a list of all available spaces in the system
+     * @returns Promise resolving to ApiResponse containing spaces data or null
+     */
+    static getSpaces(): Promise<ApiResponse | null>;
+    /**
+     * Gets child resources within a specified space and subpath
+     * @param request - GetChildrenRequest containing search parameters and filters
+     * @returns Promise resolving to ApiResponse with child resources or null
+     */
+    static getChildren(request: GetChildrenRequest): Promise<ApiResponse | null>;
+    /**
+     * Generates a URL for accessing attachment resources
+     * @param request - GetAttachmentURLRequest containing attachment identification parameters
+     * @param scope - The scope for the attachment URL (default: DmartScope.managed)
+     * @returns String URL for accessing the attachment
+     */
+    static getAttachmentUrl(request: GetAttachmentURLRequest, scope?: DmartScope): string;
+    /**
+     * Retrieves health information and statistics for a specific space
+     * @param space_name - The name of the space to check health for
+     * @returns Promise resolving to ApiQueryResponse with health data and folders report
+     */
+    static getSpaceHealth(space_name: string): Promise<ApiResponse & {
+        attributes: {
+            total: number;
+            returned: number;
+        };
+    } & {
+        attributes: {
+            folders_report: Record<string, unknown>;
+        };
+    }>;
+    /**
+     * Retrieves payload data for a specific resource
+     * @param request - GetPayloadRequest containing payload identification parameters
+     * @param scope - The scope for the payload retrieval (default: DmartScope.managed)
+     * @returns Promise resolving to payload data
+     */
+    static getPayload(request: GetPayloadRequest, scope?: DmartScope): Promise<any>;
+    /**
+     * Updates the progress of a ticket with resolution and comments
+     * @param request - ProgressTicketRequest containing ticket identification and update data
+     * @returns Promise resolving to ApiQueryResponse with progress update result
+     */
+    static progressTicket(request: ProgressTicketRequest): Promise<ApiResponse & {
+        attributes: {
+            total: number;
+            returned: number;
+        };
+    } & {
+        attributes: {
+            folders_report: Record<string, unknown>;
+        };
+    }>;
+    /**
+     * Submits data to a public endpoint with optional workflow processing
+     * @param request - SubmitRequest containing submission data and routing information
+     * @returns Promise resolving to submission response data
+     */
+    static submit(request: SubmitRequest): Promise<any>;
+    /**
+     * Retrieves the system manifest containing configuration and metadata
+     * @returns Promise resolving to manifest data
+     */
+    static getManifest(): Promise<any>;
+    /**
+     * Retrieves the system settings and configuration
+     * @returns Promise resolving to settings data
+     */
+    static getSettings(): Promise<any>;
+    /**
+     * Sends an OTP (One-Time Password) request to a user
+     * @param request - SendOTPRequest containing recipient information
+     * @param acceptLanguage - Optional language preference for the OTP message (default: null)
+     * @returns Promise resolving to ApiResponse with OTP request result
+     */
+    static otpRequest(request: SendOTPRequest, acceptLanguage?: string | null): Promise<ApiResponse>;
+    /**
+     * Sends an OTP (One-Time Password) request for login purposes
+     * @param request - SendOTPRequest containing recipient information for login OTP
+     * @param acceptLanguage - Optional language preference for the OTP message (default: null)
+     * @returns Promise resolving to ApiResponse with OTP login request result
+     */
+    static otpRequestLogin(request: SendOTPRequest, acceptLanguage?: string | null): Promise<ApiResponse>;
+    /**
+     * Initiates a password reset request for a user
+     * @param request - PasswordResetRequest containing user identification for password reset
+     * @returns Promise resolving to ApiResponse with password reset request result
+     */
+    static passwordResetRequest(request: PasswordResetRequest): Promise<ApiResponse>;
+    /**
+     * Confirms an OTP (One-Time Password) code provided by the user
+     * @param request - ConfirmOTPRequest containing the OTP code and verification details
+     * @returns Promise resolving to ApiResponse with OTP confirmation result
+     */
+    static confirmOtp(request: ConfirmOTPRequest): Promise<ApiResponse>;
+    /**
+     * Resets a user's account or session state
+     * @param shortname - The shortname (username) of the user to reset
+     * @returns Promise resolving to ApiResponse with user reset result
+     */
+    static userReset(shortname: string): Promise<ApiResponse>;
+    /**
+     * Validates a password against system password policies and requirements
+     * @param password - The password string to validate
+     * @returns Promise resolving to ApiResponse with validation result
+     */
+    static validatePassword(password: string): Promise<ApiResponse>;
+}
+//# sourceMappingURL=dmart.service.d.ts.map

package/dist/dmart.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dmart.service.d.ts","sourceRoot":"","sources":["../dmart.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,OAAO,CAAC;AACzC,OAAO,EACH,UAAU,EAKb,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EACR,aAAa,EACb,mBAAmB,EACnB,cAAc,EACd,gBAAgB,EAChB,WAAW,EACX,iBAAiB,EACjB,qBAAqB,EACrB,uBAAuB,EACvB,kBAAkB,EAClB,iBAAiB,EACjB,aAAa,EACb,oBAAoB,EACpB,eAAe,EACf,qBAAqB,EACrB,YAAY,EACZ,uBAAuB,EACvB,aAAa,EACb,oBAAoB,EACpB,cAAc,EACd,aAAa,EACb,wBAAwB,EAC3B,MAAM,eAAe,CAAC;AAGvB,qBAAa,KAAK;IACd,MAAM,CAAC,kBAAkB,EAAE,aAAa,CAAC;IAEzC;;;OAGG;IACH,MAAM,CAAC,gBAAgB,CAAC,aAAa,EAAE,aAAa;IAIpD;;;;OAIG;WACW,gBAAgB,IAAI,aAAa;IAO/C;;;OAGG;WACW,UAAU;;;IAIxB;;;OAGG;WACW,UAAU,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAI3D;;;;OAIG;WACW,UAAU;IAIxB;;;OAGG;WACW,UAAU,CAAC,GAAG,EAAE,MAAM;IAIpC;;;OAGG;WACW,QAAQ;IAItB;;;OAGG;WACW,QAAQ,CAAC,KAAK,EAAE,MAAM;IAIpC;;;;;OAKG;WACiB,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAa7D;;;;;OAKG;WACiB,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,QAAQ,EAAE,MAAM;IAcjF;;;OAGG;WACiB,MAAM;IAS1B;;;;OAIG;WACiB,UAAU,CAAC,OAAO,EAAE,mBAAmB;IAS3D;;;;OAIG;WACiB,UAAU,CAAC,OAAO,EAAE,mBAAmB;IAS3D;;;;;OAKG;WACiB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAQ7D;;;OAGG;WACiB,UAAU;IAiB9B;;;;;OAKG;WACiB,KAAK,CACrB,KAAK,EAAE,YAAY,EACnB,KAAK,GAAE,UAA+B,GACvC,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAcnC;;;;OAIG;WACiB,GAAG,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAYvE;;;;OAIG;WACiB,gBAAgB,CAChC,OAAO,EAAE,uBAAuB;IAwCpC;;;;OAIG;WACiB,OAAO,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;IAO3E;;;;;OAKG;WACiB,aAAa,CAC7B,OAAO,EAAE,oBAAoB,EAC7B,KAAK,GAAE,UAA+B,GACvC,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;IAchC;;;;;OAKG;WACiB,iBAAiB,CACjC,OAAO,EAAE,wBAAwB,EACjC,KAAK,GAAE,UAA+B;IAqC1C;;;;OAIG;WACiB,cAAc,CAC9B,OAAO,EAAE,qBAAqB;IAkBlC;;;OAGG;WACiB,SAAS,IAAI,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAU5D;;;;OAIG;WACiB,WAAW,CAC3B,OAAO,EAAE,kBAAkB,GAC5B,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAsB9B;;;;;OAKG;WACW,gBAAgB,CAC1B,OAAO,EAAE,uBAAuB,EAChC,KAAK,GAAE,UAA+B;IAS1C;;;;OAIG;WACiB,cAAc,CAAC,UAAU,EAAE,MAAM;;;;;;oBAEZ;YAAE,cAAc,EAAE,OAAO,MAAM,EAAE,OAAO,CAAC,CAAA;SAAE;;IAKpF;;;;;OAKG;WACiB,UAAU,CAC1B,OAAO,EAAE,iBAAiB,EAC1B,KAAK,GAAE,UAA+B;IAe1C;;;;OAIG;WACiB,cAAc,CAC9B,OAAO,EAAE,qBAAqB;;;;;;oBAUO;YAAE,cAAc,EAAE,OAAO,MAAM,EAAE,OAAO,CAAC,CAAA;SAAE;;IASpF;;;;OAIG;WACiB,MAAM,CACtB,OAAO,EAAE,aAAa;IAkB1B;;;OAGG;WACiB,WAAW;IAO/B;;;OAGG;WACiB,WAAW;IAO/B;;;;;OAKG;WACiB,UAAU,CAC1B,OAAO,EAAE,cAAc,EACvB,cAAc,GAAE,MAAM,GAAG,IAAW;IAexC;;;;;OAKG;WACiB,eAAe,CAC/B,OAAO,EAAE,cAAc,EACvB,cAAc,GAAE,MAAM,GAAG,IAAW;IAexC;;;;OAIG;WACiB,oBAAoB,CAAC,OAAO,EAAE,oBAAoB;IAStE;;;;OAIG;WACiB,UAAU,CAAC,OAAO,EAAE,iBAAiB;IASzD;;;;OAIG;WACiB,SAAS,CAAC,SAAS,EAAE,MAAM;IAS/C;;;;OAIG;WACiB,gBAAgB,CAAC,QAAQ,EAAE,MAAM;CAQxD"}