@squared-functions/types - npm Package Compare versions

Comparing version 0.5.1 to 0.5.2

lib/index.d.ts

 /// <reference path="type.d.ts" />
 
+import type * as awsCore from 'aws-sdk/lib/core';
 import type { Response } from 'express';
@@ -54,2 +55,3 @@ import type { CorsOptions } from 'cors';
             attributes?: AttributeValue[];
+            cloudStorage?: CloudService[];
             preserve?: boolean;
@@ -61,3 +63,2 @@ inlineContent?: string;
             trailingContent?: FormattableContent[];
-            cloudStorage?: CloudService[];
             textContent?: string;
@@ -72,3 +73,5 @@ dataMap?: DataMap;
             localStorage?: boolean;
+            uploadAll?: boolean;
             filename?: string;
+            settings?: string;
             [key: string]: Undef<unknown>;
@@ -92,30 +95,65 @@ }
         }
+
+        interface TranspileMap {
+            html: ObjectMap<StringMap>;
+            js: ObjectMap<StringMap>;
+            css: ObjectMap<StringMap>;
+        }
     }
 
     namespace internal {
-        interface ImageUsingOptions {
-            data: FileData;
-            command?: string;
-            compress?: squared.CompressFormat;
-            callback?: FileManagerWriteImageCallback;
-        }
+        namespace settings {
+            interface Routing {
+                [key: string]: Route[];
+            }
 
-        interface RotateData {
-            values: number[];
-            color: Null<number>;
-        }
+            interface Route {
+                mount?: string;
+                path?: string;
+            }
 
-        interface ResizeData extends Dimension {
-            mode: string;
-            algorithm: Undef<string>;
-            align: Undef<string>[];
-            color: Null<number>;
+            interface CloudModule {
+                s3?: {
+                    [key: string]: awsCore.ConfigurationOptions;
+                };
+            }
+
+            interface GulpModule extends StringMap {}
+
+            interface ChromeModule {
+                eval_function?: boolean;
+                eval_text_template?: boolean;
+                html?: ObjectMap<StandardMap>;
+                css?: ObjectMap<StandardMap>;
+                js?: ObjectMap<StandardMap>;
+            }
         }
 
-        interface CropData extends Point, Dimension {}
+        namespace image {
+            interface UsingOptions {
+                data: FileData;
+                command?: string;
+                compress?: squared.CompressFormat;
+                callback?: FileManagerWriteImageCallback;
+            }
 
-        interface QualityData {
-            value: number;
-            preset: Undef<string>;
-            nearLossless: number;
+            interface RotateData {
+                values: number[];
+                color: Null<number>;
+            }
+
+            interface ResizeData extends Dimension {
+                mode: string;
+                algorithm: Undef<string>;
+                align: Undef<string>[];
+                color: Null<number>;
+            }
+
+            interface CropData extends Point, Dimension {}
+
+            interface QualityData {
+                value: number;
+                preset: Undef<string>;
+                nearLossless: number;
+            }
         }
@@ -171,8 +209,8 @@
     interface IImage extends IModule {
-        using(options: internal.ImageUsingOptions): void;
-        parseCrop(value: string): Undef<internal.CropData>;
+        using(options: internal.image.UsingOptions): void;
+        parseCrop(value: string): Undef<internal.image.CropData>;
         parseOpacity(value: string): number;
-        parseQuality(value: string): Undef<internal.QualityData>;
-        parseResize(value: string): Undef<internal.ResizeData>;
-        parseRotation(value: string): Undef<internal.RotateData>;
+        parseQuality(value: string): Undef<internal.image.QualityData>;
+        parseResize(value: string): Undef<internal.image.ResizeData>;
+        parseRotation(value: string): Undef<internal.image.RotateData>;
         parseMethod(value: string): Undef<string[]>;
@@ -182,11 +220,11 @@ }
     interface IChrome extends IModule {
-        modules?: ChromeModules;
+        settings?: internal.settings.ChromeModule;
         findPlugin(settings: Undef<ObjectMap<StandardMap>>, name: string): internal.PluginConfig;
-        findTranspiler(settings: Undef<ObjectMap<StandardMap>>, name: string, category: ExternalCategory, transpileMap?: TranspileMap): internal.PluginConfig;
+        findTranspiler(settings: Undef<ObjectMap<StandardMap>>, name: string, category: ExternalCategory, transpileMap?: chrome.TranspileMap): internal.PluginConfig;
         createTranspiler(value: string): Null<FunctionType<string>>;
         createConfig(value: string): Undef<StandardMap | string>;
-        minifyHtml(format: string, value: string, transpileMap?: TranspileMap): Promise<Void<string>>;
-        minifyCss(format: string, value: string, transpileMap?: TranspileMap): Promise<Void<string>>;
-        minifyJs(format: string, value: string, transpileMap?: TranspileMap): Promise<Void<string>>;
-        formatContent(mimeType: string, format: string, value: string, transpileMap?: TranspileMap): Promise<Void<string>>;
+        minifyHtml(format: string, value: string, transpileMap?: chrome.TranspileMap): Promise<Void<string>>;
+        minifyCss(format: string, value: string, transpileMap?: chrome.TranspileMap): Promise<Void<string>>;
+        minifyJs(format: string, value: string, transpileMap?: chrome.TranspileMap): Promise<Void<string>>;
+        formatContent(mimeType: string, format: string, value: string, transpileMap?: chrome.TranspileMap): Promise<Void<string>>;
         removeCss(source: string, styles: string[]): Undef<string>;
@@ -196,3 +234,3 @@ }
     interface ChromeConstructor {
-        new(modules?: ChromeModules): IChrome;
+        new(settings?: internal.settings.ChromeModule): IChrome;
     }
@@ -209,3 +247,5 @@
         basePath?: string;
-        Gulp?: StringMap;
+        Chrome?: IChrome;
+        Gulp?: internal.settings.GulpModule;
+        Cloud?: internal.settings.CloudModule;
         readonly files: Set<string>;
@@ -221,6 +261,6 @@ readonly filesQueued: Set<string>;
         readonly baseAsset?: ExternalAsset;
-        install(name: string, ...args: any[]): void;
+        install(name: string, ...args: unknown[]): void;
         add(value: string): void;
         delete(value: string): void;
-        has(value: string): boolean;
+        has(value: Undef<string>): boolean;
         replace(file: ExternalAsset, replaceWith: string): void;
@@ -232,3 +272,3 @@ performAsyncTask: FileManagerPerformAsyncTaskCallback;
         getCloudService(data: chrome.CloudService[]): Undef<chrome.CloudService>;
-        hasCloudService(data: Record<string, unknown>): data is chrome.CloudService;
+        hasCloudService(data: chrome.CloudService): data is chrome.CloudService;
         replacePath(source: string, segments: string[], value: string, matchSingle?: boolean, base64?: boolean): Undef<string>;
@@ -238,2 +278,3 @@ escapePathSeparator(value: string): string;
         findAsset(uri: string, fromElement?: boolean): Undef<ExternalAsset>;
+        getHtmlPages(): ExternalAsset[];
         getRelativeUri(file: ExternalAsset, uri: string): Undef<string>;
@@ -288,6 +329,6 @@ getAbsoluteUri(value: string, href: string): string;
         command: string
-        resizeData?: internal.ResizeData;
-        cropData?: internal.CropData;
-        rotateData?: internal.RotateData;
-        qualityData?: internal.QualityData;
+        resizeData?: internal.image.ResizeData;
+        cropData?: internal.image.CropData;
+        rotateData?: internal.image.RotateData;
+        qualityData?: internal.image.QualityData;
         opacityValue: number;
@@ -301,3 +342,3 @@ errorHandler?: (err: Error) => void;
         rotate(parent?: ExternalAsset, preRotate?: FileManagerPerformAsyncTaskCallback, postWrite?: FileManagerCompleteAsyncTaskCallback): void;
-        write(output: string, options?: internal.ImageUsingOptions): void;
+        write(output: string, options?: internal.image.UsingOptions): void;
         finalize(output: string, callback: (result: string) => void): void;
@@ -307,2 +348,15 @@ constructor(instance: T, fileUri: string, command?: string, finalAs?: string);
 
+    interface Arguments {
+        accessAll?: boolean;
+        accessDisk?: boolean;
+        accessUnc?: boolean;
+        diskRead?: boolean;
+        diskWrite?: boolean;
+        uncRead?: boolean;
+        uncWrite?: boolean;
+        env?: string;
+        port?: number;
+        cors?: string;
+    }
+
     interface Settings {
@@ -321,46 +375,11 @@ version?: string;
         port?: StringMap;
-        routing?: Routing;
+        routing?: internal.settings.Routing;
+        cloud?: internal.settings.CloudModule;
         gulp?: StringMap;
-        chrome?: ChromeModules;
+        chrome?: internal.settings.ChromeModule;
     }
 
-    interface Arguments {
-        accessAll?: boolean;
-        accessDisk?: boolean;
-        accessUnc?: boolean;
-        diskRead?: boolean;
-        diskWrite?: boolean;
-        uncRead?: boolean;
-        uncWrite?: boolean;
-        env?: string;
-        port?: number;
-        cors?: string;
-    }
-
-    interface Routing {
-        [key: string]: Route[];
-    }
-
-    interface Route {
-        mount?: string;
-        path?: string;
-    }
-
-    interface TranspileMap {
-        html: ObjectMap<StringMap>;
-        js: ObjectMap<StringMap>;
-        css: ObjectMap<StringMap>;
-    }
-
-    interface ChromeModules {
-        eval_function?: boolean;
-        eval_text_template?: boolean;
-        html?: ObjectMap<StandardMap>;
-        css?: ObjectMap<StandardMap>;
-        js?: ObjectMap<StandardMap>;
-    }
-
     interface ExternalAsset extends squared.FileAsset, chrome.ChromeAsset {
         fileUri?: string;
-        children?: string[];
+        transforms?: string[];
         invalid?: boolean;
@@ -371,2 +390,3 @@ buffer?: Buffer;
         inlineCloud?: string;
+        inlineCssCloud?: string;
         originalName?: string;
@@ -373,0 +393,0 @@ }

lib/type.d.ts

@@ -5,2 +5,3 @@ type Undef<T> = T | undefined;
 
+type Constructor<T> = new(...args: any[]) => T;
 type FunctionType<T> = (...args: any[]) => T;
@@ -7,0 +8,0 @@

package.json

 {
   "name": "@squared-functions/types",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "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

16567

increased by6.86%

Lines of code

354

increased by5.67%

No dependency changes