electron-builder-http - npm Package Compare versions

Comparing version 15.0.1 to 15.3.0

out/electron-builder-http.d.ts

@@ -53,131 +53,130 @@ declare module "electron-builder-http/out/CancellationToken" {
   export type PublishProvider = "github" | "bintray" | "s3" | "generic"
+  export type AllPublishOptions = string | GithubOptions | S3Options | GenericServerOptions | BintrayOptions
+  export type Publish = AllPublishOptions | Array<AllPublishOptions> | null
 
   /**
-  ### `publish`
-
-  Can be specified in the [config](https://github.com/electron-userland/electron-builder/wiki/Options#configuration-options) or any platform- or target- specific options.
-
-  If `GH_TOKEN` is set — defaults to `[{provider: "github"}]`.
-  If `BT_TOKEN` is set and `GH_TOKEN` is not set — defaults to `[{provider: "bintray"}]`.
-  If `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` are set and neither `GH_TOKEN` and `BT_TOKEN` are set — defaults to `[{provider: "s3"}]`.
-
-  Array of option objects. Order is important — first item will be used as a default auto-update server on Windows (NSIS).
-
-  Amazon S3 — `https` must be used, so, if you use direct Amazon S3 endpoints, format `https://s3.amazonaws.com/bucket_name` [must be used](http://stackoverflow.com/a/11203685/1910191). And do not forget to make files/directories public.
+   * Can be specified in the [config](https://github.com/electron-userland/electron-builder/wiki/Options#configuration-options) or any platform- or target- specific options.
+   *
+   * If `GH_TOKEN` is set — defaults to `[{provider: "github"}]`.
+   *
+   * If `BT_TOKEN` is set and `GH_TOKEN` is not set — defaults to `[{provider: "bintray"}]`.
    */
   export interface PublishConfiguration {
     /**
-    The provider, one of `github`, `s3`, `bintray`, `generic`.
+     * The provider.
      */
-    provider: PublishProvider
+    readonly provider: PublishProvider
     /**
-    The owner.
+     * The owner.
      */
-    owner?: string | null
-    token?: string | null
+    readonly owner?: string | null
+    readonly token?: string | null
   }
 
   /**
-  ### `publish` Generic (any HTTP(S) server)
+   * GitHub options.
    */
-  export interface GenericServerOptions extends PublishConfiguration {
+  export interface GithubOptions extends PublishConfiguration {
     /**
-    The base url. e.g. `https://bucket_name.s3.amazonaws.com`. You can use `${os}` (expanded to `mac`, `linux` or `win` according to target platform) and `${arch}` macros.
+     * The repository name. [Detected automatically](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts#github-repository).
      */
-    url: string
+    readonly repo?: string | null
     /**
-    The channel. Defaults to `latest`.
+     * Whether to use `v`-prefixed tag name.
+     * @default true
      */
-    channel?: string | null
+    readonly vPrefixedTagName?: boolean
+    /**
+     * The host (including the port if need).
+     * @default github.com
+     */
+    readonly host?: string | null
+    /**
+     * The protocol. GitHub Publisher supports only `https`.
+     * @default https
+     */
+    readonly protocol?: "https" | "http" | null
   }
 
+  export function githubUrl(options: GithubOptions): string
+
   /**
-  ### `publish` Amazon S3
-
-  [Getting your credentials](http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/getting-your-credentials.html).
+   * Generic (any HTTP(S) server) options.
    */
-  export interface S3Options extends PublishConfiguration {
+  export interface GenericServerOptions extends PublishConfiguration {
     /**
-    The bucket name.
+     * The base url. e.g. `https://bucket_name.s3.amazonaws.com`. You can use `${os}` (expanded to `mac`, `linux` or `win` according to target platform) and `${arch}` macros.
      */
-    bucket: string
+    readonly url: string
     /**
-    The directory path. Defaults to `/`.
+     * The channel.
+     * @default latest
      */
-    path?: string | null
-    /**
-    The channel. Defaults to `latest`.
-     */
-    channel?: string | null
-    /**
-     The ACL. Defaults to `public-read`.
-     */
-    acl?: "private" | "public-read" | null
-    /**
-    The type of storage to use for the object. One of `STANDARD`, `REDUCED_REDUNDANCY`, `STANDARD_IA`. Defaults to `STANDARD`.
-     */
-    storageClass?: "STANDARD" | "REDUCED_REDUNDANCY" | "STANDARD_IA" | null
-    secret?: string | null
+    readonly channel?: string | null
   }
 
-  export function s3Url(options: S3Options): string
-
-  export interface VersionInfo {
-    readonly version: string
-  }
-
-  export interface UpdateInfo extends VersionInfo {
-    readonly path: string
-    readonly githubArtifactName?: string | null
-    readonly sha2: string
-    readonly releaseName?: string | null
-    readonly releaseNotes?: string | null
-    readonly releaseDate: string
-  }
-
   /**
-  ### `publish` GitHub
+   * Amazon S3 options. `https` must be used, so, if you use direct Amazon S3 endpoints, format `https://s3.amazonaws.com/bucket_name` [must be used](http://stackoverflow.com/a/11203685/1910191). And do not forget to make files/directories public.
+   * @see [Getting your credentials](http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/getting-your-credentials.html).
    */
-  export interface GithubOptions extends PublishConfiguration {
+  export interface S3Options extends PublishConfiguration {
     /**
-     The repository name. [Detected automatically](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts#github-repository).
+     * The bucket name.
      */
-    repo?: string | null
+    readonly bucket: string
     /**
-    Whether to use `v`-prefixed tag name. Defaults to `true`.
+     * The directory path.
+     * @default /
      */
-    vPrefixedTagName?: boolean
+    readonly path?: string | null
     /**
-    The host (including the port if need). Defaults to `github.com`.
+     * The channel.
+     * @default latest
      */
-    host?: string | null
+    readonly channel?: string | null
     /**
-    The protocol, one of `https` or `http`. Defaults to `https`.
-  
-    GitHub Publisher supports only `https`.
+     * The ACL.
+     * @default public-read
      */
-    protocol?: string | null
+    readonly acl?: "private" | "public-read" | null
+    /**
+     * The type of storage to use for the object.
+     * @default STANDARD
+     */
+    readonly storageClass?: "STANDARD" | "REDUCED_REDUNDANCY" | "STANDARD_IA" | null
   }
 
-  export function githubUrl(options: GithubOptions): string
+  export function s3Url(options: S3Options): string
 
   /**
-  ### `publish` Bintray
+   * Bintray options.
    */
   export interface BintrayOptions extends PublishConfiguration {
     /**
-    The Bintray package name.
+     * The Bintray package name.
      */
-    package?: string | null
+    readonly package?: string | null
     /**
-     The Bintray repository name. Defaults to `generic`.
+     * The Bintray repository name.
+     * @default generic
      */
-    repo?: string | null
+    readonly repo?: string | null
     /**
-     The Bintray user account. Used in cases where the owner is an organization.
+     * The Bintray user account. Used in cases where the owner is an organization.
      */
-    user?: string | null
+    readonly user?: string | null
   }
-  export type AllPublishOptions = string | GithubOptions | S3Options | GenericServerOptions | BintrayOptions
-  export type Publish = AllPublishOptions | Array<AllPublishOptions> | null
+
+  export interface VersionInfo {
+    readonly version: string
+  }
+
+  export interface UpdateInfo extends VersionInfo {
+    readonly path: string
+    readonly githubArtifactName?: string | null
+    readonly sha2: string
+    readonly releaseName?: string | null
+    readonly releaseNotes?: string | null
+    readonly releaseDate: string
+  }
 }
@@ -184,0 +183,0 @@

out/publishOptions.js

@@ -6,4 +6,7 @@ "use strict";
 });
+exports.githubUrl = githubUrl;
 exports.s3Url = s3Url;
-exports.githubUrl = githubUrl;
+function githubUrl(options) {
+    return `${options.protocol || "https"}://${options.host || "github.com"}`;
+}
 function s3Url(options) {
@@ -16,5 +19,2 @@ let url = `https://${options.bucket}.s3.amazonaws.com`;
 }
-function githubUrl(options) {
-    return `${options.protocol || "https"}://${options.host || "github.com"}`;
-}
 //# sourceMappingURL=publishOptions.js.map

package.json

 {
   "name": "electron-builder-http",
-  "version": "15.0.1",
+  "version": "15.3.0",
   "main": "out/httpExecutor.js",
@@ -15,3 +15,3 @@ "author": "Vladimir Krivosheev",
   "dependencies": {
-    "debug": "2.6.1",
+    "debug": "2.6.2",
     "fs-extra-p": "^4.0.2"
@@ -18,0 +18,0 @@ },

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

Lines of code

748

increased by0.67%

Worsened metrics

Total package byte prevSize

68282

decreased by-0.69%

Dependency changes

• + Addeddebug@2.6.2(transitive)

• - Removeddebug@2.6.1(transitive)

• Updateddebug@2.6.2