Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions extensions/MyApiKeyAfterUpdate.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import { ApiKeyAfterUpdateEventHandler } from "webiny/api/security/api-key";
import { Logger } from "webiny/api/logger";
import { BuildParams } from "webiny/api/build-params";
import { Logger, BuildParams } from "webiny/api";

class MyApiKeyAfterUpdateImpl implements ApiKeyAfterUpdateEventHandler.Interface {
constructor(
Expand Down
2 changes: 2 additions & 0 deletions packages/api-core/src/exports/api.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export { Logger } from "~/features/logger/index.js";
export { BuildParam, BuildParams } from "~/features/buildParams/index.js";
1 change: 1 addition & 0 deletions packages/api-core/src/exports/api/build-params.ts
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
/** @deprecated Import from "webiny/api" instead. */
export { BuildParam, BuildParams } from "~/features/buildParams/index.js";
1 change: 1 addition & 0 deletions packages/api-core/src/exports/api/logger.ts
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
/** @deprecated Import from "webiny/api" instead. */
export { Logger } from "~/features/logger/index.js";
2 changes: 1 addition & 1 deletion packages/webiny/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@
"./api/system": "./api/system.js",
"./api/tasks": "./api/tasks.js",
"./api/tenancy": "./api/tenancy.js",
"./api": "./api.js",
"./api/file-manager/file": "./api/file-manager/file.js",
"./api/file-manager/permissions": "./api/file-manager/permissions.js",
"./api/file-manager/settings": "./api/file-manager/settings.js",
Expand Down Expand Up @@ -118,7 +119,6 @@
"./admin/website-builder": "./admin/website-builder.js",
"./cli/command": "./cli/command.js",
"./cli": "./cli.js",
"./api": "./api.js",
"./admin/lexical": "./admin/lexical.js",
"./infra/admin": "./infra/admin.js",
"./infra/api": "./infra/api.js",
Expand Down
2 changes: 2 additions & 0 deletions packages/webiny/src/api.ts
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
export { Logger } from "@webiny/api-core/features/logger/index.js";
export { BuildParam, BuildParams } from "@webiny/api-core/features/buildParams/index.js";
export { createFeature, createAbstraction, Result, BaseError } from "@webiny/feature/api/index.js";
1 change: 1 addition & 0 deletions packages/webiny/src/api/build-params.ts
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
/** @deprecated Import from "webiny/api" instead. */
export { BuildParam, BuildParams } from "@webiny/api-core/features/buildParams/index.js";
1 change: 1 addition & 0 deletions packages/webiny/src/api/logger.ts
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
/** @deprecated Import from "webiny/api" instead. */
export { Logger } from "@webiny/api-core/features/logger/index.js";
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ export interface ExportStatement {
source: string;
isWildcard: boolean;
isTypeOnly: boolean;
jsdoc?: string;
}

export interface IParseExportsFileService {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ export class DefaultMergeExportsService implements MergeExportsServiceNamespace.
source: string;
isWildcard: boolean;
isTypeOnly: boolean;
jsdoc?: string;
}> = [];

for (const input of inputs) {
Expand All @@ -35,13 +36,17 @@ export class DefaultMergeExportsService implements MergeExportsServiceNamespace.
namedExports: statement.namedExports,
source: sourceWithPackageName,
isWildcard: statement.isWildcard,
isTypeOnly: statement.isTypeOnly
isTypeOnly: statement.isTypeOnly,
jsdoc: statement.jsdoc
});
}
}

let output = "";
for (const exportStatement of mergedExports) {
if (exportStatement.jsdoc) {
output += `${exportStatement.jsdoc}\n`;
}
if (exportStatement.isWildcard) {
output += `export * from "${exportStatement.source}";\n`;
} else {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,17 @@ export class DefaultParseExportsFileService implements ParseExportsFileService.I
});
}

const fullText = exportDeclaration.getFullText();
const text = exportDeclaration.getText();
const leading = fullText.substring(0, fullText.lastIndexOf(text)).trim();
const jsdoc = leading.includes("@deprecated") ? leading : undefined;

exportStatements.push({
namedExports,
source: moduleSpecifier,
isWildcard: false,
isTypeOnly: isExportTypeOnly
isTypeOnly: isExportTypeOnly,
jsdoc
});
}
}
Expand Down
2 changes: 1 addition & 1 deletion skills/user-skills/api/api-architect/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -426,7 +426,7 @@ export const CreateEntityFeature = createFeature({
A deployed API must **NEVER** use `process.env` to read configuration. All configuration flows through `BuildParams` via DI:

```ts
import { BuildParams } from "webiny/api/build-params";
import { BuildParams } from "webiny/api";

class MyServiceImpl implements MyService.Interface {
constructor(private buildParams: BuildParams.Interface) {}
Expand Down
3 changes: 1 addition & 2 deletions skills/user-skills/dependency-injection/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,7 @@ Every Webiny extension type uses the same DI pattern: define a class implementin

```typescript
import { SomeFactory } from "webiny/some/path";
import { Logger } from "webiny/api/logger";
import { BuildParams } from "webiny/api/build-params";
import { Logger, BuildParams } from "webiny/api";

class MyImplementation implements SomeFactory.Interface {
constructor(
Expand Down
4 changes: 2 additions & 2 deletions skills/user-skills/generated/api/build-params/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ description: >

---
**Name:** `BuildParam`
**Import:** `import { BuildParam } from "webiny/api/build-params"`
**Import:** `import { BuildParam } from "webiny/api"`
**Source:** `@webiny/api-core/features/buildParams/index.ts`
**Description:** A single build-time configuration parameter.

---
**Name:** `BuildParams`
**Import:** `import { BuildParams } from "webiny/api/build-params"`
**Import:** `import { BuildParams } from "webiny/api"`
**Source:** `@webiny/api-core/features/buildParams/index.ts`
**Description:** Access build-time configuration parameters.

Expand Down
2 changes: 1 addition & 1 deletion skills/user-skills/generated/api/logger/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ description: >

---
**Name:** `Logger`
**Import:** `import { Logger } from "webiny/api/logger"`
**Import:** `import { Logger } from "webiny/api"`
**Source:** `@webiny/api-core/features/logger/index.ts`
**Description:** Structured logging with multiple log levels.

Expand Down
2 changes: 1 addition & 1 deletion skills/user-skills/local-development/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ During `yarn webiny watch api`:
- Use `Logger` (DI-injected) for production logging to CloudWatch

```typescript
import { Logger } from "webiny/api/logger";
import { Logger } from "webiny/api";

// In your extension class
this.logger.info("Processing request...");
Expand Down
Loading