@workbench-kit/workbench-config 0.0.2-prototype.0.2.2 → 0.0.2-prototype.0.2.21

package/package.json

@@ -1,15 +1,11 @@
 {
   "name": "@workbench-kit/workbench-config",
-  "version": "0.0.2-prototype.0.2.2",
+  "version": "0.0.2-prototype.0.2.21",
   "private": false,
   "type": "module",
   "exports": {
     ".": "./src/index.ts"
   },
-  "dependencies": {
-    "@workbench-kit/base": "0.0.2-prototype.0.2.2",
-    "@workbench-kit/platform": "0.0.2-prototype.0.2.2"
-  },
   "files": [
     "src",
     "!src/**/*.test.ts",

package/src/index.ts

@@ -1,3 +1,4 @@
+import { assertKnownKeys, assertRecord } from './parse-helpers.js';
 import { WorkbenchConfigValidationError } from './validation-error.js';
 
 export const WORKBENCH_KIT_WORKBENCH_CONFIG_VERSION = '0.0.0' as const;
@@ -19,6 +20,16 @@ export interface WorkbenchExtensionsConfig {
   recommendations: readonly string[];
 }
 
+export interface WorkbenchExtensionsLockEntry {
+  readonly integrity?: string | undefined;
+  readonly version: string;
+}
+
+export interface WorkbenchExtensionsLock {
+  readonly extensions: Readonly<Record<string, WorkbenchExtensionsLockEntry>>;
+  readonly lockfileVersion: number;
+}
+
 export interface WorkbenchLayoutConfig {
   readonly activityBar: {
     readonly hiddenItemIds?: readonly string[];
@@ -29,6 +40,8 @@ export interface WorkbenchLayoutConfig {
     readonly visible: boolean;
   };
   readonly panel: {
+    readonly activeViewContainer?: string;
+    readonly sizePercent?: number;
     readonly visible: boolean;
   };
   readonly sideBar: {
@@ -83,6 +96,57 @@ export function parseWorkbenchExtensionsConfigJson(jsonText: string): WorkbenchE
   }
 }
 
+export function parseWorkbenchExtensionsLock(input: unknown): WorkbenchExtensionsLock {
+  const record = assertRecord(input, 'extensions lock');
+  const lockfileVersion = record.lockfileVersion;
+  if (
+    typeof lockfileVersion !== 'number' ||
+    !Number.isInteger(lockfileVersion) ||
+    lockfileVersion < 1
+  ) {
+    throw new WorkbenchConfigValidationError(
+      'Expected extensions lock "lockfileVersion" to be a positive integer.',
+    );
+  }
+
+  const extensionsRecord = assertRecord(record.extensions ?? {}, 'extensions lock extensions');
+  const extensions: Record<string, WorkbenchExtensionsLockEntry> = {};
+  for (const [extensionId, rawEntry] of Object.entries(extensionsRecord)) {
+    const entry = assertRecord(rawEntry, `extensions lock entry "${extensionId}"`);
+    if (typeof entry.version !== 'string' || entry.version.trim().length === 0) {
+      throw new WorkbenchConfigValidationError(
+        `Expected extensions lock entry "${extensionId}" to include a non-empty version.`,
+      );
+    }
+    if (entry.integrity !== undefined && typeof entry.integrity !== 'string') {
+      throw new WorkbenchConfigValidationError(
+        `Expected extensions lock entry "${extensionId}" integrity to be a string.`,
+      );
+    }
+    extensions[extensionId] = {
+      integrity: typeof entry.integrity === 'string' ? entry.integrity : undefined,
+      version: entry.version.trim(),
+    };
+  }
+
+  return {
+    extensions,
+    lockfileVersion,
+  };
+}
+
+export function parseWorkbenchExtensionsLockJson(jsonText: string): WorkbenchExtensionsLock {
+  try {
+    return parseWorkbenchExtensionsLock(JSON.parse(jsonText) as unknown);
+  } catch (error) {
+    if (error instanceof WorkbenchConfigValidationError) {
+      throw error;
+    }
+
+    throw new WorkbenchConfigValidationError('Expected extensions lock to be valid JSON.');
+  }
+}
+
 export function parseWorkbenchLayoutConfig(input: unknown): WorkbenchLayoutConfig {
   const record = assertRecord(input, 'layout config');
   assertKnownKeys(record, ['activityBar', 'auxiliaryBar', 'panel', 'sideBar'], 'layout config');
@@ -98,7 +162,7 @@ export function parseWorkbenchLayoutConfig(input: unknown): WorkbenchLayoutConfi
     'layout config activityBar',
   );
   assertKnownKeys(auxiliaryBar, ['visible'], 'layout config auxiliaryBar');
-  assertKnownKeys(panel, ['visible'], 'layout config panel');
+  assertKnownKeys(panel, ['activeViewContainer', 'sizePercent', 'visible'], 'layout config panel');
   assertKnownKeys(
     sideBar,
     ['activeViewContainer', 'sizePercent', 'visible'],
@@ -123,6 +187,8 @@ export function parseWorkbenchLayoutConfig(input: unknown): WorkbenchLayoutConfi
       ),
     },
     panel: {
+      ...readOptionalLayoutId(panel, 'activeViewContainer'),
+      ...readOptionalSizePercent(panel, 'sizePercent'),
       visible: readOptionalBoolean(panel, 'visible', DEFAULT_WORKBENCH_LAYOUT_CONFIG.panel.visible),
     },
     sideBar: {
@@ -181,14 +247,6 @@ export {
   type WorkbenchUserCommandsConfig,
 } from './user-commands-config.js';
 
-function assertRecord(value: unknown, label: string): Record<string, unknown> {
-  if (typeof value !== 'object' || value === null || Array.isArray(value)) {
-    throw new WorkbenchConfigValidationError(`Expected ${label} to be an object.`);
-  }
-
-  return value as Record<string, unknown>;
-}
-
 function readOptionalRecord(record: Record<string, unknown>, key: string): Record<string, unknown> {
   const value = record[key];
   if (value === undefined) {
@@ -290,11 +348,3 @@ function readOptionalSizePercent(
 function clampLayoutSizePercent(value: number): number {
   return Math.min(90, Math.max(10, value));
 }
-
-function assertKnownKeys(record: Record<string, unknown>, keys: readonly string[], label: string) {
-  const knownKeys = new Set(keys);
-  const unknownKeys = Object.keys(record).filter((key) => !knownKeys.has(key));
-  if (unknownKeys.length > 0) {
-    throw new WorkbenchConfigValidationError(`Unexpected ${label} field "${unknownKeys[0]}".`);
-  }
-}

package/src/keybindings-config.ts

@@ -1,3 +1,9 @@
+import {
+  assertKnownKeys,
+  assertRecord,
+  readOptionalString,
+  readRequiredString,
+} from './parse-helpers.js';
 import { WorkbenchConfigValidationError } from './validation-error.js';
 
 export interface WorkbenchKeybindingDefinition {
@@ -48,36 +54,6 @@ function parseWorkbenchKeybindingDefinition(
   };
 }
 
-function assertRecord(value: unknown, label: string): Record<string, unknown> {
-  if (typeof value !== 'object' || value === null || Array.isArray(value)) {
-    throw new WorkbenchConfigValidationError(`Expected ${label} to be an object.`);
-  }
-
-  return value as Record<string, unknown>;
-}
-
-function readRequiredString(record: Record<string, unknown>, key: string): string {
-  const value = record[key];
-  if (typeof value !== 'string' || value.trim().length === 0) {
-    throw new WorkbenchConfigValidationError(`Expected "${key}" to be a non-empty string.`);
-  }
-
-  return value.trim();
-}
-
-function readOptionalString(record: Record<string, unknown>, key: string): string | undefined {
-  const value = record[key];
-  if (value === undefined) {
-    return undefined;
-  }
-
-  if (typeof value !== 'string' || value.trim().length === 0) {
-    throw new WorkbenchConfigValidationError(`Expected "${key}" to be a non-empty string.`);
-  }
-
-  return value.trim();
-}
-
 function readOptionalArgs(record: Record<string, unknown>): readonly unknown[] | undefined {
   const value = record.args;
   if (value === undefined) {
@@ -90,11 +66,3 @@ function readOptionalArgs(record: Record<string, unknown>): readonly unknown[] |
 
   return [...value];
 }
-
-function assertKnownKeys(record: Record<string, unknown>, keys: readonly string[], label: string) {
-  const knownKeys = new Set(keys);
-  const unknownKeys = Object.keys(record).filter((key) => !knownKeys.has(key));
-  if (unknownKeys.length > 0) {
-    throw new WorkbenchConfigValidationError(`Unexpected ${label} field "${unknownKeys[0]}".`);
-  }
-}

package/src/parse-helpers.ts

@@ -0,0 +1,46 @@
+import { WorkbenchConfigValidationError } from './validation-error.js';
+
+export function assertRecord(value: unknown, label: string): Record<string, unknown> {
+  if (typeof value !== 'object' || value === null || Array.isArray(value)) {
+    throw new WorkbenchConfigValidationError(`Expected ${label} to be an object.`);
+  }
+
+  return value as Record<string, unknown>;
+}
+
+export function readRequiredString(record: Record<string, unknown>, key: string): string {
+  const value = record[key];
+  if (typeof value !== 'string' || value.trim().length === 0) {
+    throw new WorkbenchConfigValidationError(`Expected "${key}" to be a non-empty string.`);
+  }
+
+  return value.trim();
+}
+
+export function readOptionalString(
+  record: Record<string, unknown>,
+  key: string,
+): string | undefined {
+  const value = record[key];
+  if (value === undefined) {
+    return undefined;
+  }
+
+  if (typeof value !== 'string' || value.trim().length === 0) {
+    throw new WorkbenchConfigValidationError(`Expected "${key}" to be a non-empty string.`);
+  }
+
+  return value.trim();
+}
+
+export function assertKnownKeys(
+  record: Record<string, unknown>,
+  keys: readonly string[],
+  label: string,
+) {
+  const knownKeys = new Set(keys);
+  const unknownKeys = Object.keys(record).filter((key) => !knownKeys.has(key));
+  if (unknownKeys.length > 0) {
+    throw new WorkbenchConfigValidationError(`Unexpected ${label} field "${unknownKeys[0]}".`);
+  }
+}

package/src/user-commands-config.ts

@@ -1,3 +1,9 @@
+import {
+  assertKnownKeys,
+  assertRecord,
+  readOptionalString,
+  readRequiredString,
+} from './parse-helpers.js';
 import { WorkbenchConfigValidationError } from './validation-error.js';
 
 export interface WorkbenchUserCommandExecuteAction {
@@ -102,36 +108,6 @@ function parseUserCommandAction(input: unknown, label: string): WorkbenchUserCom
   throw new WorkbenchConfigValidationError(`Unexpected ${label} type "${type}".`);
 }
 
-function assertRecord(value: unknown, label: string): Record<string, unknown> {
-  if (typeof value !== 'object' || value === null || Array.isArray(value)) {
-    throw new WorkbenchConfigValidationError(`Expected ${label} to be an object.`);
-  }
-
-  return value as Record<string, unknown>;
-}
-
-function readRequiredString(record: Record<string, unknown>, key: string): string {
-  const value = record[key];
-  if (typeof value !== 'string' || value.trim().length === 0) {
-    throw new WorkbenchConfigValidationError(`Expected "${key}" to be a non-empty string.`);
-  }
-
-  return value.trim();
-}
-
-function readOptionalString(record: Record<string, unknown>, key: string): string | undefined {
-  const value = record[key];
-  if (value === undefined) {
-    return undefined;
-  }
-
-  if (typeof value !== 'string' || value.trim().length === 0) {
-    throw new WorkbenchConfigValidationError(`Expected "${key}" to be a non-empty string.`);
-  }
-
-  return value.trim();
-}
-
 function readOptionalNumber(record: Record<string, unknown>, key: string): number | undefined {
   const value = record[key];
   if (value === undefined) {
@@ -144,11 +120,3 @@ function readOptionalNumber(record: Record<string, unknown>, key: string): numbe
 
   return value;
 }
-
-function assertKnownKeys(record: Record<string, unknown>, keys: readonly string[], label: string) {
-  const knownKeys = new Set(keys);
-  const unknownKeys = Object.keys(record).filter((key) => !knownKeys.has(key));
-  if (unknownKeys.length > 0) {
-    throw new WorkbenchConfigValidationError(`Unexpected ${label} field "${unknownKeys[0]}".`);
-  }
-}