Salesforce Services Extension

This extension provides core services for Salesforce development in VS Code.

Features

• Service provider functionality (Workspace, Connection, Project, Config, FS, Channel, Media, Prompt, Template)
• Core utilities for Salesforce development
• Integration with Salesforce CLI
• Template generation through @salesforce/templates
• Org metadata catalog with a read-only sf-org-metadata: document scheme for ephemeral source
• Virtual FS provider (src/virtualFsProvider) — memfs, IndexedDB storage for web
• Observability (src/observability) — OpenTelemetry spans, App Insights, O11y. See observability README

Requirements

• VS Code 1.129.0 or higher
• Salesforce CLI

Installation

This extension is part of the Salesforce Extensions for VS Code package.

Usage

This extension provides services used by other Salesforce extensions and is not directly user-facing.

Usage Example: Consuming Services from Other Extensions

Important: Do not directly import from salesforcedx-vscode-services. Instead, access services through the extension API.

Step 1: Create an Extension Provider

Create a file src/services/extensionProvider.ts in your extension:

import { ExtensionProviderService, getServicesApi } from '@salesforce/effect-ext-utils';
import * as Effect from 'effect/Effect';
import * as Layer from 'effect/Layer';

export const ExtensionProviderServiceLive = Layer.succeed(
  ExtensionProviderService,
  { getServicesApi }
);

export const AllServicesLayer = Layer.unwrapEffect(
  Effect.gen(function* () {
    const extensionProvider = yield* ExtensionProviderService;
    const api = yield* extensionProvider.getServicesApi;
    return Layer.mergeAll(
      ExtensionProviderServiceLive,
      api.services.ConfigService.Default,
      api.services.WorkspaceService.Default // Required dependency of ConfigService
      // Add other services and their dependencies as needed
    );
  }).pipe(Effect.provide(ExtensionProviderServiceLive))
);

Step 2: Use Services in Your Effect Programs

import * as Effect from 'effect/Effect';
import { ExtensionProviderService } from '@salesforce/effect-ext-utils';
import { getRuntime } from './services/runtime';

const myProgram = Effect.gen(function* () {
  const api = yield* (yield* ExtensionProviderService).getServicesApi;
  const configService = yield* api.services.ConfigService;
  const configAggregator = yield* configService.getConfigAggregator;
  return configAggregator;
});

await getRuntime().runPromise(myProgram);

See packages/salesforcedx-vscode-metadata/src/services/extensionProvider.ts for a complete example.

Contributing

Please see the contributing guide for details on how to contribute to this project.

License

BSD 3-Clause License