@jskit-ai/workspaces-core 0.1.224 → 0.1.225

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jskit-ai/workspaces-core",
-  "version": "0.1.224",
+  "version": "0.1.225",
   "type": "module",
   "scripts": {
     "test": "node --test --test-concurrency=1"
@@ -18,11 +18,11 @@
     "./shared/resources/workspaceSettingsResource": "./src/shared/resources/workspaceSettingsResource.js"
   },
   "dependencies": {
-    "@jskit-ai/database-runtime": "0.1.246",
-    "@jskit-ai/json-rest-api-core": "0.1.190",
-    "@jskit-ai/resource-core": "0.1.188",
-    "@jskit-ai/resource-crud-core": "0.1.188",
-    "@jskit-ai/users-core": "0.1.259",
+    "@jskit-ai/database-runtime": "0.1.247",
+    "@jskit-ai/json-rest-api-core": "0.1.191",
+    "@jskit-ai/resource-core": "0.1.189",
+    "@jskit-ai/resource-crud-core": "0.1.189",
+    "@jskit-ai/users-core": "0.1.260",
     "json-rest-schema": "^1.0.17"
   },
   "description": "Workspace tenancy runtime plus HTTP routes, role catalog, and workspace config scaffolding.",
@@ -169,8 +169,8 @@
     }
   },
   "peerDependencies": {
-    "@jskit-ai/auth-core": "0.1.244",
-    "@jskit-ai/http-runtime": "0.1.244",
-    "@jskit-ai/kernel": "0.1.246"
+    "@jskit-ai/auth-core": "0.1.245",
+    "@jskit-ai/http-runtime": "0.1.245",
+    "@jskit-ai/kernel": "0.1.247"
   }
 }

package/patterns/workspace-server/PATTERN.md

@@ -23,6 +23,12 @@ substitute for a simpler domain ownership column.
 Choose workspace creation policy, roles, invitation policy, expiry, email copy,
 member permissions, personal-workspace behavior, and surface access rules.
 
+In `workspaces` mode, `tenancyPolicy.workspace.autoProvision: true` gives every
+user a personal workspace in addition to shared ones; the server config function
+`personalWorkspaceName(user)` names it. `workspaceSettings.defaults` sets
+`invitesEnabled` and the colours (`lightPrimaryColor`, `darkPrimaryColor` and
+the other palette fields) that new workspaces start with.
+
 ## Framework APIs
 
 Use workspace routes, resources, scope helpers, tenancy profiles, and settings

package/src/server/WorkspacesFeature.js

@@ -9,6 +9,7 @@ import { workspaceMembershipsResource } from "../shared/resources/workspaceMembe
 import { workspaceResource } from "../shared/resources/workspaceResource.js";
 import { workspaceSettingsResource } from "../shared/resources/workspaceSettingsResource.js";
 import { createWorkspaceRoleCatalog } from "../shared/roles.js";
+import { WORKSPACE_SETTINGS_COLOR_FIELDS, normalizeWorkspaceHexColor } from "../shared/settings.js";
 import { resolveTenancyProfile } from "../shared/tenancyProfile.js";
 import { createRepository as createWorkspaceInvitesRepository } from "./common/repositories/workspaceInvitesRepository.js";
 import { createRepository as createWorkspaceMembershipsRepository } from "./common/repositories/workspaceMembershipsRepository.js";
@@ -49,6 +50,21 @@ function requireBoolean(value, label) {
   return value;
 }
 
+function requireWorkspaceColorDefaults(defaults) {
+  const colors = {};
+  for (const fieldName of WORKSPACE_SETTINGS_COLOR_FIELDS) {
+    if (defaults?.[fieldName] === undefined) {
+      continue;
+    }
+    const color = normalizeWorkspaceHexColor(defaults[fieldName]);
+    if (!color) {
+      throw new TypeError(`runtime.config.workspaceSettings.defaults.${fieldName} must be a hex color like #1867C0.`);
+    }
+    colors[fieldName] = color;
+  }
+  return colors;
+}
+
 function resolveInviteEmailTemplate(config) {
   const template =
     config.workspaceInviteEmailTemplate ||
@@ -92,7 +108,8 @@ function createWorkspacesRuntime({ config, env, jsonRestApi } = {}) {
     defaultInvitesEnabled: requireBoolean(
       config?.workspaceSettings?.defaults?.invitesEnabled,
       "runtime.config.workspaceSettings.defaults.invitesEnabled"
-    )
+    ),
+    defaultColorSettings: requireWorkspaceColorDefaults(config?.workspaceSettings?.defaults)
   });
   const workspacesRepository = createWorkspacesRepository({ api: jsonRestApi });
   const workspaceMembershipsRepository = createWorkspaceMembershipsRepository({ api: jsonRestApi });

package/src/server/common/services/workspaceContextService.js

@@ -84,6 +84,8 @@ function createService({
   const resolvedTenancyProfile = resolveTenancyProfile(appConfig);
   const resolvedTenancyMode = resolvedTenancyProfile.mode;
   const workspacePolicy = resolvedTenancyProfile.workspace;
+  const personalWorkspaceName =
+    typeof appConfig.personalWorkspaceName === "function" ? appConfig.personalWorkspaceName : null;
   async function ensureUniqueWorkspaceSlug(baseSlug, options = {}) {
     let suffix = 0;
     while (suffix < 1000) {
@@ -121,7 +123,7 @@ function createService({
     const inserted = await workspacesRepository.insert(
       {
         slug,
-        name: buildWorkspaceName(user),
+        name: normalizeText(personalWorkspaceName?.(user)) || buildWorkspaceName(user),
         ownerUserId: normalizedUserId,
         isPersonal: true,
         avatarUrl: ""

package/src/server/workspaceSettings/workspaceSettingsRepository.js

@@ -6,34 +6,12 @@ import {
   createJsonRestContext,
   extractJsonRestCollectionRows
 } from "@jskit-ai/json-rest-api-core/server/jsonRestApiHost";
+import { pickOwnProperties } from "@jskit-ai/kernel/shared/support";
+import { WORKSPACE_SETTINGS_FIELD_KEYS } from "../../shared/resources/workspaceSettingsResource.js";
 import { resolveWorkspaceThemePalettes } from "../../shared/settings.js";
 
-const WORKSPACE_SETTINGS_PATCH_FIELDS = Object.freeze([
-  "lightPrimaryColor",
-  "lightSecondaryColor",
-  "lightSurfaceColor",
-  "lightSurfaceVariantColor",
-  "darkPrimaryColor",
-  "darkSecondaryColor",
-  "darkSurfaceColor",
-  "darkSurfaceVariantColor",
-  "invitesEnabled"
-]);
-
-function pickPatchFields(source = {}) {
-  const patch = {};
-
-  for (const fieldName of WORKSPACE_SETTINGS_PATCH_FIELDS) {
-    if (Object.hasOwn(source, fieldName)) {
-      patch[fieldName] = source[fieldName];
-    }
-  }
-
-  return patch;
-}
-
-function createDefaultWorkspaceSettingsCreatePayload(workspaceId, defaultInvitesEnabled) {
-  const palettes = resolveWorkspaceThemePalettes({});
+function createDefaultWorkspaceSettingsCreatePayload(workspaceId, defaultInvitesEnabled, defaultColorSettings = {}) {
+  const palettes = resolveWorkspaceThemePalettes(defaultColorSettings);
 
   return {
     id: workspaceId,
@@ -49,7 +27,7 @@ function createDefaultWorkspaceSettingsCreatePayload(workspaceId, defaultInvites
   };
 }
 
-function createRepository({ api, defaultInvitesEnabled = true } = {}) {
+function createRepository({ api, defaultInvitesEnabled = true, defaultColorSettings = {} } = {}) {
   if (!api?.resources?.workspaceSettings) {
     throw new TypeError("workspaceSettingsRepository requires json-rest-api workspaceSettings resource.");
   }
@@ -95,7 +73,11 @@ function createRepository({ api, defaultInvitesEnabled = true } = {}) {
     try {
       await api.resources.workspaceSettings.post(
         {
-          data: createDefaultWorkspaceSettingsCreatePayload(normalizedWorkspaceId, defaultInvitesEnabled === true),
+          data: createDefaultWorkspaceSettingsCreatePayload(
+            normalizedWorkspaceId,
+            defaultInvitesEnabled === true,
+            defaultColorSettings
+          ),
           format: "plain",
           returning: "full",
           transaction: options?.trx || null
@@ -119,7 +101,7 @@ function createRepository({ api, defaultInvitesEnabled = true } = {}) {
 
     await ensureForWorkspaceId(normalizedWorkspaceId, options);
     const source = patch && typeof patch === "object" && !Array.isArray(patch) ? patch : {};
-    const updatePayload = pickPatchFields(source);
+    const updatePayload = pickOwnProperties(source, WORKSPACE_SETTINGS_FIELD_KEYS);
 
     if (Object.keys(updatePayload).length < 1) {
       return findByWorkspaceId(normalizedWorkspaceId, options);

package/src/shared/resources/workspaceSettingsResource.js

@@ -3,19 +3,14 @@ import { deepFreeze } from "@jskit-ai/kernel/shared/support/deepFreeze";
 import { RECORD_ID_PATTERN } from "@jskit-ai/kernel/shared/validators";
 import { defineCrudResource } from "@jskit-ai/resource-crud-core/shared/crudResource";
 import { workspaceRoleCatalogSchema } from "./workspaceRoleCatalogSchema.js";
-import { normalizeWorkspaceHexColor, DEFAULT_WORKSPACE_DARK_PALETTE, DEFAULT_WORKSPACE_LIGHT_PALETTE } from "../settings.js";
+import {
+  normalizeWorkspaceHexColor,
+  DEFAULT_WORKSPACE_DARK_PALETTE,
+  DEFAULT_WORKSPACE_LIGHT_PALETTE,
+  WORKSPACE_SETTINGS_COLOR_FIELDS
+} from "../settings.js";
 
-const WORKSPACE_SETTINGS_FIELD_KEYS = deepFreeze([
-  "lightPrimaryColor",
-  "lightSecondaryColor",
-  "lightSurfaceColor",
-  "lightSurfaceVariantColor",
-  "darkPrimaryColor",
-  "darkSecondaryColor",
-  "darkSurfaceColor",
-  "darkSurfaceVariantColor",
-  "invitesEnabled"
-]);
+const WORKSPACE_SETTINGS_FIELD_KEYS = deepFreeze([...WORKSPACE_SETTINGS_COLOR_FIELDS, "invitesEnabled"]);
 
 const workspaceSettingsBodySchema = createSchema({
   lightPrimaryColor: {

package/src/shared/settings.js

@@ -18,6 +18,17 @@ const DEFAULT_WORKSPACE_DARK_PALETTE = Object.freeze({
 
 const DEFAULT_WORKSPACE_COLOR = DEFAULT_WORKSPACE_LIGHT_PALETTE.color;
 
+const WORKSPACE_SETTINGS_COLOR_FIELDS = Object.freeze([
+  "lightPrimaryColor",
+  "lightSecondaryColor",
+  "lightSurfaceColor",
+  "lightSurfaceVariantColor",
+  "darkPrimaryColor",
+  "darkSecondaryColor",
+  "darkSurfaceColor",
+  "darkSurfaceVariantColor"
+]);
+
 function normalizeWorkspaceHexColor(value) {
   const normalized = String(value || "").trim();
   if (!HEX_COLOR_PATTERN.test(normalized)) {
@@ -113,6 +124,7 @@ export {
   normalizeWorkspaceThemeMode,
   resolveWorkspaceThemeDefaultPalette,
   resolveWorkspaceThemePalettes,
+  WORKSPACE_SETTINGS_COLOR_FIELDS,
   WORKSPACE_THEME_MODE_DARK,
   WORKSPACE_THEME_MODE_LIGHT,
   resolveWorkspaceThemePalette

package/src/shared/tenancyProfile.js

@@ -15,7 +15,8 @@ function resolveWorkspacePolicyOverrides(appConfig = {}) {
   const workspacePolicy = isRecord(tenancyPolicy.workspace) ? tenancyPolicy.workspace : {};
 
   return Object.freeze({
-    allowSelfCreate: typeof workspacePolicy.allowSelfCreate === "boolean" ? workspacePolicy.allowSelfCreate : null
+    allowSelfCreate: typeof workspacePolicy.allowSelfCreate === "boolean" ? workspacePolicy.allowSelfCreate : null,
+    autoProvision: typeof workspacePolicy.autoProvision === "boolean" ? workspacePolicy.autoProvision : null
   });
 }
 
@@ -40,7 +41,7 @@ function resolveWorkspacePolicy(mode, overrides = {}) {
 
   return Object.freeze({
     enabled: true,
-    autoProvision: false,
+    autoProvision: overrides.autoProvision === true,
     allowSelfCreate: overrides.allowSelfCreate === true,
     slugPolicy: WORKSPACE_SLUG_POLICY_USER_SELECTED
   });

package/test/featureRuntime.test.js

@@ -5,7 +5,7 @@ import { createActionProvider } from "@jskit-ai/kernel/server/actions";
 import { createCapabilityRuntime, defineProvider } from "@jskit-ai/kernel/shared/capabilities";
 import { createBootstrapRuntime } from "@jskit-ai/kernel/server/runtime";
 import { createUsersExtensions } from "@jskit-ai/users-core/server/usersExtensions";
-import { WorkspacesFeature } from "../src/server/WorkspacesFeature.js";
+import { WorkspacesFeature, createWorkspacesRuntime } from "../src/server/WorkspacesFeature.js";
 import { WorkspacesIntegrationsProvider } from "../src/server/WorkspacesIntegrationsProvider.js";
 
 function createJsonRestApiFixture() {
@@ -157,3 +157,15 @@ test("workspace realtime audiences are the actor's active memberships", async ()
     { kind: "workspace_user", workspaceId: "12", userId: "9" }
   ]);
 });
+
+test("workspace settings color defaults must be hex colors", () => {
+  const config = runtimeConfig();
+  config.workspaceSettings.defaults.lightPrimaryColor = "charcoal";
+  const jsonRestApi = createJsonRestApiFixture();
+  jsonRestApi.resources.workspaceSettings = {};
+
+  assert.throws(
+    () => createWorkspacesRuntime({ config, env: {}, jsonRestApi }),
+    /runtime\.config\.workspaceSettings\.defaults\.lightPrimaryColor must be a hex color/
+  );
+});

package/test/tenancyProfile.test.js

@@ -65,3 +65,19 @@ test("resolveTenancyProfile allows explicit workspace self-create policy overrid
   assert.equal(workspaceProfile.mode, TENANCY_MODE_WORKSPACES);
   assert.equal(workspaceProfile.workspace.allowSelfCreate, true);
 });
+
+test("resolveTenancyProfile lets workspace mode opt into a personal workspace for every user", () => {
+  const tenancyPolicy = { workspace: { autoProvision: true } };
+  assert.equal(
+    resolveTenancyProfile({ tenancyMode: TENANCY_MODE_WORKSPACES, tenancyPolicy }).workspace.autoProvision,
+    true
+  );
+  assert.equal(resolveTenancyProfile({ tenancyMode: TENANCY_MODE_NONE, tenancyPolicy }).workspace.autoProvision, false);
+  assert.equal(
+    resolveTenancyProfile({
+      tenancyMode: TENANCY_MODE_PERSONAL,
+      tenancyPolicy: { workspace: { autoProvision: false } }
+    }).workspace.autoProvision,
+    true
+  );
+});

package/test/workspaceService.test.js

@@ -27,6 +27,7 @@ function createWorkspaceServiceFixture({
   additionalWorkspaces = [],
   userWorkspaceRows = null,
   membershipResolver = null,
+  personalWorkspaceName = undefined,
   personalWorkspace = {
     id: "1",
     slug: "tonymobily3",
@@ -72,6 +73,7 @@ function createWorkspaceServiceFixture({
     appConfig: {
       tenancyMode,
       tenancyPolicy,
+      personalWorkspaceName,
       roleCatalog: roleCatalog && typeof roleCatalog === "object" ? { ...roleCatalog } : roleCatalog
     },
     workspacesRepository: {
@@ -278,6 +280,32 @@ test("workspaceService.ensureProvisionedWorkspaceForAuthenticatedUser provisions
   assert.equal(calls.ensureOwnerMembership, 1);
   assert.equal(calls.ensureWorkspaceSettings, 1);
   assert.equal(insertedPayloads[0].isPersonal, true);
+  assert.equal(insertedPayloads[0].name, "Chiara's Workspace");
+});
+
+test("workspaceService.ensureProvisionedWorkspaceForAuthenticatedUser provisions a named personal workspace when workspace tenancy opts in", async () => {
+  const { service, calls, insertedPayloads } = createWorkspaceServiceFixture({
+    tenancyMode: "workspaces",
+    tenancyPolicy: {
+      workspace: {
+        autoProvision: true
+      }
+    },
+    personalWorkspaceName: (user) => `${user.displayName}'s home`,
+    personalWorkspace: null
+  });
+
+  const workspace = await service.ensureProvisionedWorkspaceForAuthenticatedUser({
+    id: "7",
+    email: "chiaramobily@gmail.com",
+    displayName: "Chiara"
+  });
+
+  assert.equal(Number(workspace.ownerUserId), 7);
+  assert.equal(calls.insert, 1);
+  assert.equal(calls.ensureOwnerMembership, 1);
+  assert.equal(insertedPayloads[0].isPersonal, true);
+  assert.equal(insertedPayloads[0].name, "Chiara's home");
 });
 
 test("workspaceService.ensureProvisionedWorkspaceForAuthenticatedUser reuses the existing personal workspace in personal tenancy", async () => {

package/test/workspaceSettingsRepository.test.js

@@ -181,6 +181,25 @@ test("workspaceSettingsRepository.ensureForWorkspaceId delegates defaults to the
   assert.equal(record.id, "5");
 });
 
+test("workspaceSettingsRepository.ensureForWorkspaceId starts new workspaces from the app's default colors", async () => {
+  const { api, state, DEFAULT_WORKSPACE_THEME } = createWorkspaceSettingsApiStub();
+  state.row = null;
+  const repository = createRepository({
+    api,
+    defaultColorSettings: {
+      lightPrimaryColor: "#1C1C1C",
+      darkPrimaryColor: "#F5F5F5"
+    }
+  });
+
+  await repository.ensureForWorkspaceId("5");
+
+  assert.equal(state.postPayload.data.lightPrimaryColor, "#1C1C1C");
+  assert.equal(state.postPayload.data.darkPrimaryColor, "#F5F5F5");
+  assert.equal(state.postPayload.data.lightSecondaryColor, DEFAULT_WORKSPACE_THEME.light.secondaryColor);
+  assert.equal(state.postPayload.data.darkSurfaceColor, DEFAULT_WORKSPACE_THEME.dark.surfaceColor);
+});
+
 test("workspaceSettingsRepository.updateSettingsByWorkspaceId updates workspace settings fields", async () => {
   const { api, state } = createWorkspaceSettingsApiStub();
   const repository = createRepository({