@meshery/schemas 1.3.114 → 1.3.115
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/dist/cloudApi.d.mts +631 -4
- package/dist/cloudApi.d.ts +631 -4
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta2/core/Core.d.ts +8 -0
- package/dist/constructs/v1beta2/core/CoreSchema.js +2 -2
- package/dist/constructs/v1beta2/core/CoreSchema.mjs +2 -2
- package/dist/constructs/v1beta2/credential/Credential.d.ts +144 -0
- package/dist/constructs/v1beta2/credential/CredentialSchema.js +4 -1
- package/dist/constructs/v1beta2/credential/CredentialSchema.mjs +4 -1
- package/dist/constructs/v1beta3/design/Design.d.ts +14 -2
- package/dist/constructs/v1beta3/design/DesignSchema.js +2 -2
- package/dist/constructs/v1beta3/design/DesignSchema.mjs +2 -2
- package/dist/constructs/v1beta3/event/Event.d.ts +386 -4
- package/dist/constructs/v1beta3/event/EventSchema.js +6 -6
- package/dist/constructs/v1beta3/event/EventSchema.mjs +6 -6
- package/dist/constructs/v1beta3/user/User.d.ts +8 -0
- package/dist/constructs/v1beta3/user/UserSchema.js +1 -1
- package/dist/constructs/v1beta3/user/UserSchema.mjs +1 -1
- package/dist/index.d.mts +190 -2
- package/dist/index.d.ts +190 -2
- package/dist/mesheryApi.d.mts +8 -2
- package/dist/mesheryApi.d.ts +8 -2
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -36319,7 +36319,7 @@ interface components$3 {
|
|
|
36319
36319
|
|
|
36320
36320
|
interface components$2 {
|
|
36321
36321
|
schemas: {
|
|
36322
|
-
/** @description Payload for creating a new event. */
|
|
36322
|
+
/** @description Payload for creating a new event. If visibility is absent, the event is private. */
|
|
36323
36323
|
EventPayload: {
|
|
36324
36324
|
/**
|
|
36325
36325
|
* Format: uuid
|
|
@@ -36328,6 +36328,12 @@ interface components$2 {
|
|
|
36328
36328
|
owner?: string;
|
|
36329
36329
|
/** @description The category of the event. */
|
|
36330
36330
|
category?: string;
|
|
36331
|
+
/**
|
|
36332
|
+
* @description Who can see the event. `private` is the default; clients may set `public` for events eligible for the unauthenticated feed.
|
|
36333
|
+
* @default private
|
|
36334
|
+
* @enum {string}
|
|
36335
|
+
*/
|
|
36336
|
+
visibility: "private" | "public";
|
|
36331
36337
|
/** @description The action of the event. */
|
|
36332
36338
|
action?: string;
|
|
36333
36339
|
/** @description Description of the event. */
|
|
@@ -36384,6 +36390,12 @@ interface components$2 {
|
|
|
36384
36390
|
};
|
|
36385
36391
|
/** @description EventResult entity schema. */
|
|
36386
36392
|
EventResult: {
|
|
36393
|
+
/**
|
|
36394
|
+
* @description Who can see the event. `private` (the default, set by Layer5 Cloud) means visible only inside the event's organization. `public` means the event may appear on the unauthenticated event feed, subject to the owner's `shareActivityPublicly` preference at read time.
|
|
36395
|
+
* @default private
|
|
36396
|
+
* @enum {string}
|
|
36397
|
+
*/
|
|
36398
|
+
visibility: "private" | "public";
|
|
36387
36399
|
/**
|
|
36388
36400
|
* Format: uuid
|
|
36389
36401
|
* @description UUID of the user associated with the event.
|
|
@@ -36406,6 +36418,11 @@ interface components$2 {
|
|
|
36406
36418
|
firstName?: string;
|
|
36407
36419
|
/** @description The last name of the user associated with the event. */
|
|
36408
36420
|
lastName?: string;
|
|
36421
|
+
/**
|
|
36422
|
+
* Format: uri
|
|
36423
|
+
* @description URL to the avatar image of the user associated with the event.
|
|
36424
|
+
*/
|
|
36425
|
+
avatarUrl?: string;
|
|
36409
36426
|
/**
|
|
36410
36427
|
* Format: email
|
|
36411
36428
|
* @description Email address of the user associated with the event.
|
|
@@ -36437,7 +36454,7 @@ interface components$2 {
|
|
|
36437
36454
|
category: string;
|
|
36438
36455
|
/** @description Human-readable summary of what happened. */
|
|
36439
36456
|
description: string;
|
|
36440
|
-
/** @description Event-specific details; the structure varies by event kind. `null` when the producer attached none. It stays a free-form map; design events fill it with a named shape: RelationshipEvaluationEventMetadata (category `relationship`, action `evaluation`), DesignValidationEventMetadata (category `pattern`, actions `validate`, `deploy`, `undeploy`, `dry-run`) and DesignSavedEventMetadata (category `pattern`, actions `create`, `update`); DesignEventIdentity names the design. Never put design contents into event metadata - no `designFile`, `patternFile`, `components`, `relationships`, `trace`, `evaluationResponse`, the raw `summary` or `validationResult`. Meshery Server applies a 16 KB guard that drops oversized metadata down to the identity fields (`designId`, `designName`, `designVersion`, `designLink`, `viewLink`). On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed; a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Older Meshery Cloud rows may carry the legacy `design_name` and `view_link` keys; readers should fall back to them when `designName` and `viewLink` are absent. */
|
|
36457
|
+
/** @description Event-specific details; the structure varies by event kind. `null` when the producer attached none. It stays a free-form map; design events fill it with a named shape: RelationshipEvaluationEventMetadata (category `relationship`, action `evaluation`), DesignValidationEventMetadata (category `pattern`, actions `validate`, `deploy`, `undeploy`, `dry-run`) and DesignSavedEventMetadata (category `pattern`, actions `create`, `update`); ScheduleCompletedEventMetadata (category `schedule`, action `completed`); DesignEventIdentity names the design. Never put design contents into event metadata - no `designFile`, `patternFile`, `components`, `relationships`, `trace`, `evaluationResponse`, the raw `summary` or `validationResult`. Meshery Server applies a 16 KB guard that drops oversized metadata down to the identity fields (`designId`, `designName`, `designVersion`, `designLink`, `viewLink`). On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed; a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Older Meshery Cloud rows may carry the legacy `design_name` and `view_link` keys; readers should fall back to them when `designName` and `viewLink` are absent. */
|
|
36441
36458
|
metadata: {
|
|
36442
36459
|
[key: string]: unknown;
|
|
36443
36460
|
} | null;
|
|
@@ -36475,6 +36492,12 @@ interface components$2 {
|
|
|
36475
36492
|
* @description Timestamp when the event was last updated.
|
|
36476
36493
|
*/
|
|
36477
36494
|
updatedAt: string;
|
|
36495
|
+
/**
|
|
36496
|
+
* @description Who can see the event. Defaults to `private`.
|
|
36497
|
+
* @default private
|
|
36498
|
+
* @enum {string}
|
|
36499
|
+
*/
|
|
36500
|
+
visibility: "private" | "public";
|
|
36478
36501
|
/**
|
|
36479
36502
|
* Format: date-time
|
|
36480
36503
|
* @description Timestamp when the event was soft-deleted; omitted when it was not.
|
|
@@ -36491,6 +36514,12 @@ interface components$2 {
|
|
|
36491
36514
|
totalCount?: number;
|
|
36492
36515
|
/** @description The events returned on the current page. */
|
|
36493
36516
|
data?: {
|
|
36517
|
+
/**
|
|
36518
|
+
* @description Who can see the event. `private` (the default, set by Layer5 Cloud) means visible only inside the event's organization. `public` means the event may appear on the unauthenticated event feed, subject to the owner's `shareActivityPublicly` preference at read time.
|
|
36519
|
+
* @default private
|
|
36520
|
+
* @enum {string}
|
|
36521
|
+
*/
|
|
36522
|
+
visibility: "private" | "public";
|
|
36494
36523
|
/**
|
|
36495
36524
|
* Format: uuid
|
|
36496
36525
|
* @description UUID of the user associated with the event.
|
|
@@ -36513,6 +36542,11 @@ interface components$2 {
|
|
|
36513
36542
|
firstName?: string;
|
|
36514
36543
|
/** @description The last name of the user associated with the event. */
|
|
36515
36544
|
lastName?: string;
|
|
36545
|
+
/**
|
|
36546
|
+
* Format: uri
|
|
36547
|
+
* @description URL to the avatar image of the user associated with the event.
|
|
36548
|
+
*/
|
|
36549
|
+
avatarUrl?: string;
|
|
36516
36550
|
/**
|
|
36517
36551
|
* Format: email
|
|
36518
36552
|
* @description Email address of the user associated with the event.
|
|
@@ -36527,6 +36561,134 @@ interface components$2 {
|
|
|
36527
36561
|
createdAt?: string;
|
|
36528
36562
|
}[];
|
|
36529
36563
|
};
|
|
36564
|
+
/**
|
|
36565
|
+
* @description Who can see the event. `private` (the default, set by Layer5 Cloud) means visible only inside the event's organization. `public` means the event may appear on the unauthenticated event feed, subject to the owner's `shareActivityPublicly` preference at read time. Clients such as Blowhorn decide whether to mark their own events public.
|
|
36566
|
+
* @default private
|
|
36567
|
+
* @enum {string}
|
|
36568
|
+
*/
|
|
36569
|
+
EventVisibility: "private" | "public";
|
|
36570
|
+
/**
|
|
36571
|
+
* @description An event projected into the public feed. It never includes email,
|
|
36572
|
+
* firstName, lastName, description, provider or raw metadata.
|
|
36573
|
+
* `platform`, `role`, `line` and `networks` are projected from
|
|
36574
|
+
* ScheduleCompletedEventMetadata; events without valid required
|
|
36575
|
+
* metadata are skipped. Public profile fields are resolved by Cloud at
|
|
36576
|
+
* read time and are included only when the user's profile is public.
|
|
36577
|
+
*/
|
|
36578
|
+
EventFeedItem: {
|
|
36579
|
+
/**
|
|
36580
|
+
* Format: uuid
|
|
36581
|
+
* @description Event ID.
|
|
36582
|
+
*/
|
|
36583
|
+
id: string;
|
|
36584
|
+
/**
|
|
36585
|
+
* Format: uuid
|
|
36586
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
36587
|
+
*/
|
|
36588
|
+
userId: string;
|
|
36589
|
+
/** @description Event category. */
|
|
36590
|
+
category: string;
|
|
36591
|
+
/** @description Event action. */
|
|
36592
|
+
action: string;
|
|
36593
|
+
/**
|
|
36594
|
+
* Format: date-time
|
|
36595
|
+
* @description Event creation time; the feed is ordered newest first.
|
|
36596
|
+
*/
|
|
36597
|
+
createdAt: string;
|
|
36598
|
+
/**
|
|
36599
|
+
* @description Always `public` in the feed.
|
|
36600
|
+
* @default private
|
|
36601
|
+
* @enum {string}
|
|
36602
|
+
*/
|
|
36603
|
+
visibility: "private" | "public";
|
|
36604
|
+
/**
|
|
36605
|
+
* @description Platform from ScheduleCompletedEventMetadata.
|
|
36606
|
+
* @enum {string}
|
|
36607
|
+
*/
|
|
36608
|
+
platform: "linkedin" | "x" | "reddit" | "hacker-news" | "slack" | "bluesky" | "github";
|
|
36609
|
+
/** @description Role from ScheduleCompletedEventMetadata. */
|
|
36610
|
+
role: string;
|
|
36611
|
+
/** @description One-line result from ScheduleCompletedEventMetadata. */
|
|
36612
|
+
line: string;
|
|
36613
|
+
/** @description Networks from ScheduleCompletedEventMetadata, when present. */
|
|
36614
|
+
networks?: string[];
|
|
36615
|
+
/** @description Public username, never a real name; present only for a public profile. */
|
|
36616
|
+
displayName?: string;
|
|
36617
|
+
/**
|
|
36618
|
+
* Format: uri
|
|
36619
|
+
* @description Public avatar URL; present only for a public profile.
|
|
36620
|
+
*/
|
|
36621
|
+
avatarUrl?: string;
|
|
36622
|
+
/** @description Public organization name; present only for a public profile. */
|
|
36623
|
+
organizationName?: string;
|
|
36624
|
+
/**
|
|
36625
|
+
* Format: uri
|
|
36626
|
+
* @description HTTPS URL of the user's public profile.
|
|
36627
|
+
*/
|
|
36628
|
+
publicProfileUrl?: string;
|
|
36629
|
+
};
|
|
36630
|
+
/** @description One page of event feed items, newest first. */
|
|
36631
|
+
EventFeedPage: {
|
|
36632
|
+
/** @description Current page number of the result set. */
|
|
36633
|
+
page: number;
|
|
36634
|
+
/** @description Number of items per page. */
|
|
36635
|
+
pageSize: number;
|
|
36636
|
+
/** @description Total number of matching feed events. */
|
|
36637
|
+
totalCount: number;
|
|
36638
|
+
/** @description Events for the requested page, newest first. */
|
|
36639
|
+
data: {
|
|
36640
|
+
/**
|
|
36641
|
+
* Format: uuid
|
|
36642
|
+
* @description Event ID.
|
|
36643
|
+
*/
|
|
36644
|
+
id: string;
|
|
36645
|
+
/**
|
|
36646
|
+
* Format: uuid
|
|
36647
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
36648
|
+
*/
|
|
36649
|
+
userId: string;
|
|
36650
|
+
/** @description Event category. */
|
|
36651
|
+
category: string;
|
|
36652
|
+
/** @description Event action. */
|
|
36653
|
+
action: string;
|
|
36654
|
+
/**
|
|
36655
|
+
* Format: date-time
|
|
36656
|
+
* @description Event creation time; the feed is ordered newest first.
|
|
36657
|
+
*/
|
|
36658
|
+
createdAt: string;
|
|
36659
|
+
/**
|
|
36660
|
+
* @description Always `public` in the feed.
|
|
36661
|
+
* @default private
|
|
36662
|
+
* @enum {string}
|
|
36663
|
+
*/
|
|
36664
|
+
visibility: "private" | "public";
|
|
36665
|
+
/**
|
|
36666
|
+
* @description Platform from ScheduleCompletedEventMetadata.
|
|
36667
|
+
* @enum {string}
|
|
36668
|
+
*/
|
|
36669
|
+
platform: "linkedin" | "x" | "reddit" | "hacker-news" | "slack" | "bluesky" | "github";
|
|
36670
|
+
/** @description Role from ScheduleCompletedEventMetadata. */
|
|
36671
|
+
role: string;
|
|
36672
|
+
/** @description One-line result from ScheduleCompletedEventMetadata. */
|
|
36673
|
+
line: string;
|
|
36674
|
+
/** @description Networks from ScheduleCompletedEventMetadata, when present. */
|
|
36675
|
+
networks?: string[];
|
|
36676
|
+
/** @description Public username, never a real name; present only for a public profile. */
|
|
36677
|
+
displayName?: string;
|
|
36678
|
+
/**
|
|
36679
|
+
* Format: uri
|
|
36680
|
+
* @description Public avatar URL; present only for a public profile.
|
|
36681
|
+
*/
|
|
36682
|
+
avatarUrl?: string;
|
|
36683
|
+
/** @description Public organization name; present only for a public profile. */
|
|
36684
|
+
organizationName?: string;
|
|
36685
|
+
/**
|
|
36686
|
+
* Format: uri
|
|
36687
|
+
* @description HTTPS URL of the user's public profile.
|
|
36688
|
+
*/
|
|
36689
|
+
publicProfileUrl?: string;
|
|
36690
|
+
}[];
|
|
36691
|
+
};
|
|
36530
36692
|
/** @description Aggregated event counts across categories. */
|
|
36531
36693
|
EventsAggregate: {
|
|
36532
36694
|
/** @description Count of audit-category events. */
|
|
@@ -36705,6 +36867,20 @@ interface components$2 {
|
|
|
36705
36867
|
/** @description Name of the saved design. */
|
|
36706
36868
|
name?: string;
|
|
36707
36869
|
};
|
|
36870
|
+
/** @description Metadata for a completed scheduled run (category `schedule`, action `completed`). This typed shape keeps client-specific display data out of the core Event fields and is projected into EventFeedItem. */
|
|
36871
|
+
ScheduleCompletedEventMetadata: {
|
|
36872
|
+
/**
|
|
36873
|
+
* @description Platform the completed run acted on.
|
|
36874
|
+
* @enum {string}
|
|
36875
|
+
*/
|
|
36876
|
+
platform: "linkedin" | "x" | "reddit" | "hacker-news" | "slack" | "bluesky" | "github";
|
|
36877
|
+
/** @description Role the completed run acted in. */
|
|
36878
|
+
role: string;
|
|
36879
|
+
/** @description One-line result of the run. */
|
|
36880
|
+
line: string;
|
|
36881
|
+
/** @description Networks or communities where the run acted. */
|
|
36882
|
+
networks?: string[];
|
|
36883
|
+
};
|
|
36708
36884
|
};
|
|
36709
36885
|
responses: {
|
|
36710
36886
|
/** @description Invalid request body or request param */
|
|
@@ -36808,6 +36984,12 @@ interface components$2 {
|
|
|
36808
36984
|
* @description Get responses by pagesize. Deprecated alias of pageSize.
|
|
36809
36985
|
*/
|
|
36810
36986
|
pagesizeLegacy: number;
|
|
36987
|
+
/** @description Number of feed items per page. */
|
|
36988
|
+
feedPagesize: number;
|
|
36989
|
+
/** @description Optional event category filter. */
|
|
36990
|
+
feedCategory: string;
|
|
36991
|
+
/** @description Optional event action filter. */
|
|
36992
|
+
feedAction: string;
|
|
36811
36993
|
/** @description Get responses that match search param value */
|
|
36812
36994
|
search: string;
|
|
36813
36995
|
/** @description Get ordered responses */
|
|
@@ -36921,6 +37103,8 @@ interface components$1 {
|
|
|
36921
37103
|
};
|
|
36922
37104
|
/** @description The anonymous usage stats of the preference. */
|
|
36923
37105
|
anonymousUsageStats: boolean;
|
|
37106
|
+
/** @description Account-wide switch for whether events the user marked public appear on GET /api/events/feed. If absent, the preference is on. Cloud reads it at feed time; turning it off hides all of the user's past public events from the next response, and events are never rewritten. */
|
|
37107
|
+
shareActivityPublicly?: boolean;
|
|
36924
37108
|
/** @description The anonymous perf results of the preference. */
|
|
36925
37109
|
anonymousPerfResults: boolean;
|
|
36926
37110
|
/**
|
|
@@ -37378,6 +37562,8 @@ interface components$1 {
|
|
|
37378
37562
|
};
|
|
37379
37563
|
/** @description The anonymous usage stats of the preference. */
|
|
37380
37564
|
anonymousUsageStats: boolean;
|
|
37565
|
+
/** @description Account-wide switch for whether events the user marked public appear on GET /api/events/feed. If absent, the preference is on. Cloud reads it at feed time; turning it off hides all of the user's past public events from the next response, and events are never rewritten. */
|
|
37566
|
+
shareActivityPublicly?: boolean;
|
|
37381
37567
|
/** @description The anonymous perf results of the preference. */
|
|
37382
37568
|
anonymousPerfResults: boolean;
|
|
37383
37569
|
/**
|
|
@@ -37453,6 +37639,8 @@ interface components$1 {
|
|
|
37453
37639
|
};
|
|
37454
37640
|
/** @description The anonymous usage stats of the preference. */
|
|
37455
37641
|
anonymousUsageStats?: boolean;
|
|
37642
|
+
/** @description Account-wide switch for whether events the user marked public appear on GET /api/events/feed. If absent, the preference is on. Cloud reads it at feed time; turning it off hides all of the user's past public events from the next response, and events are never rewritten. */
|
|
37643
|
+
shareActivityPublicly?: boolean;
|
|
37456
37644
|
/** @description The anonymous perf results of the preference. */
|
|
37457
37645
|
anonymousPerfResults?: boolean;
|
|
37458
37646
|
/** @description The dashboard preferences of the preference. */
|
package/dist/index.d.ts
CHANGED
|
@@ -36319,7 +36319,7 @@ interface components$3 {
|
|
|
36319
36319
|
|
|
36320
36320
|
interface components$2 {
|
|
36321
36321
|
schemas: {
|
|
36322
|
-
/** @description Payload for creating a new event. */
|
|
36322
|
+
/** @description Payload for creating a new event. If visibility is absent, the event is private. */
|
|
36323
36323
|
EventPayload: {
|
|
36324
36324
|
/**
|
|
36325
36325
|
* Format: uuid
|
|
@@ -36328,6 +36328,12 @@ interface components$2 {
|
|
|
36328
36328
|
owner?: string;
|
|
36329
36329
|
/** @description The category of the event. */
|
|
36330
36330
|
category?: string;
|
|
36331
|
+
/**
|
|
36332
|
+
* @description Who can see the event. `private` is the default; clients may set `public` for events eligible for the unauthenticated feed.
|
|
36333
|
+
* @default private
|
|
36334
|
+
* @enum {string}
|
|
36335
|
+
*/
|
|
36336
|
+
visibility: "private" | "public";
|
|
36331
36337
|
/** @description The action of the event. */
|
|
36332
36338
|
action?: string;
|
|
36333
36339
|
/** @description Description of the event. */
|
|
@@ -36384,6 +36390,12 @@ interface components$2 {
|
|
|
36384
36390
|
};
|
|
36385
36391
|
/** @description EventResult entity schema. */
|
|
36386
36392
|
EventResult: {
|
|
36393
|
+
/**
|
|
36394
|
+
* @description Who can see the event. `private` (the default, set by Layer5 Cloud) means visible only inside the event's organization. `public` means the event may appear on the unauthenticated event feed, subject to the owner's `shareActivityPublicly` preference at read time.
|
|
36395
|
+
* @default private
|
|
36396
|
+
* @enum {string}
|
|
36397
|
+
*/
|
|
36398
|
+
visibility: "private" | "public";
|
|
36387
36399
|
/**
|
|
36388
36400
|
* Format: uuid
|
|
36389
36401
|
* @description UUID of the user associated with the event.
|
|
@@ -36406,6 +36418,11 @@ interface components$2 {
|
|
|
36406
36418
|
firstName?: string;
|
|
36407
36419
|
/** @description The last name of the user associated with the event. */
|
|
36408
36420
|
lastName?: string;
|
|
36421
|
+
/**
|
|
36422
|
+
* Format: uri
|
|
36423
|
+
* @description URL to the avatar image of the user associated with the event.
|
|
36424
|
+
*/
|
|
36425
|
+
avatarUrl?: string;
|
|
36409
36426
|
/**
|
|
36410
36427
|
* Format: email
|
|
36411
36428
|
* @description Email address of the user associated with the event.
|
|
@@ -36437,7 +36454,7 @@ interface components$2 {
|
|
|
36437
36454
|
category: string;
|
|
36438
36455
|
/** @description Human-readable summary of what happened. */
|
|
36439
36456
|
description: string;
|
|
36440
|
-
/** @description Event-specific details; the structure varies by event kind. `null` when the producer attached none. It stays a free-form map; design events fill it with a named shape: RelationshipEvaluationEventMetadata (category `relationship`, action `evaluation`), DesignValidationEventMetadata (category `pattern`, actions `validate`, `deploy`, `undeploy`, `dry-run`) and DesignSavedEventMetadata (category `pattern`, actions `create`, `update`); DesignEventIdentity names the design. Never put design contents into event metadata - no `designFile`, `patternFile`, `components`, `relationships`, `trace`, `evaluationResponse`, the raw `summary` or `validationResult`. Meshery Server applies a 16 KB guard that drops oversized metadata down to the identity fields (`designId`, `designName`, `designVersion`, `designLink`, `viewLink`). On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed; a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Older Meshery Cloud rows may carry the legacy `design_name` and `view_link` keys; readers should fall back to them when `designName` and `viewLink` are absent. */
|
|
36457
|
+
/** @description Event-specific details; the structure varies by event kind. `null` when the producer attached none. It stays a free-form map; design events fill it with a named shape: RelationshipEvaluationEventMetadata (category `relationship`, action `evaluation`), DesignValidationEventMetadata (category `pattern`, actions `validate`, `deploy`, `undeploy`, `dry-run`) and DesignSavedEventMetadata (category `pattern`, actions `create`, `update`); ScheduleCompletedEventMetadata (category `schedule`, action `completed`); DesignEventIdentity names the design. Never put design contents into event metadata - no `designFile`, `patternFile`, `components`, `relationships`, `trace`, `evaluationResponse`, the raw `summary` or `validationResult`. Meshery Server applies a 16 KB guard that drops oversized metadata down to the identity fields (`designId`, `designName`, `designVersion`, `designLink`, `viewLink`). On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed; a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Older Meshery Cloud rows may carry the legacy `design_name` and `view_link` keys; readers should fall back to them when `designName` and `viewLink` are absent. */
|
|
36441
36458
|
metadata: {
|
|
36442
36459
|
[key: string]: unknown;
|
|
36443
36460
|
} | null;
|
|
@@ -36475,6 +36492,12 @@ interface components$2 {
|
|
|
36475
36492
|
* @description Timestamp when the event was last updated.
|
|
36476
36493
|
*/
|
|
36477
36494
|
updatedAt: string;
|
|
36495
|
+
/**
|
|
36496
|
+
* @description Who can see the event. Defaults to `private`.
|
|
36497
|
+
* @default private
|
|
36498
|
+
* @enum {string}
|
|
36499
|
+
*/
|
|
36500
|
+
visibility: "private" | "public";
|
|
36478
36501
|
/**
|
|
36479
36502
|
* Format: date-time
|
|
36480
36503
|
* @description Timestamp when the event was soft-deleted; omitted when it was not.
|
|
@@ -36491,6 +36514,12 @@ interface components$2 {
|
|
|
36491
36514
|
totalCount?: number;
|
|
36492
36515
|
/** @description The events returned on the current page. */
|
|
36493
36516
|
data?: {
|
|
36517
|
+
/**
|
|
36518
|
+
* @description Who can see the event. `private` (the default, set by Layer5 Cloud) means visible only inside the event's organization. `public` means the event may appear on the unauthenticated event feed, subject to the owner's `shareActivityPublicly` preference at read time.
|
|
36519
|
+
* @default private
|
|
36520
|
+
* @enum {string}
|
|
36521
|
+
*/
|
|
36522
|
+
visibility: "private" | "public";
|
|
36494
36523
|
/**
|
|
36495
36524
|
* Format: uuid
|
|
36496
36525
|
* @description UUID of the user associated with the event.
|
|
@@ -36513,6 +36542,11 @@ interface components$2 {
|
|
|
36513
36542
|
firstName?: string;
|
|
36514
36543
|
/** @description The last name of the user associated with the event. */
|
|
36515
36544
|
lastName?: string;
|
|
36545
|
+
/**
|
|
36546
|
+
* Format: uri
|
|
36547
|
+
* @description URL to the avatar image of the user associated with the event.
|
|
36548
|
+
*/
|
|
36549
|
+
avatarUrl?: string;
|
|
36516
36550
|
/**
|
|
36517
36551
|
* Format: email
|
|
36518
36552
|
* @description Email address of the user associated with the event.
|
|
@@ -36527,6 +36561,134 @@ interface components$2 {
|
|
|
36527
36561
|
createdAt?: string;
|
|
36528
36562
|
}[];
|
|
36529
36563
|
};
|
|
36564
|
+
/**
|
|
36565
|
+
* @description Who can see the event. `private` (the default, set by Layer5 Cloud) means visible only inside the event's organization. `public` means the event may appear on the unauthenticated event feed, subject to the owner's `shareActivityPublicly` preference at read time. Clients such as Blowhorn decide whether to mark their own events public.
|
|
36566
|
+
* @default private
|
|
36567
|
+
* @enum {string}
|
|
36568
|
+
*/
|
|
36569
|
+
EventVisibility: "private" | "public";
|
|
36570
|
+
/**
|
|
36571
|
+
* @description An event projected into the public feed. It never includes email,
|
|
36572
|
+
* firstName, lastName, description, provider or raw metadata.
|
|
36573
|
+
* `platform`, `role`, `line` and `networks` are projected from
|
|
36574
|
+
* ScheduleCompletedEventMetadata; events without valid required
|
|
36575
|
+
* metadata are skipped. Public profile fields are resolved by Cloud at
|
|
36576
|
+
* read time and are included only when the user's profile is public.
|
|
36577
|
+
*/
|
|
36578
|
+
EventFeedItem: {
|
|
36579
|
+
/**
|
|
36580
|
+
* Format: uuid
|
|
36581
|
+
* @description Event ID.
|
|
36582
|
+
*/
|
|
36583
|
+
id: string;
|
|
36584
|
+
/**
|
|
36585
|
+
* Format: uuid
|
|
36586
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
36587
|
+
*/
|
|
36588
|
+
userId: string;
|
|
36589
|
+
/** @description Event category. */
|
|
36590
|
+
category: string;
|
|
36591
|
+
/** @description Event action. */
|
|
36592
|
+
action: string;
|
|
36593
|
+
/**
|
|
36594
|
+
* Format: date-time
|
|
36595
|
+
* @description Event creation time; the feed is ordered newest first.
|
|
36596
|
+
*/
|
|
36597
|
+
createdAt: string;
|
|
36598
|
+
/**
|
|
36599
|
+
* @description Always `public` in the feed.
|
|
36600
|
+
* @default private
|
|
36601
|
+
* @enum {string}
|
|
36602
|
+
*/
|
|
36603
|
+
visibility: "private" | "public";
|
|
36604
|
+
/**
|
|
36605
|
+
* @description Platform from ScheduleCompletedEventMetadata.
|
|
36606
|
+
* @enum {string}
|
|
36607
|
+
*/
|
|
36608
|
+
platform: "linkedin" | "x" | "reddit" | "hacker-news" | "slack" | "bluesky" | "github";
|
|
36609
|
+
/** @description Role from ScheduleCompletedEventMetadata. */
|
|
36610
|
+
role: string;
|
|
36611
|
+
/** @description One-line result from ScheduleCompletedEventMetadata. */
|
|
36612
|
+
line: string;
|
|
36613
|
+
/** @description Networks from ScheduleCompletedEventMetadata, when present. */
|
|
36614
|
+
networks?: string[];
|
|
36615
|
+
/** @description Public username, never a real name; present only for a public profile. */
|
|
36616
|
+
displayName?: string;
|
|
36617
|
+
/**
|
|
36618
|
+
* Format: uri
|
|
36619
|
+
* @description Public avatar URL; present only for a public profile.
|
|
36620
|
+
*/
|
|
36621
|
+
avatarUrl?: string;
|
|
36622
|
+
/** @description Public organization name; present only for a public profile. */
|
|
36623
|
+
organizationName?: string;
|
|
36624
|
+
/**
|
|
36625
|
+
* Format: uri
|
|
36626
|
+
* @description HTTPS URL of the user's public profile.
|
|
36627
|
+
*/
|
|
36628
|
+
publicProfileUrl?: string;
|
|
36629
|
+
};
|
|
36630
|
+
/** @description One page of event feed items, newest first. */
|
|
36631
|
+
EventFeedPage: {
|
|
36632
|
+
/** @description Current page number of the result set. */
|
|
36633
|
+
page: number;
|
|
36634
|
+
/** @description Number of items per page. */
|
|
36635
|
+
pageSize: number;
|
|
36636
|
+
/** @description Total number of matching feed events. */
|
|
36637
|
+
totalCount: number;
|
|
36638
|
+
/** @description Events for the requested page, newest first. */
|
|
36639
|
+
data: {
|
|
36640
|
+
/**
|
|
36641
|
+
* Format: uuid
|
|
36642
|
+
* @description Event ID.
|
|
36643
|
+
*/
|
|
36644
|
+
id: string;
|
|
36645
|
+
/**
|
|
36646
|
+
* Format: uuid
|
|
36647
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
36648
|
+
*/
|
|
36649
|
+
userId: string;
|
|
36650
|
+
/** @description Event category. */
|
|
36651
|
+
category: string;
|
|
36652
|
+
/** @description Event action. */
|
|
36653
|
+
action: string;
|
|
36654
|
+
/**
|
|
36655
|
+
* Format: date-time
|
|
36656
|
+
* @description Event creation time; the feed is ordered newest first.
|
|
36657
|
+
*/
|
|
36658
|
+
createdAt: string;
|
|
36659
|
+
/**
|
|
36660
|
+
* @description Always `public` in the feed.
|
|
36661
|
+
* @default private
|
|
36662
|
+
* @enum {string}
|
|
36663
|
+
*/
|
|
36664
|
+
visibility: "private" | "public";
|
|
36665
|
+
/**
|
|
36666
|
+
* @description Platform from ScheduleCompletedEventMetadata.
|
|
36667
|
+
* @enum {string}
|
|
36668
|
+
*/
|
|
36669
|
+
platform: "linkedin" | "x" | "reddit" | "hacker-news" | "slack" | "bluesky" | "github";
|
|
36670
|
+
/** @description Role from ScheduleCompletedEventMetadata. */
|
|
36671
|
+
role: string;
|
|
36672
|
+
/** @description One-line result from ScheduleCompletedEventMetadata. */
|
|
36673
|
+
line: string;
|
|
36674
|
+
/** @description Networks from ScheduleCompletedEventMetadata, when present. */
|
|
36675
|
+
networks?: string[];
|
|
36676
|
+
/** @description Public username, never a real name; present only for a public profile. */
|
|
36677
|
+
displayName?: string;
|
|
36678
|
+
/**
|
|
36679
|
+
* Format: uri
|
|
36680
|
+
* @description Public avatar URL; present only for a public profile.
|
|
36681
|
+
*/
|
|
36682
|
+
avatarUrl?: string;
|
|
36683
|
+
/** @description Public organization name; present only for a public profile. */
|
|
36684
|
+
organizationName?: string;
|
|
36685
|
+
/**
|
|
36686
|
+
* Format: uri
|
|
36687
|
+
* @description HTTPS URL of the user's public profile.
|
|
36688
|
+
*/
|
|
36689
|
+
publicProfileUrl?: string;
|
|
36690
|
+
}[];
|
|
36691
|
+
};
|
|
36530
36692
|
/** @description Aggregated event counts across categories. */
|
|
36531
36693
|
EventsAggregate: {
|
|
36532
36694
|
/** @description Count of audit-category events. */
|
|
@@ -36705,6 +36867,20 @@ interface components$2 {
|
|
|
36705
36867
|
/** @description Name of the saved design. */
|
|
36706
36868
|
name?: string;
|
|
36707
36869
|
};
|
|
36870
|
+
/** @description Metadata for a completed scheduled run (category `schedule`, action `completed`). This typed shape keeps client-specific display data out of the core Event fields and is projected into EventFeedItem. */
|
|
36871
|
+
ScheduleCompletedEventMetadata: {
|
|
36872
|
+
/**
|
|
36873
|
+
* @description Platform the completed run acted on.
|
|
36874
|
+
* @enum {string}
|
|
36875
|
+
*/
|
|
36876
|
+
platform: "linkedin" | "x" | "reddit" | "hacker-news" | "slack" | "bluesky" | "github";
|
|
36877
|
+
/** @description Role the completed run acted in. */
|
|
36878
|
+
role: string;
|
|
36879
|
+
/** @description One-line result of the run. */
|
|
36880
|
+
line: string;
|
|
36881
|
+
/** @description Networks or communities where the run acted. */
|
|
36882
|
+
networks?: string[];
|
|
36883
|
+
};
|
|
36708
36884
|
};
|
|
36709
36885
|
responses: {
|
|
36710
36886
|
/** @description Invalid request body or request param */
|
|
@@ -36808,6 +36984,12 @@ interface components$2 {
|
|
|
36808
36984
|
* @description Get responses by pagesize. Deprecated alias of pageSize.
|
|
36809
36985
|
*/
|
|
36810
36986
|
pagesizeLegacy: number;
|
|
36987
|
+
/** @description Number of feed items per page. */
|
|
36988
|
+
feedPagesize: number;
|
|
36989
|
+
/** @description Optional event category filter. */
|
|
36990
|
+
feedCategory: string;
|
|
36991
|
+
/** @description Optional event action filter. */
|
|
36992
|
+
feedAction: string;
|
|
36811
36993
|
/** @description Get responses that match search param value */
|
|
36812
36994
|
search: string;
|
|
36813
36995
|
/** @description Get ordered responses */
|
|
@@ -36921,6 +37103,8 @@ interface components$1 {
|
|
|
36921
37103
|
};
|
|
36922
37104
|
/** @description The anonymous usage stats of the preference. */
|
|
36923
37105
|
anonymousUsageStats: boolean;
|
|
37106
|
+
/** @description Account-wide switch for whether events the user marked public appear on GET /api/events/feed. If absent, the preference is on. Cloud reads it at feed time; turning it off hides all of the user's past public events from the next response, and events are never rewritten. */
|
|
37107
|
+
shareActivityPublicly?: boolean;
|
|
36924
37108
|
/** @description The anonymous perf results of the preference. */
|
|
36925
37109
|
anonymousPerfResults: boolean;
|
|
36926
37110
|
/**
|
|
@@ -37378,6 +37562,8 @@ interface components$1 {
|
|
|
37378
37562
|
};
|
|
37379
37563
|
/** @description The anonymous usage stats of the preference. */
|
|
37380
37564
|
anonymousUsageStats: boolean;
|
|
37565
|
+
/** @description Account-wide switch for whether events the user marked public appear on GET /api/events/feed. If absent, the preference is on. Cloud reads it at feed time; turning it off hides all of the user's past public events from the next response, and events are never rewritten. */
|
|
37566
|
+
shareActivityPublicly?: boolean;
|
|
37381
37567
|
/** @description The anonymous perf results of the preference. */
|
|
37382
37568
|
anonymousPerfResults: boolean;
|
|
37383
37569
|
/**
|
|
@@ -37453,6 +37639,8 @@ interface components$1 {
|
|
|
37453
37639
|
};
|
|
37454
37640
|
/** @description The anonymous usage stats of the preference. */
|
|
37455
37641
|
anonymousUsageStats?: boolean;
|
|
37642
|
+
/** @description Account-wide switch for whether events the user marked public appear on GET /api/events/feed. If absent, the preference is on. Cloud reads it at feed time; turning it off hides all of the user's past public events from the next response, and events are never rewritten. */
|
|
37643
|
+
shareActivityPublicly?: boolean;
|
|
37456
37644
|
/** @description The anonymous perf results of the preference. */
|
|
37457
37645
|
anonymousPerfResults?: boolean;
|
|
37458
37646
|
/** @description The dashboard preferences of the preference. */
|
package/dist/mesheryApi.d.mts
CHANGED
|
@@ -13545,7 +13545,7 @@ type CreateEventApiResponse =
|
|
|
13545
13545
|
category: string;
|
|
13546
13546
|
/** Human-readable summary of what happened. */
|
|
13547
13547
|
description: string;
|
|
13548
|
-
/** Event-specific details; the structure varies by event kind. `null` when the producer attached none. It stays a free-form map; design events fill it with a named shape: RelationshipEvaluationEventMetadata (category `relationship`, action `evaluation`), DesignValidationEventMetadata (category `pattern`, actions `validate`, `deploy`, `undeploy`, `dry-run`) and DesignSavedEventMetadata (category `pattern`, actions `create`, `update`); DesignEventIdentity names the design. Never put design contents into event metadata - no `designFile`, `patternFile`, `components`, `relationships`, `trace`, `evaluationResponse`, the raw `summary` or `validationResult`. Meshery Server applies a 16 KB guard that drops oversized metadata down to the identity fields (`designId`, `designName`, `designVersion`, `designLink`, `viewLink`). On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed; a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Older Meshery Cloud rows may carry the legacy `design_name` and `view_link` keys; readers should fall back to them when `designName` and `viewLink` are absent.
|
|
13548
|
+
/** Event-specific details; the structure varies by event kind. `null` when the producer attached none. It stays a free-form map; design events fill it with a named shape: RelationshipEvaluationEventMetadata (category `relationship`, action `evaluation`), DesignValidationEventMetadata (category `pattern`, actions `validate`, `deploy`, `undeploy`, `dry-run`) and DesignSavedEventMetadata (category `pattern`, actions `create`, `update`); ScheduleCompletedEventMetadata (category `schedule`, action `completed`); DesignEventIdentity names the design. Never put design contents into event metadata - no `designFile`, `patternFile`, `components`, `relationships`, `trace`, `evaluationResponse`, the raw `summary` or `validationResult`. Meshery Server applies a 16 KB guard that drops oversized metadata down to the identity fields (`designId`, `designName`, `designVersion`, `designLink`, `viewLink`). On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed; a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Older Meshery Cloud rows may carry the legacy `design_name` and `view_link` keys; readers should fall back to them when `designName` and `viewLink` are absent.
|
|
13549
13549
|
*/
|
|
13550
13550
|
metadata: {
|
|
13551
13551
|
[key: string]: any;
|
|
@@ -13569,6 +13569,8 @@ type CreateEventApiResponse =
|
|
|
13569
13569
|
createdAt: string;
|
|
13570
13570
|
/** Timestamp when the event was last updated. */
|
|
13571
13571
|
updatedAt: string;
|
|
13572
|
+
/** Who can see the event. Defaults to `private`. */
|
|
13573
|
+
visibility: "private" | "public";
|
|
13572
13574
|
/** Timestamp when the event was soft-deleted; omitted when it was not. */
|
|
13573
13575
|
deletedAt?: string | null;
|
|
13574
13576
|
} | /** status 201 Event created */ {
|
|
@@ -13582,7 +13584,7 @@ type CreateEventApiResponse =
|
|
|
13582
13584
|
category: string;
|
|
13583
13585
|
/** Human-readable summary of what happened. */
|
|
13584
13586
|
description: string;
|
|
13585
|
-
/** Event-specific details; the structure varies by event kind. `null` when the producer attached none. It stays a free-form map; design events fill it with a named shape: RelationshipEvaluationEventMetadata (category `relationship`, action `evaluation`), DesignValidationEventMetadata (category `pattern`, actions `validate`, `deploy`, `undeploy`, `dry-run`) and DesignSavedEventMetadata (category `pattern`, actions `create`, `update`); DesignEventIdentity names the design. Never put design contents into event metadata - no `designFile`, `patternFile`, `components`, `relationships`, `trace`, `evaluationResponse`, the raw `summary` or `validationResult`. Meshery Server applies a 16 KB guard that drops oversized metadata down to the identity fields (`designId`, `designName`, `designVersion`, `designLink`, `viewLink`). On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed; a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Older Meshery Cloud rows may carry the legacy `design_name` and `view_link` keys; readers should fall back to them when `designName` and `viewLink` are absent.
|
|
13587
|
+
/** Event-specific details; the structure varies by event kind. `null` when the producer attached none. It stays a free-form map; design events fill it with a named shape: RelationshipEvaluationEventMetadata (category `relationship`, action `evaluation`), DesignValidationEventMetadata (category `pattern`, actions `validate`, `deploy`, `undeploy`, `dry-run`) and DesignSavedEventMetadata (category `pattern`, actions `create`, `update`); ScheduleCompletedEventMetadata (category `schedule`, action `completed`); DesignEventIdentity names the design. Never put design contents into event metadata - no `designFile`, `patternFile`, `components`, `relationships`, `trace`, `evaluationResponse`, the raw `summary` or `validationResult`. Meshery Server applies a 16 KB guard that drops oversized metadata down to the identity fields (`designId`, `designName`, `designVersion`, `designLink`, `viewLink`). On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed; a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Older Meshery Cloud rows may carry the legacy `design_name` and `view_link` keys; readers should fall back to them when `designName` and `viewLink` are absent.
|
|
13586
13588
|
*/
|
|
13587
13589
|
metadata: {
|
|
13588
13590
|
[key: string]: any;
|
|
@@ -13606,6 +13608,8 @@ type CreateEventApiResponse =
|
|
|
13606
13608
|
createdAt: string;
|
|
13607
13609
|
/** Timestamp when the event was last updated. */
|
|
13608
13610
|
updatedAt: string;
|
|
13611
|
+
/** Who can see the event. Defaults to `private`. */
|
|
13612
|
+
visibility: "private" | "public";
|
|
13609
13613
|
/** Timestamp when the event was soft-deleted; omitted when it was not. */
|
|
13610
13614
|
deletedAt?: string | null;
|
|
13611
13615
|
};
|
|
@@ -13615,6 +13619,8 @@ type CreateEventApiArg = {
|
|
|
13615
13619
|
owner?: string;
|
|
13616
13620
|
/** The category of the event. */
|
|
13617
13621
|
category?: string;
|
|
13622
|
+
/** Who can see the event. `private` is the default; clients may set `public` for events eligible for the unauthenticated feed. */
|
|
13623
|
+
visibility?: "private" | "public";
|
|
13618
13624
|
/** The action of the event. */
|
|
13619
13625
|
action?: string;
|
|
13620
13626
|
/** Description of the event. */
|