@archmap/icons 0.1.0

package/dist/cloud-icons.js

@@ -0,0 +1,91 @@
+import { generatedCloudIconCounts, generatedCloudIconEntries } from "./cloud-icons.generated.js";
+export const cloudIconEntries = generatedCloudIconEntries;
+export const cloudIconCounts = generatedCloudIconCounts;
+const providerFallbackIcons = {
+    aws: badge("AWS", "FF9900"),
+    gcp: badge("GCP", "4285F4"),
+    azure: badge("AZ", "0078D4"),
+};
+function badge(label, color) {
+    return {
+        viewBox: "0 0 24 24",
+        body: `<rect width="24" height="24" rx="5" fill="#${color}" />` +
+            `<text x="12" y="13" font-family="system-ui, sans-serif" font-size="7.2" font-weight="700" ` +
+            `text-anchor="middle" dominant-baseline="central" fill="#ffffff">${label}</text>`,
+    };
+}
+function shouldInstall(provider, options) {
+    return !options.providers || options.providers.includes(provider);
+}
+function normalizeKey(value) {
+    return value
+        .replace(/&/g, " and ")
+        .toLowerCase()
+        .replace(/[^a-z0-9]+/g, "_")
+        .replace(/^_+|_+$/g, "")
+        .replace(/_{2,}/g, "_");
+}
+function entrySearchText(entry) {
+    return [entry.provider, entry.key, entry.title, entry.category, ...(entry.aliases ?? [])]
+        .map(normalizeKey)
+        .join(" ");
+}
+function registerCloudEntry(registerIcon, entry) {
+    registerIcon(`${entry.provider}/${entry.key}`, entry.icon);
+    for (const alias of entry.aliases ?? []) {
+        registerIcon(`${entry.provider}/${alias}`, entry.icon);
+    }
+}
+export function installCloudProviderIcons(registerIcon, options = {}) {
+    for (const provider of Object.keys(providerFallbackIcons)) {
+        if (shouldInstall(provider, options))
+            registerIcon(provider, providerFallbackIcons[provider]);
+    }
+    for (const entry of cloudIconEntries) {
+        if (shouldInstall(entry.provider, options))
+            registerCloudEntry(registerIcon, entry);
+    }
+}
+export function installAwsIcons(registerIcon) {
+    installCloudProviderIcons(registerIcon, { providers: ["aws"] });
+}
+export function installGcpIcons(registerIcon) {
+    installCloudProviderIcons(registerIcon, { providers: ["gcp"] });
+}
+export function installAzureIcons(registerIcon) {
+    installCloudProviderIcons(registerIcon, { providers: ["azure"] });
+}
+export function getCloudIconEntry(provider, kind) {
+    const normalized = normalizeKey(kind);
+    return cloudIconEntries.find((entry) => entry.provider === provider &&
+        (entry.key === normalized || (entry.aliases ?? []).includes(normalized)));
+}
+export function listCloudIconKeys(provider) {
+    const keys = [];
+    for (const entry of cloudIconEntries) {
+        if (provider && entry.provider !== provider)
+            continue;
+        keys.push(`${entry.provider}/${entry.key}`);
+        for (const alias of entry.aliases ?? [])
+            keys.push(`${entry.provider}/${alias}`);
+    }
+    return keys.sort();
+}
+export function searchCloudIconEntries(query, options = {}) {
+    const terms = normalizeKey(query).split("_").filter(Boolean);
+    const limit = options.limit ?? 20;
+    const scored = cloudIconEntries
+        .filter((entry) => !options.provider || entry.provider === options.provider)
+        .map((entry) => {
+        const text = entrySearchText(entry);
+        const exactKey = terms.length === 1 && entry.key === terms[0] ? 4 : 0;
+        const exactAlias = terms.some((term) => (entry.aliases ?? []).includes(term)) ? 3 : 0;
+        const score = exactKey +
+            exactAlias +
+            terms.reduce((sum, term) => sum + (text.includes(term) ? 1 : 0), 0);
+        return { entry, score };
+    })
+        .filter(({ score }) => score > 0)
+        .sort((a, b) => b.score - a.score || a.entry.key.localeCompare(b.entry.key));
+    return scored.slice(0, limit).map(({ entry }) => entry);
+}

package/dist/index.d.ts

@@ -0,0 +1,227 @@
+export interface RenderableIcon {
+    viewBox: string;
+    body: string;
+}
+export type RegisterIcon = (key: string, icon: RenderableIcon) => void;
+export interface ServiceIconEntry {
+    /** Canonical ArchMap provider key. */
+    key: string;
+    /** Human-readable service name. */
+    title: string;
+    /** Diagram role this icon is usually used for. */
+    role: string;
+    /** Ranked row from the initial famous-services set. */
+    rank: number;
+    /** Additional provider spellings registered for the same icon. */
+    aliases?: readonly string[];
+}
+export declare const famousServiceIconEntries: readonly [{
+    readonly rank: 1;
+    readonly key: "datadog";
+    readonly title: "Datadog";
+    readonly role: "Observability / Monitoring";
+}, {
+    readonly rank: 2;
+    readonly key: "cloudflare";
+    readonly title: "Cloudflare";
+    readonly role: "Edge / DNS / WAF";
+}, {
+    readonly rank: 3;
+    readonly key: "okta";
+    readonly title: "Okta";
+    readonly role: "Identity Provider";
+}, {
+    readonly rank: 4;
+    readonly key: "wiz";
+    readonly title: "Wiz";
+    readonly role: "Cloud Security / CNAPP";
+}, {
+    readonly rank: 5;
+    readonly key: "sentry";
+    readonly title: "Sentry";
+    readonly role: "Error Tracking";
+}, {
+    readonly rank: 6;
+    readonly key: "github";
+    readonly title: "GitHub";
+    readonly role: "Code / CI / Dev Platform";
+}, {
+    readonly rank: 7;
+    readonly key: "pagerduty";
+    readonly title: "PagerDuty";
+    readonly role: "Incident / Alert Routing";
+    readonly aliases: readonly ["pager-duty", "pager_duty"];
+}, {
+    readonly rank: 8;
+    readonly key: "newrelic";
+    readonly title: "New Relic";
+    readonly role: "Observability";
+    readonly aliases: readonly ["new-relic", "new_relic"];
+}, {
+    readonly rank: 8;
+    readonly key: "dynatrace";
+    readonly title: "Dynatrace";
+    readonly role: "Observability";
+}, {
+    readonly rank: 9;
+    readonly key: "splunk";
+    readonly title: "Splunk";
+    readonly role: "Log Analytics / SIEM";
+}, {
+    readonly rank: 10;
+    readonly key: "servicenow";
+    readonly title: "ServiceNow";
+    readonly role: "ITSM / Ticketing";
+    readonly aliases: readonly ["service-now", "service_now"];
+}, {
+    readonly rank: 10;
+    readonly key: "jira";
+    readonly title: "Jira";
+    readonly role: "ITSM / Ticketing";
+}, {
+    readonly rank: 11;
+    readonly key: "kubernetes";
+    readonly title: "Kubernetes";
+    readonly role: "Container Orchestration";
+    readonly aliases: readonly ["k8s"];
+}, {
+    readonly rank: 12;
+    readonly key: "docker";
+    readonly title: "Docker";
+    readonly role: "Containers";
+}, {
+    readonly rank: 13;
+    readonly key: "terraform";
+    readonly title: "Terraform";
+    readonly role: "Infrastructure as Code";
+    readonly aliases: readonly ["iac"];
+}, {
+    readonly rank: 14;
+    readonly key: "grafana";
+    readonly title: "Grafana";
+    readonly role: "Dashboards / Observability";
+}, {
+    readonly rank: 15;
+    readonly key: "prometheus";
+    readonly title: "Prometheus";
+    readonly role: "Metrics / Monitoring";
+}, {
+    readonly rank: 16;
+    readonly key: "postgresql";
+    readonly title: "PostgreSQL";
+    readonly role: "Relational Database";
+    readonly aliases: readonly ["postgres", "postgres_db"];
+}, {
+    readonly rank: 17;
+    readonly key: "mysql";
+    readonly title: "MySQL";
+    readonly role: "Relational Database";
+}, {
+    readonly rank: 18;
+    readonly key: "redis";
+    readonly title: "Redis";
+    readonly role: "Cache / Key-Value Store";
+    readonly aliases: readonly ["cache"];
+}, {
+    readonly rank: 19;
+    readonly key: "mongodb";
+    readonly title: "MongoDB";
+    readonly role: "Document Database";
+    readonly aliases: readonly ["mongo", "document_db"];
+}, {
+    readonly rank: 20;
+    readonly key: "kafka";
+    readonly title: "Apache Kafka";
+    readonly role: "Event Streaming";
+    readonly aliases: readonly ["apache_kafka", "event_streaming"];
+}, {
+    readonly rank: 21;
+    readonly key: "elasticsearch";
+    readonly title: "Elasticsearch";
+    readonly role: "Search / Log Indexing";
+    readonly aliases: readonly ["elastic_search", "search"];
+}, {
+    readonly rank: 22;
+    readonly key: "slack";
+    readonly title: "Slack";
+    readonly role: "ChatOps / Collaboration";
+}, {
+    readonly rank: 23;
+    readonly key: "microsoftteams";
+    readonly title: "Microsoft Teams";
+    readonly role: "ChatOps / Collaboration";
+    readonly aliases: readonly ["microsoft-teams", "microsoft_teams", "teams"];
+}, {
+    readonly rank: 24;
+    readonly key: "auth0";
+    readonly title: "Auth0";
+    readonly role: "Identity Provider";
+}, {
+    readonly rank: 25;
+    readonly key: "keycloak";
+    readonly title: "Keycloak";
+    readonly role: "Identity Provider";
+}, {
+    readonly rank: 26;
+    readonly key: "vercel";
+    readonly title: "Vercel";
+    readonly role: "Frontend Hosting / Deployment";
+}, {
+    readonly rank: 27;
+    readonly key: "netlify";
+    readonly title: "Netlify";
+    readonly role: "Frontend Hosting / Deployment";
+}, {
+    readonly rank: 28;
+    readonly key: "heroku";
+    readonly title: "Heroku";
+    readonly role: "PaaS / App Hosting";
+}, {
+    readonly rank: 29;
+    readonly key: "supabase";
+    readonly title: "Supabase";
+    readonly role: "Backend Platform";
+}, {
+    readonly rank: 30;
+    readonly key: "firebase";
+    readonly title: "Firebase";
+    readonly role: "Backend Platform";
+}];
+declare const iconsByKey: {
+    datadog: RenderableIcon;
+    cloudflare: RenderableIcon;
+    okta: RenderableIcon;
+    wiz: RenderableIcon;
+    sentry: RenderableIcon;
+    github: RenderableIcon;
+    pagerduty: RenderableIcon;
+    newrelic: RenderableIcon;
+    dynatrace: RenderableIcon;
+    splunk: RenderableIcon;
+    servicenow: RenderableIcon;
+    jira: RenderableIcon;
+    kubernetes: RenderableIcon;
+    docker: RenderableIcon;
+    terraform: RenderableIcon;
+    grafana: RenderableIcon;
+    prometheus: RenderableIcon;
+    postgresql: RenderableIcon;
+    mysql: RenderableIcon;
+    redis: RenderableIcon;
+    mongodb: RenderableIcon;
+    kafka: RenderableIcon;
+    elasticsearch: RenderableIcon;
+    slack: RenderableIcon;
+    microsoftteams: RenderableIcon;
+    auth0: RenderableIcon;
+    keycloak: RenderableIcon;
+    vercel: RenderableIcon;
+    netlify: RenderableIcon;
+    heroku: RenderableIcon;
+    supabase: RenderableIcon;
+    firebase: RenderableIcon;
+};
+export declare function installFamousServiceIcons(registerIcon: RegisterIcon): void;
+export { iconsByKey as famousServiceIcons };
+export { cloudIconCounts, cloudIconEntries, getCloudIconEntry, installAwsIcons, installAzureIcons, installCloudProviderIcons, installGcpIcons, listCloudIconKeys, searchCloudIconEntries, } from "./cloud-icons.js";
+export type { CloudIconEntry, CloudProvider, InstallCloudIconsOptions, SearchCloudIconOptions, } from "./cloud-icons.js";

package/dist/index.js

@@ -0,0 +1,263 @@
+import { siApachekafka, siAuth0, siCloudflare, siDatadog, siDocker, siDynatrace, siElasticsearch, siFirebase, siGrafana, siGithub, siJira, siKeycloak, siKubernetes, siMongodb, siMysql, siNewrelic, siNetlify, siOkta, siPagerduty, siPostgresql, siPrometheus, siRedis, siSentry, siSplunk, siSupabase, siTerraform, siVercel, } from "simple-icons";
+export const famousServiceIconEntries = [
+    {
+        rank: 1,
+        key: "datadog",
+        title: "Datadog",
+        role: "Observability / Monitoring",
+    },
+    {
+        rank: 2,
+        key: "cloudflare",
+        title: "Cloudflare",
+        role: "Edge / DNS / WAF",
+    },
+    {
+        rank: 3,
+        key: "okta",
+        title: "Okta",
+        role: "Identity Provider",
+    },
+    {
+        rank: 4,
+        key: "wiz",
+        title: "Wiz",
+        role: "Cloud Security / CNAPP",
+    },
+    {
+        rank: 5,
+        key: "sentry",
+        title: "Sentry",
+        role: "Error Tracking",
+    },
+    {
+        rank: 6,
+        key: "github",
+        title: "GitHub",
+        role: "Code / CI / Dev Platform",
+    },
+    {
+        rank: 7,
+        key: "pagerduty",
+        title: "PagerDuty",
+        role: "Incident / Alert Routing",
+        aliases: ["pager-duty", "pager_duty"],
+    },
+    {
+        rank: 8,
+        key: "newrelic",
+        title: "New Relic",
+        role: "Observability",
+        aliases: ["new-relic", "new_relic"],
+    },
+    {
+        rank: 8,
+        key: "dynatrace",
+        title: "Dynatrace",
+        role: "Observability",
+    },
+    {
+        rank: 9,
+        key: "splunk",
+        title: "Splunk",
+        role: "Log Analytics / SIEM",
+    },
+    {
+        rank: 10,
+        key: "servicenow",
+        title: "ServiceNow",
+        role: "ITSM / Ticketing",
+        aliases: ["service-now", "service_now"],
+    },
+    {
+        rank: 10,
+        key: "jira",
+        title: "Jira",
+        role: "ITSM / Ticketing",
+    },
+    {
+        rank: 11,
+        key: "kubernetes",
+        title: "Kubernetes",
+        role: "Container Orchestration",
+        aliases: ["k8s"],
+    },
+    {
+        rank: 12,
+        key: "docker",
+        title: "Docker",
+        role: "Containers",
+    },
+    {
+        rank: 13,
+        key: "terraform",
+        title: "Terraform",
+        role: "Infrastructure as Code",
+        aliases: ["iac"],
+    },
+    {
+        rank: 14,
+        key: "grafana",
+        title: "Grafana",
+        role: "Dashboards / Observability",
+    },
+    {
+        rank: 15,
+        key: "prometheus",
+        title: "Prometheus",
+        role: "Metrics / Monitoring",
+    },
+    {
+        rank: 16,
+        key: "postgresql",
+        title: "PostgreSQL",
+        role: "Relational Database",
+        aliases: ["postgres", "postgres_db"],
+    },
+    {
+        rank: 17,
+        key: "mysql",
+        title: "MySQL",
+        role: "Relational Database",
+    },
+    {
+        rank: 18,
+        key: "redis",
+        title: "Redis",
+        role: "Cache / Key-Value Store",
+        aliases: ["cache"],
+    },
+    {
+        rank: 19,
+        key: "mongodb",
+        title: "MongoDB",
+        role: "Document Database",
+        aliases: ["mongo", "document_db"],
+    },
+    {
+        rank: 20,
+        key: "kafka",
+        title: "Apache Kafka",
+        role: "Event Streaming",
+        aliases: ["apache_kafka", "event_streaming"],
+    },
+    {
+        rank: 21,
+        key: "elasticsearch",
+        title: "Elasticsearch",
+        role: "Search / Log Indexing",
+        aliases: ["elastic_search", "search"],
+    },
+    {
+        rank: 22,
+        key: "slack",
+        title: "Slack",
+        role: "ChatOps / Collaboration",
+    },
+    {
+        rank: 23,
+        key: "microsoftteams",
+        title: "Microsoft Teams",
+        role: "ChatOps / Collaboration",
+        aliases: ["microsoft-teams", "microsoft_teams", "teams"],
+    },
+    {
+        rank: 24,
+        key: "auth0",
+        title: "Auth0",
+        role: "Identity Provider",
+    },
+    {
+        rank: 25,
+        key: "keycloak",
+        title: "Keycloak",
+        role: "Identity Provider",
+    },
+    {
+        rank: 26,
+        key: "vercel",
+        title: "Vercel",
+        role: "Frontend Hosting / Deployment",
+    },
+    {
+        rank: 27,
+        key: "netlify",
+        title: "Netlify",
+        role: "Frontend Hosting / Deployment",
+    },
+    {
+        rank: 28,
+        key: "heroku",
+        title: "Heroku",
+        role: "PaaS / App Hosting",
+    },
+    {
+        rank: 29,
+        key: "supabase",
+        title: "Supabase",
+        role: "Backend Platform",
+    },
+    {
+        rank: 30,
+        key: "firebase",
+        title: "Firebase",
+        role: "Backend Platform",
+    },
+];
+function fromSimpleIcon(si) {
+    return { viewBox: "0 0 24 24", body: `<path fill="#${si.hex}" d="${si.path}" />` };
+}
+function letterBadge(label, color) {
+    return {
+        viewBox: "0 0 24 24",
+        body: `<rect width="24" height="24" rx="5" fill="#${color}" />` +
+            `<text x="12" y="13" font-family="system-ui, sans-serif" font-size="7.2" font-weight="700" ` +
+            `text-anchor="middle" dominant-baseline="central" fill="#ffffff">${label}</text>`,
+    };
+}
+function registerWithAliases(registerIcon, entry, icon) {
+    registerIcon(entry.key, icon);
+    for (const alias of entry.aliases ?? [])
+        registerIcon(alias, icon);
+}
+const iconsByKey = {
+    datadog: fromSimpleIcon(siDatadog),
+    cloudflare: fromSimpleIcon(siCloudflare),
+    okta: fromSimpleIcon(siOkta),
+    wiz: letterBadge("WIZ", "7C3AED"),
+    sentry: fromSimpleIcon(siSentry),
+    github: fromSimpleIcon(siGithub),
+    pagerduty: fromSimpleIcon(siPagerduty),
+    newrelic: fromSimpleIcon(siNewrelic),
+    dynatrace: fromSimpleIcon(siDynatrace),
+    splunk: fromSimpleIcon(siSplunk),
+    servicenow: letterBadge("SN", "00A13A"),
+    jira: fromSimpleIcon(siJira),
+    kubernetes: fromSimpleIcon(siKubernetes),
+    docker: fromSimpleIcon(siDocker),
+    terraform: fromSimpleIcon(siTerraform),
+    grafana: fromSimpleIcon(siGrafana),
+    prometheus: fromSimpleIcon(siPrometheus),
+    postgresql: fromSimpleIcon(siPostgresql),
+    mysql: fromSimpleIcon(siMysql),
+    redis: fromSimpleIcon(siRedis),
+    mongodb: fromSimpleIcon(siMongodb),
+    kafka: fromSimpleIcon(siApachekafka),
+    elasticsearch: fromSimpleIcon(siElasticsearch),
+    slack: letterBadge("SLK", "4A154B"),
+    microsoftteams: letterBadge("MS", "6264A7"),
+    auth0: fromSimpleIcon(siAuth0),
+    keycloak: fromSimpleIcon(siKeycloak),
+    vercel: fromSimpleIcon(siVercel),
+    netlify: fromSimpleIcon(siNetlify),
+    heroku: letterBadge("HKU", "430098"),
+    supabase: fromSimpleIcon(siSupabase),
+    firebase: fromSimpleIcon(siFirebase),
+};
+export function installFamousServiceIcons(registerIcon) {
+    for (const entry of famousServiceIconEntries) {
+        registerWithAliases(registerIcon, entry, iconsByKey[entry.key]);
+    }
+}
+export { iconsByKey as famousServiceIcons };
+export { cloudIconCounts, cloudIconEntries, getCloudIconEntry, installAwsIcons, installAzureIcons, installCloudProviderIcons, installGcpIcons, listCloudIconKeys, searchCloudIconEntries, } from "./cloud-icons.js";

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@archmap/icons",
+  "version": "0.1.0",
+  "description": "Opt-in third-party service icon pack for ArchMap diagrams.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "generate:cloud-icons": "node scripts/generate-cloud-icons.mjs",
+    "test": "npm run typecheck && npm run build && node scripts/test-icons.mjs",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "simple-icons": "^16.24.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.6.3"
+  },
+  "keywords": [
+    "archmap",
+    "architecture",
+    "diagram",
+    "icons"
+  ],
+  "license": "MIT"
+}