feat(docker): Publish a docker which can have its region changed

.github/workflows/docker-publish.yml

@@ -0,0 +1,75 @@
+name: Docker
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+on:
+  push:
+    branches: [ "master" ]
+    # Publish semver tags as releases.
+    tags: [ 'v*.*.*' ]
+  pull_request:
+    branches: [ "master" ]
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+      # This is used to complete the identity challenge
+      # with sigstore/fulcio when running outside of PRs.
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install cosign
+        if: github.event_name != 'pull_request'
+        uses: sigstore/[email protected]
+        with:
+          cosign-release: 'v2.2.4'
+
+      - name: Set up Docker Buildx
+        uses: docker/[email protected]
+
+      - name: Log into registry ${{ env.REGISTRY }}
+        if: github.event_name != 'pull_request'
+        uses: docker/[email protected]
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract Docker metadata
+        id: meta
+        uses: docker/[email protected]
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build and push Docker image
+        id: build-and-push
+        uses: docker/[email protected]
+        with:
+          context: .
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+
+      - name: Sign the published Docker image
+        if: ${{ github.event_name != 'pull_request' }}
+        env:
+          TAGS: ${{ steps.meta.outputs.tags }}
+          DIGEST: ${{ steps.build-and-push.outputs.digest }}
+        run: echo "${TAGS}" | xargs -I {} cosign sign --yes {}@${DIGEST}

Dockerfile

@@ -8,7 +8,7 @@ WORKDIR /usr/src/app
 COPY package.json yarn.lock ./
 
 # Install dependencies.
-RUN yarn install
+RUN apk --no-cache add git && yarn add xivapi/lodestone-css-selectors && yarn install
 
 # Copy local code to the container image.
 COPY . .
@@ -23,4 +23,4 @@ USER node
 EXPOSE 8080
 
 # Run the web service on container startup.
-CMD [ "yarn", "run", "express:start" ]
+CMD [ "yarn", "run", "express:start" ]

README.md

@@ -7,8 +7,16 @@ Easy to use Node Lodestone parser.
 ### Inside your own server
 
 #### Running on Host
+
+Gather dependencies
+
 ```shell
+yarn add xivapi/lodestone-css-selectors
 yarn install
+```
+
+Then start
+```
 yarn run express:start
 ```
 

src/core/css-selector-registry.ts

@@ -1,3 +1,4 @@
+export const PAGE_REGION = process.env.PAGE_REGION || "na"
 export interface CssSelectorDefinition {
     selector: string;
     multiple?: boolean;

src/freecompany/freecompany.ts

@@ -1,12 +1,12 @@
 import { Request } from "express";
 import { PageParser } from "../core/page-parser";
-import * as freecompany from "../lib/lodestone-css-selectors/freecompany/freecompany.json";
-import { CssSelectorRegistry } from "../core/css-selector-registry";
+import * as freecompany from "lodestone-css-selectors/freecompany/freecompany.json";
+import { CssSelectorRegistry, PAGE_REGION } from "../core/css-selector-registry";
 
 export class FreeCompany extends PageParser {
   protected getURL(req: Request): string {
     return (
-      "https://na.finalfantasyxiv.com/lodestone/freecompany/" + req.params.fcId
+      "https://"+ PAGE_REGION + ".finalfantasyxiv.com/lodestone/freecompany/" + req.params.fcId
     );
   }
 

src/freecompany/members.ts

@@ -1,6 +1,6 @@
 import { Request } from "express";
-import { CssSelectorRegistry } from "../core/css-selector-registry";
-import * as members from "../lib/lodestone-css-selectors/freecompany/members.json";
+import { CssSelectorRegistry, PAGE_REGION } from "../core/css-selector-registry";
+import * as members from "lodestone-css-selectors/freecompany/members.json";
 import { PaginatedPageParser } from "../core/paginated-page-parser";
 
 export class FCMembers extends PaginatedPageParser {
@@ -10,7 +10,7 @@ export class FCMembers extends PaginatedPageParser {
 
   protected getBaseURL(req: Request): string {
     return (
-      "https://na.finalfantasyxiv.com/lodestone/freecompany/" +
+      "https://"+ PAGE_REGION + ".finalfantasyxiv.com/lodestone/freecompany/" +
       req.params.fcId +
       "/member"
     );

src/profile/achievements.ts

@@ -1,6 +1,6 @@
 import {Request} from "express";
-import {CssSelectorRegistry} from "../core/css-selector-registry";
-import * as achievements from '../lib/lodestone-css-selectors/profile/achievements.json';
+import {CssSelectorRegistry, PAGE_REGION} from "../core/css-selector-registry";
+import * as achievements from 'lodestone-css-selectors/profile/achievements.json';
 import {PaginatedPageParser} from "../core/paginated-page-parser";
 
 export class Achievements extends PaginatedPageParser {
@@ -9,7 +9,7 @@ export class Achievements extends PaginatedPageParser {
     }
 
     protected getBaseURL(req: Request): string {
-        return "https://na.finalfantasyxiv.com/lodestone/character/" + req.params.characterId + "/achievement";
+        return "https://"+ PAGE_REGION + ".finalfantasyxiv.com/lodestone/character/" + req.params.characterId + "/achievement";
     }
 
     async parse(req: Request, columnsPrefix: string = ''): Promise<Object> {

src/profile/character.ts

@@ -1,14 +1,14 @@
 import { Request } from "express";
 import { PageParser } from "../core/page-parser";
-import * as character from "../lib/lodestone-css-selectors/profile/character.json";
-import * as attributes from "../lib/lodestone-css-selectors/profile/attributes.json";
-import * as gearset from "../lib/lodestone-css-selectors/profile/gearset.json";
-import { CssSelectorRegistry } from "../core/css-selector-registry";
+import * as character from "lodestone-css-selectors/profile/character.json";
+import * as attributes from "lodestone-css-selectors/profile/attributes.json";
+import * as gearset from "lodestone-css-selectors/profile/gearset.json";
+import { CssSelectorRegistry, PAGE_REGION } from "../core/css-selector-registry";
 
 export class Character extends PageParser {
   protected getURL(req: Request): string {
     return (
-      "https://na.finalfantasyxiv.com/lodestone/character/" +
+      "https://"+ PAGE_REGION + ".finalfantasyxiv.com/lodestone/character/" +
       req.params.characterId
     );
   }

src/profile/classjob.ts

@@ -1,6 +1,6 @@
 import { Request } from "express";
-import { CssSelectorRegistry } from "../core/css-selector-registry";
-import * as classjob from "../lib/lodestone-css-selectors/profile/classjob.json";
+import { CssSelectorRegistry, PAGE_REGION } from "../core/css-selector-registry";
+import * as classjob from "lodestone-css-selectors/profile/classjob.json";
 import { PaginatedPageParser } from "../core/paginated-page-parser";
 
 export class ClassJob extends PaginatedPageParser {
@@ -10,7 +10,7 @@ export class ClassJob extends PaginatedPageParser {
 
   protected getBaseURL(req: Request): string {
     return (
-      "https://na.finalfantasyxiv.com/lodestone/character/" +
+      "https://"+ PAGE_REGION + ".finalfantasyxiv.com/lodestone/character/" +
       req.params.characterId +
       "/class_job"
     );

src/search/character-search.ts

@@ -1,6 +1,6 @@
 import { PaginatedPageParser } from "../core/paginated-page-parser";
-import { CssSelectorRegistry } from "../core/css-selector-registry";
-import * as characterSearch from "../lib/lodestone-css-selectors/search/character.json";
+import { CssSelectorRegistry, PAGE_REGION } from "../core/css-selector-registry";
+import * as characterSearch from "lodestone-css-selectors/search/character.json";
 import { Request } from "express";
 import logger from "../logger/logger";
 
@@ -13,7 +13,7 @@ export class CharacterSearch extends PaginatedPageParser {
     } else if (req.query.server) {
       query += `&worldname=${req.query.server}`;
     }
-    return `https://na.finalfantasyxiv.com/lodestone/character/${query}`;
+    return `https://${PAGE_REGION}.finalfantasyxiv.com/lodestone/character/${query}`;
   }
 
   protected getCSSSelectors(): CssSelectorRegistry {

src/search/freecompany-search.ts

@@ -1,6 +1,6 @@
 import { PaginatedPageParser } from "../core/paginated-page-parser";
-import { CssSelectorRegistry } from "../core/css-selector-registry";
-import * as freeCompanySearch from "../lib/lodestone-css-selectors/search/freecompany.json";
+import { CssSelectorRegistry, PAGE_REGION } from "../core/css-selector-registry";
+import * as freeCompanySearch from "lodestone-css-selectors/search/freecompany.json";
 import { Request } from "express";
 import logger from "../logger/logger";
 
@@ -13,7 +13,7 @@ export class FreeCompanySearch extends PaginatedPageParser {
     } else if (req.query.server) {
       query += `&worldname=${req.query.server}`;
     }
-    return `https://na.finalfantasyxiv.com/lodestone/freecompany/${query}`;
+    return `https://${PAGE_REGION}.finalfantasyxiv.com/lodestone/freecompany/${query}`;
   }
 
   protected getCSSSelectors(): CssSelectorRegistry {