@slipway-systems/sdk 0.0.0 → 0.2.0

package/dist/gen/slipway/v1/notifications_pb.d.ts

@@ -0,0 +1,324 @@
+import type { GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
+import type { Timestamp } from "@bufbuild/protobuf/wkt";
+import type { PageRequest, PageResponse } from "./common_pb.js";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file slipway/v1/notifications.proto.
+ */
+export declare const file_slipway_v1_notifications: GenFile;
+/**
+ * Notification is one inbox entry.
+ *
+ * @generated from message slipway.v1.Notification
+ */
+export type Notification = Message<"slipway.v1.Notification"> & {
+    /**
+     * ntf_…
+     *
+     * @generated from field: string id = 1;
+     */
+    id: string;
+    /**
+     * run.failed, run.fixed, deployment.waiting_approval, deployment.finished, runner.offline, billing.usage
+     *
+     * @generated from field: string event = 2;
+     */
+    event: string;
+    /**
+     * the domain event that produced it (evt_…)
+     *
+     * @generated from field: string event_id = 3;
+     */
+    eventId: string;
+    /**
+     * @generated from field: string title = 4;
+     */
+    title: string;
+    /**
+     * @generated from field: string body = 5;
+     */
+    body: string;
+    /**
+     * app path to open, empty when there is nothing to open
+     *
+     * @generated from field: string href = 6;
+     */
+    href: string;
+    /**
+     * @generated from field: google.protobuf.Timestamp created_at = 7;
+     */
+    createdAt?: Timestamp | undefined;
+    /**
+     * unset while unread
+     *
+     * @generated from field: google.protobuf.Timestamp read_at = 8;
+     */
+    readAt?: Timestamp | undefined;
+};
+/**
+ * Describes the message slipway.v1.Notification.
+ * Use `create(NotificationSchema)` to create a new message.
+ */
+export declare const NotificationSchema: GenMessage<Notification>;
+/**
+ * @generated from message slipway.v1.ListNotificationsRequest
+ */
+export type ListNotificationsRequest = Message<"slipway.v1.ListNotificationsRequest"> & {
+    /**
+     * @generated from field: slipway.v1.PageRequest page = 1;
+     */
+    page?: PageRequest | undefined;
+    /**
+     * @generated from field: bool unread_only = 2;
+     */
+    unreadOnly: boolean;
+};
+/**
+ * Describes the message slipway.v1.ListNotificationsRequest.
+ * Use `create(ListNotificationsRequestSchema)` to create a new message.
+ */
+export declare const ListNotificationsRequestSchema: GenMessage<ListNotificationsRequest>;
+/**
+ * @generated from message slipway.v1.ListNotificationsResponse
+ */
+export type ListNotificationsResponse = Message<"slipway.v1.ListNotificationsResponse"> & {
+    /**
+     * @generated from field: repeated slipway.v1.Notification items = 1;
+     */
+    items: Notification[];
+    /**
+     * @generated from field: slipway.v1.PageResponse page = 2;
+     */
+    page?: PageResponse | undefined;
+    /**
+     * unread count in the organisation, independent of the page
+     *
+     * @generated from field: int32 unread = 3;
+     */
+    unread: number;
+};
+/**
+ * Describes the message slipway.v1.ListNotificationsResponse.
+ * Use `create(ListNotificationsResponseSchema)` to create a new message.
+ */
+export declare const ListNotificationsResponseSchema: GenMessage<ListNotificationsResponse>;
+/**
+ * @generated from message slipway.v1.MarkNotificationsReadRequest
+ */
+export type MarkNotificationsReadRequest = Message<"slipway.v1.MarkNotificationsReadRequest"> & {
+    /**
+     * empty with all=true marks every unread notification
+     *
+     * @generated from field: repeated string ids = 1;
+     */
+    ids: string[];
+    /**
+     * @generated from field: bool all = 2;
+     */
+    all: boolean;
+};
+/**
+ * Describes the message slipway.v1.MarkNotificationsReadRequest.
+ * Use `create(MarkNotificationsReadRequestSchema)` to create a new message.
+ */
+export declare const MarkNotificationsReadRequestSchema: GenMessage<MarkNotificationsReadRequest>;
+/**
+ * @generated from message slipway.v1.MarkNotificationsReadResponse
+ */
+export type MarkNotificationsReadResponse = Message<"slipway.v1.MarkNotificationsReadResponse"> & {
+    /**
+     * @generated from field: int32 marked = 1;
+     */
+    marked: number;
+};
+/**
+ * Describes the message slipway.v1.MarkNotificationsReadResponse.
+ * Use `create(MarkNotificationsReadResponseSchema)` to create a new message.
+ */
+export declare const MarkNotificationsReadResponseSchema: GenMessage<MarkNotificationsReadResponse>;
+/**
+ * WatchNotifications streams inbox changes: the current unread count on connect, then an update whenever a
+ * notification is added or read.
+ *
+ * @generated from message slipway.v1.WatchNotificationsRequest
+ */
+export type WatchNotificationsRequest = Message<"slipway.v1.WatchNotificationsRequest"> & {};
+/**
+ * Describes the message slipway.v1.WatchNotificationsRequest.
+ * Use `create(WatchNotificationsRequestSchema)` to create a new message.
+ */
+export declare const WatchNotificationsRequestSchema: GenMessage<WatchNotificationsRequest>;
+/**
+ * @generated from message slipway.v1.WatchNotificationsResponse
+ */
+export type WatchNotificationsResponse = Message<"slipway.v1.WatchNotificationsResponse"> & {
+    /**
+     * @generated from field: int32 unread = 1;
+     */
+    unread: number;
+    /**
+     * set when a new notification arrived
+     *
+     * @generated from field: slipway.v1.Notification added = 2;
+     */
+    added?: Notification | undefined;
+};
+/**
+ * Describes the message slipway.v1.WatchNotificationsResponse.
+ * Use `create(WatchNotificationsResponseSchema)` to create a new message.
+ */
+export declare const WatchNotificationsResponseSchema: GenMessage<WatchNotificationsResponse>;
+/**
+ * NotificationPreference is one event's delivery choice.
+ *
+ * @generated from message slipway.v1.NotificationPreference
+ */
+export type NotificationPreference = Message<"slipway.v1.NotificationPreference"> & {
+    /**
+     * @generated from field: string event = 1;
+     */
+    event: string;
+    /**
+     * @generated from field: bool in_app = 2;
+     */
+    inApp: boolean;
+    /**
+     * @generated from field: bool email = 3;
+     */
+    email: boolean;
+};
+/**
+ * Describes the message slipway.v1.NotificationPreference.
+ * Use `create(NotificationPreferenceSchema)` to create a new message.
+ */
+export declare const NotificationPreferenceSchema: GenMessage<NotificationPreference>;
+/**
+ * NotificationEvent describes an event the user can subscribe to.
+ *
+ * @generated from message slipway.v1.NotificationEvent
+ */
+export type NotificationEvent = Message<"slipway.v1.NotificationEvent"> & {
+    /**
+     * @generated from field: string id = 1;
+     */
+    id: string;
+    /**
+     * @generated from field: string label = 2;
+     */
+    label: string;
+    /**
+     * @generated from field: string description = 3;
+     */
+    description: string;
+};
+/**
+ * Describes the message slipway.v1.NotificationEvent.
+ * Use `create(NotificationEventSchema)` to create a new message.
+ */
+export declare const NotificationEventSchema: GenMessage<NotificationEvent>;
+/**
+ * @generated from message slipway.v1.GetNotificationPreferencesRequest
+ */
+export type GetNotificationPreferencesRequest = Message<"slipway.v1.GetNotificationPreferencesRequest"> & {};
+/**
+ * Describes the message slipway.v1.GetNotificationPreferencesRequest.
+ * Use `create(GetNotificationPreferencesRequestSchema)` to create a new message.
+ */
+export declare const GetNotificationPreferencesRequestSchema: GenMessage<GetNotificationPreferencesRequest>;
+/**
+ * @generated from message slipway.v1.GetNotificationPreferencesResponse
+ */
+export type GetNotificationPreferencesResponse = Message<"slipway.v1.GetNotificationPreferencesResponse"> & {
+    /**
+     * one per known event, defaults filled in
+     *
+     * @generated from field: repeated slipway.v1.NotificationPreference preferences = 1;
+     */
+    preferences: NotificationPreference[];
+    /**
+     * the catalogue, in display order
+     *
+     * @generated from field: repeated slipway.v1.NotificationEvent events = 2;
+     */
+    events: NotificationEvent[];
+};
+/**
+ * Describes the message slipway.v1.GetNotificationPreferencesResponse.
+ * Use `create(GetNotificationPreferencesResponseSchema)` to create a new message.
+ */
+export declare const GetNotificationPreferencesResponseSchema: GenMessage<GetNotificationPreferencesResponse>;
+/**
+ * @generated from message slipway.v1.UpdateNotificationPreferencesRequest
+ */
+export type UpdateNotificationPreferencesRequest = Message<"slipway.v1.UpdateNotificationPreferencesRequest"> & {
+    /**
+     * events not listed keep their stored (or default) value
+     *
+     * @generated from field: repeated slipway.v1.NotificationPreference preferences = 1;
+     */
+    preferences: NotificationPreference[];
+};
+/**
+ * Describes the message slipway.v1.UpdateNotificationPreferencesRequest.
+ * Use `create(UpdateNotificationPreferencesRequestSchema)` to create a new message.
+ */
+export declare const UpdateNotificationPreferencesRequestSchema: GenMessage<UpdateNotificationPreferencesRequest>;
+/**
+ * @generated from message slipway.v1.UpdateNotificationPreferencesResponse
+ */
+export type UpdateNotificationPreferencesResponse = Message<"slipway.v1.UpdateNotificationPreferencesResponse"> & {
+    /**
+     * @generated from field: repeated slipway.v1.NotificationPreference preferences = 1;
+     */
+    preferences: NotificationPreference[];
+};
+/**
+ * Describes the message slipway.v1.UpdateNotificationPreferencesResponse.
+ * Use `create(UpdateNotificationPreferencesResponseSchema)` to create a new message.
+ */
+export declare const UpdateNotificationPreferencesResponseSchema: GenMessage<UpdateNotificationPreferencesResponse>;
+/**
+ * @generated from service slipway.v1.NotificationService
+ */
+export declare const NotificationService: GenService<{
+    /**
+     * @generated from rpc slipway.v1.NotificationService.ListNotifications
+     */
+    listNotifications: {
+        methodKind: "unary";
+        input: typeof ListNotificationsRequestSchema;
+        output: typeof ListNotificationsResponseSchema;
+    };
+    /**
+     * @generated from rpc slipway.v1.NotificationService.MarkNotificationsRead
+     */
+    markNotificationsRead: {
+        methodKind: "unary";
+        input: typeof MarkNotificationsReadRequestSchema;
+        output: typeof MarkNotificationsReadResponseSchema;
+    };
+    /**
+     * @generated from rpc slipway.v1.NotificationService.WatchNotifications
+     */
+    watchNotifications: {
+        methodKind: "server_streaming";
+        input: typeof WatchNotificationsRequestSchema;
+        output: typeof WatchNotificationsResponseSchema;
+    };
+    /**
+     * @generated from rpc slipway.v1.NotificationService.GetNotificationPreferences
+     */
+    getNotificationPreferences: {
+        methodKind: "unary";
+        input: typeof GetNotificationPreferencesRequestSchema;
+        output: typeof GetNotificationPreferencesResponseSchema;
+    };
+    /**
+     * @generated from rpc slipway.v1.NotificationService.UpdateNotificationPreferences
+     */
+    updateNotificationPreferences: {
+        methodKind: "unary";
+        input: typeof UpdateNotificationPreferencesRequestSchema;
+        output: typeof UpdateNotificationPreferencesResponseSchema;
+    };
+}>;

package/dist/gen/slipway/v1/notifications_pb.js

@@ -0,0 +1,79 @@
+// @generated by protoc-gen-es v2.16.0 with parameter "target=ts,import_extension=js"
+// @generated from file slipway/v1/notifications.proto (package slipway.v1, syntax proto3)
+/* eslint-disable */
+import { fileDesc, messageDesc, serviceDesc } from "@bufbuild/protobuf/codegenv2";
+import { file_google_protobuf_timestamp } from "@bufbuild/protobuf/wkt";
+import { file_slipway_v1_common } from "./common_pb.js";
+/**
+ * Describes the file slipway/v1/notifications.proto.
+ */
+export const file_slipway_v1_notifications = /*@__PURE__*/ fileDesc("Ch5zbGlwd2F5L3YxL25vdGlmaWNhdGlvbnMucHJvdG8SCnNsaXB3YXkudjEiwwEKDE5vdGlmaWNhdGlvbhIKCgJpZBgBIAEoCRINCgVldmVudBgCIAEoCRIQCghldmVudF9pZBgDIAEoCRINCgV0aXRsZRgEIAEoCRIMCgRib2R5GAUgASgJEgwKBGhyZWYYBiABKAkSLgoKY3JlYXRlZF9hdBgHIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXASKwoHcmVhZF9hdBgIIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXAiVgoYTGlzdE5vdGlmaWNhdGlvbnNSZXF1ZXN0EiUKBHBhZ2UYASABKAsyFy5zbGlwd2F5LnYxLlBhZ2VSZXF1ZXN0EhMKC3VucmVhZF9vbmx5GAIgASgIInwKGUxpc3ROb3RpZmljYXRpb25zUmVzcG9uc2USJwoFaXRlbXMYASADKAsyGC5zbGlwd2F5LnYxLk5vdGlmaWNhdGlvbhImCgRwYWdlGAIgASgLMhguc2xpcHdheS52MS5QYWdlUmVzcG9uc2USDgoGdW5yZWFkGAMgASgFIjgKHE1hcmtOb3RpZmljYXRpb25zUmVhZFJlcXVlc3QSCwoDaWRzGAEgAygJEgsKA2FsbBgCIAEoCCIvCh1NYXJrTm90aWZpY2F0aW9uc1JlYWRSZXNwb25zZRIOCgZtYXJrZWQYASABKAUiGwoZV2F0Y2hOb3RpZmljYXRpb25zUmVxdWVzdCJVChpXYXRjaE5vdGlmaWNhdGlvbnNSZXNwb25zZRIOCgZ1bnJlYWQYASABKAUSJwoFYWRkZWQYAiABKAsyGC5zbGlwd2F5LnYxLk5vdGlmaWNhdGlvbiJGChZOb3RpZmljYXRpb25QcmVmZXJlbmNlEg0KBWV2ZW50GAEgASgJEg4KBmluX2FwcBgCIAEoCBINCgVlbWFpbBgDIAEoCCJDChFOb3RpZmljYXRpb25FdmVudBIKCgJpZBgBIAEoCRINCgVsYWJlbBgCIAEoCRITCgtkZXNjcmlwdGlvbhgDIAEoCSIjCiFHZXROb3RpZmljYXRpb25QcmVmZXJlbmNlc1JlcXVlc3QijAEKIkdldE5vdGlmaWNhdGlvblByZWZlcmVuY2VzUmVzcG9uc2USNwoLcHJlZmVyZW5jZXMYASADKAsyIi5zbGlwd2F5LnYxLk5vdGlmaWNhdGlvblByZWZlcmVuY2USLQoGZXZlbnRzGAIgAygLMh0uc2xpcHdheS52MS5Ob3RpZmljYXRpb25FdmVudCJfCiRVcGRhdGVOb3RpZmljYXRpb25QcmVmZXJlbmNlc1JlcXVlc3QSNwoLcHJlZmVyZW5jZXMYASADKAsyIi5zbGlwd2F5LnYxLk5vdGlmaWNhdGlvblByZWZlcmVuY2UiYAolVXBkYXRlTm90aWZpY2F0aW9uUHJlZmVyZW5jZXNSZXNwb25zZRI3CgtwcmVmZXJlbmNlcxgBIAMoCzIiLnNsaXB3YXkudjEuTm90aWZpY2F0aW9uUHJlZmVyZW5jZTLQBAoTTm90aWZpY2F0aW9uU2VydmljZRJgChFMaXN0Tm90aWZpY2F0aW9ucxIkLnNsaXB3YXkudjEuTGlzdE5vdGlmaWNhdGlvbnNSZXF1ZXN0GiUuc2xpcHdheS52MS5MaXN0Tm90aWZpY2F0aW9uc1Jlc3BvbnNlEmwKFU1hcmtOb3RpZmljYXRpb25zUmVhZBIoLnNsaXB3YXkudjEuTWFya05vdGlmaWNhdGlvbnNSZWFkUmVxdWVzdBopLnNsaXB3YXkudjEuTWFya05vdGlmaWNhdGlvbnNSZWFkUmVzcG9uc2USZQoSV2F0Y2hOb3RpZmljYXRpb25zEiUuc2xpcHdheS52MS5XYXRjaE5vdGlmaWNhdGlvbnNSZXF1ZXN0GiYuc2xpcHdheS52MS5XYXRjaE5vdGlmaWNhdGlvbnNSZXNwb25zZTABEnsKGkdldE5vdGlmaWNhdGlvblByZWZlcmVuY2VzEi0uc2xpcHdheS52MS5HZXROb3RpZmljYXRpb25QcmVmZXJlbmNlc1JlcXVlc3QaLi5zbGlwd2F5LnYxLkdldE5vdGlmaWNhdGlvblByZWZlcmVuY2VzUmVzcG9uc2UShAEKHVVwZGF0ZU5vdGlmaWNhdGlvblByZWZlcmVuY2VzEjAuc2xpcHdheS52MS5VcGRhdGVOb3RpZmljYXRpb25QcmVmZXJlbmNlc1JlcXVlc3QaMS5zbGlwd2F5LnYxLlVwZGF0ZU5vdGlmaWNhdGlvblByZWZlcmVuY2VzUmVzcG9uc2VCrQEKDmNvbS5zbGlwd2F5LnYxQhJOb3RpZmljYXRpb25zUHJvdG9QAVo+Z2l0aHViLmNvbS9zbGlwd2F5LXN5c3RlbXMvc2xpcHdheS1zZGsvZ28vc2xpcHdheS92MTtzbGlwd2F5djGiAgNTWFiqAgpTbGlwd2F5LlYxygIKU2xpcHdheVxWMeICFlNsaXB3YXlcVjFcR1BCTWV0YWRhdGHqAgtTbGlwd2F5OjpWMWIGcHJvdG8z", [file_google_protobuf_timestamp, file_slipway_v1_common]);
+/**
+ * Describes the message slipway.v1.Notification.
+ * Use `create(NotificationSchema)` to create a new message.
+ */
+export const NotificationSchema = /*@__PURE__*/ messageDesc(file_slipway_v1_notifications, 0);
+/**
+ * Describes the message slipway.v1.ListNotificationsRequest.
+ * Use `create(ListNotificationsRequestSchema)` to create a new message.
+ */
+export const ListNotificationsRequestSchema = /*@__PURE__*/ messageDesc(file_slipway_v1_notifications, 1);
+/**
+ * Describes the message slipway.v1.ListNotificationsResponse.
+ * Use `create(ListNotificationsResponseSchema)` to create a new message.
+ */
+export const ListNotificationsResponseSchema = /*@__PURE__*/ messageDesc(file_slipway_v1_notifications, 2);
+/**
+ * Describes the message slipway.v1.MarkNotificationsReadRequest.
+ * Use `create(MarkNotificationsReadRequestSchema)` to create a new message.
+ */
+export const MarkNotificationsReadRequestSchema = /*@__PURE__*/ messageDesc(file_slipway_v1_notifications, 3);
+/**
+ * Describes the message slipway.v1.MarkNotificationsReadResponse.
+ * Use `create(MarkNotificationsReadResponseSchema)` to create a new message.
+ */
+export const MarkNotificationsReadResponseSchema = /*@__PURE__*/ messageDesc(file_slipway_v1_notifications, 4);
+/**
+ * Describes the message slipway.v1.WatchNotificationsRequest.
+ * Use `create(WatchNotificationsRequestSchema)` to create a new message.
+ */
+export const WatchNotificationsRequestSchema = /*@__PURE__*/ messageDesc(file_slipway_v1_notifications, 5);
+/**
+ * Describes the message slipway.v1.WatchNotificationsResponse.
+ * Use `create(WatchNotificationsResponseSchema)` to create a new message.
+ */
+export const WatchNotificationsResponseSchema = /*@__PURE__*/ messageDesc(file_slipway_v1_notifications, 6);
+/**
+ * Describes the message slipway.v1.NotificationPreference.
+ * Use `create(NotificationPreferenceSchema)` to create a new message.
+ */
+export const NotificationPreferenceSchema = /*@__PURE__*/ messageDesc(file_slipway_v1_notifications, 7);
+/**
+ * Describes the message slipway.v1.NotificationEvent.
+ * Use `create(NotificationEventSchema)` to create a new message.
+ */
+export const NotificationEventSchema = /*@__PURE__*/ messageDesc(file_slipway_v1_notifications, 8);
+/**
+ * Describes the message slipway.v1.GetNotificationPreferencesRequest.
+ * Use `create(GetNotificationPreferencesRequestSchema)` to create a new message.
+ */
+export const GetNotificationPreferencesRequestSchema = /*@__PURE__*/ messageDesc(file_slipway_v1_notifications, 9);
+/**
+ * Describes the message slipway.v1.GetNotificationPreferencesResponse.
+ * Use `create(GetNotificationPreferencesResponseSchema)` to create a new message.
+ */
+export const GetNotificationPreferencesResponseSchema = /*@__PURE__*/ messageDesc(file_slipway_v1_notifications, 10);
+/**
+ * Describes the message slipway.v1.UpdateNotificationPreferencesRequest.
+ * Use `create(UpdateNotificationPreferencesRequestSchema)` to create a new message.
+ */
+export const UpdateNotificationPreferencesRequestSchema = /*@__PURE__*/ messageDesc(file_slipway_v1_notifications, 11);
+/**
+ * Describes the message slipway.v1.UpdateNotificationPreferencesResponse.
+ * Use `create(UpdateNotificationPreferencesResponseSchema)` to create a new message.
+ */
+export const UpdateNotificationPreferencesResponseSchema = /*@__PURE__*/ messageDesc(file_slipway_v1_notifications, 12);
+/**
+ * @generated from service slipway.v1.NotificationService
+ */
+export const NotificationService = /*@__PURE__*/ serviceDesc(file_slipway_v1_notifications, 0);