@ossy/platform 0.0.1-alpha.1

package/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 0.0.1-alpha.1 (2026-03-29)
+
+**Note:** Version bump only for package @ossy/platform
+
+
+
+
+
+# Changelog
+
+## 0.0.1-alpha.0
+
+- Initial extract from `website-ossy`: `Definition`, `PlatformResourceTemplates`, `PlatformHomeBody`, `platformHomeMetadata`.

package/README.md

@@ -0,0 +1,30 @@
+# @ossy/platform
+
+Ossy **Platform** module: resource template `@ossy/platform/config` (mirrors deployment-tools `platform-config.json`) and the platform home UI (`PlatformHomeBody`, metadata for routing).
+
+## Install
+
+```bash
+npm install @ossy/platform
+```
+
+Peer dependencies (your app should already include them):
+
+- `react`
+- `@ossy/design-system`
+- `@ossy/router-react`
+- `@ossy/sdk-react`
+
+## Use in a website
+
+1. Spread **`PlatformResourceTemplates`** into your app `resourceTemplates` (and sync to the API via publish / cms upload).
+2. Add a page that wraps **`PlatformHomeBody`** in your shell layout and export **`platformHomeMetadata`**.
+3. Register **`Definition`** in your navigation / module registry.
+
+## Publishing
+
+Released on its **own semver** from this monorepo (`lerna publish` with independent versions). Bump **`@ossy/platform`** when only this module changes.
+
+## Direction
+
+Long term, **which modules a workspace may enable** should be driven by the **CMS** and tied to **billing / entitlements**. Packages stay the **distributable implementation** of each module; access control lives in the product, not in npm scope alone.

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@ossy/platform",
+  "version": "0.0.1-alpha.1",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ossy-se/ossy.git",
+    "directory": "packages/platform"
+  },
+  "type": "module",
+  "description": "Platform module: deployment platform config resource template and home UI for Ossy websites",
+  "exports": {
+    ".": "./src/index.js",
+    "./package.json": "./package.json"
+  },
+  "main": "./src/index.js",
+  "sideEffects": false,
+  "scripts": {
+    "build": "echo \"@ossy/platform: no build step\" && exit 0",
+    "test": ""
+  },
+  "author": "Ossy <yourfriends@ossy.se> (https://ossy.se)",
+  "license": "MIT",
+  "files": [
+    "src",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "peerDependencies": {
+    "@ossy/design-system": ">=0.14.0",
+    "@ossy/router-react": ">=0.14.0",
+    "@ossy/sdk-react": ">=0.14.0",
+    "react": ">=19.0.0"
+  },
+  "gitHead": "1da35d94f324f917d5ea790f838ce8e50214730e"
+}

package/src/Definition.js

@@ -0,0 +1,13 @@
+export const Definition = {
+  id: 'platform',
+  title: 'Platform',
+  description: 'Deployment platform configuration aligned with deployment-tools S3 platform-config.json.',
+  module: {
+    id: 'platform',
+    enabled: true,
+  },
+  statuses: ['beta'],
+  actions: ['resources.create', 'resources.update-content', 'resources.rename', 'resources.remove'],
+  views: ['home.page', 'resources.search', 'resources.get'],
+  tasks: [],
+}

package/src/PlatformHomeBody.jsx

@@ -0,0 +1,88 @@
+import React from 'react'
+import { useRouter } from '@ossy/router-react'
+import { useResources, AsyncStatus } from '@ossy/sdk-react'
+import { Title, Text, View, Tags, Button, Switch } from '@ossy/design-system'
+import { Definition } from './Definition.js'
+import { moduleStatusTags } from './moduleStatus.js'
+import { ResourceList } from './ResourceList.jsx'
+import { PLATFORM_CONFIG_TEMPLATE_ID, PLATFORM_RESOURCE_LOCATION } from './constants.js'
+
+/**
+ * Platform module home content (no site chrome). Wrap with your app {@code Layout} in a *.page.jsx file.
+ */
+export function PlatformHomeBody () {
+  const router = useRouter()
+  const { status, resources } = useResources(PLATFORM_RESOURCE_LOCATION)
+  const platformResources = (resources || []).filter(
+    (resource) => resource?.type === PLATFORM_CONFIG_TEMPLATE_ID
+  )
+
+  let listStatus = status
+
+  if (status === AsyncStatus.Success && platformResources.length === 0) {
+    listStatus = 'Empty'
+  }
+
+  return (
+    <View
+      gap="m"
+      surface="primary"
+      style={{ padding: 'var(--space-m) var(--space-l)', height: '100%', overflowY: 'auto' }}
+    >
+      <View inset="s" gap="s">
+        <View layout="row" justifyContent="space-between" alignItems="center">
+          <View layout="row" gap="s" alignItems="center">
+            <Title>{Definition.title}</Title>
+            {moduleStatusTags(Definition).length > 0 && (
+              <Tags tags={moduleStatusTags(Definition)} size="s" />
+            )}
+          </View>
+          <Button
+            variant="cta"
+            prefix="add"
+            href={router.getHref(
+              `@create-document?location=${encodeURIComponent(PLATFORM_RESOURCE_LOCATION)}&templateId=${encodeURIComponent(PLATFORM_CONFIG_TEMPLATE_ID)}`
+            )}
+          >
+            New platform config
+          </Button>
+        </View>
+
+        <Text style={{ maxWidth: '640px' }}>
+          {Definition.description} Field names match deployment-tools{' '}
+          <strong>platform-config.json</strong> on the S3 bucket (excluding <strong>awsRoleToAssume</strong>).
+        </Text>
+      </View>
+
+      <View gap="m" inset="s" style={{ overflowY: 'auto' }}>
+        <Switch on={listStatus}>
+          <Switch.Case match={[AsyncStatus.NotInitialized, AsyncStatus.Loading]}>
+            <Text>Loading…</Text>
+          </Switch.Case>
+
+          <Switch.Case match={[AsyncStatus.Error, AsyncStatus.AuthenticationError]}>
+            <Text>Could not load platform configs.</Text>
+          </Switch.Case>
+
+          <Switch.Case match={['Empty']}>
+            <Text>No platform configs yet. Create one to mirror a deployment-tools platform-config.json.</Text>
+          </Switch.Case>
+
+          <Switch.Case match={[AsyncStatus.Success]}>
+            <ResourceList
+              resources={platformResources.map((resource) => ({
+                ...resource,
+                name:
+                  resource?.content?.platformName ||
+                  resource?.content?.platformId ||
+                  resource?.name ||
+                  'Unnamed platform',
+                href: router.getHref({ id: '@resource', params: { resourceId: resource?.id } }),
+              }))}
+            />
+          </Switch.Case>
+        </Switch>
+      </View>
+    </View>
+  )
+}

package/src/ResourceList.jsx

@@ -0,0 +1,138 @@
+'use client'
+import React from 'react'
+import { useWorkspace } from '@ossy/sdk-react'
+import {
+  Dropdown,
+  DropZone,
+  Icon2,
+  Image,
+  View,
+  Text,
+  Button,
+  ContextMenu,
+} from '@ossy/design-system'
+import { formatBytes } from './utils/format-bytes.js'
+
+export const ResourceList = ({
+  resources = [],
+  onClick = () => {},
+}) => {
+  return resources
+    .map((resource) => (
+      <ResourceListItem
+        {...resource}
+        key={resource.id}
+        onClick={() => {
+          onClick(resource)
+          resource?.onClick?.(resource)
+        }}
+      />
+    ))
+}
+
+function ResourceListItem ({
+  onClick,
+  href,
+  onDrop,
+  dragData,
+  ...resource
+}) {
+  let Container = ({ children }) => <>{children}</>
+
+  if (onDrop) {
+    Container = DropZone
+  } else if (dragData) {
+    Container = DropZone.Dragable
+  }
+
+  return (
+    <Container onDrop={onDrop} dragData={dragData}>
+      <View
+        layout="row"
+        selectable
+        gap="m"
+        style={{
+          height: '56px',
+          flexShrink: 0,
+          borderBottom: '1px solid var(--separator-primary)',
+        }}
+      >
+        <View
+          as={href ? 'a' : undefined}
+          gap="m"
+          layout="row"
+          alignItems="center"
+          style={{ flexGrow: 1, padding: '12px 0 12px 20px' }}
+          href={href}
+          onClick={onClick}
+        >
+          <ResourceIcon {...resource} />
+          <Text>{typeof resource.name === 'string' && resource.name}</Text>
+          <View style={{ flexGrow: 1 }} />
+          <Size {...resource} />
+        </View>
+
+        <View style={{ padding: '12px 8px 12px 0' }}>
+          <RowActions {...resource} />
+        </View>
+      </View>
+    </Container>
+  )
+}
+
+function Size (resource) {
+  if (resource.content?.ContentLength) {
+    return (
+      <Text variant="small">
+        {formatBytes(resource.content.ContentLength)}
+      </Text>
+    )
+  }
+
+  return <></>
+}
+
+function ResourceIcon ({ ...resource }) {
+  const { workspace } = useWorkspace()
+
+  const resourceTemplates = (workspace.resourceTemplates || [])
+    .reduce((acc, curr) => ({ ...acc, [curr.id]: curr }), {})
+
+  if (resource?.type === 'directory') {
+    return (
+      <Icon2 size="s" name="folder" style={{ fill: 'hsl(0, 0%, 60%)' }} />
+    )
+  }
+
+  if (resource.type.startsWith('image')) {
+    return (
+      <Image
+        src={resource?.content?.sizes?.thumbnailSmall || resource?.content?.src}
+        placeholderSrc={resource?.content?.sizes?.['loader-square-blurred-after'] || resource?.content?.src}
+        style={{ width: '24px', height: '24px', borderRadius: '25%' }}
+      />
+    )
+  }
+
+  return (
+    <Icon2
+      size="s"
+      name={resourceTemplates[resource.type]?.icon || 'file'}
+      style={{ fill: 'hsl(0, 0%, 80%)' }}
+    />
+  )
+}
+
+function RowActions ({ actions }) {
+  if (!actions) return <></>
+
+  return (
+    <Dropdown trigger={<Button prefix="more-vertical-alt" variant="command" />}>
+      <View inset="xs" surface="primary" roundness="s">
+        <ContextMenu roundness="s" surface="primary">
+          {actions}
+        </ContextMenu>
+      </View>
+    </Dropdown>
+  )
+}

package/src/constants.js

@@ -0,0 +1,2 @@
+export const PLATFORM_RESOURCE_LOCATION = '/@ossy/platform/'
+export const PLATFORM_CONFIG_TEMPLATE_ID = '@ossy/platform/config'

package/src/index.js

@@ -0,0 +1,6 @@
+export { Definition } from './Definition.js'
+export { PlatformResourceTemplates } from './resourceTemplates.js'
+export { PLATFORM_RESOURCE_LOCATION, PLATFORM_CONFIG_TEMPLATE_ID } from './constants.js'
+export { platformHomeMetadata } from './platformHomeMetadata.js'
+export { PlatformHomeBody } from './PlatformHomeBody.jsx'
+export { moduleStatusTags, moduleStatuses, MODULE_STATUS } from './moduleStatus.js'

package/src/moduleStatus.js

@@ -0,0 +1,34 @@
+/**
+ * Minimal subset of website module status helpers for {@link Definition} tags.
+ */
+
+export const MODULE_STATUS = {
+  beta: 'beta',
+  comingSoon: 'coming-soon',
+  stable: 'stable',
+  hidden: 'hidden',
+}
+
+const STATUS_TO_TAG_LABEL = {
+  [MODULE_STATUS.beta]: 'Beta',
+  [MODULE_STATUS.comingSoon]: 'Coming Soon',
+  [MODULE_STATUS.stable]: null,
+  [MODULE_STATUS.hidden]: null,
+}
+
+export function moduleStatuses (definition) {
+  const fromArray = Array.isArray(definition?.statuses) ? definition.statuses : []
+  const fromLegacy = definition?.status && typeof definition.status === 'string' ? [definition.status] : []
+  if (fromArray.length) return [...new Set(fromArray)]
+  if (fromLegacy.length) return [...new Set(fromLegacy)]
+  return []
+}
+
+export function moduleStatusTags (definition) {
+  const labels = []
+  for (const s of moduleStatuses(definition)) {
+    const label = STATUS_TO_TAG_LABEL[s]
+    if (label) labels.push(label)
+  }
+  return [...new Set(labels)]
+}

package/src/platformHomeMetadata.js

@@ -0,0 +1,11 @@
+import { Definition } from './Definition.js'
+
+export const platformHomeMetadata = {
+  id: 'platform/home',
+  title: Definition.title,
+  description: Definition.description,
+  path: {
+    sv: '/plattform',
+    en: '/platform',
+  },
+}

package/src/resourceTemplates.js

@@ -0,0 +1,84 @@
+/**
+ * Matches the shape written to S3 as `platform-config.json` by deployment-tools
+ * (`BucketDeployment` → `Source.jsonData('platform-config.json', { ...config, awsRoleToAssume: undefined })`).
+ *
+ * @see ossy/packages/deployment-tools/src/config/platform-config.js (PlatformConfig typedef)
+ * @see ossy/packages/deployment-tools/src/infrastructure/container-deployment-target/container-deployment-target.js
+ *
+ * Note: `awsRoleToAssume` is intentionally omitted from the uploaded file (secret); do not store it here.
+ * Optional `sesDomains` / `dnsRecords` are JSON text fields for arrays/objects.
+ */
+export const PlatformResourceTemplates = [
+  {
+    name: 'Platform config',
+    id: '@ossy/platform/config',
+    icon: 'controller',
+    fields: [
+      {
+        name: 'platformId',
+        label: 'Platform ID (Ossy reference)',
+        type: 'text',
+      },
+      {
+        name: 'platformName',
+        label: 'platformName',
+        type: 'text',
+      },
+      {
+        name: 'awsAccountId',
+        label: 'awsAccountId',
+        type: 'text',
+      },
+      {
+        name: 'awsRegion',
+        label: 'awsRegion',
+        type: 'text',
+      },
+      {
+        name: 'awsKeyPairName',
+        label: 'awsKeyPairName',
+        type: 'text',
+      },
+      {
+        name: 'awsStaticBucketName',
+        label: 'awsStaticBucketName',
+        type: 'text',
+      },
+      {
+        name: 'awsDeploymentSqsName',
+        label: 'awsDeploymentSqsName',
+        type: 'text',
+      },
+      {
+        name: 'awsDeploymentSqsArn',
+        label: 'awsDeploymentSqsArn',
+        type: 'text',
+      },
+      {
+        name: 'ciGithubActionsRepo',
+        label: 'ciGithubActionsRepo (org/repo)',
+        type: 'text',
+      },
+      {
+        name: 'ciDockerNetworkName',
+        label: 'ciDockerNetworkName',
+        type: 'text',
+      },
+      {
+        name: 'sesDomains',
+        label: 'sesDomains (JSON array of strings, optional)',
+        type: 'textarea',
+      },
+      {
+        name: 'dnsRecords',
+        label: 'dnsRecords (JSON object, optional)',
+        type: 'textarea',
+      },
+      {
+        name: 'Notes',
+        label: 'Notes',
+        type: 'textarea',
+      },
+    ],
+  },
+]

package/src/utils/format-bytes.js

@@ -0,0 +1,14 @@
+/**
+ * Converts bytes to a human-readable format.
+ * @param {number} bytes - The number of bytes.
+ * @param {number} decimals - The number of decimal places to include (default is 2).
+ * @returns {string} - The human-readable format.
+ */
+export function formatBytes (bytes, decimals = 2) {
+  if (!bytes) return
+  const k = 1024
+  const dm = decimals < 0 ? 0 : decimals
+  const sizes = ['Bytes', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB']
+  const i = Math.floor(Math.log(bytes) / Math.log(k))
+  return `${parseFloat((bytes / k ** i).toFixed(dm))} ${sizes[i]}`
+}