@ossy/cli 0.9.0 → 0.10.0

package/README.md

@@ -1,45 +1,87 @@
 # @ossy/cli
 
-Command line tool that makes it easier to interact with our APIs
+Unified CLI for the Ossy platform: app dev/build and CMS workflows.
 
-## Cms
+## Commands
 
-### import-resource-templates
-Imports resource templates to your workspace so that they can be used in the UI.
+| Command | Description |
+|---------|-------------|
+| `init [dir]` | Scaffold a new Ossy app (default: current directory) |
+| `dev` | Start dev server with watch (uses `src/*.page.jsx` or `src/pages.jsx`, `src/config.js`) |
+| `build` | Production build |
+| `cms upload` | Upload resource templates to your workspace |
+| `cms validate` | Validate ossy config and resource templates |
+
+## App: dev & build
 
 ```bash
-npx @ossy/cli cms import-resource-templates --authentication <cms-api-token> --ossy-file ossy.json
+npx @ossy/cli dev
+npx @ossy/cli build
 ```
 
-#### Workflow example
+Options: `--pages`, `--config`, `--destination`. See `@ossy/app` for details.
+
+## CMS: upload
+
+Upload resource templates to your workspace so they can be used in the UI.
 
 ```bash
+npx @ossy/cli cms upload --authentication <cms-api-token> --ossy-file ossy.json
+```
+
+### Config consistency
+
+- **App** (`dev`, `build`): `--config` → app config (`src/config.js` by default)
+- **CMS** (`cms upload`): `--ossy-file` → workspace config with `workspaceId` and `resourceTemplates`
+
+### Workflow example
+
+```yaml
 name: "[CMS] Upload resource templates"
 
 on:
   workflow_dispatch:
 
 jobs:
-
   upload-resource-templates:
     name: Upload resource templates
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-
       - uses: actions/setup-node@v2
         with:
           node-version: "16"
-
       - name: Upload
         run: |
-          npx --yes @ossy/cli cms import-resource-templates \
+          npx --yes @ossy/cli cms upload \
             --authentication ${{ secrets.CMS_API_TOKEN }} \
-            --ossy-file ossy.json \
+            --ossy-file ossy.json
+```
+
+### cms validate
+
+Validate an ossy config file before uploading:
+
+```bash
+npx @ossy/cli cms validate --ossy-file ossy.json
 ```
 
-#### Arguments
+Defaults to `ossy.json` in the current directory when `--ossy-file` is omitted.
+
+### Arguments
+
 | Argument | Description | Required |
-|-|-|-|
-| --authentication | Your personal CMS API token | required |
-| --ossy-file | Path to the file containing the workspaceId and resource templates | required |
+|----------|-------------|----------|
+| --authentication, -a | Your CMS API token | Yes (upload only) |
+| --ossy-file | Path to file with `workspaceId` and `resourceTemplates` | Yes (upload), optional (validate) |
+
+## init
+
+Scaffold a new Ossy app:
+
+```bash
+npx @ossy/cli init
+npx @ossy/cli init my-app
+```
+
+Creates `src/pages.jsx`, `src/config.js`, and `package.json` (if missing).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ossy/cli",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ossy-se/packages.git"
@@ -10,13 +10,14 @@
   "main": "./src/index.js",
   "type": "module",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 0",
+    "test": "node --experimental-vm-modules ../node_modules/jest/bin/jest.js --verbose",
     "build": "echo \"The build step is not required when using JavaScript!\" && exit 0"
   },
   "author": "Ossy <yourfriends@ossy.se> (https://ossy.se)",
   "license": "MIT",
   "bin": "./src/index.js",
   "dependencies": {
+    "@ossy/app": "^0.10.0",
     "arg": "^5.0.2"
   },
   "publishConfig": {
@@ -27,5 +28,5 @@
     "/src",
     "README.md"
   ],
-  "gitHead": "eec27800542ed59264caf788326e525a2ee77d63"
+  "gitHead": "3019a8da590435ba6f10d7d861addeba011baf5d"
 }

package/src/cms/cli.js

@@ -0,0 +1,145 @@
+import { resolve } from 'path'
+import { readFileSync, existsSync } from 'fs'
+import arg from 'arg'
+import { logInfo, logError } from '../log.js'
+
+const Api = {
+  uploadResourceTemplates: (apiUrl, token, workspaceId, resourceTemplates) => {
+    const endpoint = `${apiUrl}/workspaces/${workspaceId}/resource-templates`
+    const fetchOptions = {
+      method: 'POST',
+      headers: { 'Authorization': token, 'Content-Type': 'application/json' },
+      body: JSON.stringify(resourceTemplates)
+    }
+    return fetch(endpoint, fetchOptions)
+  }
+}
+
+const resolveConfigImport = (filePath) =>
+  filePath.endsWith('json')
+    ? Promise.resolve(JSON.parse(readFileSync(filePath, 'utf8')))
+    : import(filePath)
+
+const upload = (options) => {
+  const parsedArgs = arg({
+    '--authentication': String,
+    '--a': '--authentication',
+    '--ossy-file': String,
+  }, { argv: options })
+
+  const token = parsedArgs['--authentication']
+  const ossyFilePath = parsedArgs['--ossy-file']
+
+  if (!token) {
+    logError({ message: '[@ossy/cli] No token provided. Use --authentication or -a' })
+    process.exit(1)
+  }
+  if (!ossyFilePath) {
+    logError({ message: '[@ossy/cli] No config file provided. Use --ossy-file' })
+    process.exit(1)
+  }
+
+  logInfo({ message: '[@ossy/cli] Reading config...' })
+  const filePath = resolve(ossyFilePath)
+
+  return resolveConfigImport(filePath)
+    .then((module) => {
+      const config = module?.default ?? module
+      const apiUrl = config?.apiUrl || 'https://api.ossy.se/api/v0'
+      const workspaceId = config?.workspaceId
+      const resourceTemplates = config?.resourceTemplates
+
+      if (!workspaceId) {
+        logError({ message: '[@ossy/cli] No workspaceId in ossy file' })
+        process.exit(1)
+      }
+      if (!resourceTemplates) {
+        logError({ message: '[@ossy/cli] No resourceTemplates in ossy file' })
+        process.exit(1)
+      }
+
+      logInfo({ message: '[@ossy/cli] Uploading resource templates...' })
+
+      return Api.uploadResourceTemplates(apiUrl, token, workspaceId, resourceTemplates)
+        .then((response) => {
+          if (!response.ok) throw new Error(`Upload failed: ${response.status}`)
+          logInfo({ message: '[@ossy/cli] Done' })
+        })
+        .catch((error) => {
+          logError({ message: '[@ossy/cli] Error', error })
+          process.exit(1)
+        })
+    })
+    .catch((error) => {
+      logError({ message: '[@ossy/cli] Error', error })
+      process.exit(1)
+    })
+}
+
+const validate = (options) => {
+  const parsedArgs = arg({
+    '--ossy-file': String,
+  }, { argv: options })
+
+  const ossyFilePath = parsedArgs['--ossy-file']
+  const filePath = ossyFilePath ? resolve(ossyFilePath) : resolve('ossy.json')
+
+  if (!existsSync(filePath)) {
+    logError({ message: `[@ossy/cli] File not found: ${filePath}. Use --ossy-file` })
+    process.exit(1)
+  }
+
+  logInfo({ message: '[@ossy/cli] Validating...' })
+
+  resolveConfigImport(filePath)
+    .then((module) => {
+      const config = module?.default ?? module
+      const workspaceId = config?.workspaceId
+      const resourceTemplates = config?.resourceTemplates
+
+      const errors = []
+      if (!workspaceId) errors.push('Missing workspaceId')
+      if (!resourceTemplates) {
+        errors.push('Missing resourceTemplates')
+      } else if (!Array.isArray(resourceTemplates)) {
+        errors.push('resourceTemplates must be an array')
+      } else {
+        resourceTemplates.forEach((t, i) => {
+          if (!t.id) errors.push(`Template ${i}: missing id`)
+          if (!t.name) errors.push(`Template ${i}: missing name`)
+          if (!t.fields || !Array.isArray(t.fields)) {
+            errors.push(`Template ${i}: fields must be an array`)
+          }
+        })
+      }
+
+      if (errors.length > 0) {
+        console.error('[@ossy/cli] Validation failed:')
+        errors.forEach((e) => console.error('  -', e))
+        process.exit(1)
+      }
+      logInfo({ message: '[@ossy/cli] Valid' })
+    })
+    .catch((error) => {
+      logError({ message: '[@ossy/cli] Error', error })
+      process.exit(1)
+    })
+}
+
+const subcommands = {
+  upload,
+  validate,
+}
+
+export const handler = ([subcommand, ...options]) => {
+  if (!subcommand) {
+    logError({ message: '[@ossy/cli] cms: no subcommand. Use: ossy cms upload | validate' })
+    process.exit(1)
+  }
+  const fn = subcommands[subcommand]
+  if (!fn) {
+    logError({ message: `[@ossy/cli] cms: unknown subcommand "${subcommand}". Use: ossy cms upload | validate` })
+    process.exit(1)
+  }
+  fn(options)
+}

package/src/index.js

@@ -1,11 +1,34 @@
 #!/usr/bin/env node
-/* eslint-disable global-require, no-unused-vars */
-import * as ResourceTemplates from './resource-templates/cli.js'
+import { build, dev } from '@ossy/app'
+import * as Cms from './cms/cli.js'
+import * as Init from './init/cli.js'
 
-const [_, __, handlerName, ...restArgs] = process.argv
+const [,, command, ...restArgs] = process.argv
 
-const handler = {
-  'resource-templates': () => ResourceTemplates.handler
-}[handlerName]
+if (!command) {
+  console.error('[@ossy/cli] No command provided. Usage: ossy dev | build | init | cms <subcommand>')
+  process.exit(1)
+}
 
-handler(restArgs)
+const run = async () => {
+  if (command === 'cms') {
+    Cms.handler(restArgs)
+    return
+  }
+  if (command === 'init') {
+    Init.init(restArgs)
+    return
+  }
+  if (command === 'dev') {
+    await dev(restArgs)
+    return
+  }
+  if (command === 'build') {
+    await build(restArgs)
+    return
+  }
+  console.error(`[@ossy/cli] Unknown command: ${command}`)
+  process.exit(1)
+}
+
+run()

package/src/init/cli.js

@@ -0,0 +1,73 @@
+import fs from 'fs'
+import path from 'path'
+import { logInfo, logError } from '../log.js'
+
+const TEMPLATE_HOME_PAGE = `import React from 'react'
+
+export default () => (
+  <main style={{ padding: '2rem' }}>
+    <h1>Welcome</h1>
+    <p>Add new pages by creating *.page.jsx files in src/</p>
+  </main>
+)
+`
+
+const TEMPLATE_CONFIG = `import { CloudLight } from '@ossy/themes'
+
+export default {
+  workspaceId: 'your-workspace-id',
+  theme: CloudLight,
+}
+`
+
+const TEMPLATE_PACKAGE_JSON = {
+  name: 'my-ossy-app',
+  version: '0.0.1',
+  private: true,
+  type: 'module',
+  scripts: {
+    dev: 'npx @ossy/cli dev',
+    build: 'npx @ossy/cli build',
+    start: 'node build/server.js',
+  },
+  dependencies: {
+    '@ossy/cli': '^0.9.0',
+    '@ossy/app': '^0.9.0',
+    '@ossy/connected-components': '^0.9.0',
+    '@ossy/design-system': '^0.9.0',
+    '@ossy/themes': '^0.9.0',
+    '@ossy/router-react': '^0.9.0',
+    '@ossy/sdk': '^0.9.0',
+    '@ossy/sdk-react': '^0.9.0',
+    react: '^19.0.0',
+    'react-dom': '^19.0.0',
+  },
+}
+
+export const init = (options) => {
+  const parsedArgs = options || []
+  const targetDir = parsedArgs[0] ? path.resolve(parsedArgs[0]) : process.cwd()
+
+  const srcDir = path.join(targetDir, 'src')
+  const homePagePath = path.join(srcDir, 'home.page.jsx')
+  if (fs.existsSync(homePagePath) || fs.existsSync(path.join(targetDir, 'src', 'pages.jsx'))) {
+    logError({ message: '[@ossy/cli] Project already exists (src/home.page.jsx or src/pages.jsx found)' })
+    process.exit(1)
+  }
+
+  logInfo({ message: `[@ossy/cli] Creating project in ${targetDir}` })
+
+  fs.mkdirSync(srcDir, { recursive: true })
+
+  fs.writeFileSync(homePagePath, TEMPLATE_HOME_PAGE)
+  fs.writeFileSync(path.join(srcDir, 'config.js'), TEMPLATE_CONFIG)
+
+  const pkgPath = path.join(targetDir, 'package.json')
+  if (!fs.existsSync(pkgPath)) {
+    fs.writeFileSync(pkgPath, JSON.stringify(TEMPLATE_PACKAGE_JSON, null, 2))
+  } else {
+    logInfo({ message: '[@ossy/cli] package.json exists, skipping. Add scripts manually if needed.' })
+  }
+
+  logInfo({ message: '[@ossy/cli] Done. Run: npm install && npm run dev' })
+}

package/src/resource-templates/cli.js

@@ -1,65 +0,0 @@
-import { resolve } from 'path'
-import { readFileSync } from 'fs'
-import arg from 'arg'
-import { logInfo, logError, logErrorAndReject } from '../log.js'
-
-const Api = {
-  uploadResourceTemplates: (apiUrl, token, workspaceId, resourceTemplates) => {
-    const endpoint = `${apiUrl}/workspaces/${workspaceId}/resource-templates`
-
-    const fetchOptions = {
-      method: 'POST',
-      headers: { 'Authorization': token, 'Content-Type': 'application/json' },
-      body: JSON.stringify(resourceTemplates)
-    }
-
-    return fetch(endpoint, fetchOptions)
-  }
-}
-
-const resolveConfigImport = path => path.endsWith('json')
-  ? Promise.resolve(JSON.parse(readFileSync(path), 'utf8'))
-  : import(path)
-
-const importResourceTemplates = options => {
-
-  const parsedArgs = arg({
-    '--authentication': String,
-    '--a': '--authentication',
-
-    '--config': String,
-    '-c': '--config',
-  }, { argv: options })
-
-  logInfo({ message: '[CMS] reading files' })
-  const token = parsedArgs['--authentication'];
-  const filePath = resolve(parsedArgs['--config'])
-
-  if (!token) return logErrorAndReject({ message: '[CMS] No token provided with --authentication'})
-
-  return resolveConfigImport(filePath)
-    .then(module => {
-      const config = module?.default
-      const apiUrl = config?.apiUrl || 'https://api.ossy.se/api/v0'
-      const workspaceId = config?.workspaceId
-      const resourceTemplates = config?.resourceTemplates
-
-      if (!workspaceId) return logErrorAndReject({ message: '[@ossy/cli] No workspaceId provided in config'})
-      if (!resourceTemplates) return logErrorAndReject({ message: '[@ossy/cli] No resource templates provided in config'})
-
-      logInfo({ message: '[@ossy/cli] uploading resource templates' })
-
-      Api.uploadResourceTemplates(apiUrl, token, workspaceId, resourceTemplates)
-          .then(response => {
-            logInfo({ message: '[@ossy/cli] Done' })
-          })
-          .catch(error => logError({ message: '[@ossy/cli] Error', error }))
-    })
-
-}
-
-export const handler = ([command, ...options]) => {
-  !!command
-    ? { 'upload': importResourceTemplates }[command](options)
-    : logError({ message: '[@ossy/cli] No command provided' })
-}