enonic-fp - npm Package Compare versions

Comparing version 0.1.6 to 0.1.7

lib/content.d.ts

@@ -139,2 +139,6 @@ import { IOEither } from "fp-ts/lib/IOEither";
 }
+export interface ByteSource {
+    isEmpty(): boolean;
+    size(): number;
+}
 export interface CreateMediaParams {
@@ -146,3 +150,3 @@ readonly name?: string;
     readonly focalY?: number;
-    readonly data: any;
+    readonly data: ByteSource;
 }
@@ -168,3 +172,3 @@ export interface GetPermissionsParams {
 export interface IconType {
-    readonly data?: any;
+    readonly data?: ByteSource;
     readonly mimeType?: string;
@@ -198,3 +202,3 @@ readonly modifiedTime?: string;
 export declare function getAttachments(key: string): IOEither<EnonicError, Attachments>;
-export declare function getAttachmentStream(params: AttachmentStreamParams): IOEither<EnonicError, any>;
+export declare function getAttachmentStream(params: AttachmentStreamParams): IOEither<EnonicError, ByteSource>;
 export declare function removeAttachment(params: RemoveAttachmentParams): IOEither<EnonicError, void>;
@@ -201,0 +205,0 @@ export declare function getPermissions(params: GetPermissionsParams): IOEither<EnonicError, GetPermissionsResult>;

lib/http.d.ts

 import { IOEither } from "fp-ts/lib/IOEither";
 import { EnonicError } from "./common";
+import { ByteSource } from "./content";
 interface HttpRequestParamsProxy {
@@ -37,3 +38,3 @@ /** Proxy host name to use. */
     /** Body content to send with the request, usually for POST or PUT requests. It can be of type string or stream. */
-    readonly body?: string | any;
+    readonly body?: string | ByteSource;
     /** Content type of the request. */
@@ -71,3 +72,3 @@ readonly contentType?: string;
     /** Body of the response as a stream object. */
-    readonly bodyStream: any;
+    readonly bodyStream: ByteSource;
 }
@@ -74,0 +75,0 @@ /**

lib/mail.d.ts

 import { IOEither } from "fp-ts/lib/IOEither";
 import { EnonicError } from "./common";
+import { ByteSource } from "./content";
 export interface EmailAttachment {
     readonly fileName: string;
-    readonly data: any;
+    readonly data: ByteSource;
     readonly mimeType: string;
@@ -7,0 +8,0 @@ readonly headers: {

lib/portal.d.ts

 import { IOEither } from "fp-ts/lib/IOEither";
 import { EnonicError } from "./common";
-import { Content, Site } from "./content";
+import { ByteSource, Content, Site } from "./content";
 export interface IdProviderUrlParams {
@@ -103,2 +103,12 @@ readonly idProvider?: string;
 export declare function getIdProviderKey(): IOEither<EnonicError, string>;
+export interface MultipartItem {
+    readonly name: string;
+    readonly fileName: string;
+    readonly contentType: string;
+    readonly size: number;
+}
+export declare function getMultipartForm(): IOEither<EnonicError, ReadonlyArray<MultipartItem | ReadonlyArray<MultipartItem>>>;
+export declare function getMultipartItem(name: string, index?: number): IOEither<EnonicError, MultipartItem>;
+export declare function getMultipartStream(name: string, index?: number): IOEither<EnonicError, ByteSource>;
+export declare function getMultipartText(name: string, index?: number): IOEither<EnonicError, string>;
 export declare function getSite<A>(): IOEither<EnonicError, Site<A>>;
@@ -105,0 +115,0 @@ export declare function getSiteConfig<A>(): IOEither<EnonicError, A>;

lib/portal.js

@@ -16,2 +16,18 @@ "use strict";
 exports.getIdProviderKey = getIdProviderKey;
+function getMultipartForm() {
+    return utils_1.catchEnonicError(function () { return portal.getMultipartForm(); });
+}
+exports.getMultipartForm = getMultipartForm;
+function getMultipartItem(name, index) {
+    return utils_1.catchEnonicError(function () { return portal.getMultipartItem(name, index); });
+}
+exports.getMultipartItem = getMultipartItem;
+function getMultipartStream(name, index) {
+    return utils_1.catchEnonicError(function () { return portal.getMultipartStream(name, index); });
+}
+exports.getMultipartStream = getMultipartStream;
+function getMultipartText(name, index) {
+    return utils_1.catchEnonicError(function () { return portal.getMultipartText(name, index); });
+}
+exports.getMultipartText = getMultipartText;
 function getSite() {
@@ -18,0 +34,0 @@ return utils_1.catchEnonicError(function () { return portal.getSite(); });

package.json

 {
   "name": "enonic-fp",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "Functional programming helpers for Enonic XP",
@@ -30,4 +30,4 @@ "main": "lib/index.js",
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^2.5.0",
-    "@typescript-eslint/parser": "^2.5.0",
+    "@typescript-eslint/eslint-plugin": "^2.6.0",
+    "@typescript-eslint/parser": "^2.6.0",
     "eslint": "^6.6.0",
@@ -34,0 +34,0 @@ "husky": "^3.0.9",

No alert changes

Improved metrics

Total package byte prevSize

57562

increased by2.76%

Lines of code

1348

increased by2.43%

No dependency changes