@ohos-ports/fastly-cli 0.0.0-stage → 16.2.0-beta.0

package/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "[]"
+replaced with your own identifying information. (Don't include
+the brackets!)  The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright 2015 Seth Vargo
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -1,3 +1,76 @@
-# Temporary Holding Version
+<div align="center">
+  <h3 align="center">Fastly CLI</h3>
+  <p align="center">A CLI for interacting with the Fastly platform.</p>
+  <p align="center">
+      <a href="https://www.fastly.com/documentation/reference/cli"><img alt="Documentation" src="https://img.shields.io/badge/cli-reference-yellow"></a>
+      <a href="https://github.com/fastly/cli/releases/latest"><img alt="Latest release" src="https://img.shields.io/github/v/release/fastly/cli" /></a>
+      <a href="#License"><img alt="Apache 2.0 License" src="https://img.shields.io/github/license/fastly/cli" /></a>
+      <a href="https://goreportcard.com/report/github.com/fastly/cli"><img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/fastly/cli" /></a>
+  </p>
+</div>
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+## Quick links
+
+- [Installation](https://www.fastly.com/documentation/reference/tools/cli#installing)
+- [Shell auto-completion](https://www.fastly.com/documentation/reference/tools/cli#shell-auto-completion)
+- [Configuring](https://www.fastly.com/documentation/reference/tools/cli#configuring)
+- [Authentication](https://fastly.help/cli/cli-auth) (`fastly auth login`)
+- [Commands](https://www.fastly.com/documentation/reference/cli#command-groups)
+- [Development](https://github.com/fastly/cli/blob/main/DEVELOPMENT.md)
+- [Testing](https://github.com/fastly/cli/blob/main/TESTING.md)
+- [Issues](https://github.com/fastly/cli/blob/main/ISSUES.md)
+- [Documentation](https://github.com/fastly/cli/blob/main/DOCUMENTATION.md)
+
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `FASTLY_API_TOKEN` | Fastly API token used for authentication. |
+| `FASTLY_DISABLE_AUTH_COMMAND` | When set (any non-empty value), all authentication-related commands (`auth`, `auth-token`, `sso`, `profile`, `whoami`) and the `--token`/`-t` global flag are disabled. Authentication is handled via `FASTLY_API_TOKEN` or pre-configured stored tokens. Background SSO flows are unaffected. |
+
+## Versioning and Release Schedules
+
+The maintainers of this module strive to maintain [semantic versioning
+(SemVer)](https://semver.org/). This means that breaking changes
+(removal of functionality, or incompatible changes to existing
+functionality) will be released in a version with the first version
+component (`major`) incremented. Feature additions will increment the
+second version component (`minor`), and bug fixes which do not affect
+compatibility will increment the third version component (`patch`).
+
+On the second Wednesday of each month, a release will be published
+including all breaking, feature, and bug-fix changes that are ready
+for release. If that Wednesday should happen to be a US holiday, the
+release will be delayed until the next available working day.
+
+If critical or urgent bug fixes are ready for release in between those
+primary releases, patch releases will be made as needed to make those
+fixes available.
+
+## Contributing
+
+Refer to [CONTRIBUTING.md](https://github.com/fastly/cli/blob/main/CONTRIBUTING.md)
+
+## Issues
+
+If you encounter any non-security-related bug or unexpected behavior, please [file an issue][bug]
+using the bug report template.
+
+Please also check the [CHANGELOG](https://github.com/fastly/cli/blob/main/CHANGELOG.md) for any breaking-changes or migration guidance.
+
+### Security issues
+
+Please see our [SECURITY.md](SECURITY.md) for guidance on reporting security-related issues.
+
+## Binaries with unreleased changes
+
+Binaries containing merged changes that are planned for the next release are available [here](https://github.com/fastly/cli/actions/workflows/merge_to_main.yml). 
+Use at your own risk. 
+Updating will revert the binary to the latest released version.
+
+## License
+
+[Apache 2.0](LICENSE).
+
+[bug]: https://github.com/fastly/cli/issues/new?labels=bug&template=bug_report.md

package/SECURITY.md

@@ -0,0 +1,9 @@
+## Report a security issue
+
+The fastly/cli project team welcomes security reports and is committed to providing prompt attention to security issues. Security issues should be reported privately via [Fastly’s security issue reporting process](https://www.fastly.com/security/report-security-issue).
+
+## Security advisories
+
+Remediation of security vulnerabilities is prioritized by the project team. The project team endeavors to coordinate remediation with third-party stakeholders, and is committed to transparency in the disclosure process. The fastly/cli team announces security issues in release notes as well as Github Security Advisories on a best-effort basis.
+
+Note that communications related to security issues in Fastly-maintained OSS as described here are distinct from [Fastly Security Advisories](https://www.fastly.com/security-advisories).

package/fastly.js

@@ -0,0 +1,32 @@
+#!/usr/bin/env node
+import { execFileSync } from "node:child_process";
+
+import { pkgForCurrentPlatform } from "./package-helpers.js";
+
+const pkg = pkgForCurrentPlatform();
+
+let location;
+try {
+  // Check for the binary package from our "optionalDependencies". This
+  // package should have been installed alongside this package at install time.
+  location = (await import(pkg)).default;
+} catch (e) {
+  throw new Error(`The package "${pkg}" could not be found, and is needed by @fastly/cli.
+    Either the package is missing or the platform/architecture you are using is not supported.
+    If you are installing @fastly/cli with npm, make sure that you don't specify the
+    "--no-optional" flag. The "optionalDependencies" package.json feature is used
+    by @fastly/cli to install the correct binary executable for your current platform.
+    If your platform is not supported, you can open an issue at https://github.com/fastly/cli/issues`);
+}
+
+try {
+  execFileSync(location, process.argv.slice(2), { stdio: "inherit" });
+} catch(err) {
+  if (err.code) {
+    // Spawning child process failed
+    throw err;
+  }
+  if (err.status != null) {
+    process.exitCode = err.status;
+  }
+}

package/index.d.ts

@@ -0,0 +1,4 @@
+declare module '@fastly/cli' {
+  const location: string;
+  export default location;
+}

package/index.js

@@ -0,0 +1,19 @@
+import { pkgForCurrentPlatform } from "./package-helpers.js";
+
+const pkg = pkgForCurrentPlatform();
+
+let location;
+try {
+  // Check for the binary package from our "optionalDependencies". This
+  // package should have been installed alongside this package at install time.
+  location = (await import(pkg)).default;
+} catch (e) {
+  throw new Error(`The package "${pkg}" could not be found, and is needed by @fastly/cli.
+    Either the package is missing or the platform/architecture you are using is not supported.
+    If you are installing @fastly/cli with npm, make sure that you don't specify the
+    "--no-optional" flag. The "optionalDependencies" package.json feature is used
+    by @fastly/cli to install the correct binary executable for your current platform.
+    If your platform is not supported, you can open an issue at https://github.com/fastly/cli/issues`);
+}
+
+export default location;

package/package-helpers.js

@@ -0,0 +1,10 @@
+import { platform, arch } from "node:process";
+
+export function pkgForCurrentPlatform() {
+  if (platform === "openharmony") {
+    // @ohos-ports port: the platform binary package is published as
+    // @ohos-ports/fastly-cli-openharmony-arm64 (never mapped to "linux").
+    return `@ohos-ports/fastly-cli-${platform}-${arch}`;
+  }
+  return `@fastly/cli-${platform}-${arch}`;
+}

package/package.json

@@ -1,6 +1,52 @@
 {
-  "name": "@ohos-ports/fastly-cli",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+    "name": "@ohos-ports/fastly-cli",
+    "version": "16.2.0-beta.0",
+    "description": "Build, deploy and configure Fastly services from your terminal",
+    "type": "module",
+    "scripts": {
+        "version": "node ./update.js $npm_package_version"
+    },
+    "devDependencies": {
+        "@xhmikosr/decompress": "^11.1.3",
+        "@xhmikosr/decompress-targz": "^9.0.1"
+    },
+    "main": "index.js",
+    "types": "index.d.ts",
+    "engines": {
+        "node": ">=16"
+    },
+    "bin": {
+        "fastly": "fastly.js"
+    },
+    "optionalDependencies": {
+        "@fastly/cli-darwin-arm64": "=16.2.0",
+        "@fastly/cli-darwin-x64": "=16.2.0",
+        "@fastly/cli-linux-arm64": "=16.2.0",
+        "@fastly/cli-linux-x32": "=16.2.0",
+        "@fastly/cli-linux-x64": "=16.2.0",
+        "@fastly/cli-win32-arm64": "=16.2.0",
+        "@fastly/cli-win32-x32": "=16.2.0",
+        "@fastly/cli-win32-x64": "=16.2.0",
+        "@ohos-ports/fastly-cli-openharmony-arm64": "=16.2.0-beta.0"
+    },
+    "files": [
+        "index.js",
+        "fastly.js",
+        "package-helpers.js",
+        "update.js",
+        "index.d.ts",
+        "README.md",
+        "LICENSE",
+        "SECURITY.md"
+    ],
+    "license": "Apache-2.0",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/ohos-ports/ohos-ports.git",
+        "directory": "ports/fastly-cli/16.2.0"
+    },
+    "bugs": {
+        "url": "https://github.com/ohos-ports/ohos-ports/issues"
+    },
+    "homepage": "https://github.com/fastly/cli#readme"
+}

package/update.js

@@ -0,0 +1,196 @@
+#!/usr/bin/env node
+
+import { fileURLToPath } from "node:url";
+import { dirname, join, parse } from "node:path";
+import { mkdir, readFile, writeFile } from "node:fs/promises";
+import decompress from "@xhmikosr/decompress";
+import decompressTargz from "@xhmikosr/decompress-targz";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const input = process.argv.slice(2).at(0);
+const tag = input ? `v${input}` : "dev";
+
+let packages = [
+  {
+    releaseAsset: `fastly_${tag}_darwin-arm64.tar.gz`,
+    binaryAsset: "fastly",
+    description: "The macOS (M-series) binary for the Fastly CLI",
+    os: "darwin",
+    cpu: "arm64",
+  },
+  {
+    releaseAsset: `fastly_${tag}_darwin-amd64.tar.gz`,
+    binaryAsset: "fastly",
+    description: "The macOS (Intel) binary for the Fastly CLI",
+    os: "darwin",
+    cpu: "x64",
+  },
+  {
+    releaseAsset: `fastly_${tag}_linux-arm64.tar.gz`,
+    binaryAsset: "fastly",
+    description: "The Linux (arm64) binary for the Fastly CLI",
+    os: "linux",
+    cpu: "arm64",
+  },
+  {
+    releaseAsset: `fastly_${tag}_linux-amd64.tar.gz`,
+    binaryAsset: "fastly",
+    description: "The Linux (64-bit) binary for the Fastly CLI",
+    os: "linux",
+    cpu: "x64",
+  },
+  {
+    releaseAsset: `fastly_${tag}_linux-386.tar.gz`,
+    binaryAsset: "fastly",
+    description: "The Linux (32-bit) binary for the Fastly CLI",
+    os: "linux",
+    cpu: "x32",
+  },
+  {
+    releaseAsset: `fastly_${tag}_windows-arm64.tar.gz`,
+    binaryAsset: "fastly.exe",
+    description: "The Windows (arm64) binary for the Fastly CLI",
+    os: "win32",
+    cpu: "arm64",
+  },
+  {
+    releaseAsset: `fastly_${tag}_windows-amd64.tar.gz`,
+    binaryAsset: "fastly.exe",
+    description: "The Windows (64-bit) binary for the Fastly CLI",
+    os: "win32",
+    cpu: "x64",
+  },
+  {
+    releaseAsset: `fastly_${tag}_windows-386.tar.gz`,
+    binaryAsset: "fastly.exe",
+    description: "The Windows (32-bit) binary for the Fastly CLI",
+    os: "win32",
+    cpu: "x32",
+  },
+];
+
+let response = await fetch(
+  `https://api.github.com/repos/fastly/cli/releases/tags/${tag}`
+);
+if (!response.ok) {
+  console.error(
+    '%s %o',
+    `Response from https://api.github.com/repos/fastly/cli/releases/tags/${tag} was not ok`,
+    response
+  );
+  console.error(await response.text());
+  process.exit(1);
+}
+response = await response.json();
+const id = response.id;
+let assets = await fetch(
+  `https://api.github.com/repos/fastly/cli/releases/${id}/assets`
+);
+if (!assets.ok) {
+  console.error(
+    '%s %o',
+    `Response from https://api.github.com/repos/fastly/cli/releases/${id}/assets was not ok`,
+    assets
+  );
+  console.error(await assets.text());
+  process.exit(1);
+}
+assets = await assets.json();
+
+let generatedPackages = [];
+
+for (const info of packages) {
+  const packageName = `cli-${info.os}-${info.cpu}`;
+  const asset = assets.find((asset) => asset.name === info.releaseAsset);
+  if (!asset) {
+    console.error(
+      `Can't find an asset named ${info.releaseAsset} for the release https://github.com/fastly/cli/releases/tag/${tag}`
+    );
+    process.exit(1);
+  }
+  const packageDirectory = join(__dirname, "../", packageName.split("/").pop());
+  await mkdir(packageDirectory, { recursive: true });
+  await writeFile(
+    join(packageDirectory, "package.json"),
+    packageJson(packageName, tag, info.description, info.os, info.cpu, info.binaryAsset)
+  );
+  await writeFile(
+    join(packageDirectory, "index.js"),
+    indexJs(info.binaryAsset)
+  );
+  generatedPackages.push(packageName);
+  const browser_download_url = asset.browser_download_url;
+  const archive = await fetch(browser_download_url);
+  if (!archive.ok) {
+    console.error(
+      '%s %o',
+      `Response from ${browser_download_url} was not ok`,
+      archive
+    );
+    console.error(await response.text());
+    process.exit(1);
+  }
+  let buf = await archive.arrayBuffer();
+
+  await decompress(Buffer.from(buf), packageDirectory, {
+    // Remove the leading directory from the extracted file.
+    strip: 1,
+    plugins: [decompressTargz()],
+    // Only extract the binary file and nothing else
+    filter: (file) => parse(file.path).base === info.binaryAsset,
+  });
+}
+
+// Generate `optionalDependencies` section in the root package.json
+const rootPackageJsonPath = join(__dirname, "./package.json");
+let rootPackageJson = await readFile(rootPackageJsonPath, "utf8");
+rootPackageJson = JSON.parse(rootPackageJson);
+rootPackageJson["optionalDependencies"] = generatedPackages.reduce(
+  (acc, packageName) => {
+    acc[`@fastly/${packageName}`] = `=${tag.substring(1)}`;
+    return acc;
+  },
+  {}
+);
+await writeFile(rootPackageJsonPath, JSON.stringify(rootPackageJson, null, 4));
+
+function indexJs(binaryAsset) {
+  return `
+import { fileURLToPath } from 'node:url'
+import { dirname, join } from 'node:path'
+const __dirname = dirname(fileURLToPath(import.meta.url))
+let location = join(__dirname, '${binaryAsset}')
+export default location
+`;
+}
+function packageJson(name, version, description, os, cpu, binaryAsset) {
+  version = version.startsWith("v") ? version.replace("v", "") : version;
+  return JSON.stringify(
+    {
+      name: `@fastly/${name}`,
+      bin: {
+        [name]: `${binaryAsset}`,
+      },
+      scripts: {
+      },
+      type: "module",
+      version,
+      main: "index.js",
+      description,
+      license: "Apache-2.0",
+      repository: {
+        type: "git",
+        url: "git+https://github.com/fastly/cli.git"
+      },
+      bugs: {
+        url: "https://github.com/fastly/cli/issues"
+      },
+      homepage: "https://github.com/fastly/cli#readme",
+      preferUnplugged: false,
+      os: [os],
+      cpu: [cpu],
+    },
+    null,
+    4
+  );
+}