Skip to content

Commit d08a1ec

Browse files
committed
restore jdocs
1 parent b570575 commit d08a1ec

20 files changed

Lines changed: 138 additions & 0 deletions

File tree

packages/b2c-cli/src/i18n/locales/de.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
* SPDX-License-Identifier: Apache-2
44
* For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
55
*/
6+
/**
7+
* DE - German translations for b2c-cli commands.
8+
*/
69
export const de = {
710
commands: {
811
sites: {

packages/b2c-cli/src/i18n/locales/en.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@
33
* SPDX-License-Identifier: Apache-2
44
* For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
55
*/
6+
/**
7+
* EN - English translations for b2c-cli commands.
8+
*
9+
* Note: These serve as documentation of translatable strings.
10+
* English defaults are also defined inline at point of use via t().
11+
*/
612
export const en = {
713
commands: {
814
sites: {

packages/b2c-cli/src/i18n/locales/index.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,17 @@
33
* SPDX-License-Identifier: Apache-2
44
* For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
55
*/
6+
/**
7+
* Locale resources for b2c-cli commands.
8+
*
9+
* Each locale file exports a translation object matching the structure
10+
* of keys used in t() calls. English is included for documentation
11+
* but defaults are defined inline at point of use.
12+
*
13+
* To add a new language:
14+
* 1. Create a new file (e.g., fr.ts) with translations
15+
* 2. Import and add to the locales object below
16+
*/
617

718
import {de} from './de.js';
819
import {en} from './en.js';

packages/b2c-tooling-sdk/src/clients/middleware.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,14 @@
33
* SPDX-License-Identifier: Apache-2
44
* For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
55
*/
6+
/**
7+
* Shared middleware for openapi-fetch clients.
8+
*
9+
* Provides reusable authentication and logging middleware that can be
10+
* used across all API clients (OCAPI, SLAS, SCAPI, etc.).
11+
*
12+
* @module clients/middleware
13+
*/
614
import type {Middleware} from 'openapi-fetch';
715
import type {AuthStrategy} from '../auth/types.js';
816
import {getLogger} from '../logging/logger.js';

packages/b2c-tooling-sdk/src/clients/mrt.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,15 @@
33
* SPDX-License-Identifier: Apache-2
44
* For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
55
*/
6+
/**
7+
* Managed Runtime (MRT) API client for B2C Commerce.
8+
*
9+
* Provides a fully typed client for Managed Runtime API operations using
10+
* openapi-fetch with API key authentication middleware. Used for
11+
* managing deployments, bundles, projects, and environments.
12+
*
13+
* @module clients/mrt
14+
*/
615
import createClient, {type Client} from 'openapi-fetch';
716
import type {AuthStrategy} from '../auth/types.js';
817
import type {paths, components} from './mrt.generated.js';

packages/b2c-tooling-sdk/src/clients/ocapi.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,14 @@
33
* SPDX-License-Identifier: Apache-2
44
* For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
55
*/
6+
/**
7+
* OCAPI client for B2C Commerce Data API operations.
8+
*
9+
* Provides a fully typed client for OCAPI Data API operations using
10+
* openapi-fetch with authentication middleware.
11+
*
12+
* @module clients/ocapi
13+
*/
614
import createClient, {type Client} from 'openapi-fetch';
715
import type {AuthStrategy} from '../auth/types.js';
816
import type {paths, components} from './ocapi.generated.js';

packages/b2c-tooling-sdk/src/clients/ods.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,16 @@
33
* SPDX-License-Identifier: Apache-2
44
* For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
55
*/
6+
/**
7+
* ODS (On-Demand Sandbox) API client for B2C Commerce.
8+
*
9+
* Provides a fully typed client for the Developer Sandbox REST API using
10+
* openapi-fetch with OAuth authentication middleware. Used for managing
11+
* developer sandboxes including creation, deletion, start/stop operations,
12+
* and retrieving realm and system information.
13+
*
14+
* @module clients/ods
15+
*/
616
import createClient, {type Client} from 'openapi-fetch';
717
import type {AuthStrategy} from '../auth/types.js';
818
import type {paths, components} from './ods.generated.js';

packages/b2c-tooling-sdk/src/clients/slas-admin.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,15 @@
33
* SPDX-License-Identifier: Apache-2
44
* For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
55
*/
6+
/**
7+
* SLAS Admin API client for B2C Commerce.
8+
*
9+
* Provides a fully typed client for SLAS Admin API operations using
10+
* openapi-fetch with OAuth authentication middleware. Used for
11+
* administration tasks like managing tenants and SLAS clients.
12+
*
13+
* @module clients/slas-admin
14+
*/
615
import createClient, {type Client} from 'openapi-fetch';
716
import type {AuthStrategy} from '../auth/types.js';
817
import type {paths, components} from './slas-admin.generated.js';

packages/b2c-tooling-sdk/src/clients/webdav.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,14 @@
33
* SPDX-License-Identifier: Apache-2
44
* For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
55
*/
6+
/**
7+
* WebDAV client for B2C Commerce file operations.
8+
*
9+
* Provides typed methods for common WebDAV operations like file upload,
10+
* download, directory creation, and listing.
11+
*
12+
* @module clients/webdav
13+
*/
614
import type {AuthStrategy} from '../auth/types.js';
715
import {getLogger} from '../logging/logger.js';
816

packages/b2c-tooling-sdk/src/config/dw-json.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,14 @@
33
* SPDX-License-Identifier: Apache-2
44
* For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
55
*/
6+
/**
7+
* dw.json configuration file loading.
8+
*
9+
* This module provides utilities for loading B2C Commerce configuration from
10+
* dw.json files, the standard configuration format used by B2C development tools.
11+
*
12+
* @module config
13+
*/
614
import * as fs from 'node:fs';
715
import * as path from 'node:path';
816
import type {AuthMethod} from '../auth/types.js';

0 commit comments

Comments
 (0)