Merge pull request #7 from kratos-mc/release/pre-built

Release a new version `1.1.0-pre`

.github/workflows/npm-publish.yml

@@ -28,6 +28,7 @@ jobs:
           node-version: 14
           registry-url: https://registry.npmjs.org/
       - run: npm ci
+      - run: npm run build
       - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKENS }}

package.json

@@ -1,12 +1,13 @@
 {
   "name": "kratos-api-engine",
-  "version": "1.0.0",
+  "version": "1.1.0-pre1",
   "description": "",
   "main": "./dist/index.js",
   "scripts": {
-    "build": "tsc",
+    "build": "npm run clean && tsc",
     "test": "mocha .",
-    "coverage": "nyc npm run test"
+    "coverage": "nyc npm run test",
+    "clean": "node ./scripts/rm-scripts.js ./dist"
   },
   "repository": {
     "type": "git",
@@ -32,7 +33,8 @@
     "mocha": "^10.2.0",
     "nyc": "^15.1.0",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.5"
+    "typescript": "^4.9.5",
+    "yargs": "^17.6.2"
   },
   "dependencies": {
     "fs-extra": "^11.1.0",

scripts/rm-scripts.js

@@ -0,0 +1,18 @@
+const fse = require("fs-extra");
+const { hideBin } = require("yargs/helpers");
+
+const shortenArgv = hideBin(process.argv);
+if (shortenArgv.length === 0) {
+  throw new Error(`Directory has not provided, using ./rm-scripts <path>`);
+}
+
+const willRemoveDirectory = shortenArgv[0];
+if (fse.existsSync(willRemoveDirectory)) {
+  // Empty the directory
+  fse.emptyDirSync(willRemoveDirectory);
+  fse.rmSync(willRemoveDirectory, { force: true, recursive: true });
+
+  console.log(`Eliminated ${willRemoveDirectory}`);
+} else {
+  console.log(`warn: not found ${willRemoveDirectory}`);
+}

src/Asset.ts

@@ -0,0 +1,39 @@
+import { AssetIndexContent } from "./Version";
+import needle, { NeedleOptions } from "needle";
+
+/**
+ * A reference that point to the asset json file.
+ * Asset json file contains all asset item references to download.
+ *
+ */
+export interface AssetIndexReference {
+  /**
+   * The id of the asset.
+   */
+  id: string;
+  /**
+   * Checksum as sha1 for the asset json file.
+   */
+  sha1: string;
+  /**
+   * File size of the json reference.
+   */
+  size: number;
+  /**
+   * Total file size for all assets inside the reference after downloaded.
+   */
+  totalSize: number;
+  /**
+   * Url that point to json file.
+   */
+  url: string;
+}
+
+export async function getAssetIndexFromReference(
+  reference: AssetIndexReference,
+  options?: NeedleOptions
+): Promise<AssetIndexContent> {
+  const response = await needle("get", reference.url, options);
+
+  return response.body;
+}

src/Index.ts

@@ -1,3 +1,5 @@
 import * as Manifest from "./Manifest";
+import * as Version from "./Version";
+import * as Asset from "./Asset";
 
-export { Manifest };
+export { Manifest, Version, Asset };