mira-form-sdk 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +9 -8
- package/dist/index.cjs.map +1 -1
- package/dist/index.mjs +9 -8
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.cjs
CHANGED
|
@@ -42,12 +42,13 @@ var MiraFormSDK = class {
|
|
|
42
42
|
* @return {PreparedFormData} An object containing the prepared FormData object or error messages if validation fails.
|
|
43
43
|
*/
|
|
44
44
|
prepareFormData(params) {
|
|
45
|
+
const { resourceId, formId, content, files } = params;
|
|
45
46
|
const errors = [];
|
|
46
|
-
if (!
|
|
47
|
+
if (!resourceId)
|
|
47
48
|
errors.push("resourceId is required");
|
|
48
|
-
if (!
|
|
49
|
+
if (!formId)
|
|
49
50
|
errors.push("formId is required");
|
|
50
|
-
if (
|
|
51
|
+
if (content && typeof content !== "object")
|
|
51
52
|
errors.push("content must be a valid object");
|
|
52
53
|
if (errors.length)
|
|
53
54
|
return { formData: null, errors };
|
|
@@ -55,10 +56,10 @@ var MiraFormSDK = class {
|
|
|
55
56
|
formData.append("resourceId", params.resourceId);
|
|
56
57
|
formData.append("formId", params.formId);
|
|
57
58
|
formData.append("content", JSON.stringify(params.content));
|
|
58
|
-
if (
|
|
59
|
-
|
|
60
|
-
formData.append(
|
|
61
|
-
}
|
|
59
|
+
if (files) {
|
|
60
|
+
for (const file of files) {
|
|
61
|
+
formData.append("files", file);
|
|
62
|
+
}
|
|
62
63
|
}
|
|
63
64
|
return { formData };
|
|
64
65
|
}
|
|
@@ -74,7 +75,7 @@ var MiraFormSDK = class {
|
|
|
74
75
|
const res = await fetch(url, {
|
|
75
76
|
method: "POST",
|
|
76
77
|
headers: {
|
|
77
|
-
"
|
|
78
|
+
"Authorization": `Bearer ${this.apiKey}`
|
|
78
79
|
},
|
|
79
80
|
body: formData
|
|
80
81
|
});
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts","../src/sdk.ts"],"sourcesContent":["export { MiraFormSDK } from './sdk';\nexport type { MiraFormSDKOptions } from './types';\n\n","import { MiraFormSDKOptions } from './types';\nimport {\n PrepareFormDataParams,\n PreparedFormData,\n SendFormResponse,\n} from './types';\n\n\n/**\n * A class to interact with the MiraForm API for creating and sending form data.\n */\nexport class MiraFormSDK {\n private readonly apiKey: string;\n private options: MiraFormSDKOptions;\n\n constructor(apiKey: string, options?: MiraFormSDKOptions) {\n this.apiKey = apiKey;\n this.options = options || {};\n }\n\n\n /**\n * Prepares form data for submission by validating the input parameters and appending them to a FormData object.\n *\n * @param {PrepareFormDataParams} params - The input parameters for preparing the form data.\n * - resourceId: The ID of the resource (required).\n * - formId: The ID of the form (required).\n * - content: The content object to include (optional, must be a valid object).\n * - files: An array of files to include in the form data (optional).\n *\n * @return {PreparedFormData} An object containing the prepared FormData object or error messages if validation fails.\n */\n public prepareFormData(params: PrepareFormDataParams): PreparedFormData {\n const errors: string[] = [];\n if (!
|
|
1
|
+
{"version":3,"sources":["../src/index.ts","../src/sdk.ts"],"sourcesContent":["export { MiraFormSDK } from './sdk';\nexport type { MiraFormSDKOptions } from './types';\n\n","import { MiraFormSDKOptions } from './types';\nimport {\n PrepareFormDataParams,\n PreparedFormData,\n SendFormResponse,\n} from './types';\n\n\n/**\n * A class to interact with the MiraForm API for creating and sending form data.\n */\nexport class MiraFormSDK {\n private readonly apiKey: string;\n private options: MiraFormSDKOptions;\n\n constructor(apiKey: string, options?: MiraFormSDKOptions) {\n this.apiKey = apiKey;\n this.options = options || {};\n }\n\n\n /**\n * Prepares form data for submission by validating the input parameters and appending them to a FormData object.\n *\n * @param {PrepareFormDataParams} params - The input parameters for preparing the form data.\n * - resourceId: The ID of the resource (required).\n * - formId: The ID of the form (required).\n * - content: The content object to include (optional, must be a valid object).\n * - files: An array of files to include in the form data (optional).\n *\n * @return {PreparedFormData} An object containing the prepared FormData object or error messages if validation fails.\n */\n public prepareFormData(params: PrepareFormDataParams): PreparedFormData {\n const { resourceId, formId, content, files } = params;\n const errors: string[] = [];\n if (!resourceId) errors.push('resourceId is required');\n if (!formId) errors.push('formId is required');\n if (content && typeof content !== 'object') errors.push('content must be a valid object');\n if (errors.length) return { formData: null as any, errors };\n\n const formData = new FormData();\n formData.append('resourceId', params.resourceId);\n formData.append('formId', params.formId);\n formData.append('content', JSON.stringify(params.content));\n\n if (files) {\n for (const file of files) {\n formData.append('files', file as any);\n }\n }\n\n return { formData };\n }\n\n /**\n * Sends a form to the specified API endpoint.\n *\n * @param {FormData} formData - The form data to be sent to the server.\n * @return {Promise<SendFormResponse>} A promise that resolves to an object indicating the success of the operation, the server response data, and any errors encountered.\n */\n public async sendForm(formData: FormData): Promise<SendFormResponse> {\n const url = `${this.options.baseUrl}/api/v1/send`;\n try {\n const res = await fetch(url, {\n method: 'POST',\n headers: {\n 'Authorization': `Bearer ${this.apiKey}`,\n },\n body: formData,\n });\n const data = await res.json();\n return { success: res.ok, data, errors: !res.ok ? [data?.message || 'Unknown error'] : undefined };\n } catch (e: any) {\n return { success: false, errors: [e.message] };\n }\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACWO,IAAM,cAAN,MAAkB;AAAA,EAIvB,YAAY,QAAgB,SAA8B;AACxD,SAAK,SAAS;AACd,SAAK,UAAU,WAAW,CAAC;AAAA,EAC7B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcO,gBAAgB,QAAiD;AACtE,UAAM,EAAE,YAAY,QAAQ,SAAS,MAAM,IAAI;AAC/C,UAAM,SAAmB,CAAC;AAC1B,QAAI,CAAC;AAAY,aAAO,KAAK,wBAAwB;AACrD,QAAI,CAAC;AAAQ,aAAO,KAAK,oBAAoB;AAC7C,QAAI,WAAW,OAAO,YAAY;AAAU,aAAO,KAAK,gCAAgC;AACxF,QAAI,OAAO;AAAQ,aAAO,EAAE,UAAU,MAAa,OAAO;AAE1D,UAAM,WAAW,IAAI,SAAS;AAC9B,aAAS,OAAO,cAAc,OAAO,UAAU;AAC/C,aAAS,OAAO,UAAU,OAAO,MAAM;AACvC,aAAS,OAAO,WAAW,KAAK,UAAU,OAAO,OAAO,CAAC;AAEzD,QAAI,OAAO;AACT,iBAAW,QAAQ,OAAO;AACxB,iBAAS,OAAO,SAAS,IAAW;AAAA,MACtC;AAAA,IACF;AAEA,WAAO,EAAE,SAAS;AAAA,EACpB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAa,SAAS,UAA+C;AACnE,UAAM,MAAM,GAAG,KAAK,QAAQ,OAAO;AACnC,QAAI;AACF,YAAM,MAAM,MAAM,MAAM,KAAK;AAAA,QAC3B,QAAQ;AAAA,QACR,SAAS;AAAA,UACP,iBAAiB,UAAU,KAAK,MAAM;AAAA,QACxC;AAAA,QACA,MAAM;AAAA,MACR,CAAC;AACD,YAAM,OAAO,MAAM,IAAI,KAAK;AAC5B,aAAO,EAAE,SAAS,IAAI,IAAI,MAAM,QAAQ,CAAC,IAAI,KAAK,CAAC,MAAM,WAAW,eAAe,IAAI,OAAU;AAAA,IACnG,SAAS,GAAQ;AACf,aAAO,EAAE,SAAS,OAAO,QAAQ,CAAC,EAAE,OAAO,EAAE;AAAA,IAC/C;AAAA,EACF;AACF;","names":[]}
|
package/dist/index.mjs
CHANGED
|
@@ -16,12 +16,13 @@ var MiraFormSDK = class {
|
|
|
16
16
|
* @return {PreparedFormData} An object containing the prepared FormData object or error messages if validation fails.
|
|
17
17
|
*/
|
|
18
18
|
prepareFormData(params) {
|
|
19
|
+
const { resourceId, formId, content, files } = params;
|
|
19
20
|
const errors = [];
|
|
20
|
-
if (!
|
|
21
|
+
if (!resourceId)
|
|
21
22
|
errors.push("resourceId is required");
|
|
22
|
-
if (!
|
|
23
|
+
if (!formId)
|
|
23
24
|
errors.push("formId is required");
|
|
24
|
-
if (
|
|
25
|
+
if (content && typeof content !== "object")
|
|
25
26
|
errors.push("content must be a valid object");
|
|
26
27
|
if (errors.length)
|
|
27
28
|
return { formData: null, errors };
|
|
@@ -29,10 +30,10 @@ var MiraFormSDK = class {
|
|
|
29
30
|
formData.append("resourceId", params.resourceId);
|
|
30
31
|
formData.append("formId", params.formId);
|
|
31
32
|
formData.append("content", JSON.stringify(params.content));
|
|
32
|
-
if (
|
|
33
|
-
|
|
34
|
-
formData.append(
|
|
35
|
-
}
|
|
33
|
+
if (files) {
|
|
34
|
+
for (const file of files) {
|
|
35
|
+
formData.append("files", file);
|
|
36
|
+
}
|
|
36
37
|
}
|
|
37
38
|
return { formData };
|
|
38
39
|
}
|
|
@@ -48,7 +49,7 @@ var MiraFormSDK = class {
|
|
|
48
49
|
const res = await fetch(url, {
|
|
49
50
|
method: "POST",
|
|
50
51
|
headers: {
|
|
51
|
-
"
|
|
52
|
+
"Authorization": `Bearer ${this.apiKey}`
|
|
52
53
|
},
|
|
53
54
|
body: formData
|
|
54
55
|
});
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/sdk.ts"],"sourcesContent":["import { MiraFormSDKOptions } from './types';\nimport {\n PrepareFormDataParams,\n PreparedFormData,\n SendFormResponse,\n} from './types';\n\n\n/**\n * A class to interact with the MiraForm API for creating and sending form data.\n */\nexport class MiraFormSDK {\n private readonly apiKey: string;\n private options: MiraFormSDKOptions;\n\n constructor(apiKey: string, options?: MiraFormSDKOptions) {\n this.apiKey = apiKey;\n this.options = options || {};\n }\n\n\n /**\n * Prepares form data for submission by validating the input parameters and appending them to a FormData object.\n *\n * @param {PrepareFormDataParams} params - The input parameters for preparing the form data.\n * - resourceId: The ID of the resource (required).\n * - formId: The ID of the form (required).\n * - content: The content object to include (optional, must be a valid object).\n * - files: An array of files to include in the form data (optional).\n *\n * @return {PreparedFormData} An object containing the prepared FormData object or error messages if validation fails.\n */\n public prepareFormData(params: PrepareFormDataParams): PreparedFormData {\n const errors: string[] = [];\n if (!
|
|
1
|
+
{"version":3,"sources":["../src/sdk.ts"],"sourcesContent":["import { MiraFormSDKOptions } from './types';\nimport {\n PrepareFormDataParams,\n PreparedFormData,\n SendFormResponse,\n} from './types';\n\n\n/**\n * A class to interact with the MiraForm API for creating and sending form data.\n */\nexport class MiraFormSDK {\n private readonly apiKey: string;\n private options: MiraFormSDKOptions;\n\n constructor(apiKey: string, options?: MiraFormSDKOptions) {\n this.apiKey = apiKey;\n this.options = options || {};\n }\n\n\n /**\n * Prepares form data for submission by validating the input parameters and appending them to a FormData object.\n *\n * @param {PrepareFormDataParams} params - The input parameters for preparing the form data.\n * - resourceId: The ID of the resource (required).\n * - formId: The ID of the form (required).\n * - content: The content object to include (optional, must be a valid object).\n * - files: An array of files to include in the form data (optional).\n *\n * @return {PreparedFormData} An object containing the prepared FormData object or error messages if validation fails.\n */\n public prepareFormData(params: PrepareFormDataParams): PreparedFormData {\n const { resourceId, formId, content, files } = params;\n const errors: string[] = [];\n if (!resourceId) errors.push('resourceId is required');\n if (!formId) errors.push('formId is required');\n if (content && typeof content !== 'object') errors.push('content must be a valid object');\n if (errors.length) return { formData: null as any, errors };\n\n const formData = new FormData();\n formData.append('resourceId', params.resourceId);\n formData.append('formId', params.formId);\n formData.append('content', JSON.stringify(params.content));\n\n if (files) {\n for (const file of files) {\n formData.append('files', file as any);\n }\n }\n\n return { formData };\n }\n\n /**\n * Sends a form to the specified API endpoint.\n *\n * @param {FormData} formData - The form data to be sent to the server.\n * @return {Promise<SendFormResponse>} A promise that resolves to an object indicating the success of the operation, the server response data, and any errors encountered.\n */\n public async sendForm(formData: FormData): Promise<SendFormResponse> {\n const url = `${this.options.baseUrl}/api/v1/send`;\n try {\n const res = await fetch(url, {\n method: 'POST',\n headers: {\n 'Authorization': `Bearer ${this.apiKey}`,\n },\n body: formData,\n });\n const data = await res.json();\n return { success: res.ok, data, errors: !res.ok ? [data?.message || 'Unknown error'] : undefined };\n } catch (e: any) {\n return { success: false, errors: [e.message] };\n }\n }\n}\n"],"mappings":";AAWO,IAAM,cAAN,MAAkB;AAAA,EAIvB,YAAY,QAAgB,SAA8B;AACxD,SAAK,SAAS;AACd,SAAK,UAAU,WAAW,CAAC;AAAA,EAC7B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcO,gBAAgB,QAAiD;AACtE,UAAM,EAAE,YAAY,QAAQ,SAAS,MAAM,IAAI;AAC/C,UAAM,SAAmB,CAAC;AAC1B,QAAI,CAAC;AAAY,aAAO,KAAK,wBAAwB;AACrD,QAAI,CAAC;AAAQ,aAAO,KAAK,oBAAoB;AAC7C,QAAI,WAAW,OAAO,YAAY;AAAU,aAAO,KAAK,gCAAgC;AACxF,QAAI,OAAO;AAAQ,aAAO,EAAE,UAAU,MAAa,OAAO;AAE1D,UAAM,WAAW,IAAI,SAAS;AAC9B,aAAS,OAAO,cAAc,OAAO,UAAU;AAC/C,aAAS,OAAO,UAAU,OAAO,MAAM;AACvC,aAAS,OAAO,WAAW,KAAK,UAAU,OAAO,OAAO,CAAC;AAEzD,QAAI,OAAO;AACT,iBAAW,QAAQ,OAAO;AACxB,iBAAS,OAAO,SAAS,IAAW;AAAA,MACtC;AAAA,IACF;AAEA,WAAO,EAAE,SAAS;AAAA,EACpB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAa,SAAS,UAA+C;AACnE,UAAM,MAAM,GAAG,KAAK,QAAQ,OAAO;AACnC,QAAI;AACF,YAAM,MAAM,MAAM,MAAM,KAAK;AAAA,QAC3B,QAAQ;AAAA,QACR,SAAS;AAAA,UACP,iBAAiB,UAAU,KAAK,MAAM;AAAA,QACxC;AAAA,QACA,MAAM;AAAA,MACR,CAAC;AACD,YAAM,OAAO,MAAM,IAAI,KAAK;AAC5B,aAAO,EAAE,SAAS,IAAI,IAAI,MAAM,QAAQ,CAAC,IAAI,KAAK,CAAC,MAAM,WAAW,eAAe,IAAI,OAAU;AAAA,IACnG,SAAS,GAAQ;AACf,aAAO,EAAE,SAAS,OAAO,QAAQ,CAAC,EAAE,OAAO,EAAE;AAAA,IAC/C;AAAA,EACF;AACF;","names":[]}
|