Valkyrie 1.0

.editorconfig

@@ -0,0 +1,13 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

.github/workflows/deploy.yml

@@ -0,0 +1,75 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches: ['1.0']
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: 'pages'
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+      - name: Install dependencies
+        run: npm install
+      - name: Production build
+        run: npm run prod
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: valkyrieicons
+          path: |
+            dist
+            node_modules
+
+  deploy:
+    needs: build
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: docs
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+      - name: Download artifact
+        id: download
+        uses: actions/download-artifact@v4
+        with:
+          name: valkyrieicons
+      - name: Install dependencies
+        if: steps.download.outcome == 'success'
+        run: npm install
+      - name: Build
+        run: npm run build
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/dist
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1,2 +1,6 @@
-/node_modules
-/dist
+.DS_Store
+/.hugo_build.lock
+/_site/
+/node_modules/
+/resources/
+/dist/

.svg-to-tsrc

@@ -1,11 +1,11 @@
 {
   "srcFiles": ["./icons/**/*.svg"],
   "outputDirectory": "./src",
-  "interfaceName": "ValkyrieIcon",
+  "interfaceName": "IValkyrieIcon",
   "typeName": "Valkyrie",
   "prefix": "vi",
   "fileName": "Valkyrie",
   "additionalModelFile": "./src",
   "compileSources": true,
   "completeIconSetName": "valkyrieSet"
-}
+}

README.md

@@ -10,11 +10,11 @@ npm install @sippy-platform/valkyrie
 
 Valkyrie includes a number of ways to use it. Our package will include the individual SVG files, a React-component and JavaScript implementation with TypeScript definitions, as well as an old-school webfont.
 
-# 216 icons
+# 255 icons
 [Available on Figma](https://www.figma.com/file/jeP1aSRulegRxHDegrrmWc/Valkyrie?node-id=1%3A11358)
 
 # About
-Valkyrie is an iconset designed for use in the Mellow Design Language. Our goal is to provide a highly-optimized set of icons that are custom made for Sippy and any future environments required. As such, Valkyrie will mostly include iconography related to basic UI (arrows, menu icons, etc.) and phone iconography (voicemail, call directions, etc.).
+Valkyrie is an iconset designed for use in the Mellow Design Language. Our goal is to provide a highly-optimized set of icons that are custom made for Sippy and any future environments required. As such, Valkyrie will mostly include iconography related to basic UI (arrows, menu icons, etc.) and phone iconography (voicemail, call directions, etc.) required for My Sippy, and other iconography required for marketing including Sippy.cloud.
 
 # License
 AGPL v3

build/generate-library.js

@@ -0,0 +1,117 @@
+#!/usr/bin/env node
+
+"use strict";
+
+const fs = require("fs").promises;
+const fst = require("fs");
+const path = require("path");
+const picocolors = require("picocolors");
+
+const iconsDir = path.join(__dirname, "../docs/public/data/icons");
+const pagesDir = path.join(__dirname, "../docs/src/data/");
+
+function getReactImportName(string) {
+  return `vi${string
+    .split("-")
+    .map(word => {
+      return word[0].toUpperCase() + word.substring(1);
+    })
+    .join("")}`;
+}
+
+async function main(file) {
+  const iconFilePath = path.join(iconsDir, file);
+  const iconFile = fst.readFileSync(iconFilePath);
+
+  let iconJson = {};
+
+  try {
+    iconJson = JSON.parse(iconFile);
+  } catch (e) {
+    console.log(iconFilePath);
+  }
+
+  const iconBasename = path.basename(file, path.extname(file));
+  const iconTitle = getReactImportName(iconBasename);
+
+  const jsonTemplate = `
+  {
+    component: '${iconTitle}',
+    categories: ${JSON.stringify(iconJson.categories)},
+    tags: ${JSON.stringify(iconJson.tags)},
+    slug: '${iconBasename}',
+    icon: ${iconTitle}
+  }`;
+
+  return [`${iconTitle}`, jsonTemplate, iconJson.categories];
+}
+
+(async () => {
+  try {
+    const timeLabel = picocolors.cyan(`Library generation finished`);
+
+    console.log(picocolors.cyan(`Library generation started`));
+    console.time(timeLabel);
+
+    const files = await fs.readdir(iconsDir);
+
+    const names = [];
+    const configs = [];
+    let categories = new Set();
+
+    // Read content from each icon
+    await Promise.all(
+      files.map(async file => {
+        const [name, config, cats] = await Promise.resolve(main(file));
+
+        names.push(name);
+        configs.push(config);
+
+        cats.map(cat => {
+          categories.add(cat);
+        });
+      })
+    );
+
+    categories = Array.from(categories).sort();
+
+    const template = `
+import { ${names.map(icon => `${icon}`)} } from '@sippy-platform/valkyrie';
+
+const icons = [${configs.map(page => `${page}`)}
+];
+
+export default icons;`;
+
+    await fs.writeFile(path.join(pagesDir, `icons.ts`), template);
+
+    const categoriesTemplate = `
+import { viCircleDashed } from '@sippy-platform/valkyrie';
+
+const categories = [${categories.map(
+      cat => `
+  {
+    slug: "${cat}",
+    title: "${cat}",
+    icon: viCircleDashed
+  }`
+    )}
+];
+
+export default categories;`;
+
+    // await fs.writeFile(path.join(pagesDir, `categories.ts`), categoriesTemplate)
+
+    const filesLength = files.length;
+
+    console.log(
+      picocolors.green("\nSuccess, %s icon%s written to library!"),
+      filesLength,
+      filesLength !== 1 ? "s" : ""
+    );
+    console.timeEnd(timeLabel);
+  } catch (error) {
+    console.error(error);
+    process.exit(1);
+  }
+})();

build/generate-pages.js

@@ -0,0 +1,74 @@
+#!/usr/bin/env node
+
+"use strict";
+
+const fs = require("fs").promises;
+const path = require("path");
+const picocolors = require("picocolors");
+
+const version = require("../package.json").version;
+
+const iconsDir = path.join(__dirname, "../icons/");
+const pagesDir = path.join(__dirname, "../docs/public/data/icons/");
+
+const VERBOSE = process.argv.includes("--verbose");
+
+function capitalizeFirstLetter(string) {
+  return (string.charAt(0).toUpperCase() + string.slice(1))
+    .split("-")
+    .join(" ");
+}
+
+async function main(file) {
+  const iconBasename = path.basename(file, path.extname(file));
+  const iconTitle = capitalizeFirstLetter(iconBasename);
+  const pageName = path.join(pagesDir, `${iconBasename}.json`);
+
+  const pageTemplate = `{
+  "title": "${iconTitle}",
+  "categories": [],
+  "tags": [],
+  "created": "${version.substring(0, version.indexOf("-"))}",
+  "updated": "${version.substring(0, version.indexOf("-"))}"
+}`;
+
+  try {
+    await fs.access(pageName, fs.F_OK);
+
+    if (VERBOSE) {
+      console.log(
+        `☑️ ${picocolors.cyan(iconBasename)}: Already exists, skipping`
+      );
+    }
+  } catch {
+    await fs.writeFile(pageName, pageTemplate);
+    console.log(
+      `✅ ${picocolors.cyan(iconBasename)}: ${picocolors.green("Page created")}`
+    );
+  }
+}
+
+(async () => {
+  try {
+    const timeLabel = picocolors.cyan(`Page generation finished`);
+
+    console.log(picocolors.cyan(`Page generation started`));
+    console.time(timeLabel);
+
+    const files = await fs.readdir(iconsDir);
+
+    await Promise.all(files.map(file => main(file)));
+
+    const filesLength = files.length;
+
+    console.log(
+      picocolors.green("\nSuccess, %s page%s created!"),
+      filesLength,
+      filesLength !== 1 ? "s" : ""
+    );
+    console.timeEnd(timeLabel);
+  } catch (error) {
+    console.error(error);
+    process.exit(1);
+  }
+})();

docs/.editorconfig

@@ -0,0 +1,13 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

docs/.env

@@ -0,0 +1,2 @@
+VALKYRIE_ENV='production'
+VALKYRIE_APP_TITLE='Valkyrie Docs'