@salesforce/metadata-core-sdk 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.txt +27 -0
- package/README.md +219 -0
- package/dist/index.d.ts +38 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +22 -0
- package/dist/index.js.map +1 -0
- package/dist/sdk/abstractions/core/IPlatformContext.d.ts +45 -0
- package/dist/sdk/abstractions/core/IPlatformContext.d.ts.map +1 -0
- package/dist/sdk/abstractions/core/IPlatformContext.js +8 -0
- package/dist/sdk/abstractions/core/IPlatformContext.js.map +1 -0
- package/dist/sdk/abstractions/core/index.d.ts +8 -0
- package/dist/sdk/abstractions/core/index.d.ts.map +1 -0
- package/dist/sdk/abstractions/core/index.js +8 -0
- package/dist/sdk/abstractions/core/index.js.map +1 -0
- package/dist/sdk/abstractions/index.d.ts +17 -0
- package/dist/sdk/abstractions/index.d.ts.map +1 -0
- package/dist/sdk/abstractions/index.js +20 -0
- package/dist/sdk/abstractions/index.js.map +1 -0
- package/dist/sdk/abstractions/services/IFileSystem.d.ts +114 -0
- package/dist/sdk/abstractions/services/IFileSystem.d.ts.map +1 -0
- package/dist/sdk/abstractions/services/IFileSystem.js +8 -0
- package/dist/sdk/abstractions/services/IFileSystem.js.map +1 -0
- package/dist/sdk/abstractions/services/ILogger.d.ts +63 -0
- package/dist/sdk/abstractions/services/ILogger.d.ts.map +1 -0
- package/dist/sdk/abstractions/services/ILogger.js +18 -0
- package/dist/sdk/abstractions/services/ILogger.js.map +1 -0
- package/dist/sdk/abstractions/services/ITelemetry.d.ts +159 -0
- package/dist/sdk/abstractions/services/ITelemetry.d.ts.map +1 -0
- package/dist/sdk/abstractions/services/ITelemetry.js +97 -0
- package/dist/sdk/abstractions/services/ITelemetry.js.map +1 -0
- package/dist/sdk/abstractions/services/index.d.ts +10 -0
- package/dist/sdk/abstractions/services/index.d.ts.map +1 -0
- package/dist/sdk/abstractions/services/index.js +10 -0
- package/dist/sdk/abstractions/services/index.js.map +1 -0
- package/dist/sdk/abstractions/types/FileMetadata.d.ts +15 -0
- package/dist/sdk/abstractions/types/FileMetadata.d.ts.map +1 -0
- package/dist/sdk/abstractions/types/FileMetadata.js +8 -0
- package/dist/sdk/abstractions/types/FileMetadata.js.map +1 -0
- package/dist/sdk/abstractions/types/Result.d.ts +15 -0
- package/dist/sdk/abstractions/types/Result.d.ts.map +1 -0
- package/dist/sdk/abstractions/types/Result.js +8 -0
- package/dist/sdk/abstractions/types/Result.js.map +1 -0
- package/dist/sdk/abstractions/types/index.d.ts +9 -0
- package/dist/sdk/abstractions/types/index.d.ts.map +1 -0
- package/dist/sdk/abstractions/types/index.js +9 -0
- package/dist/sdk/abstractions/types/index.js.map +1 -0
- package/dist/sdk/constants.d.ts +35 -0
- package/dist/sdk/constants.d.ts.map +1 -0
- package/dist/sdk/constants.js +35 -0
- package/dist/sdk/constants.js.map +1 -0
- package/dist/sdk/contracts/core/IMetadataParser.d.ts +49 -0
- package/dist/sdk/contracts/core/IMetadataParser.d.ts.map +1 -0
- package/dist/sdk/contracts/core/IMetadataParser.js +8 -0
- package/dist/sdk/contracts/core/IMetadataParser.js.map +1 -0
- package/dist/sdk/contracts/core/IVisualizationPlugin.d.ts +65 -0
- package/dist/sdk/contracts/core/IVisualizationPlugin.d.ts.map +1 -0
- package/dist/sdk/contracts/core/IVisualizationPlugin.js +8 -0
- package/dist/sdk/contracts/core/IVisualizationPlugin.js.map +1 -0
- package/dist/sdk/contracts/core/index.d.ts +9 -0
- package/dist/sdk/contracts/core/index.d.ts.map +1 -0
- package/dist/sdk/contracts/core/index.js +9 -0
- package/dist/sdk/contracts/core/index.js.map +1 -0
- package/dist/sdk/contracts/index.d.ts +9 -0
- package/dist/sdk/contracts/index.d.ts.map +1 -0
- package/dist/sdk/contracts/index.js +9 -0
- package/dist/sdk/contracts/index.js.map +1 -0
- package/dist/sdk/contracts/types/MetadataPluginInfo.d.ts +56 -0
- package/dist/sdk/contracts/types/MetadataPluginInfo.d.ts.map +1 -0
- package/dist/sdk/contracts/types/MetadataPluginInfo.js +8 -0
- package/dist/sdk/contracts/types/MetadataPluginInfo.js.map +1 -0
- package/dist/sdk/contracts/types/PluginConfig.d.ts +16 -0
- package/dist/sdk/contracts/types/PluginConfig.d.ts.map +1 -0
- package/dist/sdk/contracts/types/PluginConfig.js +8 -0
- package/dist/sdk/contracts/types/PluginConfig.js.map +1 -0
- package/dist/sdk/contracts/types/PluginContext.d.ts +22 -0
- package/dist/sdk/contracts/types/PluginContext.d.ts.map +1 -0
- package/dist/sdk/contracts/types/PluginContext.js +8 -0
- package/dist/sdk/contracts/types/PluginContext.js.map +1 -0
- package/dist/sdk/contracts/types/PluginError.d.ts +50 -0
- package/dist/sdk/contracts/types/PluginError.d.ts.map +1 -0
- package/dist/sdk/contracts/types/PluginError.js +31 -0
- package/dist/sdk/contracts/types/PluginError.js.map +1 -0
- package/dist/sdk/contracts/types/ValidationResult.d.ts +15 -0
- package/dist/sdk/contracts/types/ValidationResult.d.ts.map +1 -0
- package/dist/sdk/contracts/types/ValidationResult.js +8 -0
- package/dist/sdk/contracts/types/ValidationResult.js.map +1 -0
- package/dist/sdk/contracts/types/VersionInfo.d.ts +24 -0
- package/dist/sdk/contracts/types/VersionInfo.d.ts.map +1 -0
- package/dist/sdk/contracts/types/VersionInfo.js +8 -0
- package/dist/sdk/contracts/types/VersionInfo.js.map +1 -0
- package/dist/sdk/contracts/types/index.d.ts +13 -0
- package/dist/sdk/contracts/types/index.d.ts.map +1 -0
- package/dist/sdk/contracts/types/index.js +13 -0
- package/dist/sdk/contracts/types/index.js.map +1 -0
- package/dist/sdk/design-system/index.d.ts +11 -0
- package/dist/sdk/design-system/index.d.ts.map +1 -0
- package/dist/sdk/design-system/index.js +12 -0
- package/dist/sdk/design-system/index.js.map +1 -0
- package/dist/sdk/design-system/tokens/colors.d.ts +122 -0
- package/dist/sdk/design-system/tokens/colors.d.ts.map +1 -0
- package/dist/sdk/design-system/tokens/colors.js +142 -0
- package/dist/sdk/design-system/tokens/colors.js.map +1 -0
- package/dist/sdk/design-system/tokens/spacing.d.ts +24 -0
- package/dist/sdk/design-system/tokens/spacing.d.ts.map +1 -0
- package/dist/sdk/design-system/tokens/spacing.js +24 -0
- package/dist/sdk/design-system/tokens/spacing.js.map +1 -0
- package/dist/sdk/design-system/tokens/typography.d.ts +31 -0
- package/dist/sdk/design-system/tokens/typography.d.ts.map +1 -0
- package/dist/sdk/design-system/tokens/typography.js +31 -0
- package/dist/sdk/design-system/tokens/typography.js.map +1 -0
- package/dist/sdk/design-system/utils.d.ts +66 -0
- package/dist/sdk/design-system/utils.d.ts.map +1 -0
- package/dist/sdk/design-system/utils.js +116 -0
- package/dist/sdk/design-system/utils.js.map +1 -0
- package/dist/sdk/design-system/vscode-design-system.css +623 -0
- package/dist/sdk/utils/errors/ErrorBoundary.d.ts +35 -0
- package/dist/sdk/utils/errors/ErrorBoundary.d.ts.map +1 -0
- package/dist/sdk/utils/errors/ErrorBoundary.js +65 -0
- package/dist/sdk/utils/errors/ErrorBoundary.js.map +1 -0
- package/dist/sdk/utils/errors/ErrorBuilder.d.ts +107 -0
- package/dist/sdk/utils/errors/ErrorBuilder.d.ts.map +1 -0
- package/dist/sdk/utils/errors/ErrorBuilder.js +163 -0
- package/dist/sdk/utils/errors/ErrorBuilder.js.map +1 -0
- package/dist/sdk/utils/errors/setupHandlers.d.ts +12 -0
- package/dist/sdk/utils/errors/setupHandlers.d.ts.map +1 -0
- package/dist/sdk/utils/errors/setupHandlers.js +42 -0
- package/dist/sdk/utils/errors/setupHandlers.js.map +1 -0
- package/dist/sdk/utils/logger.d.ts +41 -0
- package/dist/sdk/utils/logger.d.ts.map +1 -0
- package/dist/sdk/utils/logger.js +54 -0
- package/dist/sdk/utils/logger.js.map +1 -0
- package/dist/sdk/utils/test-helpers/architecture-test-utils.d.ts +146 -0
- package/dist/sdk/utils/test-helpers/architecture-test-utils.d.ts.map +1 -0
- package/dist/sdk/utils/test-helpers/architecture-test-utils.js +286 -0
- package/dist/sdk/utils/test-helpers/architecture-test-utils.js.map +1 -0
- package/dist/sdk/utils/test-helpers/index.d.ts +8 -0
- package/dist/sdk/utils/test-helpers/index.d.ts.map +1 -0
- package/dist/sdk/utils/test-helpers/index.js +8 -0
- package/dist/sdk/utils/test-helpers/index.js.map +1 -0
- package/dist/sdk/utils/xmlParser.d.ts +38 -0
- package/dist/sdk/utils/xmlParser.d.ts.map +1 -0
- package/dist/sdk/utils/xmlParser.js +79 -0
- package/dist/sdk/utils/xmlParser.js.map +1 -0
- package/dist/sdk/webviewMessageTypes.d.ts +24 -0
- package/dist/sdk/webviewMessageTypes.d.ts.map +1 -0
- package/dist/sdk/webviewMessageTypes.js +23 -0
- package/dist/sdk/webviewMessageTypes.js.map +1 -0
- package/package.json +80 -0
- package/src/sdk/utils/test-helpers/architecture-test-utils.ts +365 -0
- package/src/sdk/utils/test-helpers/index.ts +20 -0
package/LICENSE.txt
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
Copyright (c) 2025, Salesforce.com, inc.
|
|
2
|
+
All rights reserved.
|
|
3
|
+
|
|
4
|
+
Redistribution and use in source and binary forms, with or without modification,
|
|
5
|
+
are permitted provided that the following conditions are met:
|
|
6
|
+
|
|
7
|
+
* Redistributions of source code must retain the above copyright notice, this
|
|
8
|
+
list of conditions and the following disclaimer.
|
|
9
|
+
|
|
10
|
+
* Redistributions in binary form must reproduce the above copyright notice, this
|
|
11
|
+
list of conditions and the following disclaimer in the documentation and/or
|
|
12
|
+
other materials provided with the distribution.
|
|
13
|
+
|
|
14
|
+
* Neither the name of Salesforce.com nor the names of its contributors may be
|
|
15
|
+
used to endorse or promote products derived from this software without specific
|
|
16
|
+
prior written permission.
|
|
17
|
+
|
|
18
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
|
19
|
+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
20
|
+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
21
|
+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
|
|
22
|
+
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
23
|
+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
24
|
+
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
|
|
25
|
+
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
26
|
+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
27
|
+
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
package/README.md
ADDED
|
@@ -0,0 +1,219 @@
|
|
|
1
|
+
# @salesforce/metadata-core-sdk
|
|
2
|
+
|
|
3
|
+
Core SDK with shared contracts and platform abstractions for visualization plugins.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
This package provides the foundational contracts used by visualization plugins. It contains:
|
|
8
|
+
|
|
9
|
+
- Plugin contracts (`IVisualizationPlugin`, `IMetadataParser`)
|
|
10
|
+
- Platform abstractions (`IPlatformContext`, `IFileSystem`, `ILogger`, `ITelemetry`)
|
|
11
|
+
- Shared types (`MetadataPluginInfo`, `ValidationResult`, `PluginContext`, `PluginError`, `PluginConfig`, `VersionInfo`)
|
|
12
|
+
- Webview messaging (`WebviewMessageType`, `VALID_MESSAGE_TYPES`)
|
|
13
|
+
- Common utilities (`SalesforceXMLParser`, `Logger`)
|
|
14
|
+
- Error handling (`ErrorBuilder`, `setupErrorHandlers`, `ErrorBoundary`)
|
|
15
|
+
- Design system tokens (colors, spacing, typography) via `@salesforce/metadata-core-sdk/design-system`
|
|
16
|
+
- Constants (`PLUGINS_DIR`, `PLUGINS_DIST_DIR`, `REACT_UI_DIR_NAME`)
|
|
17
|
+
|
|
18
|
+
**Note**: Rendering is handled automatically by the framework package (`@salesforce/metadata-visualizer-core`). The framework auto-detects React builds by checking for `ui/` directory in plugin build outputs.
|
|
19
|
+
|
|
20
|
+
## Installation
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npm install @salesforce/metadata-core-sdk
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Usage
|
|
27
|
+
|
|
28
|
+
### Plugin Contracts
|
|
29
|
+
|
|
30
|
+
```typescript
|
|
31
|
+
import {
|
|
32
|
+
IVisualizationPlugin,
|
|
33
|
+
MetadataPluginInfo,
|
|
34
|
+
IMetadataParser,
|
|
35
|
+
IPlatformContext,
|
|
36
|
+
} from '@salesforce/metadata-core-sdk';
|
|
37
|
+
import type { VersionInfo } from '@salesforce/metadata-core-sdk';
|
|
38
|
+
|
|
39
|
+
export class MyVisualizer implements IVisualizationPlugin<MyData> {
|
|
40
|
+
// 1. Cache metadata for efficiency (return same instance)
|
|
41
|
+
private readonly pluginMetadata: MetadataPluginInfo = {
|
|
42
|
+
id: 'myplugin', // Must match folder name!
|
|
43
|
+
name: 'My Visualizer',
|
|
44
|
+
description: 'Visualizes my metadata type', // optional
|
|
45
|
+
author: 'My Team',
|
|
46
|
+
filePatterns: ['.my-meta.xml'],
|
|
47
|
+
priority: 0, // optional, higher = preferred when multiple plugins match
|
|
48
|
+
};
|
|
49
|
+
|
|
50
|
+
// 2. Required: Parser instance
|
|
51
|
+
readonly parser: IMetadataParser<MyData>;
|
|
52
|
+
|
|
53
|
+
constructor() {
|
|
54
|
+
this.parser = new MyParser();
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
// 3. Required: Return metadata (mandatory hook)
|
|
58
|
+
getMetadataPluginInfo(): MetadataPluginInfo {
|
|
59
|
+
return this.pluginMetadata; // Return cached instance
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
// 4. Required: Check if plugin can handle file
|
|
63
|
+
canHandle(filePath: string): boolean {
|
|
64
|
+
return filePath.endsWith('.my-meta.xml');
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
// 5. Required: Initialize with platform context
|
|
68
|
+
async initialize(context: IPlatformContext): Promise<void> {
|
|
69
|
+
// Initialize parser, logger, etc.
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
// 6. Optional: Cleanup resources
|
|
73
|
+
dispose?(): void {
|
|
74
|
+
// Cleanup
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### Platform Abstractions
|
|
80
|
+
|
|
81
|
+
Platform abstractions are provided by core-sdk. Plugins receive these at runtime through the `initialize()` method:
|
|
82
|
+
|
|
83
|
+
```typescript
|
|
84
|
+
import type {
|
|
85
|
+
IPlatformContext,
|
|
86
|
+
IFileSystem,
|
|
87
|
+
ILogger,
|
|
88
|
+
ITelemetry,
|
|
89
|
+
} from '@salesforce/metadata-core-sdk';
|
|
90
|
+
|
|
91
|
+
interface IPlatformContext {
|
|
92
|
+
readonly fileSystem: IFileSystem; // Platform-agnostic file operations
|
|
93
|
+
readonly logger: ILogger; // Platform-agnostic logging
|
|
94
|
+
readonly telemetry: ITelemetry; // Telemetry (metrics/events)
|
|
95
|
+
readonly reactBuildsBasePath: string; // Base path for React builds
|
|
96
|
+
readonly pluginSettings?: Record<string, unknown>; // Optional plugin feature flags
|
|
97
|
+
}
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
Platforms (like the VS Code extension) implement these interfaces to provide platform-specific functionality.
|
|
101
|
+
|
|
102
|
+
### Design System
|
|
103
|
+
|
|
104
|
+
Design tokens for building consistent plugin UIs:
|
|
105
|
+
|
|
106
|
+
```typescript
|
|
107
|
+
import {
|
|
108
|
+
colorTokens,
|
|
109
|
+
spacingTokens,
|
|
110
|
+
fontSizeTokens,
|
|
111
|
+
} from '@salesforce/metadata-core-sdk/design-system';
|
|
112
|
+
import {
|
|
113
|
+
getCSSVariableValue,
|
|
114
|
+
resolveTokens,
|
|
115
|
+
cssVar,
|
|
116
|
+
} from '@salesforce/metadata-core-sdk/design-system';
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
## API
|
|
120
|
+
|
|
121
|
+
### Plugin Contracts
|
|
122
|
+
|
|
123
|
+
- **`IVisualizationPlugin<TData>`** - Main plugin interface (`getMetadataPluginInfo`, `parser`, `canHandle`, `initialize`, `dispose?`)
|
|
124
|
+
- **`IMetadataParser<TData>`** - Parser contract (`parse(filePath, versionInfo)`, `validate?(data)`, `getVizDependentFilePaths?(filePath)`)
|
|
125
|
+
|
|
126
|
+
### Types
|
|
127
|
+
|
|
128
|
+
- **`MetadataPluginInfo`** - Plugin metadata (id, name, author, filePatterns, description?, priority?, trustedSources?)
|
|
129
|
+
- **`PluginContext`** - Context passed to renderers
|
|
130
|
+
- **`ValidationResult`** - Validation result with errors and warnings
|
|
131
|
+
- **`PluginError`** - Structured error type with category, message, and context
|
|
132
|
+
- **`PluginConfig`** - Plugin configuration with settings
|
|
133
|
+
- **`VersionInfo`** - Version information resolved by the framework
|
|
134
|
+
- **`FileMetadata`** - File metadata structure
|
|
135
|
+
- **`Result<T>`** - Result type for operations
|
|
136
|
+
|
|
137
|
+
### Platform Abstractions
|
|
138
|
+
|
|
139
|
+
- **`IPlatformContext`** - Core platform context (fileSystem, logger, telemetry, reactBuildsBasePath, pluginSettings?)
|
|
140
|
+
- **`IFileSystem`** - Platform-agnostic file operations
|
|
141
|
+
- **`ILogger`** - Platform-agnostic logging interface
|
|
142
|
+
- **`ITelemetry`** - Platform-agnostic telemetry interface
|
|
143
|
+
|
|
144
|
+
### Utilities
|
|
145
|
+
|
|
146
|
+
- **`ErrorBuilder`** - Fluent API for constructing and reporting errors; `send()` posts to extension via postMessage
|
|
147
|
+
- **`setupErrorHandlers`** - Global handlers for uncaught errors and unhandled promise rejections (call at app start)
|
|
148
|
+
- **`ErrorBoundary`** - React error boundary for catching rendering errors
|
|
149
|
+
- **`SalesforceXMLParser`** - Utility class for parsing Salesforce XML files with sensible defaults
|
|
150
|
+
- **`Logger`** - Simple console-based logger utility (plugins can also use platform logger from `IPlatformContext`)
|
|
151
|
+
|
|
152
|
+
### Webview Messaging
|
|
153
|
+
|
|
154
|
+
- **`WebviewMessageType`** - Message type constants for webview ↔ extension host communication (`PLUGIN_ERROR`, `RETRY_VISUALIZATION`, `COPY_STACK_TRACE`, `OPEN_SETTINGS`)
|
|
155
|
+
- **`VALID_MESSAGE_TYPES`** - Set of all valid message types for whitelist validation
|
|
156
|
+
- **`WebviewMessageTypeValue`** - Union type of all message type values
|
|
157
|
+
|
|
158
|
+
### Constants
|
|
159
|
+
|
|
160
|
+
- **`PLUGINS_DIR`** - Directory name for plugins (`'plugins'`)
|
|
161
|
+
- **`PLUGINS_DIST_DIR`** - Build output directory name (`'dist'`)
|
|
162
|
+
- **`REACT_UI_DIR_NAME`** - React UI directory name (`'ui'`)
|
|
163
|
+
|
|
164
|
+
## Package Exports
|
|
165
|
+
|
|
166
|
+
```typescript
|
|
167
|
+
// Main exports
|
|
168
|
+
import {
|
|
169
|
+
IVisualizationPlugin,
|
|
170
|
+
IMetadataParser,
|
|
171
|
+
MetadataPluginInfo,
|
|
172
|
+
IPlatformContext,
|
|
173
|
+
IFileSystem,
|
|
174
|
+
ILogger,
|
|
175
|
+
SalesforceXMLParser,
|
|
176
|
+
Logger,
|
|
177
|
+
ErrorBuilder,
|
|
178
|
+
ErrorCategory,
|
|
179
|
+
setupErrorHandlers,
|
|
180
|
+
ErrorBoundary,
|
|
181
|
+
WebviewMessageType,
|
|
182
|
+
VALID_MESSAGE_TYPES,
|
|
183
|
+
PLUGINS_DIR,
|
|
184
|
+
PLUGINS_DIST_DIR,
|
|
185
|
+
REACT_UI_DIR_NAME,
|
|
186
|
+
} from '@salesforce/metadata-core-sdk';
|
|
187
|
+
|
|
188
|
+
// Types
|
|
189
|
+
import type {
|
|
190
|
+
ValidationResult,
|
|
191
|
+
PluginContext,
|
|
192
|
+
PluginError,
|
|
193
|
+
PluginConfig,
|
|
194
|
+
VersionInfo,
|
|
195
|
+
WebviewMessageTypeValue,
|
|
196
|
+
} from '@salesforce/metadata-core-sdk';
|
|
197
|
+
|
|
198
|
+
// Design system tokens and utilities (separate export)
|
|
199
|
+
import {
|
|
200
|
+
colorTokens,
|
|
201
|
+
spacingTokens,
|
|
202
|
+
fontSizeTokens,
|
|
203
|
+
getCSSVariableValue,
|
|
204
|
+
resolveTokens,
|
|
205
|
+
cssVar,
|
|
206
|
+
} from '@salesforce/metadata-core-sdk/design-system';
|
|
207
|
+
|
|
208
|
+
// Test helpers (separate export)
|
|
209
|
+
import {} from /* test utilities */ '@salesforce/metadata-core-sdk/test-helpers';
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
## License
|
|
213
|
+
|
|
214
|
+
BSD-3-Clause
|
|
215
|
+
|
|
216
|
+
## Support
|
|
217
|
+
|
|
218
|
+
For issues or questions, please file an issue at:
|
|
219
|
+
https://github.com/forcedotcom/salesforce-metadata-visualizer-support/issues
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) 2025, Salesforce, Inc.
|
|
3
|
+
* All rights reserved.
|
|
4
|
+
* Licensed under the BSD 3-Clause license.
|
|
5
|
+
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
6
|
+
**/
|
|
7
|
+
/**
|
|
8
|
+
* Core SDK for Salesforce Metadata Visualization
|
|
9
|
+
*
|
|
10
|
+
* This package provides:
|
|
11
|
+
* - Plugin contracts (visualization only)
|
|
12
|
+
* - Shared types for plugin contracts
|
|
13
|
+
* - Common utilities for plugins (XML parsing, etc.)
|
|
14
|
+
*
|
|
15
|
+
*/
|
|
16
|
+
export { IVisualizationPlugin } from './sdk/contracts/core/IVisualizationPlugin.js';
|
|
17
|
+
export { IMetadataParser } from './sdk/contracts/core/IMetadataParser.js';
|
|
18
|
+
export type { MetadataPluginInfo } from './sdk/contracts/types/MetadataPluginInfo.js';
|
|
19
|
+
export type { ValidationResult } from './sdk/contracts/types/ValidationResult.js';
|
|
20
|
+
export type { PluginContext } from './sdk/contracts/types/PluginContext.js';
|
|
21
|
+
export type { PluginError } from './sdk/contracts/types/PluginError.js';
|
|
22
|
+
export { ErrorCategory } from './sdk/contracts/types/PluginError.js';
|
|
23
|
+
export type { PluginConfig } from './sdk/contracts/types/PluginConfig.js';
|
|
24
|
+
export * from './sdk/abstractions/index.js';
|
|
25
|
+
export type { IPlatformContext } from './sdk/abstractions/core/IPlatformContext.js';
|
|
26
|
+
export type { IFileSystem } from './sdk/abstractions/services/IFileSystem.js';
|
|
27
|
+
export type { ILogger } from './sdk/abstractions/services/ILogger.js';
|
|
28
|
+
export { SalesforceXMLParser } from './sdk/utils/xmlParser.js';
|
|
29
|
+
export { Logger } from './sdk/utils/logger.js';
|
|
30
|
+
export { ErrorBuilder } from './sdk/utils/errors/ErrorBuilder.js';
|
|
31
|
+
export { ErrorBoundary } from './sdk/utils/errors/ErrorBoundary.js';
|
|
32
|
+
export { setupErrorHandlers } from './sdk/utils/errors/setupHandlers.js';
|
|
33
|
+
export { WebviewMessageType, VALID_MESSAGE_TYPES } from './sdk/webviewMessageTypes.js';
|
|
34
|
+
export type { WebviewMessageTypeValue } from './sdk/webviewMessageTypes.js';
|
|
35
|
+
export type { VersionInfo } from './sdk/contracts/types/VersionInfo.js';
|
|
36
|
+
export { PLUGINS_DIST_DIR, PLUGINS_DIR, REACT_UI_DIR_NAME } from './sdk/constants.js';
|
|
37
|
+
export * from './sdk/design-system/index.js';
|
|
38
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;IAKI;AAEJ;;;;;;;;GAQG;AAGH,OAAO,EAAE,oBAAoB,EAAE,MAAM,8CAA8C,CAAC;AACpF,OAAO,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAG1E,YAAY,EAAE,kBAAkB,EAAE,MAAM,6CAA6C,CAAC;AACtF,YAAY,EAAE,gBAAgB,EAAE,MAAM,2CAA2C,CAAC;AAClF,YAAY,EAAE,aAAa,EAAE,MAAM,wCAAwC,CAAC;AAC5E,YAAY,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,YAAY,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAC;AAG1E,cAAc,6BAA6B,CAAC;AAC5C,YAAY,EAAE,gBAAgB,EAAE,MAAM,6CAA6C,CAAC;AACpF,YAAY,EAAE,WAAW,EAAE,MAAM,4CAA4C,CAAC;AAC9E,YAAY,EAAE,OAAO,EAAE,MAAM,wCAAwC,CAAC;AAGtE,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAGzE,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACvF,YAAY,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAG5E,YAAY,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAC;AAGxE,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAGtF,cAAc,8BAA8B,CAAC"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) 2025, Salesforce, Inc.
|
|
3
|
+
* All rights reserved.
|
|
4
|
+
* Licensed under the BSD 3-Clause license.
|
|
5
|
+
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
6
|
+
**/
|
|
7
|
+
export { ErrorCategory } from './sdk/contracts/types/PluginError.js';
|
|
8
|
+
// Platform Abstractions
|
|
9
|
+
export * from './sdk/abstractions/index.js';
|
|
10
|
+
// Utilities
|
|
11
|
+
export { SalesforceXMLParser } from './sdk/utils/xmlParser.js';
|
|
12
|
+
export { Logger } from './sdk/utils/logger.js';
|
|
13
|
+
export { ErrorBuilder } from './sdk/utils/errors/ErrorBuilder.js';
|
|
14
|
+
export { ErrorBoundary } from './sdk/utils/errors/ErrorBoundary.js';
|
|
15
|
+
export { setupErrorHandlers } from './sdk/utils/errors/setupHandlers.js';
|
|
16
|
+
// Webview message contract (single source of truth for postMessage types)
|
|
17
|
+
export { WebviewMessageType, VALID_MESSAGE_TYPES } from './sdk/webviewMessageTypes.js';
|
|
18
|
+
// Constants
|
|
19
|
+
export { PLUGINS_DIST_DIR, PLUGINS_DIR, REACT_UI_DIR_NAME } from './sdk/constants.js';
|
|
20
|
+
// Design System
|
|
21
|
+
export * from './sdk/design-system/index.js';
|
|
22
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;IAKI;AAqBJ,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AAGrE,wBAAwB;AACxB,cAAc,6BAA6B,CAAC;AAK5C,YAAY;AACZ,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAEzE,0EAA0E;AAC1E,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAMvF,YAAY;AACZ,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAEtF,gBAAgB;AAChB,cAAc,8BAA8B,CAAC"}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) 2025, Salesforce, Inc.
|
|
3
|
+
* All rights reserved.
|
|
4
|
+
* Licensed under the BSD 3-Clause license.
|
|
5
|
+
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
6
|
+
**/
|
|
7
|
+
import { IFileSystem } from '../services/IFileSystem.js';
|
|
8
|
+
import { ILogger } from '../services/ILogger.js';
|
|
9
|
+
import { ITelemetry } from '../services/ITelemetry.js';
|
|
10
|
+
/**
|
|
11
|
+
* Platform context provides all platform specific services
|
|
12
|
+
*
|
|
13
|
+
* This is the main interface that ties together all platform abstractions.
|
|
14
|
+
* Each platform (VS Code, Node, Browser) provides its own implementation.
|
|
15
|
+
*/
|
|
16
|
+
export interface IPlatformContext {
|
|
17
|
+
/**
|
|
18
|
+
* File system operations
|
|
19
|
+
*/
|
|
20
|
+
readonly fileSystem: IFileSystem;
|
|
21
|
+
/**
|
|
22
|
+
* Logging
|
|
23
|
+
*/
|
|
24
|
+
readonly logger: ILogger;
|
|
25
|
+
/**
|
|
26
|
+
* Telemetry (metrics/events)
|
|
27
|
+
*/
|
|
28
|
+
readonly telemetry: ITelemetry;
|
|
29
|
+
/**
|
|
30
|
+
* Optional plugin settings from user configuration.
|
|
31
|
+
* Used to pass feature flags (e.g., plugin enable/disable) to the plugins repo.
|
|
32
|
+
*/
|
|
33
|
+
readonly pluginSettings?: Record<string, unknown>;
|
|
34
|
+
/**
|
|
35
|
+
* Base path for React builds
|
|
36
|
+
*
|
|
37
|
+
* Platform provides the base path where React builds are located.
|
|
38
|
+
* Framework constructs full path: {reactBuildsBasePath}/{pluginId}/ui/
|
|
39
|
+
*
|
|
40
|
+
* Example: "{PathToExtensionRoot}plugins"
|
|
41
|
+
* Framework will construct: "{PathToExtensionRoot}/{pluginId}/ui"
|
|
42
|
+
*/
|
|
43
|
+
readonly reactBuildsBasePath: string;
|
|
44
|
+
}
|
|
45
|
+
//# sourceMappingURL=IPlatformContext.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IPlatformContext.d.ts","sourceRoot":"","sources":["../../../../src/sdk/abstractions/core/IPlatformContext.ts"],"names":[],"mappings":"AAAA;;;;;IAKI;AAEJ,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAEvD;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,WAAW,CAAC;IAEjC;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC;IAE/B;;;OAGG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElD;;;;;;;;OAQG;IACH,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC;CACtC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) 2025, Salesforce, Inc.
|
|
3
|
+
* All rights reserved.
|
|
4
|
+
* Licensed under the BSD 3-Clause license.
|
|
5
|
+
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
6
|
+
**/
|
|
7
|
+
export {};
|
|
8
|
+
//# sourceMappingURL=IPlatformContext.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IPlatformContext.js","sourceRoot":"","sources":["../../../../src/sdk/abstractions/core/IPlatformContext.ts"],"names":[],"mappings":"AAAA;;;;;IAKI"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) 2025, Salesforce, Inc.
|
|
3
|
+
* All rights reserved.
|
|
4
|
+
* Licensed under the BSD 3-Clause license.
|
|
5
|
+
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
6
|
+
**/
|
|
7
|
+
export * from './IPlatformContext.js';
|
|
8
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/sdk/abstractions/core/index.ts"],"names":[],"mappings":"AAAA;;;;;IAKI;AAEJ,cAAc,uBAAuB,CAAC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) 2025, Salesforce, Inc.
|
|
3
|
+
* All rights reserved.
|
|
4
|
+
* Licensed under the BSD 3-Clause license.
|
|
5
|
+
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
6
|
+
**/
|
|
7
|
+
export * from './IPlatformContext.js';
|
|
8
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/sdk/abstractions/core/index.ts"],"names":[],"mappings":"AAAA;;;;;IAKI;AAEJ,cAAc,uBAAuB,CAAC"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) 2025, Salesforce, Inc.
|
|
3
|
+
* All rights reserved.
|
|
4
|
+
* Licensed under the BSD 3-Clause license.
|
|
5
|
+
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
6
|
+
**/
|
|
7
|
+
/**
|
|
8
|
+
* Platform Abstractions
|
|
9
|
+
*
|
|
10
|
+
* This module provides platform-agnostic interfaces that allow plugins and framework
|
|
11
|
+
* to work across different platforms (VS Code, Node.js, Browser) without
|
|
12
|
+
* coupling to any specific platform APIs.
|
|
13
|
+
*/
|
|
14
|
+
export * from './core/index.js';
|
|
15
|
+
export * from './services/index.js';
|
|
16
|
+
export * from './types/index.js';
|
|
17
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/sdk/abstractions/index.ts"],"names":[],"mappings":"AAAA;;;;;IAKI;AAEJ;;;;;;GAMG;AAGH,cAAc,iBAAiB,CAAC;AAGhC,cAAc,qBAAqB,CAAC;AAGpC,cAAc,kBAAkB,CAAC"}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) 2025, Salesforce, Inc.
|
|
3
|
+
* All rights reserved.
|
|
4
|
+
* Licensed under the BSD 3-Clause license.
|
|
5
|
+
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
6
|
+
**/
|
|
7
|
+
/**
|
|
8
|
+
* Platform Abstractions
|
|
9
|
+
*
|
|
10
|
+
* This module provides platform-agnostic interfaces that allow plugins and framework
|
|
11
|
+
* to work across different platforms (VS Code, Node.js, Browser) without
|
|
12
|
+
* coupling to any specific platform APIs.
|
|
13
|
+
*/
|
|
14
|
+
// Core platform context
|
|
15
|
+
export * from './core/index.js';
|
|
16
|
+
// Platform service interfaces
|
|
17
|
+
export * from './services/index.js';
|
|
18
|
+
// Shared types
|
|
19
|
+
export * from './types/index.js';
|
|
20
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/sdk/abstractions/index.ts"],"names":[],"mappings":"AAAA;;;;;IAKI;AAEJ;;;;;;GAMG;AAEH,wBAAwB;AACxB,cAAc,iBAAiB,CAAC;AAEhC,8BAA8B;AAC9B,cAAc,qBAAqB,CAAC;AAEpC,eAAe;AACf,cAAc,kBAAkB,CAAC"}
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) 2025, Salesforce, Inc.
|
|
3
|
+
* All rights reserved.
|
|
4
|
+
* Licensed under the BSD 3-Clause license.
|
|
5
|
+
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
6
|
+
**/
|
|
7
|
+
import { Result } from '../types/Result.js';
|
|
8
|
+
import { FileMetadata } from '../types/FileMetadata.js';
|
|
9
|
+
/**
|
|
10
|
+
* Parsed path object returned by parse()
|
|
11
|
+
*/
|
|
12
|
+
export interface ParsedPath {
|
|
13
|
+
root: string;
|
|
14
|
+
dir: string;
|
|
15
|
+
base: string;
|
|
16
|
+
ext: string;
|
|
17
|
+
name: string;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Platform-agnostic file system interface
|
|
21
|
+
*
|
|
22
|
+
* Different platforms implement this differently:
|
|
23
|
+
* - VS Code: Uses vscode.workspace APIs
|
|
24
|
+
* - Node.js: Uses fs module
|
|
25
|
+
* - Browser: Uses Fetch API or File API
|
|
26
|
+
*/
|
|
27
|
+
export interface IFileSystem {
|
|
28
|
+
/**
|
|
29
|
+
* Read file content as string
|
|
30
|
+
*/
|
|
31
|
+
readFile(path: string): Promise<Result<string>>;
|
|
32
|
+
/**
|
|
33
|
+
* Write content to file
|
|
34
|
+
*/
|
|
35
|
+
writeFile(path: string, content: string): Promise<Result<void>>;
|
|
36
|
+
/**
|
|
37
|
+
* Check if file exists
|
|
38
|
+
*/
|
|
39
|
+
exists(path: string): Promise<boolean>;
|
|
40
|
+
/**
|
|
41
|
+
* Get file metadata
|
|
42
|
+
*/
|
|
43
|
+
getMetadata(path: string): Promise<Result<FileMetadata>>;
|
|
44
|
+
/**
|
|
45
|
+
* List directory contents with entry type.
|
|
46
|
+
* @param dirPath Absolute path to the directory
|
|
47
|
+
* @returns Result with array of { name, isFile } for each entry, or error if directory cannot be read
|
|
48
|
+
*/
|
|
49
|
+
readDirectory(dirPath: string): Promise<Result<Array<{
|
|
50
|
+
name: string;
|
|
51
|
+
isFile: boolean;
|
|
52
|
+
}>>>;
|
|
53
|
+
/**
|
|
54
|
+
* Find files matching pattern in the current workspace
|
|
55
|
+
* @param pattern Glob pattern to match files
|
|
56
|
+
* @param maxResults Optional maximum number of results
|
|
57
|
+
*/
|
|
58
|
+
findFiles(pattern: string, maxResults?: number): Promise<Result<string[]>>;
|
|
59
|
+
/**
|
|
60
|
+
* Get workspace root path (if applicable)
|
|
61
|
+
*/
|
|
62
|
+
getWorkspaceRoot(): string | undefined;
|
|
63
|
+
/**
|
|
64
|
+
* Normalize path for current platform
|
|
65
|
+
*/
|
|
66
|
+
normalizePath(path: string): string;
|
|
67
|
+
/**
|
|
68
|
+
* Path separator for the current platform ('/' or '\')
|
|
69
|
+
*/
|
|
70
|
+
readonly separator: string;
|
|
71
|
+
/**
|
|
72
|
+
* Get the last portion of a path (similar to path.basename)
|
|
73
|
+
* @param filePath The file path
|
|
74
|
+
* @param ext Optional extension to remove from the result
|
|
75
|
+
*/
|
|
76
|
+
basename(filePath: string, ext?: string): string;
|
|
77
|
+
/**
|
|
78
|
+
* Get the directory name of a path (similar to path.dirname)
|
|
79
|
+
* @param filePath The file path
|
|
80
|
+
*/
|
|
81
|
+
dirname(filePath: string): string;
|
|
82
|
+
/**
|
|
83
|
+
* Join path segments together (similar to path.join)
|
|
84
|
+
* @param segments Path segments to join
|
|
85
|
+
*/
|
|
86
|
+
join(...segments: string[]): string;
|
|
87
|
+
/**
|
|
88
|
+
* Get the extension of a path (similar to path.extname)
|
|
89
|
+
* @param filePath The file path
|
|
90
|
+
*/
|
|
91
|
+
extname(filePath: string): string;
|
|
92
|
+
/**
|
|
93
|
+
* Parse a path into its components (similar to path.parse)
|
|
94
|
+
* @param filePath The file path
|
|
95
|
+
*/
|
|
96
|
+
parse(filePath: string): ParsedPath;
|
|
97
|
+
/**
|
|
98
|
+
* Get the relative path from one path to another (similar to path.relative)
|
|
99
|
+
* @param from The source path
|
|
100
|
+
* @param to The target path
|
|
101
|
+
*/
|
|
102
|
+
relative(from: string, to: string): string;
|
|
103
|
+
/**
|
|
104
|
+
* Resolve path segments into an absolute path (similar to path.resolve)
|
|
105
|
+
* @param segments Path segments to resolve
|
|
106
|
+
*/
|
|
107
|
+
resolve(...segments: string[]): string;
|
|
108
|
+
/**
|
|
109
|
+
* Check if a path is absolute (similar to path.isAbsolute)
|
|
110
|
+
* @param filePath The file path
|
|
111
|
+
*/
|
|
112
|
+
isAbsolute(filePath: string): boolean;
|
|
113
|
+
}
|
|
114
|
+
//# sourceMappingURL=IFileSystem.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IFileSystem.d.ts","sourceRoot":"","sources":["../../../../src/sdk/abstractions/services/IFileSystem.ts"],"names":[],"mappings":"AAAA;;;;;IAKI;AAEJ,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IAEhD;;OAEG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAEhE;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEvC;;OAEG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;IAEzD;;;;OAIG;IACH,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC,CAAC,CAAC;IAE1F;;;;OAIG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAE3E;;OAEG;IACH,gBAAgB,IAAI,MAAM,GAAG,SAAS,CAAC;IAEvC;;OAEG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAEjD;;;OAGG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;IAElC;;;OAGG;IACH,IAAI,CAAC,GAAG,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAEpC;;;OAGG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;IAElC;;;OAGG;IACH,KAAK,CAAC,QAAQ,EAAE,MAAM,GAAG,UAAU,CAAC;IAEpC;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC;IAE3C;;;OAGG;IACH,OAAO,CAAC,GAAG,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAEvC;;;OAGG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;CACvC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) 2025, Salesforce, Inc.
|
|
3
|
+
* All rights reserved.
|
|
4
|
+
* Licensed under the BSD 3-Clause license.
|
|
5
|
+
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
6
|
+
**/
|
|
7
|
+
export {};
|
|
8
|
+
//# sourceMappingURL=IFileSystem.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IFileSystem.js","sourceRoot":"","sources":["../../../../src/sdk/abstractions/services/IFileSystem.ts"],"names":[],"mappings":"AAAA;;;;;IAKI"}
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) 2025, Salesforce, Inc.
|
|
3
|
+
* All rights reserved.
|
|
4
|
+
* Licensed under the BSD 3-Clause license.
|
|
5
|
+
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
6
|
+
**/
|
|
7
|
+
/**
|
|
8
|
+
* Log levels
|
|
9
|
+
**/
|
|
10
|
+
export declare enum LogLevel {
|
|
11
|
+
Debug = "debug",
|
|
12
|
+
Info = "info",
|
|
13
|
+
Warn = "warn",
|
|
14
|
+
Error = "error",
|
|
15
|
+
Success = "success"
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* Platform-agnostic logger interface
|
|
19
|
+
*
|
|
20
|
+
* Different platforms implement this differently:
|
|
21
|
+
* - VS Code: Uses OutputChannel
|
|
22
|
+
* - Node.js: Uses console with colors
|
|
23
|
+
* - Browser: Uses console API
|
|
24
|
+
*/
|
|
25
|
+
export interface ILogger {
|
|
26
|
+
/**
|
|
27
|
+
* Log debug message
|
|
28
|
+
*/
|
|
29
|
+
debug(message: string, ...args: unknown[]): void;
|
|
30
|
+
/**
|
|
31
|
+
* Log info message
|
|
32
|
+
*/
|
|
33
|
+
info(message: string, ...args: unknown[]): void;
|
|
34
|
+
/**
|
|
35
|
+
* Log warning message
|
|
36
|
+
*/
|
|
37
|
+
warn(message: string, ...args: unknown[]): void;
|
|
38
|
+
/**
|
|
39
|
+
* Log error message
|
|
40
|
+
*/
|
|
41
|
+
error(message: string, ...args: unknown[]): void;
|
|
42
|
+
/**
|
|
43
|
+
* Log success message
|
|
44
|
+
*/
|
|
45
|
+
success(message: string, ...args: unknown[]): void;
|
|
46
|
+
/**
|
|
47
|
+
* Log with specific level
|
|
48
|
+
*/
|
|
49
|
+
log(level: LogLevel, message: string, ...args: unknown[]): void;
|
|
50
|
+
/**
|
|
51
|
+
* Set minimum log level
|
|
52
|
+
*/
|
|
53
|
+
setLevel(level: LogLevel): void;
|
|
54
|
+
/**
|
|
55
|
+
* Get current log level
|
|
56
|
+
*/
|
|
57
|
+
getLevel(): LogLevel;
|
|
58
|
+
/**
|
|
59
|
+
* Create a child logger with prefix
|
|
60
|
+
*/
|
|
61
|
+
createChild(prefix: string): ILogger;
|
|
62
|
+
}
|
|
63
|
+
//# sourceMappingURL=ILogger.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ILogger.d.ts","sourceRoot":"","sources":["../../../../src/sdk/abstractions/services/ILogger.ts"],"names":[],"mappings":"AAAA;;;;;IAKI;AAEJ;;IAEI;AACJ,oBAAY,QAAQ;IAClB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,IAAI,SAAS;IACb,KAAK,UAAU;IACf,OAAO,YAAY;CACpB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAEjD;;OAEG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAEhD;;OAEG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAEhD;;OAEG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAEjD;;OAEG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAEnD;;OAEG;IACH,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAEhE;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,QAAQ,IAAI,QAAQ,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;CACtC"}
|