@treasuryspatial/surface-kit 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,55 @@
+import type { DeepPartial, UiBrandProfile, UiManifest } from '@treasuryspatial/ui-manifest';
+export type SurfaceKitId = 'composer' | 'transit' | 'courtyard';
+export type SurfaceSkinId = 'transitguy';
+export type SurfaceCompatibilityMode = 'direct-tenant' | 'tenant-subtenant-bridge';
+export type SurfaceKitProfile = {
+    id: SurfaceKitId;
+    manifest: DeepPartial<UiManifest>;
+};
+export type SurfaceSkinProfile = {
+    id: SurfaceSkinId | string;
+    manifest: DeepPartial<UiManifest>;
+};
+export type SurfaceHostContext = {
+    publicHost: string;
+    hostSlug: string;
+    tenantSlug: string;
+    effectiveTenantSlug: string;
+    subtenantSlug: string | null;
+    surfaceId: string;
+    brandProfile: UiBrandProfile;
+    compatibilityMode: SurfaceCompatibilityMode;
+    isMarketingHost: boolean;
+};
+export type SurfaceHostPreset = Omit<SurfaceHostContext, 'publicHost' | 'hostSlug' | 'isMarketingHost'>;
+export type SurfaceHostResolverOptions = {
+    defaultTenantSlug: string;
+    defaultSurfaceId: SurfaceKitId;
+    fallbackHostSlug?: string;
+    marketingSlugs?: string[];
+    hostPresets?: Record<string, SurfaceHostPreset>;
+};
+export declare const DEFAULT_MARKETING_SLUGS: string[];
+export declare const TREASURY_LOGO: {
+    src: string;
+    alt: string;
+};
+export declare const TRANSITGUY_LOGO: {
+    src: string;
+    alt: string;
+};
+export declare const SURFACE_KITS: Record<SurfaceKitId, SurfaceKitProfile>;
+export declare const SURFACE_SKINS: Record<string, SurfaceSkinProfile>;
+export declare const SURFACE_HOST_PRESETS: Record<string, SurfaceHostPreset>;
+export declare const resolveSurfaceKitProfile: (surfaceId: string) => SurfaceKitProfile | null;
+export declare const resolveSurfaceSkinProfile: (skinId: string) => SurfaceSkinProfile | null;
+export declare const buildMarketingSlugSet: (overrides?: string[]) => Set<string>;
+export declare const isMarketingSlug: (slug?: string | null, marketingSlugs?: Set<string>) => boolean;
+export declare const createSurfaceHostResolver: (options: SurfaceHostResolverOptions) => {
+    marketingSlugs: Set<string>;
+    isMarketingSlug: (slug?: string | null) => boolean;
+    resolveSurfaceHostContext: (host?: string | null) => SurfaceHostContext;
+    resolveTenantSlugFromHost: (host?: string | null) => string;
+    resolveCanonicalTenantSlugFromHost: (host?: string | null) => string;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE5F,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,SAAS,GAAG,WAAW,CAAC;AAChE,MAAM,MAAM,aAAa,GAAG,YAAY,CAAC;AACzC,MAAM,MAAM,wBAAwB,GAAG,eAAe,GAAG,yBAAyB,CAAC;AAEnF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,EAAE,EAAE,YAAY,CAAC;IACjB,QAAQ,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,EAAE,aAAa,GAAG,MAAM,CAAC;IAC3B,QAAQ,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,cAAc,CAAC;IAC7B,iBAAiB,EAAE,wBAAwB,CAAC;IAC5C,eAAe,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,kBAAkB,EAAE,YAAY,GAAG,UAAU,GAAG,iBAAiB,CAAC,CAAC;AAExG,MAAM,MAAM,0BAA0B,GAAG;IACvC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,EAAE,YAAY,CAAC;IAC/B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;CACjD,CAAC;AAEF,eAAO,MAAM,uBAAuB,UAOnC,CAAC;AAEF,eAAO,MAAM,aAAa;;;CAGzB,CAAC;AAEF,eAAO,MAAM,eAAe;;;CAG3B,CAAC;AA6BF,eAAO,MAAM,YAAY,EAAE,MAAM,CAAC,YAAY,EAAE,iBAAiB,CA2FhE,CAAC;AAEF,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAmD5D,CAAC;AAEF,eAAO,MAAM,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAiClE,CAAC;AAEF,eAAO,MAAM,wBAAwB,GAAI,WAAW,MAAM,KAAG,iBAAiB,GAAG,IAGhF,CAAC;AAEF,eAAO,MAAM,yBAAyB,GAAI,QAAQ,MAAM,KAAG,kBAAkB,GAAG,IAG/E,CAAC;AAOF,eAAO,MAAM,qBAAqB,GAAI,YAAW,MAAM,EAAO,gBACmC,CAAC;AAElG,eAAO,MAAM,eAAe,GAAI,OAAO,MAAM,GAAG,IAAI,EAAE,4BAAwC,YAG7F,CAAC;AAcF,eAAO,MAAM,yBAAyB,GAAI,SAAS,0BAA0B;;6BA8ChD,MAAM,GAAG,IAAI;uCAtCE,MAAM,GAAG,IAAI,KAAG,kBAAkB;uCAwCvC,MAAM,GAAG,IAAI;gDAEJ,MAAM,GAAG,IAAI;CAG5D,CAAC"}

package/dist/index.js

@@ -0,0 +1,290 @@
+import { DEFAULT_COMPOSER_SURFACE_MODE_POLICY, mergeSurfaceModePolicy } from '@treasuryspatial/mode-policy';
+export const DEFAULT_MARKETING_SLUGS = [
+    'localhost',
+    'treasury',
+    'treasury-dev',
+    'treasury-staging',
+    'dev',
+    'staging',
+];
+export const TREASURY_LOGO = {
+    src: 'https://treasury.space/logo.svg',
+    alt: 'Treasury',
+};
+export const TRANSITGUY_LOGO = {
+    src: 'https://images.squarespace-cdn.com/content/v1/60074cff46d4c56a53f5b0f8/c9051ab0-28f7-4840-ae97-4d70737abffe/the%2Btransit%2Bgay%2Blogo%2B%281%29.png',
+    alt: 'The Transit Guy',
+};
+const TRANSIT_MODE_POLICY = mergeSurfaceModePolicy(DEFAULT_COMPOSER_SURFACE_MODE_POLICY, {
+    defaultMode: 'streetmix',
+    modes: {
+        design: {
+            launchState: 'hidden',
+            shell: { leftPanelOpen: false },
+        },
+        map: {
+            launchState: 'coming-soon',
+            panelTabs: ['render'],
+            defaultPanelTab: 'render',
+            kits: { upload: false, 'compute-target': false },
+            modules: { hud: false, inspector: false, viewControls: false },
+            actions: { 'generate-geometry': false, 'asset-download': false },
+            shell: { leftPanelOpen: false },
+        },
+        streetmix: {
+            enabled: true,
+            label: 'streetmix',
+            panelTabs: ['render'],
+            defaultPanelTab: 'render',
+            kits: { upload: false, 'compute-target': false },
+            actions: { 'generate-geometry': false, 'asset-download': false },
+        },
+    },
+});
+export const SURFACE_KITS = {
+    composer: {
+        id: 'composer',
+        manifest: {
+            surface: {
+                id: 'composer',
+                family: 'composer',
+                label: 'Composer',
+                promptFamily: 'composer',
+                brandProfile: 'treasury-native',
+                summary: 'Treasury design and render surface.',
+                standaloneCapable: true,
+            },
+            branding: {
+                profile: 'treasury-native',
+                poweredBy: { enabled: false },
+            },
+        },
+    },
+    transit: {
+        id: 'transit',
+        manifest: {
+            tenantId: 'transit',
+            surface: {
+                id: 'transit',
+                family: 'transit',
+                label: 'Transit',
+                promptFamily: 'transit',
+                brandProfile: 'treasury-native',
+                summary: 'Treasury-native transit surface built on the Composer runtime.',
+                description: 'Transit is the packaged Treasury surface for corridor visuals, stop environments, and street-section scaffold workflows.',
+                standaloneCapable: true,
+                scaffoldShell: {
+                    badge: 'Streetmix',
+                    footerText: 'Surface logos, copy, and support content live in the Treasury shell. Embedded Streetmix runtime customization remains a separate adapter concern.',
+                },
+            },
+            branding: {
+                profile: 'treasury-native',
+                poweredBy: {
+                    enabled: false,
+                },
+            },
+            topbar: {
+                title: 'Treasury',
+                subtitle: 'Treasury-native transit surface',
+                productLabel: 'Transit Composer',
+                links: [
+                    { label: 'Treasury', href: 'https://treasury.space/', target: '_blank' },
+                    { label: 'Composer', href: 'https://composer.treasury.space/', target: '_blank' },
+                ],
+            },
+            modes: {
+                defaultMode: TRANSIT_MODE_POLICY.defaultMode,
+                modes: TRANSIT_MODE_POLICY.modes,
+            },
+        },
+    },
+    courtyard: {
+        id: 'courtyard',
+        manifest: {
+            tenantId: 'courtyard',
+            surface: {
+                id: 'courtyard',
+                family: 'courtyard',
+                label: 'Courtyard',
+                promptFamily: 'courtyard',
+                brandProfile: 'treasury-native',
+                summary: 'Treasury-native courtyard surface built on shared Composer kits.',
+                description: 'Courtyard is the packaged Treasury surface for design, geometry, and map-led place workflows.',
+                standaloneCapable: true,
+            },
+            branding: {
+                profile: 'treasury-native',
+                poweredBy: {
+                    enabled: false,
+                },
+            },
+            topbar: {
+                title: 'Treasury',
+                subtitle: 'Treasury-native courtyard surface',
+                productLabel: 'Courtyard Composer',
+                links: [
+                    { label: 'Treasury', href: 'https://treasury.space/', target: '_blank' },
+                    { label: 'Composer', href: 'https://composer.treasury.space/', target: '_blank' },
+                ],
+            },
+        },
+    },
+};
+export const SURFACE_SKINS = {
+    transitguy: {
+        id: 'transitguy',
+        manifest: {
+            tenantId: 'transitguy',
+            surface: {
+                id: 'transitguy',
+                family: 'transit',
+                label: 'Transit',
+                promptFamily: 'transit',
+                brandProfile: 'client-skinned',
+                summary: 'Client-skinned transit surface built on the Treasury Transit runtime.',
+                description: 'Transitguy runs as a branded skin of the Treasury Transit surface, keeping scaffold-first transit modes and Treasury runtime behavior while swapping client identity and content.',
+                scaffoldShell: {
+                    badge: 'Streetmix',
+                    secondaryLogo: TRANSITGUY_LOGO,
+                    footerText: 'Client branding and support content are shell-level overrides. Embedded Streetmix runtime customization remains a separate adapter concern.',
+                },
+            },
+            branding: {
+                profile: 'client-skinned',
+                poweredBy: {
+                    enabled: true,
+                    href: 'https://treasury.space',
+                    logo: TREASURY_LOGO,
+                    kicker: 'Powered by',
+                    labelPrefix: 'Treasury',
+                    labelAccent: 'Transit Runtime',
+                },
+            },
+            theme: {
+                typography: {
+                    fontFamily: "'Epilogue', system-ui, -apple-system, BlinkMacSystemFont, sans-serif",
+                    weights: [400, 700],
+                },
+            },
+            topbar: {
+                logo: TRANSITGUY_LOGO,
+                secondaryLogo: TREASURY_LOGO,
+                title: 'TTG',
+                subtitle: 'Transit surface skin on Treasury Composer',
+                productLabel: 'Composer',
+                links: [
+                    { label: 'Website', href: 'https://www.thetransitguy.com/', target: '_blank' },
+                    { label: 'Substack', href: 'https://thetransitguy.substack.com/', target: '_blank' },
+                ],
+            },
+        },
+    },
+};
+export const SURFACE_HOST_PRESETS = {
+    composer: {
+        tenantSlug: 'treasury',
+        effectiveTenantSlug: 'treasury',
+        subtenantSlug: null,
+        surfaceId: 'composer',
+        brandProfile: 'treasury-native',
+        compatibilityMode: 'direct-tenant',
+    },
+    transit: {
+        tenantSlug: 'treasury',
+        effectiveTenantSlug: 'transit',
+        subtenantSlug: 'transit',
+        surfaceId: 'transit',
+        brandProfile: 'treasury-native',
+        compatibilityMode: 'tenant-subtenant-bridge',
+    },
+    transitguy: {
+        tenantSlug: 'transitguy',
+        effectiveTenantSlug: 'transitguy',
+        subtenantSlug: null,
+        surfaceId: 'transit',
+        brandProfile: 'client-skinned',
+        compatibilityMode: 'direct-tenant',
+    },
+    courtyard: {
+        tenantSlug: 'treasury',
+        effectiveTenantSlug: 'courtyard',
+        subtenantSlug: 'courtyard',
+        surfaceId: 'courtyard',
+        brandProfile: 'treasury-native',
+        compatibilityMode: 'tenant-subtenant-bridge',
+    },
+};
+export const resolveSurfaceKitProfile = (surfaceId) => {
+    const normalized = String(surfaceId || '').trim().toLowerCase();
+    return SURFACE_KITS[normalized] ?? null;
+};
+export const resolveSurfaceSkinProfile = (skinId) => {
+    const normalized = String(skinId || '').trim().toLowerCase();
+    return SURFACE_SKINS[normalized] ?? null;
+};
+const normalizeHost = (host) => {
+    if (!host)
+        return '';
+    return host.split(':')[0]?.toLowerCase() ?? '';
+};
+export const buildMarketingSlugSet = (overrides = []) => new Set([...DEFAULT_MARKETING_SLUGS, ...overrides.map((value) => value.toLowerCase())]);
+export const isMarketingSlug = (slug, marketingSlugs = buildMarketingSlugSet()) => {
+    if (!slug)
+        return false;
+    return marketingSlugs.has(slug.toLowerCase());
+};
+const buildDirectTenantContext = (slug, options) => ({
+    tenantSlug: slug || options.defaultTenantSlug,
+    effectiveTenantSlug: slug || options.defaultTenantSlug,
+    subtenantSlug: null,
+    surfaceId: options.defaultSurfaceId,
+    brandProfile: slug && slug !== options.defaultTenantSlug ? 'client-skinned' : 'treasury-native',
+    compatibilityMode: 'direct-tenant',
+});
+export const createSurfaceHostResolver = (options) => {
+    const fallbackHostSlug = (options.fallbackHostSlug || options.defaultTenantSlug).trim().toLowerCase();
+    const marketingSlugs = buildMarketingSlugSet(options.marketingSlugs ?? []);
+    const hostPresets = {
+        ...SURFACE_HOST_PRESETS,
+        ...(options.hostPresets ?? {}),
+    };
+    const resolveSurfaceHostContext = (host) => {
+        const hostname = normalizeHost(host);
+        if (!hostname) {
+            const fallback = hostPresets[fallbackHostSlug] ??
+                buildDirectTenantContext(fallbackHostSlug, {
+                    defaultTenantSlug: options.defaultTenantSlug,
+                    defaultSurfaceId: options.defaultSurfaceId,
+                });
+            return {
+                publicHost: '',
+                hostSlug: fallbackHostSlug,
+                isMarketingHost: true,
+                ...fallback,
+            };
+        }
+        const candidate = hostname.split('.')[0] ?? '';
+        const normalizedCandidate = candidate.toLowerCase();
+        const marketingHost = !normalizedCandidate || marketingSlugs.has(normalizedCandidate);
+        const hostSlug = marketingHost ? fallbackHostSlug : normalizedCandidate;
+        const preset = hostPresets[hostSlug] ??
+            buildDirectTenantContext(hostSlug, {
+                defaultTenantSlug: options.defaultTenantSlug,
+                defaultSurfaceId: options.defaultSurfaceId,
+            });
+        return {
+            publicHost: hostname,
+            hostSlug,
+            isMarketingHost: marketingHost,
+            ...preset,
+        };
+    };
+    return {
+        marketingSlugs,
+        isMarketingSlug: (slug) => isMarketingSlug(slug, marketingSlugs),
+        resolveSurfaceHostContext,
+        resolveTenantSlugFromHost: (host) => resolveSurfaceHostContext(host).effectiveTenantSlug,
+        resolveCanonicalTenantSlugFromHost: (host) => resolveSurfaceHostContext(host).tenantSlug,
+    };
+};

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@treasuryspatial/surface-kit",
+  "version": "0.1.0",
+  "type": "module",
+  "license": "UNLICENSED",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@treasuryspatial/mode-policy": "^0.1.5",
+    "@treasuryspatial/ui-manifest": "^0.1.6"
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "typecheck": "tsc -b --pretty false --noEmit"
+  }
+}