@leaflow/sdk 0.0.0-dev.451.gfd4baf5 → 0.0.0-dev.455.ge99314c

package/dist/proto/leaflow/fleet/printing/v1/printing_pb.d.ts

@@ -0,0 +1,741 @@
+import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import type { Status } from "../../../../google/rpc/status_pb.js";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file leaflow/fleet/printing/v1/printing.proto.
+ */
+export declare const file_leaflow_fleet_printing_v1_printing: GenFile;
+/**
+ * A message from the participant on the printing channel.
+ *
+ * @generated from message leaflow.fleet.printing.v1.ClientMessage
+ */
+export type ClientMessage = Message<"leaflow.fleet.printing.v1.ClientMessage"> & {
+    /**
+     * The message.
+     *
+     * @generated from oneof leaflow.fleet.printing.v1.ClientMessage.message
+     */
+    message: {
+        /**
+         * The printers the participant shares now, in full.
+         *
+         * @generated from field: leaflow.fleet.printing.v1.PrinterList printer_list = 1;
+         */
+        value: PrinterList;
+        case: "printerList";
+    } | {
+        /**
+         * The participant accepts or refuses a job.
+         *
+         * @generated from field: leaflow.fleet.printing.v1.PrintJobCreateResponse job_create_response = 2;
+         */
+        value: PrintJobCreateResponse;
+        case: "jobCreateResponse";
+    } | {
+        /**
+         * What became of a job.
+         *
+         * @generated from field: leaflow.fleet.printing.v1.PrintJobStatus job_status = 3;
+         */
+        value: PrintJobStatus;
+        case: "jobStatus";
+    } | {
+        /**
+         * The participant cancelled a job, such as at its person's request.
+         *
+         * @generated from field: leaflow.fleet.printing.v1.PrintJobCancel job_cancel = 4;
+         */
+        value: PrintJobCancel;
+        case: "jobCancel";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+};
+/**
+ * Describes the message leaflow.fleet.printing.v1.ClientMessage.
+ * Use `create(ClientMessageSchema)` to create a new message.
+ */
+export declare const ClientMessageSchema: GenMessage<ClientMessage>;
+/**
+ * A message from the session on the printing channel.
+ *
+ * @generated from message leaflow.fleet.printing.v1.ServerMessage
+ */
+export type ServerMessage = Message<"leaflow.fleet.printing.v1.ServerMessage"> & {
+    /**
+     * The message.
+     *
+     * @generated from oneof leaflow.fleet.printing.v1.ServerMessage.message
+     */
+    message: {
+        /**
+         * The session applied a PrinterList.
+         *
+         * @generated from field: leaflow.fleet.printing.v1.PrinterListResponse printer_list_response = 1;
+         */
+        value: PrinterListResponse;
+        case: "printerListResponse";
+    } | {
+        /**
+         * An application printed a document.
+         *
+         * @generated from field: leaflow.fleet.printing.v1.PrintJobCreate job_create = 2;
+         */
+        value: PrintJobCreate;
+        case: "jobCreate";
+    } | {
+        /**
+         * The participant may submit a job it stored.
+         *
+         * @generated from field: leaflow.fleet.printing.v1.PrintJobSubmit job_submit = 3;
+         */
+        value: PrintJobSubmit;
+        case: "jobSubmit";
+    } | {
+        /**
+         * An application cancelled a job.
+         *
+         * @generated from field: leaflow.fleet.printing.v1.PrintJobCancel job_cancel = 4;
+         */
+        value: PrintJobCancel;
+        case: "jobCancel";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+};
+/**
+ * Describes the message leaflow.fleet.printing.v1.ServerMessage.
+ * Use `create(ServerMessageSchema)` to create a new message.
+ */
+export declare const ServerMessageSchema: GenMessage<ServerMessage>;
+/**
+ * The printers the participant shares, replacing the previous list.
+ *
+ * @generated from message leaflow.fleet.printing.v1.PrinterList
+ */
+export type PrinterList = Message<"leaflow.fleet.printing.v1.PrinterList"> & {
+    /**
+     * At most PrintingPolicy.max_printers.
+     *
+     * @generated from field: repeated leaflow.fleet.printing.v1.Printer printers = 1;
+     */
+    printers: Printer[];
+};
+/**
+ * Describes the message leaflow.fleet.printing.v1.PrinterList.
+ * Use `create(PrinterListSchema)` to create a new message.
+ */
+export declare const PrinterListSchema: GenMessage<PrinterList>;
+/**
+ * The session applied a PrinterList.
+ *
+ * @generated from message leaflow.fleet.printing.v1.PrinterListResponse
+ */
+export type PrinterListResponse = Message<"leaflow.fleet.printing.v1.PrinterListResponse"> & {
+    /**
+     * Why it refused the list, such as for more printers than allowed. Unset
+     * on success.
+     *
+     * @generated from field: google.rpc.Status error = 1;
+     */
+    error?: Status | undefined;
+};
+/**
+ * Describes the message leaflow.fleet.printing.v1.PrinterListResponse.
+ * Use `create(PrinterListResponseSchema)` to create a new message.
+ */
+export declare const PrinterListResponseSchema: GenMessage<PrinterListResponse>;
+/**
+ * A printer of the participant.
+ *
+ * @generated from message leaflow.fleet.printing.v1.Printer
+ */
+export type Printer = Message<"leaflow.fleet.printing.v1.Printer"> & {
+    /**
+     * Chosen by the participant, never reused on the connection.
+     *
+     * @generated from field: string printer_id = 1;
+     */
+    printerId: string;
+    /**
+     * Its name for people (printer-name), at most 256 bytes. Plain text.
+     *
+     * @generated from field: string name = 2;
+     */
+    name: string;
+    /**
+     * Its state (printer-state).
+     *
+     * @generated from field: leaflow.fleet.printing.v1.PrinterState state = 3;
+     */
+    state: PrinterState;
+    /**
+     * It accepts jobs now (printer-is-accepting-jobs).
+     *
+     * @generated from field: bool accepting_jobs = 4;
+     */
+    acceptingJobs: boolean;
+    /**
+     * The paper it has (media-supported).
+     *
+     * @generated from field: repeated leaflow.fleet.printing.v1.PrintMedia media = 5;
+     */
+    media: PrintMedia[];
+    /**
+     * How it can use the sides of the paper (sides-supported).
+     *
+     * @generated from field: repeated leaflow.fleet.printing.v1.Sides sides = 6;
+     */
+    sides: Sides[];
+    /**
+     * Its resolutions (printer-resolution-supported).
+     *
+     * @generated from field: repeated leaflow.fleet.printing.v1.PrintResolution resolutions = 7;
+     */
+    resolutions: PrintResolution[];
+    /**
+     * It prints in colour (print-color-mode-supported has "color").
+     *
+     * @generated from field: bool color_supported = 8;
+     */
+    colorSupported: boolean;
+    /**
+     * The most copies of one job (copies-supported).
+     *
+     * @generated from field: uint32 max_copies = 9;
+     */
+    maxCopies: number;
+    /**
+     * The document formats it takes (document-format-supported), such as
+     * "application/pdf".
+     *
+     * @generated from field: repeated string document_mime_types = 10;
+     */
+    documentMimeTypes: string[];
+};
+/**
+ * Describes the message leaflow.fleet.printing.v1.Printer.
+ * Use `create(PrinterSchema)` to create a new message.
+ */
+export declare const PrinterSchema: GenMessage<Printer>;
+/**
+ * A paper size (media).
+ *
+ * @generated from message leaflow.fleet.printing.v1.PrintMedia
+ */
+export type PrintMedia = Message<"leaflow.fleet.printing.v1.PrintMedia"> & {
+    /**
+     * Its self-describing name (PWG 5101.1), such as "iso_a4_210x297mm".
+     *
+     * @generated from field: string media_id = 1;
+     */
+    mediaId: string;
+    /**
+     * Its width in hundredths of a millimetre.
+     *
+     * @generated from field: uint32 width = 2;
+     */
+    width: number;
+    /**
+     * Its height in hundredths of a millimetre.
+     *
+     * @generated from field: uint32 height = 3;
+     */
+    height: number;
+};
+/**
+ * Describes the message leaflow.fleet.printing.v1.PrintMedia.
+ * Use `create(PrintMediaSchema)` to create a new message.
+ */
+export declare const PrintMediaSchema: GenMessage<PrintMedia>;
+/**
+ * A resolution (printer-resolution).
+ *
+ * @generated from message leaflow.fleet.printing.v1.PrintResolution
+ */
+export type PrintResolution = Message<"leaflow.fleet.printing.v1.PrintResolution"> & {
+    /**
+     * Dots per inch across.
+     *
+     * @generated from field: uint32 x_dpi = 1;
+     */
+    xDpi: number;
+    /**
+     * Dots per inch down.
+     *
+     * @generated from field: uint32 y_dpi = 2;
+     */
+    yDpi: number;
+};
+/**
+ * Describes the message leaflow.fleet.printing.v1.PrintResolution.
+ * Use `create(PrintResolutionSchema)` to create a new message.
+ */
+export declare const PrintResolutionSchema: GenMessage<PrintResolution>;
+/**
+ * How to print a job.
+ *
+ * @generated from message leaflow.fleet.printing.v1.PrintOptions
+ */
+export type PrintOptions = Message<"leaflow.fleet.printing.v1.PrintOptions"> & {
+    /**
+     * PrintMedia.media_id of the paper.
+     *
+     * @generated from field: string media_id = 1;
+     */
+    mediaId: string;
+    /**
+     * How to use the sides of the paper.
+     *
+     * @generated from field: leaflow.fleet.printing.v1.Sides sides = 2;
+     */
+    sides: Sides;
+    /**
+     * Prints in colour; otherwise monochrome (print-color-mode).
+     *
+     * @generated from field: bool color = 3;
+     */
+    color: boolean;
+    /**
+     * The number of copies (copies).
+     *
+     * @generated from field: uint32 copies = 4;
+     */
+    copies: number;
+    /**
+     * The resolution. Unset: the printer's default.
+     *
+     * @generated from field: leaflow.fleet.printing.v1.PrintResolution resolution = 5;
+     */
+    resolution?: PrintResolution | undefined;
+};
+/**
+ * Describes the message leaflow.fleet.printing.v1.PrintOptions.
+ * Use `create(PrintOptionsSchema)` to create a new message.
+ */
+export declare const PrintOptionsSchema: GenMessage<PrintOptions>;
+/**
+ * An application printed a document, which the session has spooled whole.
+ *
+ * @generated from message leaflow.fleet.printing.v1.PrintJobCreate
+ */
+export type PrintJobCreate = Message<"leaflow.fleet.printing.v1.PrintJobCreate"> & {
+    /**
+     * Chosen by the session, unique on the connection.
+     *
+     * @generated from field: string job_id = 1;
+     */
+    jobId: string;
+    /**
+     * The printer.
+     *
+     * @generated from field: string printer_id = 2;
+     */
+    printerId: string;
+    /**
+     * The name the application gave it (job-name). Plain text.
+     *
+     * @generated from field: string name = 3;
+     */
+    name: string;
+    /**
+     * The size of the document, at most PrintingPolicy.max_document_size_bytes.
+     *
+     * @generated from field: uint64 document_size_bytes = 4;
+     */
+    documentSizeBytes: bigint;
+    /**
+     * Its format: "application/pdf".
+     *
+     * @generated from field: string document_mime_type = 5;
+     */
+    documentMimeType: string;
+    /**
+     * How to print it.
+     *
+     * @generated from field: leaflow.fleet.printing.v1.PrintOptions options = 6;
+     */
+    options?: PrintOptions | undefined;
+};
+/**
+ * Describes the message leaflow.fleet.printing.v1.PrintJobCreate.
+ * Use `create(PrintJobCreateSchema)` to create a new message.
+ */
+export declare const PrintJobCreateSchema: GenMessage<PrintJobCreate>;
+/**
+ * The participant accepts or refuses a job.
+ *
+ * @generated from message leaflow.fleet.printing.v1.PrintJobCreateResponse
+ */
+export type PrintJobCreateResponse = Message<"leaflow.fleet.printing.v1.PrintJobCreateResponse"> & {
+    /**
+     * The job.
+     *
+     * @generated from field: string job_id = 1;
+     */
+    jobId: string;
+    /**
+     * Why the participant refused it, such as an unknown printer, unsupported
+     * options or too many jobs. Unset when it accepted it.
+     *
+     * @generated from field: google.rpc.Status error = 2;
+     */
+    error?: Status | undefined;
+};
+/**
+ * Describes the message leaflow.fleet.printing.v1.PrintJobCreateResponse.
+ * Use `create(PrintJobCreateResponseSchema)` to create a new message.
+ */
+export declare const PrintJobCreateResponseSchema: GenMessage<PrintJobCreateResponse>;
+/**
+ * The participant may submit a job it stored.
+ *
+ * @generated from message leaflow.fleet.printing.v1.PrintJobSubmit
+ */
+export type PrintJobSubmit = Message<"leaflow.fleet.printing.v1.PrintJobSubmit"> & {
+    /**
+     * The job.
+     *
+     * @generated from field: string job_id = 1;
+     */
+    jobId: string;
+};
+/**
+ * Describes the message leaflow.fleet.printing.v1.PrintJobSubmit.
+ * Use `create(PrintJobSubmitSchema)` to create a new message.
+ */
+export declare const PrintJobSubmitSchema: GenMessage<PrintJobSubmit>;
+/**
+ * A job is cancelled. From either side.
+ *
+ * @generated from message leaflow.fleet.printing.v1.PrintJobCancel
+ */
+export type PrintJobCancel = Message<"leaflow.fleet.printing.v1.PrintJobCancel"> & {
+    /**
+     * The job.
+     *
+     * @generated from field: string job_id = 1;
+     */
+    jobId: string;
+};
+/**
+ * Describes the message leaflow.fleet.printing.v1.PrintJobCancel.
+ * Use `create(PrintJobCancelSchema)` to create a new message.
+ */
+export declare const PrintJobCancelSchema: GenMessage<PrintJobCancel>;
+/**
+ * What became of a job.
+ *
+ * @generated from message leaflow.fleet.printing.v1.PrintJobStatus
+ */
+export type PrintJobStatus = Message<"leaflow.fleet.printing.v1.PrintJobStatus"> & {
+    /**
+     * The job.
+     *
+     * @generated from field: string job_id = 1;
+     */
+    jobId: string;
+    /**
+     * How far the participant got with it.
+     *
+     * @generated from field: leaflow.fleet.printing.v1.PrintJobPhase phase = 2;
+     */
+    phase: PrintJobPhase;
+    /**
+     * Its state in the participant's print queue, once submitted.
+     *
+     * @generated from field: leaflow.fleet.printing.v1.PrintJobState state = 3;
+     */
+    state: PrintJobState;
+    /**
+     * Why it failed. Unset otherwise.
+     *
+     * @generated from field: google.rpc.Status error = 4;
+     */
+    error?: Status | undefined;
+};
+/**
+ * Describes the message leaflow.fleet.printing.v1.PrintJobStatus.
+ * Use `create(PrintJobStatusSchema)` to create a new message.
+ */
+export declare const PrintJobStatusSchema: GenMessage<PrintJobStatus>;
+/**
+ * Asks for the document of an accepted job. The only message the opener of a
+ * document channel sends.
+ *
+ * @generated from message leaflow.fleet.printing.v1.PrintDocumentRequest
+ */
+export type PrintDocumentRequest = Message<"leaflow.fleet.printing.v1.PrintDocumentRequest"> & {
+    /**
+     * The job.
+     *
+     * @generated from field: string job_id = 1;
+     */
+    jobId: string;
+};
+/**
+ * Describes the message leaflow.fleet.printing.v1.PrintDocumentRequest.
+ * Use `create(PrintDocumentRequestSchema)` to create a new message.
+ */
+export declare const PrintDocumentRequestSchema: GenMessage<PrintDocumentRequest>;
+/**
+ * Part of a document, from the session.
+ *
+ * @generated from message leaflow.fleet.printing.v1.PrintDocument
+ */
+export type PrintDocument = Message<"leaflow.fleet.printing.v1.PrintDocument"> & {
+    /**
+     * The part.
+     *
+     * @generated from oneof leaflow.fleet.printing.v1.PrintDocument.part
+     */
+    part: {
+        /**
+         * The next bytes, in order, at most 256 KiB.
+         *
+         * @generated from field: bytes data = 1;
+         */
+        value: Uint8Array;
+        case: "data";
+    } | {
+        /**
+         * The end of the document. The last message.
+         *
+         * @generated from field: leaflow.fleet.printing.v1.PrintDocumentEnd end = 2;
+         */
+        value: PrintDocumentEnd;
+        case: "end";
+    } | {
+        /**
+         * Why the session could not provide it. The last message.
+         *
+         * @generated from field: google.rpc.Status error = 3;
+         */
+        value: Status;
+        case: "error";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+};
+/**
+ * Describes the message leaflow.fleet.printing.v1.PrintDocument.
+ * Use `create(PrintDocumentSchema)` to create a new message.
+ */
+export declare const PrintDocumentSchema: GenMessage<PrintDocument>;
+/**
+ * The end of a document. The participant checks the size and the digest before
+ * storing it.
+ *
+ * @generated from message leaflow.fleet.printing.v1.PrintDocumentEnd
+ */
+export type PrintDocumentEnd = Message<"leaflow.fleet.printing.v1.PrintDocumentEnd"> & {
+    /**
+     * SHA-256 of the whole document, 32 bytes.
+     *
+     * @generated from field: bytes sha256 = 1;
+     */
+    sha256: Uint8Array;
+};
+/**
+ * Describes the message leaflow.fleet.printing.v1.PrintDocumentEnd.
+ * Use `create(PrintDocumentEndSchema)` to create a new message.
+ */
+export declare const PrintDocumentEndSchema: GenMessage<PrintDocumentEnd>;
+/**
+ * What a participant may print. Carried in the participant's signed
+ * authorization; without it the participant shares no printers. It shares
+ * nothing else, such as files or devices.
+ *
+ * @generated from message leaflow.fleet.printing.v1.PrintingPolicy
+ */
+export type PrintingPolicy = Message<"leaflow.fleet.printing.v1.PrintingPolicy"> & {
+    /**
+     * The largest document, at most 128 MiB. 0: no documents.
+     *
+     * @generated from field: uint64 max_document_size_bytes = 1;
+     */
+    maxDocumentSizeBytes: bigint;
+    /**
+     * The most jobs received or submitted at a time, at most 4. 0: no jobs.
+     *
+     * @generated from field: uint32 max_jobs = 2;
+     */
+    maxJobs: number;
+    /**
+     * The most printers shared, at most 16. 0: none.
+     *
+     * @generated from field: uint32 max_printers = 3;
+     */
+    maxPrinters: number;
+};
+/**
+ * Describes the message leaflow.fleet.printing.v1.PrintingPolicy.
+ * Use `create(PrintingPolicySchema)` to create a new message.
+ */
+export declare const PrintingPolicySchema: GenMessage<PrintingPolicy>;
+/**
+ * The state of a printer (printer-state), with the IPP values.
+ *
+ * @generated from enum leaflow.fleet.printing.v1.PrinterState
+ */
+export declare enum PrinterState {
+    /**
+     * @generated from enum value: PRINTER_STATE_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * Ready ("idle").
+     *
+     * @generated from enum value: PRINTER_STATE_IDLE = 3;
+     */
+    IDLE = 3,
+    /**
+     * Printing ("processing").
+     *
+     * @generated from enum value: PRINTER_STATE_PROCESSING = 4;
+     */
+    PROCESSING = 4,
+    /**
+     * Needs attention ("stopped").
+     *
+     * @generated from enum value: PRINTER_STATE_STOPPED = 5;
+     */
+    STOPPED = 5
+}
+/**
+ * Describes the enum leaflow.fleet.printing.v1.PrinterState.
+ */
+export declare const PrinterStateSchema: GenEnum<PrinterState>;
+/**
+ * How to use the sides of the paper (sides).
+ *
+ * @generated from enum leaflow.fleet.printing.v1.Sides
+ */
+export declare enum Sides {
+    /**
+     * @generated from enum value: SIDES_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * "one-sided".
+     *
+     * @generated from enum value: SIDES_ONE_SIDED = 1;
+     */
+    ONE_SIDED = 1,
+    /**
+     * "two-sided-long-edge".
+     *
+     * @generated from enum value: SIDES_TWO_SIDED_LONG_EDGE = 2;
+     */
+    TWO_SIDED_LONG_EDGE = 2,
+    /**
+     * "two-sided-short-edge".
+     *
+     * @generated from enum value: SIDES_TWO_SIDED_SHORT_EDGE = 3;
+     */
+    TWO_SIDED_SHORT_EDGE = 3
+}
+/**
+ * Describes the enum leaflow.fleet.printing.v1.Sides.
+ */
+export declare const SidesSchema: GenEnum<Sides>;
+/**
+ * How far the participant got with a job.
+ *
+ * @generated from enum leaflow.fleet.printing.v1.PrintJobPhase
+ */
+export declare enum PrintJobPhase {
+    /**
+     * @generated from enum value: PRINT_JOB_PHASE_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * Fetching the document.
+     *
+     * @generated from enum value: PRINT_JOB_PHASE_RECEIVING = 1;
+     */
+    RECEIVING = 1,
+    /**
+     * The document is stored and verified.
+     *
+     * @generated from enum value: PRINT_JOB_PHASE_VERIFIED = 2;
+     */
+    VERIFIED = 2,
+    /**
+     * The job is in the participant's print queue.
+     *
+     * @generated from enum value: PRINT_JOB_PHASE_SUBMITTED = 3;
+     */
+    SUBMITTED = 3,
+    /**
+     * The submission may have happened, but its outcome is unknown.
+     *
+     * @generated from enum value: PRINT_JOB_PHASE_UNKNOWN = 4;
+     */
+    UNKNOWN = 4
+}
+/**
+ * Describes the enum leaflow.fleet.printing.v1.PrintJobPhase.
+ */
+export declare const PrintJobPhaseSchema: GenEnum<PrintJobPhase>;
+/**
+ * The state of a submitted job (job-state), with the IPP values.
+ *
+ * @generated from enum leaflow.fleet.printing.v1.PrintJobState
+ */
+export declare enum PrintJobState {
+    /**
+     * @generated from enum value: PRINT_JOB_STATE_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * Waiting ("pending").
+     *
+     * @generated from enum value: PRINT_JOB_STATE_PENDING = 3;
+     */
+    PENDING = 3,
+    /**
+     * Held ("pending-held").
+     *
+     * @generated from enum value: PRINT_JOB_STATE_PENDING_HELD = 4;
+     */
+    PENDING_HELD = 4,
+    /**
+     * Printing ("processing").
+     *
+     * @generated from enum value: PRINT_JOB_STATE_PROCESSING = 5;
+     */
+    PROCESSING = 5,
+    /**
+     * Stopped while printing ("processing-stopped").
+     *
+     * @generated from enum value: PRINT_JOB_STATE_PROCESSING_STOPPED = 6;
+     */
+    PROCESSING_STOPPED = 6,
+    /**
+     * Cancelled ("canceled").
+     *
+     * @generated from enum value: PRINT_JOB_STATE_CANCELED = 7;
+     */
+    CANCELED = 7,
+    /**
+     * Failed ("aborted").
+     *
+     * @generated from enum value: PRINT_JOB_STATE_ABORTED = 8;
+     */
+    ABORTED = 8,
+    /**
+     * Printed, as the participant's print queue reports ("completed").
+     *
+     * @generated from enum value: PRINT_JOB_STATE_COMPLETED = 9;
+     */
+    COMPLETED = 9
+}
+/**
+ * Describes the enum leaflow.fleet.printing.v1.PrintJobState.
+ */
+export declare const PrintJobStateSchema: GenEnum<PrintJobState>;