@webiny/api-apw 5.40.5 → 5.41.0-dbt.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/index.d.ts CHANGED
@@ -1,3 +1,3 @@
1
1
  import { CreateApwContextParams } from "./scheduler/types";
2
- export declare const createApwPageBuilderContext: (params: CreateApwContextParams) => (import("@webiny/api").ContextPlugin<import("./types").ApwContext> | import("@webiny/plugins/types").Plugin<Record<string, any>> | import("@webiny/plugins/types").PluginCollection | import("@webiny/handler-graphql").GraphQLSchemaPlugin<import("@webiny/api-mailer/types").MailerContext> | import("@webiny/plugins/types").PluginFactory)[];
2
+ export declare const createApwPageBuilderContext: (params: CreateApwContextParams) => (import("@webiny/plugins/types").Plugin<Record<string, any>> | import("@webiny/plugins/types").PluginFactory | import("@webiny/plugins/types").PluginCollection | import("@webiny/api").ContextPlugin<import("./types").ApwContext> | import("@webiny/handler-graphql").GraphQLSchemaPlugin<import("@webiny/api-mailer/types").MailerContext>)[];
3
3
  export declare const createApwGraphQL: () => import("@webiny/api").ContextPlugin<import("./types").ApwContext>[];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@webiny/api-apw",
3
- "version": "5.40.5",
3
+ "version": "5.41.0-dbt.0",
4
4
  "keywords": [
5
5
  "apw:base"
6
6
  ],
@@ -16,27 +16,27 @@
16
16
  "dependencies": {
17
17
  "@babel/runtime": "7.24.1",
18
18
  "@commodo/fields": "1.1.2-beta.20",
19
- "@webiny/api": "5.40.5",
20
- "@webiny/api-admin-settings": "5.40.5",
21
- "@webiny/api-headless-cms": "5.40.5",
22
- "@webiny/api-i18n": "5.40.5",
23
- "@webiny/api-mailer": "5.40.5",
24
- "@webiny/api-page-builder": "5.40.5",
25
- "@webiny/api-security": "5.40.5",
26
- "@webiny/api-tenancy": "5.40.5",
27
- "@webiny/api-wcp": "5.40.5",
28
- "@webiny/aws-sdk": "5.40.5",
29
- "@webiny/db-dynamodb": "5.40.5",
30
- "@webiny/error": "5.40.5",
31
- "@webiny/handler": "5.40.5",
32
- "@webiny/handler-client": "5.40.5",
33
- "@webiny/handler-db": "5.40.5",
34
- "@webiny/handler-graphql": "5.40.5",
35
- "@webiny/handler-logs": "5.40.5",
36
- "@webiny/plugins": "5.40.5",
37
- "@webiny/pubsub": "5.40.5",
38
- "@webiny/utils": "5.40.5",
39
- "@webiny/validation": "5.40.5",
19
+ "@webiny/api": "5.41.0-dbt.0",
20
+ "@webiny/api-admin-settings": "5.41.0-dbt.0",
21
+ "@webiny/api-headless-cms": "5.41.0-dbt.0",
22
+ "@webiny/api-i18n": "5.41.0-dbt.0",
23
+ "@webiny/api-mailer": "5.41.0-dbt.0",
24
+ "@webiny/api-page-builder": "5.41.0-dbt.0",
25
+ "@webiny/api-security": "5.41.0-dbt.0",
26
+ "@webiny/api-tenancy": "5.41.0-dbt.0",
27
+ "@webiny/api-wcp": "5.41.0-dbt.0",
28
+ "@webiny/aws-sdk": "5.41.0-dbt.0",
29
+ "@webiny/db-dynamodb": "5.41.0-dbt.0",
30
+ "@webiny/error": "5.41.0-dbt.0",
31
+ "@webiny/handler": "5.41.0-dbt.0",
32
+ "@webiny/handler-client": "5.41.0-dbt.0",
33
+ "@webiny/handler-db": "5.41.0-dbt.0",
34
+ "@webiny/handler-graphql": "5.41.0-dbt.0",
35
+ "@webiny/handler-logs": "5.41.0-dbt.0",
36
+ "@webiny/plugins": "5.41.0-dbt.0",
37
+ "@webiny/pubsub": "5.41.0-dbt.0",
38
+ "@webiny/utils": "5.41.0-dbt.0",
39
+ "@webiny/validation": "5.41.0-dbt.0",
40
40
  "dayjs": "1.11.7",
41
41
  "lodash": "4.17.21"
42
42
  },
@@ -44,10 +44,10 @@
44
44
  "@babel/cli": "7.24.1",
45
45
  "@babel/core": "7.24.3",
46
46
  "@babel/preset-env": "7.24.3",
47
- "@webiny/cli": "5.40.5",
48
- "@webiny/handler-aws": "5.40.5",
49
- "@webiny/project-utils": "5.40.5",
50
- "@webiny/wcp": "5.40.5",
47
+ "@webiny/cli": "5.41.0-dbt.0",
48
+ "@webiny/handler-aws": "5.41.0-dbt.0",
49
+ "@webiny/project-utils": "5.41.0-dbt.0",
50
+ "@webiny/wcp": "5.41.0-dbt.0",
51
51
  "get-yarn-workspaces": "1.0.2",
52
52
  "graphql": "15.8.0",
53
53
  "jest": "29.7.0",
@@ -55,7 +55,7 @@
55
55
  "rimraf": "5.0.5",
56
56
  "sinon": "9.2.4",
57
57
  "ttypescript": "1.5.15",
58
- "typescript": "4.7.4"
58
+ "typescript": "4.9.5"
59
59
  },
60
60
  "publishConfig": {
61
61
  "access": "public",
@@ -65,5 +65,5 @@
65
65
  "build": "yarn webiny run build",
66
66
  "watch": "yarn webiny run watch"
67
67
  },
68
- "gitHead": "f67778732392ed88f28da869ddacbf08a98cdec6"
68
+ "gitHead": "bbaec4dd1685579548c08bbde386aee5d96b80f8"
69
69
  }
@@ -19,7 +19,7 @@ export interface ExtractContentReviewIdAndStepResult {
19
19
  stepId: string;
20
20
  }
21
21
  export declare const extractContentReviewIdAndStep: (step: ApwChangeRequest["step"]) => ExtractContentReviewIdAndStepResult;
22
- declare type SafelyGetContentReviewParams = Pick<UpdateContentReviewParams, "id" | "contentReviewMethods">;
22
+ type SafelyGetContentReviewParams = Pick<UpdateContentReviewParams, "id" | "contentReviewMethods">;
23
23
  export declare const safelyGetContentReview: ({ id, contentReviewMethods }: SafelyGetContentReviewParams) => Promise<ApwContentReview | null>;
24
24
  export interface UpdateContentReviewParams {
25
25
  id: string;
@@ -28,7 +28,7 @@ export interface UpdateContentReviewParams {
28
28
  }
29
29
  export declare const updateContentReview: ({ contentReviewMethods, id, getNewContentReviewData }: UpdateContentReviewParams) => Promise<void>;
30
30
  export declare const updateContentReviewStep: (steps: ApwContentReviewStep[], stepId: string, updater: (step: ApwContentReviewStep) => ApwContentReviewStep) => ApwContentReviewStep[];
31
- declare type CheckInstallationParams = Pick<ApwContext, "tenancy" | "i18n">;
31
+ type CheckInstallationParams = Pick<ApwContext, "tenancy" | "i18n">;
32
32
  export declare const isInstallationPending: ({ tenancy, i18n }: CheckInstallationParams) => boolean;
33
33
  export declare const workflowByPrecedenceDesc: (a: ApwWorkflow, b: ApwWorkflow) => number;
34
34
  export declare const workflowByCreatedOnDesc: (a: ApwWorkflow, b: ApwWorkflow) => number;
@@ -9,5 +9,5 @@ export interface HandlerArgs {
9
9
  interface Configuration {
10
10
  storageOperations: ApwScheduleActionStorageOperations;
11
11
  }
12
- export declare const executeActionHandlerPlugins: (config: Configuration) => ((import("@webiny/db-dynamodb/plugins/definitions/ValueFilterPlugin").ValueFilterPlugin[][] | import("@webiny/handler").HandlerResultPlugin<import("@webiny/handler/types").Context> | ContextPlugin<import("@webiny/handler-db/types").DbContext>[])[] | import("@webiny/handler-aws").RawEventHandler<HandlerArgs, import("@webiny/handler/types").Context, any> | ContextPlugin<import("@webiny/api/types").Context>)[];
12
+ export declare const executeActionHandlerPlugins: (config: Configuration) => (ContextPlugin<import("@webiny/api/types").Context> | (import("@webiny/handler").HandlerResultPlugin<import("@webiny/handler/types").Context> | import("@webiny/db-dynamodb/plugins/definitions/ValueFilterPlugin").ValueFilterPlugin[][] | ContextPlugin<import("@webiny/handler-db/types").DbContext>[])[] | import("@webiny/handler-aws").RawEventHandler<HandlerArgs, import("@webiny/handler/types").Context, any>)[];
13
13
  export {};
@@ -19,4 +19,4 @@ export interface Configuration {
19
19
  executeAction: string;
20
20
  };
21
21
  }
22
- export declare const scheduleActionHandlerPlugins: (config: Configuration) => ((import("@webiny/db-dynamodb/plugins/definitions/ValueFilterPlugin").ValueFilterPlugin[][] | import("@webiny/handler").HandlerResultPlugin<import("@webiny/handler/types").Context> | import("@webiny/api").ContextPlugin<import("@webiny/handler-db/types").DbContext>[])[] | import("@webiny/handler-aws").RawEventHandler<HandlerArgs, import("@webiny/handler/types").Context, any>)[];
22
+ export declare const scheduleActionHandlerPlugins: (config: Configuration) => ((import("@webiny/handler").HandlerResultPlugin<import("@webiny/handler/types").Context> | import("@webiny/db-dynamodb/plugins/definitions/ValueFilterPlugin").ValueFilterPlugin[][] | import("@webiny/api").ContextPlugin<import("@webiny/handler-db/types").DbContext>[])[] | import("@webiny/handler-aws").RawEventHandler<HandlerArgs, import("@webiny/handler/types").Context, any>)[];
@@ -18,7 +18,7 @@ export declare const encodeToken: ({ id, tenant, locale }: EncodeTokenParams) =>
18
18
  export declare const TOKEN_PREFIX = "apw-";
19
19
  export declare const decodeToken: (token: string) => Partial<EncodeTokenParams>;
20
20
  export declare const documentClient: import("@webiny/aws-sdk/client-dynamodb").DynamoDBDocument;
21
- export declare const basePlugins: () => (import("@webiny/db-dynamodb/plugins/definitions/ValueFilterPlugin").ValueFilterPlugin[][] | import("@webiny/handler").HandlerResultPlugin<import("@webiny/handler/types").Context> | import("@webiny/api").ContextPlugin<import("@webiny/handler-db/types").DbContext>[])[];
21
+ export declare const basePlugins: () => (import("@webiny/handler").HandlerResultPlugin<import("@webiny/handler/types").Context> | import("@webiny/db-dynamodb/plugins/definitions/ValueFilterPlugin").ValueFilterPlugin[][] | import("@webiny/api").ContextPlugin<import("@webiny/handler-db/types").DbContext>[])[];
22
22
  /**
23
23
  * Get APW settings record from DDB.
24
24
  */
@@ -123,22 +123,22 @@ export interface ApwScheduleActionListParams extends ListParams {
123
123
  locale: string;
124
124
  };
125
125
  }
126
- export declare type StorageOperationsGetScheduleActionParams = StorageOperationsGetParams;
127
- export declare type StorageOperationsDeleteScheduleActionParams = StorageOperationsDeleteParams;
128
- export declare type StorageOperationsListScheduleActionsParams = ApwScheduleActionListParams;
129
- export declare type StorageOperationsCreateScheduleActionParams = CreateApwScheduleActionParams;
126
+ export type StorageOperationsGetScheduleActionParams = StorageOperationsGetParams;
127
+ export type StorageOperationsDeleteScheduleActionParams = StorageOperationsDeleteParams;
128
+ export type StorageOperationsListScheduleActionsParams = ApwScheduleActionListParams;
129
+ export type StorageOperationsCreateScheduleActionParams = CreateApwScheduleActionParams;
130
130
  export interface StorageOperationsUpdateScheduleActionParams {
131
131
  item: ApwScheduleAction;
132
132
  input: ApwScheduleActionData;
133
133
  }
134
- export declare type StorageOperationsListScheduleActionsResponse = [ApwScheduleAction[], ListMeta];
134
+ export type StorageOperationsListScheduleActionsResponse = [ApwScheduleAction[], ListMeta];
135
135
  export interface StorageOperationsUpdateCurrentTaskParams {
136
136
  item: ApwScheduleAction;
137
137
  }
138
138
  export interface StorageOperationsGetCurrentTaskParams {
139
139
  where: Pick<StorageOperationsGetParams["where"], "tenant" | "locale">;
140
140
  }
141
- export declare type StorageOperationsDeleteCurrentTaskParams = Pick<StorageOperationsDeleteParams, "tenant" | "locale">;
141
+ export type StorageOperationsDeleteCurrentTaskParams = Pick<StorageOperationsDeleteParams, "tenant" | "locale">;
142
142
  export interface ApwScheduleActionStorageOperations {
143
143
  get(params: StorageOperationsGetScheduleActionParams): Promise<ApwScheduleAction | null>;
144
144
  list(params: StorageOperationsListScheduleActionsParams): Promise<StorageOperationsListScheduleActionsResponse>;
package/types.d.ts CHANGED
@@ -77,10 +77,10 @@ export interface PageSettingsWithWorkflow extends PageSettings {
77
77
  export interface PageWithWorkflow extends Page {
78
78
  settings: PageSettingsWithWorkflow;
79
79
  }
80
- export declare type ApwOnPageBeforeCreateTopicParams = OnPageBeforeCreateTopicParams<PageWithWorkflow>;
81
- export declare type ApwOnPageBeforeCreateFromTopicParams = OnPageBeforeCreateFromTopicParams<PageWithWorkflow>;
82
- export declare type ApwOnPageBeforeUpdateTopicParams = OnPageBeforeUpdateTopicParams<PageWithWorkflow>;
83
- export declare type ApwOnPageBeforePublishTopicParams = OnPageBeforePublishTopicParams<PageWithWorkflow>;
80
+ export type ApwOnPageBeforeCreateTopicParams = OnPageBeforeCreateTopicParams<PageWithWorkflow>;
81
+ export type ApwOnPageBeforeCreateFromTopicParams = OnPageBeforeCreateFromTopicParams<PageWithWorkflow>;
82
+ export type ApwOnPageBeforeUpdateTopicParams = OnPageBeforeUpdateTopicParams<PageWithWorkflow>;
83
+ export type ApwOnPageBeforePublishTopicParams = OnPageBeforePublishTopicParams<PageWithWorkflow>;
84
84
  export declare enum WorkflowScopeTypes {
85
85
  DEFAULT = "default",
86
86
  CUSTOM = "custom"
@@ -193,7 +193,7 @@ export declare enum ApwContentReviewStatus {
193
193
  READY_TO_BE_PUBLISHED = "readyToBePublished",
194
194
  PUBLISHED = "published"
195
195
  }
196
- export declare type ApwContentReviewListFilter = ApwContentReviewStatus | "requiresMyAttention";
196
+ export type ApwContentReviewListFilter = ApwContentReviewStatus | "requiresMyAttention";
197
197
  export interface ApwWorkflowStep<TReviewer = ApwReviewer> {
198
198
  title: string;
199
199
  type: ApwWorkflowStepTypes;
@@ -373,13 +373,13 @@ export interface ApwContentReviewCrud extends BaseApwCrud<ApwContentReview, Crea
373
373
  onContentReviewAfterDelete: Topic<OnContentReviewAfterDeleteTopicParams>;
374
374
  onContentReviewBeforeList: Topic<OnContentReviewBeforeListTopicParams>;
375
375
  }
376
- export declare type ContentGetter = (id: string, settings: {
376
+ export type ContentGetter = (id: string, settings: {
377
377
  modelId?: string;
378
378
  }) => Promise<PageWithWorkflow | ApwCmsEntry | null>;
379
- export declare type ContentPublisher = (id: string, settings: {
379
+ export type ContentPublisher = (id: string, settings: {
380
380
  modelId?: string;
381
381
  }) => Promise<boolean | null>;
382
- export declare type ContentUnPublisher = (id: string, settings: {
382
+ export type ContentUnPublisher = (id: string, settings: {
383
383
  modelId?: string;
384
384
  }) => Promise<boolean | null>;
385
385
  export interface AdvancedPublishingWorkflow {
@@ -420,7 +420,7 @@ export interface CreateApwParams {
420
420
  interface StorageOperationsGetReviewerParams {
421
421
  id: string;
422
422
  }
423
- declare type StorageOperationsListReviewersParams = ApwReviewerListParams;
423
+ type StorageOperationsListReviewersParams = ApwReviewerListParams;
424
424
  interface CreateApwReviewerData {
425
425
  identityId: string;
426
426
  displayName: string | null;
@@ -449,8 +449,8 @@ interface StorageOperationsGetParams {
449
449
  interface StorageOperationsDeleteParams {
450
450
  id: string;
451
451
  }
452
- declare type StorageOperationsGetWorkflowParams = StorageOperationsGetParams;
453
- declare type StorageOperationsListWorkflowsParams = ListParams;
452
+ type StorageOperationsGetWorkflowParams = StorageOperationsGetParams;
453
+ type StorageOperationsListWorkflowsParams = ListParams;
454
454
  interface StorageOperationsCreateWorkflowParams {
455
455
  data: CreateApwWorkflowParams;
456
456
  }
@@ -458,8 +458,8 @@ interface StorageOperationsUpdateWorkflowParams {
458
458
  id: string;
459
459
  data: UpdateApwWorkflowParams;
460
460
  }
461
- declare type StorageOperationsDeleteWorkflowParams = StorageOperationsDeleteParams;
462
- declare type StorageOperationsGetContentReviewParams = StorageOperationsGetParams;
461
+ type StorageOperationsDeleteWorkflowParams = StorageOperationsDeleteParams;
462
+ type StorageOperationsGetContentReviewParams = StorageOperationsGetParams;
463
463
  export interface ApwContentReviewListParams extends ListParams {
464
464
  where: ListWhere & {
465
465
  reviewStatus?: ApwContentReviewListFilter;
@@ -469,7 +469,7 @@ export interface ApwContentReviewListParams extends ListParams {
469
469
  workflowId_in?: string[];
470
470
  };
471
471
  }
472
- declare type StorageOperationsListContentReviewsParams = ApwContentReviewListParams;
472
+ type StorageOperationsListContentReviewsParams = ApwContentReviewListParams;
473
473
  interface StorageOperationsCreateContentReviewParams {
474
474
  data: CreateApwContentReviewParams;
475
475
  }
@@ -477,9 +477,9 @@ interface StorageOperationsUpdateContentReviewParams {
477
477
  id: string;
478
478
  data: UpdateApwContentReviewParams;
479
479
  }
480
- declare type StorageOperationsDeleteContentReviewParams = StorageOperationsDeleteParams;
481
- declare type StorageOperationsGetChangeRequestParams = StorageOperationsGetParams;
482
- declare type StorageOperationsListChangeRequestsParams = ApwChangeRequestListParams;
480
+ type StorageOperationsDeleteContentReviewParams = StorageOperationsDeleteParams;
481
+ type StorageOperationsGetChangeRequestParams = StorageOperationsGetParams;
482
+ type StorageOperationsListChangeRequestsParams = ApwChangeRequestListParams;
483
483
  interface StorageOperationsCreateChangeRequestParams {
484
484
  data: CreateApwChangeRequestParams;
485
485
  }
@@ -487,10 +487,10 @@ interface StorageOperationsUpdateChangeRequestParams {
487
487
  id: string;
488
488
  data: UpdateApwChangeRequestParams;
489
489
  }
490
- declare type StorageOperationsDeleteChangeRequestParams = StorageOperationsDeleteParams;
491
- declare type StorageOperationsGetCommentParams = StorageOperationsGetParams;
492
- declare type StorageOperationsDeleteCommentParams = StorageOperationsDeleteParams;
493
- declare type StorageOperationsListCommentsParams = ApwCommentListParams;
490
+ type StorageOperationsDeleteChangeRequestParams = StorageOperationsDeleteParams;
491
+ type StorageOperationsGetCommentParams = StorageOperationsGetParams;
492
+ type StorageOperationsDeleteCommentParams = StorageOperationsDeleteParams;
493
+ type StorageOperationsListCommentsParams = ApwCommentListParams;
494
494
  interface StorageOperationsCreateCommentParams {
495
495
  data: CreateApwCommentParams;
496
496
  }
@@ -1,3 +1,3 @@
1
1
  import { Response, ErrorResponse } from "@webiny/handler-graphql";
2
- declare const _default: (fn: () => Promise<any>) => Promise<Response<any> | ErrorResponse>;
2
+ declare const _default: (fn: () => Promise<any>) => Promise<ErrorResponse | Response<any>>;
3
3
  export default _default;