@caronashow/api 0.1.3

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026 CaronaShow
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,80 @@
+# @caronashow/api
+
+TypeScript/JavaScript client library for the CaronaShow API. This package provides type-safe access to the CaronaShow service APIs.
+
+## Installation
+
+```bash
+npm install @caronashow/api
+# or
+yarn add @caronashow/api
+# or
+pnpm add @caronashow/api
+# or
+bun install @caronashow/api
+```
+
+## Usage
+
+### Basic Setup Example
+
+```typescript
+import { createClient } from "@connectrpc/connect";
+import { createGrpcWebTransport } from "@connectrpc/connect-web";
+import { PoolerService } from "@caronashow/api";
+
+// Create a transport
+const transport = createGrpcWebTransport({
+  baseUrl: "https://dev.carona.show",
+  useBinaryFormat: true,
+});
+
+// Create the client
+const client = createClient(PoolerService, transport);
+
+// Example: Using the positions service
+const position = await client.getPosition({ deviceId: "device-123" });
+```
+
+### API Documentation
+
+#### Types
+
+The package includes the following type definitions:
+
+- `Position` - Represents a device's location with latitude, longitude, altitude, speed, and heading
+- `DevicePosition` - Combines a device ID with its position
+- `Device` - Device information including ID and name
+- `User` - User information including ID, name, and associated devices
+- `Group` - Group information including ID, name, description, and associated users
+
+#### Services
+
+This is not a full list of services. These are just some examples.
+
+- `PositionsService` - Service for managing device positions
+  - `sendPositions(positions: DevicePosition[]): Promise<SendPositionsResponse>` - Send multiple device position updates
+  - `getGroup(groupId: string): Promise<GetGroupResponse>` - Get a group by ID, including user data and their devices
+  - `getGroupPositions(groupId: string): Promise<GetGroupPositionsResponse>` - Get positions for all devices in a group
+
+## Development
+
+This package is automatically generated from Protocol Buffer definitions. Do not modify the generated code directly. Instead, make changes to the proto files in the parent repository.
+
+### Building
+
+The package is built using the following tools:
+
+- `buf` - Protocol Buffer compiler
+- `protoc-gen-es` - TypeScript code generator
+- `protoc-gen-connect-es` - Connect-ES code generator
+
+To rebuild the package:
+
+```bash
+make generate
+```
+
+## License
+
+MIT License - see LICENSE file for details.

package/dist/gen/caronashow/pooler/v1/pooler_pb.d.ts

@@ -0,0 +1,219 @@
+import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
+import type { Duration, Timestamp } from "@bufbuild/protobuf/wkt";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file caronashow/pooler/v1/pooler.proto.
+ */
+export declare const file_caronashow_pooler_v1_pooler: GenFile;
+/**
+ * @generated from message caronashow.pooler.v1.Operation
+ */
+export type Operation = Message<"caronashow.pooler.v1.Operation"> & {
+    /**
+     * @generated from field: string operation_id = 1;
+     */
+    operationId: string;
+    /**
+     * @generated from field: string dataset_id = 2;
+     */
+    datasetId: string;
+    /**
+     * @generated from field: google.protobuf.Timestamp started_at = 3;
+     */
+    startedAt?: Timestamp;
+    /**
+     * @generated from field: google.protobuf.Duration time_elapsed = 4;
+     */
+    timeElapsed?: Duration;
+    /**
+     * @generated from field: caronashow.pooler.v1.OperationState state = 5;
+     */
+    state: OperationState;
+};
+/**
+ * Describes the message caronashow.pooler.v1.Operation.
+ * Use `create(OperationSchema)` to create a new message.
+ */
+export declare const OperationSchema: GenMessage<Operation>;
+/**
+ * @generated from message caronashow.pooler.v1.ExecuteMatchingAlgorithmOnDatasetRequest
+ */
+export type ExecuteMatchingAlgorithmOnDatasetRequest = Message<"caronashow.pooler.v1.ExecuteMatchingAlgorithmOnDatasetRequest"> & {
+    /**
+     * @generated from field: string dataset_id = 1;
+     */
+    datasetId: string;
+    /**
+     * @generated from field: caronashow.pooler.v1.MatchingAlgorithm algorithm = 2;
+     */
+    algorithm: MatchingAlgorithm;
+};
+/**
+ * Describes the message caronashow.pooler.v1.ExecuteMatchingAlgorithmOnDatasetRequest.
+ * Use `create(ExecuteMatchingAlgorithmOnDatasetRequestSchema)` to create a new message.
+ */
+export declare const ExecuteMatchingAlgorithmOnDatasetRequestSchema: GenMessage<ExecuteMatchingAlgorithmOnDatasetRequest>;
+/**
+ * @generated from message caronashow.pooler.v1.ExecuteMatchingAlgorithmOnDatasetResponse
+ */
+export type ExecuteMatchingAlgorithmOnDatasetResponse = Message<"caronashow.pooler.v1.ExecuteMatchingAlgorithmOnDatasetResponse"> & {
+    /**
+     * @generated from field: caronashow.pooler.v1.Operation operation = 1;
+     */
+    operation?: Operation;
+};
+/**
+ * Describes the message caronashow.pooler.v1.ExecuteMatchingAlgorithmOnDatasetResponse.
+ * Use `create(ExecuteMatchingAlgorithmOnDatasetResponseSchema)` to create a new message.
+ */
+export declare const ExecuteMatchingAlgorithmOnDatasetResponseSchema: GenMessage<ExecuteMatchingAlgorithmOnDatasetResponse>;
+/**
+ * @generated from message caronashow.pooler.v1.ListOperationsRequest
+ */
+export type ListOperationsRequest = Message<"caronashow.pooler.v1.ListOperationsRequest"> & {
+    /**
+     * @generated from field: optional int32 limit = 1;
+     */
+    limit?: number;
+    /**
+     * @generated from field: optional caronashow.pooler.v1.OperationState state = 2;
+     */
+    state?: OperationState;
+};
+/**
+ * Describes the message caronashow.pooler.v1.ListOperationsRequest.
+ * Use `create(ListOperationsRequestSchema)` to create a new message.
+ */
+export declare const ListOperationsRequestSchema: GenMessage<ListOperationsRequest>;
+/**
+ * @generated from message caronashow.pooler.v1.ListOperationsResponse
+ */
+export type ListOperationsResponse = Message<"caronashow.pooler.v1.ListOperationsResponse"> & {
+    /**
+     * @generated from field: repeated caronashow.pooler.v1.Operation operations = 1;
+     */
+    operations: Operation[];
+};
+/**
+ * Describes the message caronashow.pooler.v1.ListOperationsResponse.
+ * Use `create(ListOperationsResponseSchema)` to create a new message.
+ */
+export declare const ListOperationsResponseSchema: GenMessage<ListOperationsResponse>;
+/**
+ * @generated from message caronashow.pooler.v1.GetStateOfOperationRequest
+ */
+export type GetStateOfOperationRequest = Message<"caronashow.pooler.v1.GetStateOfOperationRequest"> & {
+    /**
+     * @generated from field: string operation_id = 1;
+     */
+    operationId: string;
+};
+/**
+ * Describes the message caronashow.pooler.v1.GetStateOfOperationRequest.
+ * Use `create(GetStateOfOperationRequestSchema)` to create a new message.
+ */
+export declare const GetStateOfOperationRequestSchema: GenMessage<GetStateOfOperationRequest>;
+/**
+ * @generated from message caronashow.pooler.v1.GetStateOfOperationResponse
+ */
+export type GetStateOfOperationResponse = Message<"caronashow.pooler.v1.GetStateOfOperationResponse"> & {
+    /**
+     * @generated from field: caronashow.pooler.v1.Operation operation = 1;
+     */
+    operation?: Operation;
+};
+/**
+ * Describes the message caronashow.pooler.v1.GetStateOfOperationResponse.
+ * Use `create(GetStateOfOperationResponseSchema)` to create a new message.
+ */
+export declare const GetStateOfOperationResponseSchema: GenMessage<GetStateOfOperationResponse>;
+/**
+ * @generated from enum caronashow.pooler.v1.MatchingAlgorithm
+ */
+export declare enum MatchingAlgorithm {
+    /**
+     * @generated from enum value: MATCHING_ALGORITHM_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * @generated from enum value: MATCHING_ALGORITHM_RANDOM = 1;
+     */
+    RANDOM = 1,
+    /**
+     * @generated from enum value: MATCHING_ALGORITHM_ROUTE_SIMILARITY = 2;
+     */
+    ROUTE_SIMILARITY = 2,
+    /**
+     * @generated from enum value: MATCHING_ALGORITHM_POINT_DISTANCE = 3;
+     */
+    POINT_DISTANCE = 3,
+    /**
+     * @generated from enum value: MATCHING_ALGORITHM_FULL = 4;
+     */
+    FULL = 4
+}
+/**
+ * Describes the enum caronashow.pooler.v1.MatchingAlgorithm.
+ */
+export declare const MatchingAlgorithmSchema: GenEnum<MatchingAlgorithm>;
+/**
+ * @generated from enum caronashow.pooler.v1.OperationState
+ */
+export declare enum OperationState {
+    /**
+     * @generated from enum value: OPERATION_STATE_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * @generated from enum value: OPERATION_STATE_PENDING = 1;
+     */
+    PENDING = 1,
+    /**
+     * @generated from enum value: OPERATION_STATE_RUNNING = 2;
+     */
+    RUNNING = 2,
+    /**
+     * @generated from enum value: OPERATION_STATE_SUCCEEDED = 3;
+     */
+    SUCCEEDED = 3,
+    /**
+     * @generated from enum value: OPERATION_STATE_FAILED = 4;
+     */
+    FAILED = 4
+}
+/**
+ * Describes the enum caronashow.pooler.v1.OperationState.
+ */
+export declare const OperationStateSchema: GenEnum<OperationState>;
+/**
+ * Service executing the main carpooling algorithm on
+ * datasets defined directly in the database
+ *
+ * @generated from service caronashow.pooler.v1.PoolerService
+ */
+export declare const PoolerService: GenService<{
+    /**
+     * @generated from rpc caronashow.pooler.v1.PoolerService.ExecuteMatchingAlgorithmOnDataset
+     */
+    executeMatchingAlgorithmOnDataset: {
+        methodKind: "unary";
+        input: typeof ExecuteMatchingAlgorithmOnDatasetRequestSchema;
+        output: typeof ExecuteMatchingAlgorithmOnDatasetResponseSchema;
+    };
+    /**
+     * @generated from rpc caronashow.pooler.v1.PoolerService.ListOperations
+     */
+    listOperations: {
+        methodKind: "unary";
+        input: typeof ListOperationsRequestSchema;
+        output: typeof ListOperationsResponseSchema;
+    };
+    /**
+     * @generated from rpc caronashow.pooler.v1.PoolerService.GetStateOfOperation
+     */
+    getStateOfOperation: {
+        methodKind: "unary";
+        input: typeof GetStateOfOperationRequestSchema;
+        output: typeof GetStateOfOperationResponseSchema;
+    };
+}>;

package/dist/gen/caronashow/types/v1/user_pb.d.ts

@@ -0,0 +1,36 @@
+import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file caronashow/types/v1/user.proto.
+ */
+export declare const file_caronashow_types_v1_user: GenFile;
+/**
+ * @generated from message caronashow.types.v1.User
+ */
+export type User = Message<"caronashow.types.v1.User"> & {
+    /**
+     * @generated from field: string id = 1;
+     */
+    id: string;
+    /**
+     * @generated from field: string username = 2;
+     */
+    username: string;
+    /**
+     * @generated from field: string first_name = 3;
+     */
+    firstName: string;
+    /**
+     * @generated from field: string last_name = 4;
+     */
+    lastName: string;
+    /**
+     * @generated from field: string email = 5;
+     */
+    email: string;
+};
+/**
+ * Describes the message caronashow.types.v1.User.
+ * Use `create(UserSchema)` to create a new message.
+ */
+export declare const UserSchema: GenMessage<User>;