@squared-functions/types - npm Package Compare versions

Comparing version 0.4.3 to 0.5.0

lib/index.d.ts

@@ -11,37 +11,35 @@ /// <reference path="type.d.ts" />
     type FileCompressFormat = "gz" | "br";
-    type FileManagerWriteImageCallback = (data: internal.FileData, output: string, command: string, compress?: squared.base.CompressFormat, err?: Null<Error>) => void;
+    type FileManagerWriteImageCallback = (data: internal.FileData, output: string, command: string, compress?: squared.CompressFormat, err?: Null<Error>) => void;
     type FileManagerPerformAsyncTaskCallback = () => void;
-    type FileManagerCompleteAsyncTaskCallback = (filepath?: string) => void;
+    type FileManagerCompleteAsyncTaskCallback = (fileUri?: string) => void;
     type FileOutputCallback = (result: string, err?: Null<Error>) => void;
 
     namespace squared {
-        namespace base {
-            interface LocationUri {
-                pathname: string;
-                filename: string;
-            }
+        interface LocationUri {
+            pathname: string;
+            filename: string;
+        }
 
-            interface FileAsset extends LocationUri {
-                content?: string;
-                uri?: string;
-                mimeType?: string;
-                base64?: string;
-                commands?: string[];
-                compress?: CompressFormat[];
-            }
+        interface FileAsset extends LocationUri {
+            content?: string;
+            uri?: string;
+            mimeType?: string;
+            base64?: string;
+            commands?: string[];
+            compress?: CompressFormat[];
+        }
 
-            interface CompressFormat {
-                format: string;
-                level?: number;
-                condition?: string;
-            }
+        interface CompressFormat {
+            format: string;
+            level?: number;
+            condition?: string;
+        }
 
-            interface ResultOfFileAction {
-                success: boolean;
-                zipname?: string;
-                bytes?: number;
-                files?: string[];
-                application?: string;
-                system?: string;
-            }
+        interface ResultOfFileAction {
+            success: boolean;
+            zipname?: string;
+            bytes?: number;
+            files?: string[];
+            application?: string;
+            system?: string;
         }
@@ -88,3 +86,3 @@ }
             command?: string;
-            compress?: squared.base.CompressFormat;
+            compress?: squared.CompressFormat;
             callback?: FileManagerWriteImageCallback;
@@ -100,4 +98,4 @@ }
             mode: string;
-            algorithm: string;
-            align: number;
+            algorithm: Undef<string>;
+            align: Undef<string>[];
             color: Null<number>;
@@ -108,5 +106,10 @@ }
 
+        interface QualityData {
+            value: number;
+            preset?: string;
+        }
+
         interface FileData {
-            file: ExpressAsset;
-            filepath: string;
+            file: ExternalAsset;
+            fileUri: string;
         }
@@ -116,3 +119,3 @@
             pathname: string;
-            filepath: string;
+            fileUri: string;
         }
@@ -147,8 +150,8 @@
         tinifyApiKey: string;
-        createWriteStreamAsGzip(source: string, filepath: string, level?: number): WriteStream;
-        createWriteStreamAsBrotli(source: string, filepath: string, quality?: number, mimeType?: string): WriteStream;
-        findFormat(compress: Undef<squared.base.CompressFormat[]>, format: string): Undef<squared.base.CompressFormat>;
+        createWriteStreamAsGzip(source: string, fileUri: string, level?: number): WriteStream;
+        createWriteStreamAsBrotli(source: string, fileUri: string, quality?: number, mimeType?: string): WriteStream;
+        findFormat(compress: Undef<squared.CompressFormat[]>, format: string): Undef<squared.CompressFormat>;
         hasImageService(): boolean;
         parseSizeRange(value: string): [number, number];
-        withinSizeRange(filepath: string, value: Undef<string>): boolean;
+        withinSizeRange(fileUri: string, value: Undef<string>): boolean;
         tryFile(data: internal.FileData, format: FileCompressFormat, preCompress?: FileManagerPerformAsyncTaskCallback, postWrite?: FileManagerCompleteAsyncTaskCallback): void;
@@ -160,6 +163,6 @@ tryImage(data: internal.FileData, callback: FileOutputCallback): void;
         using(options: internal.ImageUsingOptions): void;
-        parseResize(value: string): Undef<internal.ResizeData>;
         parseCrop(value: string): Undef<internal.CropData>;
         parseOpacity(value: string): number;
-        parseQuality(value: string): number;
+        parseQuality(value: string): Undef<internal.QualityData>;
+        parseResize(value: string): Undef<internal.ResizeData>;
         parseRotation(value: string): Undef<internal.RotateData>;
@@ -193,2 +196,3 @@ }
         productionRelease: boolean;
+        basePath?: string;
         Gulp?: StringMap;
@@ -198,13 +202,13 @@ readonly files: Set<string>;
         readonly filesToRemove: Set<string>;
-        readonly filesToCompare: Map<ExpressAsset, string[]>;
+        readonly filesToCompare: Map<ExternalAsset, string[]>;
         readonly contentToAppend: Map<string, string[]>;
         readonly dirname: string;
-        readonly assets: ExpressAsset[];
+        readonly assets: ExternalAsset[];
         readonly postFinalize: FunctionType<void>;
         readonly dataMap: chrome.DataMap;
-        readonly baseAsset?: ExpressAsset;
+        readonly baseAsset?: ExternalAsset;
         install(name: string, ...args: any[]): void;
         add(value: string): void;
         delete(value: string): void;
-        replace(file: ExpressAsset, replaceWith: string): void;
+        replace(file: ExternalAsset, replaceWith: string): void;
         performAsyncTask: FileManagerPerformAsyncTaskCallback;
@@ -214,13 +218,14 @@ removeAsyncTask(): void;
         performFinalize(): void;
-        getHtmlPages(modified?: boolean): ExpressAsset[];
-        replacePath(source: string, segment: string, value: string, base64?: boolean): Undef<string>;
+        getHtmlPages(modified?: boolean): ExternalAsset[];
+        replacePath(source: string, segments: string[], value: string, matchSingle?: boolean, base64?: boolean): Undef<string>;
         escapePathSeparator(value: string): string;
-        getFileOutput(file: ExpressAsset): internal.FileOutput;
-        getRelativeUri(file: ExpressAsset, uri: string): Undef<string>;
+        getFileOutput(file: ExternalAsset): internal.FileOutput;
+        findAsset(uri: string, fromElement?: boolean): Undef<ExternalAsset>;
+        getRelativeUri(file: ExternalAsset, uri: string): Undef<string>;
         getAbsoluteUri(value: string, href: string): string;
-        getFileUri(file: ExpressAsset, filename?: string): string;
-        getUTF8String(file: ExpressAsset, filepath?: string): string;
-        appendContent(file: ExpressAsset, filepath: string, content: string, bundleIndex: number): Promise<string>;
-        getTrailingContent(file: ExpressAsset): Promise<string>;
-        transformCss(file: ExpressAsset, content: string): Undef<string>;
+        getFileUri(file: ExternalAsset, filename?: string): string;
+        getUTF8String(file: ExternalAsset, fileUri?: string): string;
+        appendContent(file: ExternalAsset, fileUri: string, content: string, bundleIndex: number): Promise<string>;
+        getTrailingContent(file: ExternalAsset): Promise<string>;
+        transformCss(file: ExternalAsset, content: string): Undef<string>;
         newImage(data: internal.FileData, ouputType: string, saveAs: string, command?: string): string;
@@ -242,3 +247,3 @@ replaceImage(data: internal.FileData, output: string, command: string): void;
         moduleImage(): IImage;
-        new(dirname: string, assets: ExpressAsset[], postFinalize: FunctionType<void>, productionRelease?: boolean): IFileManager;
+        new(dirname: string, assets: ExternalAsset[], postFinalize: FunctionType<void>, productionRelease?: boolean): IFileManager;
     }
@@ -253,3 +258,3 @@
         checkVersion(major: number, minor: number, patch?: number): boolean;
-        getFileSize(filepath: string): number;
+        getFileSize(fileUri: string): number;
         replaceExtension(value: string, ext: string): string;
@@ -268,3 +273,3 @@ getTempDir(): string;
         instance: T;
-        filepath: string
+        fileUri: string
         command: string
@@ -274,3 +279,3 @@ resizeData?: internal.ResizeData;
         rotateData?: internal.RotateData;
-        qualityValue: number;
+        qualityData?: internal.QualityData;
         opacityValue: number;
@@ -285,3 +290,3 @@ errorHandler?: (err: Error) => void;
         finalize(output: string, callback: (result: string) => void): void;
-        constructor(instance: T, filepath: string, command?: string, finalAs?: string);
+        constructor(instance: T, fileUri: string, command?: string, finalAs?: string);
     }
@@ -343,4 +348,4 @@
 
-    interface ExpressAsset extends squared.base.FileAsset, chrome.ChromeAsset {
-        filepath?: string;
+    interface ExternalAsset extends squared.FileAsset, chrome.ChromeAsset {
+        fileUri?: string;
         invalid?: boolean;
@@ -347,0 +352,0 @@ buffer?: Buffer;

package.json

 {
   "name": "@squared-functions/types",
-  "version": "0.4.3",
+  "version": "0.5.0",
   "description": "Type definitions for squared-functions",
@@ -5,0 +5,0 @@ "types": "lib/index.d.ts",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

14769

increased by0.87%

Lines of code

319

increased by1.27%

No dependency changes