beta 48 and i18n

Author: MattDHill

package-lock.json

@@ -6,7 +6,7 @@
     "check": "tsc --noEmit"
   },
   "dependencies": {
-    "@start9labs/start-sdk": "^0.4.0-beta.48"
+    "@start9labs/start-sdk": "0.4.0-beta.48"
   },
   "devDependencies": {
     "@types/node": "^22.19.0",

package.json

@@ -1,4 +1,4 @@
-PACKAGE_ID := $(shell awk -F"'" '/id:/ {print $$2}' startos/manifest.ts)
+PACKAGE_ID := $(shell awk -F"'" '/id:/ {print $$2}' startos/manifest/index.ts)
 INGREDIENTS := $(shell start-cli s9pk list-ingredients 2>/dev/null)
 ALL_ARCHES ?= x86 arm riscv
 ALL_TARGETS ?= all_arches

s9pk.mk

@@ -1,36 +1,37 @@
 import { homeserverYaml } from '../fileModels/homeserver.yml'
 import { storeJson } from '../fileModels/store.json'
+import { i18n } from '../i18n'
 import { sdk } from '../sdk'
 
 const { InputSpec, Value, Variants, List } = sdk
 
 export const inputSpec = InputSpec.of({
   registration: Value.select({
-    name: 'Registration',
-    description: `Allow outsiders to create their own accounts on your homeserver. This is not recommended, as it leaves your server vulnerable to attack. It is preferable for you to create accounts on their behalf using your server's admin portal.`,
+    name: i18n('Registration'),
+    description: i18n('Allow outsiders to create their own accounts on your homeserver. This is not recommended, as it leaves your server vulnerable to attack. It is preferable for you to create accounts on their behalf using your server\'s admin portal.'),
     default: 'disabled',
     values: {
-      disabled: 'Disabled',
-      enabled: 'Enabled',
+      disabled: i18n('Disabled'),
+      enabled: i18n('Enabled'),
     },
   }),
   federation: Value.union({
-    name: 'Federation',
+    name: i18n('Federation'),
     default: 'disabled',
     description:
-      'If enabled, users on your homeserver will be able to join rooms on other homeservers and vica versa. If disabled, users on your homeserver will only be able to interact with other users and rooms on your homeserver.',
+      i18n('If enabled, users on your homeserver will be able to join rooms on other homeservers and vica versa. If disabled, users on your homeserver will only be able to interact with other users and rooms on your homeserver.'),
     variants: Variants.of({
-      disabled: { name: 'Disabled', spec: InputSpec.of({}) },
+      disabled: { name: i18n('Disabled'), spec: InputSpec.of({}) },
       enabled: {
-        name: 'Enabled',
+        name: i18n('Enabled'),
         spec: InputSpec.of({
           federation_domain_whitelist: Value.list(
             List.text(
               {
-                name: 'Domain Whitelist (optional)',
+                name: i18n('Domain Whitelist (optional)'),
                 default: [],
                 description:
-                  'If you only want your server to federate with specific homeservers and reject all others, enter the server addresses/domains here. If no domains are provided, your server will be capable of federating with all public Matrix servers',
+                  i18n('If you only want your server to federate with specific homeservers and reject all others, enter the server addresses/domains here. If no domains are provided, your server will be capable of federating with all public Matrix servers'),
               },
               {
                 placeholder: 'matrix.start9labs.com',
@@ -42,12 +43,12 @@ export const inputSpec = InputSpec.of({
     }),
   }),
   max_upload_size: Value.number({
-    name: 'Max Upload Size',
+    name: i18n('Max Upload Size'),
     description:
-      'The maximum file size that is permitted to be uploaded by users to your homeserver.',
+      i18n('The maximum file size that is permitted to be uploaded by users to your homeserver.'),
     required: true,
     default: 50,
-    units: 'MB',
+    units: i18n('MB'),
     integer: true,
     min: 1,
     max: 2000,
@@ -61,8 +62,8 @@ export const config = sdk.Action.withInput(
 
   // metadata
   async ({ effects }) => ({
-    name: 'Config',
-    description: 'Configure your Synapse homeserver.',
+    name: i18n('Config'),
+    description: i18n('Configure your Synapse homeserver.'),
     warning: null,
     allowedStatuses: 'any',
     group: null,

startos/actions/config.ts

@@ -1,36 +1,37 @@
+import { i18n } from '../i18n'
 import { sdk } from '../sdk'
 import { mount } from '../utils'
 
 const { InputSpec, Value } = sdk
 
 export const inputSpec = InputSpec.of({
   username: Value.dynamicText(async () => ({
-    name: 'Username',
+    name: i18n('Username'),
     description:
-      'The localpart for the bot user (e.g. "mybot" creates @mybot:your.domain)',
+      i18n('The localpart for the bot user (e.g. "mybot" creates @mybot:your.domain)'),
     required: true as const,
     default: null,
     placeholder: 'mybot',
     masked: false,
-    disabled: 'Provided by the bridge service',
+    disabled: i18n('Provided by the bridge service'),
   })),
   password: Value.dynamicText(async () => ({
-    name: 'Password',
-    description: 'The password for the bot user',
+    name: i18n('Password'),
+    description: i18n('The password for the bot user'),
     required: true as const,
     default: null,
     placeholder: null,
     masked: true,
-    disabled: 'Provided by the bot service',
+    disabled: i18n('Provided by the bot service'),
   })),
 })
 
 export const createBotUser = sdk.Action.withInput(
   'create-bot-user',
 
   async ({ effects }) => ({
-    name: 'Create Bot User',
-    description: 'Create a new bot (non-admin) user account on the homeserver.',
+    name: i18n('Create Bot User'),
+    description: i18n('Create a new bot (non-admin) user account on the homeserver.'),
     warning: null,
     allowedStatuses: 'only-running',
     group: null,

startos/actions/createBotUser.ts

@@ -1,5 +1,6 @@
 import { unlink } from 'node:fs/promises'
 import { homeserverYaml } from '../fileModels/homeserver.yml'
+import { i18n } from '../i18n'
 import { sdk } from '../sdk'
 import { mountpoint } from '../utils'
 
@@ -22,8 +23,8 @@ export const inputSpec = InputSpec.of({
     const keys = Object.keys(values)
 
     return {
-      name: 'Appservice',
-      description: 'Select the appservice to remove',
+      name: i18n('Appservice'),
+      description: i18n('Select the appservice to remove'),
       values,
       default: keys[0] || '',
     }
@@ -34,10 +35,10 @@ export const deleteAppservice = sdk.Action.withInput(
   'delete-appservice',
 
   async ({ effects }) => ({
-    name: 'Delete Appservice',
-    description: 'Remove a registered appservice (bridge) from the homeserver.',
+    name: i18n('Delete Appservice'),
+    description: i18n('Remove a registered appservice (bridge) from the homeserver.'),
     warning:
-      'This will remove the appservice registration. The bridge service will no longer be able to communicate with Synapse until re-registered.',
+      i18n('This will remove the appservice registration. The bridge service will no longer be able to communicate with Synapse until re-registered.'),
     allowedStatuses: 'any',
     group: null,
     visibility: 'enabled',

startos/actions/deleteAppservice.ts

@@ -1,5 +1,6 @@
 import { YAML } from '@start9labs/start-sdk'
 import { homeserverYaml } from '../fileModels/homeserver.yml'
+import { i18n } from '../i18n'
 import { sdk } from '../sdk'
 import { mountpoint } from '../utils'
 
@@ -24,9 +25,9 @@ export const listAppservices = sdk.Action.withoutInput(
   'list-appservices',
 
   async ({ effects }) => ({
-    name: 'List Appservices',
+    name: i18n('List Appservices'),
     description:
-      'View all registered Matrix appservices (bridges) on this homeserver.',
+      i18n('View all registered Matrix appservices (bridges) on this homeserver.'),
     warning: null,
     allowedStatuses: 'any',
     group: null,
@@ -41,8 +42,8 @@ export const listAppservices = sdk.Action.withoutInput(
     if (files.length === 0) {
       return {
         version: '1' as const,
-        title: 'Registered Appservices',
-        message: 'No appservices are currently registered.',
+        title: i18n('Registered Appservices'),
+        message: i18n('No appservices are currently registered.'),
         result: null,
       }
     }
@@ -58,7 +59,7 @@ export const listAppservices = sdk.Action.withoutInput(
         const fields: ResultEntry[] = [
           {
             type: 'single',
-            name: 'ID',
+            name: i18n('ID'),
             description: null,
             value: parsed.id || 'unknown',
             masked: false,
@@ -67,7 +68,7 @@ export const listAppservices = sdk.Action.withoutInput(
           },
           {
             type: 'single',
-            name: 'URL',
+            name: i18n('URL'),
             description: null,
             value: parsed.url || 'not configured',
             masked: false,
@@ -76,7 +77,7 @@ export const listAppservices = sdk.Action.withoutInput(
           },
           {
             type: 'single',
-            name: 'Sender Localpart',
+            name: i18n('Sender Localpart'),
             description: null,
             value: parsed.sender_localpart || 'unknown',
             masked: false,
@@ -85,7 +86,7 @@ export const listAppservices = sdk.Action.withoutInput(
           },
           {
             type: 'single',
-            name: 'AS Token',
+            name: i18n('AS Token'),
             description: null,
             value: parsed.as_token || 'unknown',
             masked: true,
@@ -94,7 +95,7 @@ export const listAppservices = sdk.Action.withoutInput(
           },
           {
             type: 'single',
-            name: 'HS Token',
+            name: i18n('HS Token'),
             description: null,
             value: parsed.hs_token || 'unknown',
             masked: true,
@@ -103,7 +104,7 @@ export const listAppservices = sdk.Action.withoutInput(
           },
           {
             type: 'single',
-            name: 'Rate Limited',
+            name: i18n('Rate Limited'),
             description: null,
             value: String(parsed.rate_limited ?? 'unknown'),
             masked: false,
@@ -115,7 +116,7 @@ export const listAppservices = sdk.Action.withoutInput(
         if (parsed.namespaces?.users?.[0]?.regex) {
           fields.push({
             type: 'single',
-            name: 'User Namespace',
+            name: i18n('User Namespace'),
             description: null,
             value: parsed.namespaces.users[0].regex,
             masked: false,
@@ -135,7 +136,7 @@ export const listAppservices = sdk.Action.withoutInput(
           type: 'single',
           name: subpath,
           description: null,
-          value: 'Error reading registration file',
+          value: i18n('Error reading registration file'),
           masked: false,
           copyable: false,
           qr: false,
@@ -145,7 +146,7 @@ export const listAppservices = sdk.Action.withoutInput(
 
     return {
       version: '1' as const,
-      title: 'Registered Appservices',
+      title: i18n('Registered Appservices'),
       message: null,
       result: {
         type: 'group' as const,

startos/actions/listAppservices.ts

@@ -1,4 +1,5 @@
 import { homeserverYaml } from '../fileModels/homeserver.yml'
+import { i18n } from '../i18n'
 import { sdk } from '../sdk'
 import { mountpoint } from '../utils'
 
@@ -8,58 +9,58 @@ const appservicesSubpath = 'appservices'
 
 export const inputSpec = InputSpec.of({
   id: Value.text({
-    name: 'Appservice ID',
-    description: 'Unique identifier for this appservice (e.g. "signal")',
+    name: i18n('Appservice ID'),
+    description: i18n('Unique identifier for this appservice (e.g. "signal")'),
     required: true,
     default: null,
     placeholder: 'signal',
     masked: false,
   }),
   asToken: Value.text({
-    name: 'AS Token',
+    name: i18n('AS Token'),
     description:
-      'Appservice token used by the bridge to authenticate with the homeserver',
+      i18n('Appservice token used by the bridge to authenticate with the homeserver'),
     required: true,
     default: null,
     placeholder: null,
     masked: true,
   }),
   hsToken: Value.text({
-    name: 'HS Token',
+    name: i18n('HS Token'),
     description:
-      'Homeserver token used by the homeserver to authenticate with the bridge',
+      i18n('Homeserver token used by the homeserver to authenticate with the bridge'),
     required: true,
     default: null,
     placeholder: null,
     masked: true,
   }),
   senderLocalpart: Value.text({
-    name: 'Sender Localpart',
-    description: 'The localpart of the bot user (e.g. "signalbot")',
+    name: i18n('Sender Localpart'),
+    description: i18n('The localpart of the bot user (e.g. "signalbot")'),
     required: true,
     default: null,
     placeholder: 'signalbot',
     masked: false,
   }),
   url: Value.text({
-    name: 'Bridge URL',
+    name: i18n('Bridge URL'),
     description:
-      'The URL where the homeserver can reach the bridge appservice',
+      i18n('The URL where the homeserver can reach the bridge appservice'),
     required: true,
     default: null,
     placeholder: 'http://mautrix-signal.startos:29328',
     masked: false,
   }),
   rateLimited: Value.toggle({
-    name: 'Rate Limited',
+    name: i18n('Rate Limited'),
     description:
-      'Whether requests from this appservice should be rate limited',
+      i18n('Whether requests from this appservice should be rate limited'),
     default: false,
   }),
   userNamespaceRegex: Value.text({
-    name: 'User Namespace Regex',
+    name: i18n('User Namespace Regex'),
     description:
-      'Regex pattern for user IDs managed by this appservice (e.g. "@signal_.*:.*")',
+      i18n('Regex pattern for user IDs managed by this appservice (e.g. "@signal_.*:.*")'),
     required: true,
     default: null,
     placeholder: '@signal_.*:.*',
@@ -71,9 +72,9 @@ export const registerAppservice = sdk.Action.withInput(
   'register-appservice',
 
   async ({ effects }) => ({
-    name: 'Register Appservice',
+    name: i18n('Register Appservice'),
     description:
-      'Register a Matrix appservice (bridge) with the homeserver. This is typically triggered automatically by bridge services.',
+      i18n('Register a Matrix appservice (bridge) with the homeserver. This is typically triggered automatically by bridge services.'),
     warning: null,
     allowedStatuses: 'any',
     group: null,