zarro 1.165.4 → 1.165.8

package/gulp-tasks/modules/fetch-github-release/dist-copy/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const PACKAGE_NAME = "fetch-github-release";
+export declare const PACKAGE_DATA_DIR: string;

package/gulp-tasks/modules/fetch-github-release/dist-copy/fetchRelease.d.ts

@@ -0,0 +1,22 @@
+import { OctokitRelease, OctokitReleaseAssets, RepoInfo } from './types';
+export interface FetchReleaseOptions extends RepoInfo {
+    getRelease: (owner: string, repo: string) => Promise<OctokitRelease>;
+    getAsset?: (version: string, assets: OctokitReleaseAssets) => OctokitReleaseAssets[number] | undefined;
+    accessToken?: string;
+    destination?: string;
+    shouldExtract?: boolean;
+}
+/**
+ * Downloads and extract release for the specified tag from Github to the destination.
+ *
+ * await fetchLatestRelease({ owner: 'smallstep', repo: 'cli', tag: '1.0.0' })
+ */
+export declare function fetchReleaseByTag(options: Omit<FetchReleaseOptions, 'getRelease'> & {
+    tag: string;
+}): Promise<string[]>;
+/**
+ * Downloads and extract latest release from Github to the destination.
+ *
+ * await fetchLatestRelease({ owner: 'smallstep', repo: 'cli' })
+ */
+export declare function fetchLatestRelease(options: Omit<FetchReleaseOptions, 'getRelease'>): Promise<string[]>;

package/gulp-tasks/modules/fetch-github-release/dist-copy/getAssetDefault.d.ts

@@ -0,0 +1,2 @@
+import { OctokitReleaseAssets } from './types';
+export declare function getAssetDefault(version: string, assets: OctokitReleaseAssets): OctokitReleaseAssets[number];

package/gulp-tasks/modules/fetch-github-release/dist-copy/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./fetchRelease";
+export * from "./isUpdateAvailable";

package/gulp-tasks/modules/fetch-github-release/dist-copy/isUpdateAvailable.d.ts

@@ -0,0 +1,99 @@
+import { RepoInfo } from "./types";
+interface IsUpdateAvailableOptions extends RepoInfo {
+    currentVersion: string;
+    accessToken?: string;
+}
+export declare function isUpdateAvailable(options: IsUpdateAvailableOptions): Promise<boolean>;
+export interface FetchLatestReleaseOptions extends RepoInfo {
+    accessToken?: string;
+}
+export interface FetchLatestReleaseResult {
+    url: string;
+    id: number;
+    assets: any[];
+    name: string | null;
+    body?: string | null;
+    assets_url: string;
+    author: string;
+    body_html: string;
+    body_text: string;
+    created_at: string;
+    discussion_url: string;
+    draft: boolean;
+    html_url: string;
+    mentions_count: number;
+}
+export declare function fetchLatestReleaseInfo(opts: ListReleasesOptions): Promise<ReleaseInfo>;
+export interface ListReleasesOptions extends RepoInfo {
+    accessToken?: string;
+}
+export interface AuthorInfo {
+    login: string;
+    id: number;
+    node_id: string;
+    avatar_url: string;
+    gravatar_id: string;
+    url: string;
+    html_url: string;
+    followers_url: string;
+    following_url: string;
+    gists_url: string;
+    starred_url: string;
+    subscriptions_url: string;
+    organizations_url: string;
+    repos_url: string;
+    events_url: string;
+    received_events_url: string;
+    type: string;
+    site_admin: boolean;
+}
+export interface ReleaseAsset {
+    url: string;
+    id: number;
+    node_id: string;
+    name: string;
+    label: string;
+    uploader: AuthorInfo;
+    content_type: string;
+    state: string;
+    size: number;
+    download_count: number;
+    created_at: string;
+    updated_at: string;
+    browser_download_url: string;
+}
+export interface ReleaseReactions {
+    url: string;
+    total_count: number;
+    "+1": number;
+    "-1": number;
+    laugh: number;
+    hooray: number;
+    confused: number;
+    heart: number;
+    rocket: number;
+    eyes: number;
+}
+export interface ReleaseInfo {
+    url: string;
+    assets_url: string;
+    upload_url: string;
+    html_url: string;
+    author: AuthorInfo;
+    node_id: string;
+    tag_name: string;
+    tag_commitish?: string;
+    name: string;
+    draft: boolean;
+    prerelease: boolean;
+    created_at: string;
+    published_at: string;
+    assets: ReleaseAsset[];
+    tarball_url: string;
+    zipball_url: string;
+    body: string;
+    reactions: ReleaseReactions;
+}
+export declare function listReleases(opts: ListReleasesOptions): Promise<ReleaseInfo[]>;
+export declare function newerVersion(latestVersion: string, currentVersion: string): boolean;
+export {};

package/gulp-tasks/modules/fetch-github-release/dist-copy/util.d.ts

@@ -0,0 +1,3 @@
+export declare const exists: (filePath: string) => Promise<boolean>;
+export declare const mkdir: (dirname: string) => Promise<void>;
+export declare const ensureDirExist: (filePath: string) => Promise<void>;

package/gulp-tasks/modules/fetch-github-release/src/constants.ts

@@ -0,0 +1,5 @@
+import os from 'os'
+import path from 'path'
+
+export const PACKAGE_NAME = 'fetch-github-release'
+export const PACKAGE_DATA_DIR = path.join(os.homedir(), `.${PACKAGE_NAME}`)

package/gulp-tasks/modules/fetch-github-release/src/fetchRelease.ts

@@ -0,0 +1,159 @@
+import { writeFile, rm } from "yafs";
+import path from 'path'
+
+import { Octokit } from '@octokit/rest'
+import decompress from 'decompress'
+const bent = require("bent");
+
+import { PACKAGE_DATA_DIR } from './constants'
+import { OctokitRelease, OctokitReleaseAssets, RepoInfo } from './types'
+import { ensureDirExist } from './util'
+import { getAssetDefault } from './getAssetDefault'
+
+export interface FetchReleaseOptions extends RepoInfo {
+  getRelease: (owner: string, repo: string) => Promise<OctokitRelease>
+  getAsset?: (
+    version: string,
+    assets: OctokitReleaseAssets,
+  ) => OctokitReleaseAssets[number] | undefined
+  accessToken?: string
+  destination?: string
+  shouldExtract?: boolean
+}
+
+type AsyncFunction<T> = () => Promise<T>;
+type AsyncVoidFunction = AsyncFunction<void>;
+interface Dictionary<T> {
+  [key: string]: T;
+}
+
+interface BentResponse {
+  statusCode: number;
+  json: AsyncFunction<any>;
+  text: AsyncFunction<string>;
+  arrayBuffer: AsyncFunction<Buffer>;
+  headers: Dictionary<string>;
+}
+
+function determineFilenameFrom(response: BentResponse): string {
+  const contentDisposition = response.headers["content-disposition"];
+  if (!contentDisposition) {
+    // guess? shouldn't get here from GH queries...
+    return fallback();
+  }
+  const parts = contentDisposition.split(";").map(s => s.trim());
+  for (const part of parts) {
+    let match = part.match(/^filename=(?<filename>.+)/i);
+    if (match && match.groups) {
+      const filename = match.groups["filename"];
+      if (filename) {
+        return filename;
+      }
+    }
+  }
+  return fallback();
+
+  function fallback() {
+    console.warn(`Unable to determine filename from request, falling back on release.zip`);
+    return "release.zip";
+  }
+}
+
+async function download(url: string, destination: string): Promise<string> {
+  const fetch = bent(url);
+  try {
+    const response = await fetch();
+    const data = await response.arrayBuffer();
+    const filename = determineFilenameFrom(response);
+    await writeFile(path.join(destination, filename), data);
+    return determineFilenameFrom(response);
+  } catch (e) {
+    const err = e as BentResponse;
+    if (err.statusCode === undefined) {
+      throw err;
+    }
+    if (err.statusCode === 301 || err.statusCode === 302) {
+      const next = err.headers["location"];
+      if (!next) {
+        throw new Error(`No location provided for http response ${err.statusCode}`);
+      }
+      return download(next, destination);
+    }
+    throw err;
+  }
+}
+
+async function fetchRelease(options: FetchReleaseOptions): Promise<string[]> {
+  const {
+    owner,
+    repo,
+    getRelease,
+    getAsset = getAssetDefault,
+    destination = PACKAGE_DATA_DIR,
+    shouldExtract = true,
+  } = options
+
+  if (!owner) {
+    throw new Error('Required "owner" option is missing')
+  }
+
+  if (!repo) {
+    throw new Error('Required "repo" option is missing')
+  }
+
+  const {
+    data: { assets, tag_name: version },
+  } = await getRelease(owner, repo)
+  const downloadUrl = getAsset(version, assets)?.browser_download_url
+
+  if (!downloadUrl) {
+    throw new Error('Unable to find download URL')
+  }
+
+  await ensureDirExist(destination)
+  const filename = await download(downloadUrl, destination)
+  const downloadPath = path.join(destination, filename)
+
+  if (shouldExtract) {
+    const files = await decompress(downloadPath, destination)
+    await rm(downloadPath)
+
+    return files.map((file: decompress.File) => path.join(destination, file.path))
+  }
+
+  return [downloadPath]
+}
+
+/**
+ * Downloads and extract release for the specified tag from Github to the destination.
+ *
+ * await fetchLatestRelease({ owner: 'smallstep', repo: 'cli', tag: '1.0.0' })
+ */
+export async function fetchReleaseByTag(
+  options: Omit<FetchReleaseOptions, 'getRelease'> & { tag: string },
+): Promise<string[]> {
+  return fetchRelease({
+    ...options,
+    getRelease: (owner, repo) =>
+      new Octokit({ auth: options.accessToken }).repos.getReleaseByTag({
+        owner,
+        repo,
+        tag: options.tag,
+      }),
+  })
+}
+
+/**
+ * Downloads and extract latest release from Github to the destination.
+ *
+ * await fetchLatestRelease({ owner: 'smallstep', repo: 'cli' })
+ */
+export async function fetchLatestRelease(
+  options: Omit<FetchReleaseOptions, 'getRelease'>,
+): Promise<string[]> {
+  return fetchRelease({
+    ...options,
+    getRelease: (owner, repo) =>
+      new Octokit({ auth: options.accessToken }).repos.getLatestRelease({ owner, repo }),
+  })
+}

package/gulp-tasks/modules/fetch-github-release/src/getAssetDefault.ts

@@ -0,0 +1,48 @@
+import { OctokitReleaseAssets } from './types'
+
+interface PlatformIdentifier {
+  platform: string
+  arch: string
+}
+
+function getPlatformIdentifier(): PlatformIdentifier {
+  switch (process.platform) {
+    case 'win32':
+      return { platform: 'windows', arch: 'amd64' }
+    case 'linux':
+      if (process.arch === 'arm64') {
+        return { platform: 'linux', arch: 'arm64' }
+      }
+
+      if (process.arch === 'arm') {
+        return { platform: 'linux', arch: 'arm' }
+      }
+
+      return { platform: 'linux', arch: 'amd64' }
+    case 'darwin':
+      return { platform: 'darwin', arch: 'amd64' }
+    default:
+      throw new Error('Unsupported platform')
+  }
+}
+
+export function getAssetDefault(
+  version: string,
+  assets: OctokitReleaseAssets,
+): OctokitReleaseAssets[number] {
+  const { platform, arch } = getPlatformIdentifier()
+
+  const platformAssets = assets.filter((asset: { name: string }) => asset.name.includes(platform))
+
+  if (platformAssets.length === 1) {
+    return platformAssets[0]
+  }
+
+  const archAsset = platformAssets.find((asset: { name: string }) => asset.name.includes(arch))
+
+  if (!archAsset) {
+    throw new Error(`Unable to find release for platform: ${platform} and arch: ${arch}`)
+  }
+
+  return archAsset
+}

package/gulp-tasks/modules/fetch-github-release/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./fetchRelease";
+export * from "./isUpdateAvailable";

package/gulp-tasks/modules/fetch-github-release/src/isUpdateAvailable.ts

@@ -0,0 +1,143 @@
+import { Octokit } from "@octokit/rest"
+import { gt } from "semver"
+
+import { RepoInfo } from "./types"
+
+interface IsUpdateAvailableOptions extends RepoInfo {
+  currentVersion: string
+  accessToken?: string
+}
+
+export async function isUpdateAvailable(options: IsUpdateAvailableOptions): Promise<boolean> {
+  const { repo, owner, currentVersion, accessToken } = options
+  const {
+    data: { tag_name: latestVersion },
+  } = await new Octokit({ auth: accessToken }).repos.getLatestRelease({ owner, repo })
+
+  return newerVersion(latestVersion, currentVersion)
+}
+
+export interface FetchLatestReleaseOptions extends RepoInfo {
+  accessToken?: string;
+}
+
+export interface FetchLatestReleaseResult {
+  url: string;
+  id: number;
+  assets: any[];
+  name: string | null;
+  body?: string | null;
+  assets_url: string;
+  author: string;
+  body_html: string;
+  body_text: string;
+  created_at: string;
+  discussion_url: string;
+  draft: boolean;
+  html_url: string;
+  mentions_count: number;
+}
+
+export async function fetchLatestReleaseInfo(
+    opts: ListReleasesOptions
+): Promise<ReleaseInfo> {
+  const { repo, owner, accessToken } = opts;
+  const result = await new Octokit({ auth: accessToken }).repos.getLatestRelease({ owner, repo });
+  return result.data as ReleaseInfo;
+}
+
+export interface ListReleasesOptions extends RepoInfo {
+  accessToken?: string;
+}
+
+export interface AuthorInfo {
+  login: string;
+  id: number;
+  node_id: string;
+  avatar_url: string;
+  gravatar_id: string;
+  url: string;
+  html_url: string;
+  followers_url: string;
+  following_url: string;
+  gists_url: string;
+  starred_url: string;
+  subscriptions_url: string;
+  organizations_url: string;
+  repos_url: string;
+  events_url: string;
+  received_events_url: string;
+  type: string;
+  site_admin: boolean;
+}
+
+export interface ReleaseAsset {
+  url: string;
+  id: number;
+  node_id: string;
+  name: string;
+  label: string;
+  uploader: AuthorInfo;
+  content_type: string;
+  state: string;
+  size: number;
+  download_count: number;
+  created_at: string;
+  updated_at: string;
+  browser_download_url: string;
+}
+
+export interface ReleaseReactions {
+  url: string;
+  total_count: number;
+  "+1": number;
+  "-1": number;
+  laugh: number;
+  hooray: number;
+  confused: number;
+  heart: number;
+  rocket: number;
+  eyes: number;
+}
+
+export interface ReleaseInfo {
+  url: string;
+  assets_url: string;
+  upload_url: string;
+  html_url: string;
+  author: AuthorInfo;
+  node_id: string;
+  tag_name: string;
+  tag_commitish?: string;
+  name: string;
+  draft: boolean;
+  prerelease: boolean;
+  created_at: string;
+  published_at: string;
+  assets: ReleaseAsset[];
+  tarball_url: string;
+  zipball_url: string;
+  body: string;
+  reactions: ReleaseReactions
+}
+
+export async function listReleases(opts: ListReleasesOptions): Promise<ReleaseInfo[]> {
+  const { repo, owner, accessToken } = opts;
+  const result = await new Octokit({ auth: accessToken }).repos.listReleases({ owner, repo });
+  return result.data as ReleaseInfo[];
+}
+
+export function newerVersion(latestVersion: string, currentVersion: string): boolean {
+  if (!latestVersion) {
+    return false
+  }
+
+  if (!currentVersion) {
+    return true
+  }
+
+  const normalizedLatestVersion = latestVersion.replace(/^v/, "")
+  const normalizedCurrentVersion = currentVersion.replace(/^v/, "")
+
+  return gt(normalizedLatestVersion, normalizedCurrentVersion)
+}

package/gulp-tasks/modules/fetch-github-release/src/types.ts

@@ -0,0 +1,17 @@
+import { RestEndpointMethodTypes } from '@octokit/rest'
+
+export type OctokitRelease = RestEndpointMethodTypes['repos']['getLatestRelease']['response']
+export type OctokitReleaseAssets = OctokitRelease['data']['assets']
+
+export interface Release {
+  repository: string
+  package: string
+  destination: string
+  version: string
+  extract: boolean
+}
+
+export interface RepoInfo {
+  owner: string
+  repo: string
+}

package/gulp-tasks/modules/fetch-github-release/src/util.ts

@@ -0,0 +1,24 @@
+import fs from 'fs'
+import path from 'path'
+
+export const exists = async (filePath: string): Promise<boolean> => {
+  try {
+    await fs.promises.access(filePath)
+    return true
+  } catch {
+    return false
+  }
+}
+
+export const mkdir = async (dirname: string): Promise<void> => {
+  const isExist = await exists(dirname)
+
+  if (!isExist) {
+    await fs.promises.mkdir(dirname, { recursive: true })
+  }
+}
+
+export const ensureDirExist = async (filePath: string): Promise<void> => {
+  const dirname = path.dirname(filePath)
+  await mkdir(dirname)
+}

package/gulp-tasks/modules/fetch-github-release.js

@@ -8,7 +8,7 @@
     // refuses to pack them, and I haven't figured out
     // why; so another process should create dist-copy
     // specifically for packing purposes
-    search = ["src", "dist", "dist-copy"];
+    search = ["dist-copy", "src"];
     for (const item of search) {
         const seek = path.join(__dirname, "fetch-github-release", item);
         if (folderExistsSync(seek)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zarro",
-  "version": "1.165.4",
+  "version": "1.165.8",
   "description": "Some glue to make gulp easier, perhaps even zero- or close-to-zero-conf",
   "bin": {
     "zarro": "./index.js"
@@ -94,8 +94,10 @@
   },
   "files": [
     "gulp-tasks/**/*.js",
-    "gulp-tasks/modules/fetch-github-release/moo/*.js",
-    "gulp-tasks/modules/fetch-github-release/moo/*.d.ts",
+    "gulp-tasks/modules/fetch-github-release/dist-copy/*.js",
+    "gulp-tasks/modules/fetch-github-release/dist-copy/*.d.ts",
+    "gulp-tasks/modules/fetch-github-release/src/*.ts",
+    "gulp-tasks/modules/fetch-github-release/src/*.js",
     "index-modules/**/*.js",
     "types.d.ts",
     "tsconfig.json"