ocpplab 0.1.2

package/README.md

@@ -0,0 +1,375 @@
+# Ocpplab TypeScript Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fev-cloudx%2Focpplab-sdk)
+[![npm shield](https://img.shields.io/npm/v/ocpplab)](https://www.npmjs.com/package/ocpplab)
+
+The Ocpplab TypeScript library provides convenient access to the Ocpplab APIs from TypeScript.
+
+## Table of Contents
+
+- [Run](#run)
+- [Contract](#contract)
+- [Client Generation](#client-generation)
+- [Notes](#notes)
+- [Seed Scripts](#seed-scripts)
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Async Client](#async-client)
+- [Request and Response Types](#request-and-response-types)
+- [Exception Handling](#exception-handling)
+- [Advanced](#advanced)
+  - [Subpackage Exports](#subpackage-exports)
+  - [Additional Headers](#additional-headers)
+  - [Additional Query String Parameters](#additional-query-string-parameters)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Aborting Requests](#aborting-requests)
+  - [Access Raw Response Data](#access-raw-response-data)
+  - [Logging](#logging)
+  - [Custom Fetch](#custom-fetch)
+  - [Runtime Compatibility](#runtime-compatibility)
+- [Contributing](#contributing)
+
+## Run
+
+Start the API locally with:
+
+```bash
+uvicorn src.main:app --reload --host 0.0.0.0 --port 8000
+```
+
+## Contract
+
+- Runtime OpenAPI JSON: `/openapi.json`
+- Checked-in spec: [`openapi.yaml`](/Users/yacine-elazrak/OCPPLAB/OCPP/ocpplab-sdk/openapi.yaml)
+- Regenerate artifacts: `make openapi`
+
+The checked-in OpenAPI files are generated from the current FastAPI app with runtime dependencies disabled, so the exported contract does not depend on Supabase or Temporal startup.
+
+## Client Generation
+
+Generate your preferred client directly from `/openapi.json` or the checked-in
+OpenAPI artifacts.
+
+## Notes
+
+- Tenant-scoped endpoints require the `X-Organization-Id` header.
+- Pydantic API schemas live under `src/schemas/`.
+- Queue producers and consumers live under `src/messaging/`.
+
+## Seed Scripts
+
+This repo also contains TypeScript data seeding files for local or sandbox database setup:
+
+- [seed.ts](/Users/yacine-elazrak/OCPPLAB/OCPP/ocpplab-sdk/seed.ts): uses Snaplet Seed to reset and populate the `brands`, `models`, `locations`, and `deployments` tables with demo data.
+- [seed.config.ts](/Users/yacine-elazrak/OCPPLAB/OCPP/ocpplab-sdk/seed.config.ts): defines the Postgres adapter and target schema selection used by the seeding tool.
+
+Prerequisites:
+
+- Node.js installed
+- project dependencies installed with your preferred JS package manager
+- access to the target Postgres database configured for Snaplet Seed
+
+## Installation
+
+```sh
+npm i -s ocpplab
+```
+
+## Reference
+
+A full reference for this library is available [here](https://github.com/ev-cloudx/ocpplab-sdk/blob/HEAD/./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```typescript
+import { OcpplabClient } from "ocpplab";
+
+const client = new OcpplabClient({ environment: "YOUR_BASE_URL", token: "YOUR_TOKEN", organizationId: "YOUR_ORGANIZATION_ID" });
+await client.chargerDeployments.createCharger({
+    identity: "CP-FAST-201",
+    brand_slug: "abb",
+    model_slug: "terra-184",
+    connector_type: "CCS2",
+    ws_url: "wss://example-ocpp-backend.test/ws",
+    ocpp_version: "OCPP2.0.1",
+    charge_point_name: "Fast Bay 01",
+    location_id: "4090477f-a416-4515-a302-97aa344a0a2a",
+    location_name: "La Defense Charging Hub"
+});
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use `httpx.AsyncClient()` instead of `httpx.Client()` (e.g. for the `httpx_client` parameter of this client).
+
+```python
+import asyncio
+
+from ocpplab import AsyncOcpplabApi
+
+client = AsyncOcpplabApi(
+    token="<token>",
+    base_url="https://yourhost.com/path/to/api",
+)
+
+
+async def main() -> None:
+    await client.charger_deployments.create_charger(
+        identity="CP-TEST-001",
+        brand_slug="wallbox",
+        model_slug="wallbox-pulsar-plus",
+        connector_type="Type2",
+        ws_url="wss://ocpp-toolkit-api.monta.app",
+        ocpp_version="OCPP1.6",
+        charge_point_name="Bay A01",
+        location_id="4090477f-a416-4515-a302-97aa344a0a2a",
+        location_name="La Defense Charging Hub",
+    )
+
+
+asyncio.run(main())
+```
+
+## Request and Response Types
+
+The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
+following namespace:
+
+```typescript
+import { Ocpplab } from "ocpplab";
+
+const request: Ocpplab.ListChargersRequest = {
+    ...
+};
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```typescript
+import { OcpplabError } from "ocpplab";
+
+try {
+    await client.chargerDeployments.createCharger(...);
+} catch (err) {
+    if (err instanceof OcpplabError) {
+        console.log(err.statusCode);
+        console.log(err.message);
+        console.log(err.body);
+        console.log(err.rawResponse);
+    }
+}
+```
+
+## Advanced
+
+### Subpackage Exports
+
+This SDK supports direct imports of subpackage clients, which allows JavaScript bundlers to tree-shake and include only the imported subpackage code. This results in much smaller bundle sizes.
+
+```typescript
+import { ChargerDeploymentsClient } from 'ocpplab/chargerDeployments';
+
+const client = new ChargerDeploymentsClient({...});
+```
+
+### Additional Headers
+
+If you would like to send additional headers as part of the request, use the `headers` request option.
+
+```typescript
+import { OcpplabClient } from "ocpplab";
+
+const client = new OcpplabClient({
+    ...
+    headers: {
+        'X-Custom-Header': 'custom value'
+    }
+});
+
+const response = await client.chargerDeployments.createCharger(..., {
+    headers: {
+        'X-Custom-Header': 'custom value'
+    }
+});
+```
+
+### Additional Query String Parameters
+
+If you would like to send additional query string parameters as part of the request, use the `queryParams` request option.
+
+```typescript
+const response = await client.chargerDeployments.createCharger(..., {
+    queryParams: {
+        'customQueryParamKey': 'custom query param value'
+    }
+});
+```
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retryable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `maxRetries` request option to configure this behavior.
+
+```typescript
+const response = await client.chargerDeployments.createCharger(..., {
+    maxRetries: 0 // override maxRetries at the request level
+});
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
+
+```typescript
+const response = await client.chargerDeployments.createCharger(..., {
+    timeoutInSeconds: 30 // override timeout to 30s
+});
+```
+
+### Aborting Requests
+
+The SDK allows users to abort requests at any point by passing in an abort signal.
+
+```typescript
+const controller = new AbortController();
+const response = await client.chargerDeployments.createCharger(..., {
+    abortSignal: controller.signal
+});
+controller.abort(); // aborts the request
+```
+
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.withRawResponse()` method.
+The `.withRawResponse()` method returns a promise that results to an object with a `data` and a `rawResponse` property.
+
+```typescript
+const { data, rawResponse } = await client.chargerDeployments.createCharger(...).withRawResponse();
+
+console.log(data);
+console.log(rawResponse.headers['X-My-Header']);
+```
+
+### Logging
+
+The SDK supports logging. You can configure the logger by passing in a `logging` object to the client options.
+
+```typescript
+import { OcpplabClient, logging } from "ocpplab";
+
+const client = new OcpplabClient({
+    ...
+    logging: {
+        level: logging.LogLevel.Debug, // defaults to logging.LogLevel.Info
+        logger: new logging.ConsoleLogger(), // defaults to ConsoleLogger
+        silent: false, // defaults to true, set to false to enable logging
+    }
+});
+```
+The `logging` object can have the following properties:
+- `level`: The log level to use. Defaults to `logging.LogLevel.Info`.
+- `logger`: The logger to use. Defaults to a `logging.ConsoleLogger`.
+- `silent`: Whether to silence the logger. Defaults to `true`.
+
+The `level` property can be one of the following values:
+- `logging.LogLevel.Debug`
+- `logging.LogLevel.Info`
+- `logging.LogLevel.Warn`
+- `logging.LogLevel.Error`
+
+To provide a custom logger, you can pass in an object that implements the `logging.ILogger` interface.
+
+<details>
+<summary>Custom logger examples</summary>
+
+Here's an example using the popular `winston` logging library.
+```ts
+import winston from 'winston';
+
+const winstonLogger = winston.createLogger({...});
+
+const logger: logging.ILogger = {
+    debug: (msg, ...args) => winstonLogger.debug(msg, ...args),
+    info: (msg, ...args) => winstonLogger.info(msg, ...args),
+    warn: (msg, ...args) => winstonLogger.warn(msg, ...args),
+    error: (msg, ...args) => winstonLogger.error(msg, ...args),
+};
+```
+
+Here's an example using the popular `pino` logging library.
+
+```ts
+import pino from 'pino';
+
+const pinoLogger = pino({...});
+
+const logger: logging.ILogger = {
+  debug: (msg, ...args) => pinoLogger.debug(args, msg),
+  info: (msg, ...args) => pinoLogger.info(args, msg),
+  warn: (msg, ...args) => pinoLogger.warn(args, msg),
+  error: (msg, ...args) => pinoLogger.error(args, msg),
+};
+```
+</details>
+
+
+### Custom Fetch
+
+The SDK provides a low-level `fetch` method for making custom HTTP requests while still
+benefiting from SDK-level configuration like authentication, retries, timeouts, and logging.
+This is useful for calling API endpoints not yet supported in the SDK.
+
+```typescript
+const response = await client.fetch("/v1/custom/endpoint", {
+    method: "GET",
+}, {
+    timeoutInSeconds: 30,
+    maxRetries: 3,
+    headers: {
+        "X-Custom-Header": "custom-value",
+    },
+});
+
+const data = await response.json();
+```
+
+### Runtime Compatibility
+
+
+The SDK works in the following runtimes:
+
+
+
+- Node.js 18+
+- Vercel
+- Cloudflare Workers
+- Deno v1.25+
+- Bun 1.0+
+- React Native
+
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

package/dist/cjs/BaseClient.d.ts

@@ -0,0 +1,42 @@
+import { BearerAuthProvider } from "./auth/BearerAuthProvider.js";
+import * as core from "./core/index.js";
+export type BaseClientOptions = {
+    environment: core.Supplier<string>;
+    /** Specify a custom URL to connect the client to. */
+    baseUrl?: core.Supplier<string>;
+    /** Override the X-Organization-Id header */
+    organizationId?: core.Supplier<(string | null) | undefined>;
+    /** Additional headers to include in requests. */
+    headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    /** The default maximum time to wait for a response in seconds. */
+    timeoutInSeconds?: number;
+    /** The default number of times to retry the request. Defaults to 2. */
+    maxRetries?: number;
+    /** Provide a custom fetch implementation. Useful for platforms that don't have a built-in fetch or need a custom implementation. */
+    fetch?: typeof fetch;
+    /** Configure logging for the client. */
+    logging?: core.logging.LogConfig | core.logging.Logger;
+} & BearerAuthProvider.AuthOptions;
+export interface BaseRequestOptions {
+    /** The maximum time to wait for a response in seconds. */
+    timeoutInSeconds?: number;
+    /** The number of times to retry the request. Defaults to 2. */
+    maxRetries?: number;
+    /** A hook to abort the request. */
+    abortSignal?: AbortSignal;
+    /** Override the X-Organization-Id header */
+    organizationId?: (string | null) | undefined;
+    /** Additional query string parameters to include in the request. */
+    queryParams?: Record<string, unknown>;
+    /** Additional headers to include in the request. */
+    headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+}
+export type NormalizedClientOptions<T extends BaseClientOptions = BaseClientOptions> = T & {
+    logging: core.logging.Logger;
+    authProvider?: core.AuthProvider;
+};
+export type NormalizedClientOptionsWithAuth<T extends BaseClientOptions = BaseClientOptions> = NormalizedClientOptions<T> & {
+    authProvider: core.AuthProvider;
+};
+export declare function normalizeClientOptions<T extends BaseClientOptions = BaseClientOptions>(options: T): NormalizedClientOptions<T>;
+export declare function normalizeClientOptionsWithAuth<T extends BaseClientOptions = BaseClientOptions>(options: T): NormalizedClientOptionsWithAuth<T>;

package/dist/cjs/BaseClient.js

@@ -0,0 +1,63 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeClientOptions = normalizeClientOptions;
+exports.normalizeClientOptionsWithAuth = normalizeClientOptionsWithAuth;
+const BearerAuthProvider_js_1 = require("./auth/BearerAuthProvider.js");
+const headers_js_1 = require("./core/headers.js");
+const core = __importStar(require("./core/index.js"));
+function normalizeClientOptions(options) {
+    const headers = (0, headers_js_1.mergeHeaders)({
+        "X-Fern-Language": "JavaScript",
+        "X-Fern-SDK-Name": "ocpplab",
+        "X-Fern-SDK-Version": "0.1.2",
+        "User-Agent": "ocpplab/0.1.2",
+        "X-Fern-Runtime": core.RUNTIME.type,
+        "X-Fern-Runtime-Version": core.RUNTIME.version,
+        "X-Organization-Id": options === null || options === void 0 ? void 0 : options.organizationId,
+    }, options === null || options === void 0 ? void 0 : options.headers);
+    return Object.assign(Object.assign({}, options), { logging: core.logging.createLogger(options === null || options === void 0 ? void 0 : options.logging), headers });
+}
+function normalizeClientOptionsWithAuth(options) {
+    var _a;
+    const normalized = normalizeClientOptions(options);
+    const normalizedWithNoOpAuthProvider = withNoOpAuthProvider(normalized);
+    (_a = normalized.authProvider) !== null && _a !== void 0 ? _a : (normalized.authProvider = new BearerAuthProvider_js_1.BearerAuthProvider(normalizedWithNoOpAuthProvider));
+    return normalized;
+}
+function withNoOpAuthProvider(options) {
+    return Object.assign(Object.assign({}, options), { authProvider: new core.NoOpAuthProvider() });
+}

package/dist/cjs/Client.d.ts

@@ -0,0 +1,75 @@
+import { CatalogClient } from "./api/resources/catalog/client/Client.js";
+import { ChargerCommandsClient } from "./api/resources/chargerCommands/client/Client.js";
+import { ChargerConfigurationClient } from "./api/resources/chargerConfiguration/client/Client.js";
+import { ChargerDeploymentsClient } from "./api/resources/chargerDeployments/client/Client.js";
+import { ChargerFaultsClient } from "./api/resources/chargerFaults/client/Client.js";
+import { ChargerLocalAuthorizationClient } from "./api/resources/chargerLocalAuthorization/client/Client.js";
+import { ChargerLogsClient } from "./api/resources/chargerLogs/client/Client.js";
+import { HealthClient } from "./api/resources/health/client/Client.js";
+import { LocationChargerCommandsClient } from "./api/resources/locationChargerCommands/client/Client.js";
+import { LocationChargerFaultsClient } from "./api/resources/locationChargerFaults/client/Client.js";
+import { LocationChargerProvisioningClient } from "./api/resources/locationChargerProvisioning/client/Client.js";
+import { LocationsClient } from "./api/resources/locations/client/Client.js";
+import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "./BaseClient.js";
+import * as core from "./core/index.js";
+export declare namespace OcpplabClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class OcpplabClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<OcpplabClient.Options>;
+    protected _chargerDeployments: ChargerDeploymentsClient | undefined;
+    protected _catalog: CatalogClient | undefined;
+    protected _locations: LocationsClient | undefined;
+    protected _chargerCommands: ChargerCommandsClient | undefined;
+    protected _chargerConfiguration: ChargerConfigurationClient | undefined;
+    protected _chargerLogs: ChargerLogsClient | undefined;
+    protected _chargerLocalAuthorization: ChargerLocalAuthorizationClient | undefined;
+    protected _chargerFaults: ChargerFaultsClient | undefined;
+    protected _locationChargerCommands: LocationChargerCommandsClient | undefined;
+    protected _locationChargerFaults: LocationChargerFaultsClient | undefined;
+    protected _locationChargerProvisioning: LocationChargerProvisioningClient | undefined;
+    protected _health: HealthClient | undefined;
+    constructor(options: OcpplabClient.Options);
+    get chargerDeployments(): ChargerDeploymentsClient;
+    get catalog(): CatalogClient;
+    get locations(): LocationsClient;
+    get chargerCommands(): ChargerCommandsClient;
+    get chargerConfiguration(): ChargerConfigurationClient;
+    get chargerLogs(): ChargerLogsClient;
+    get chargerLocalAuthorization(): ChargerLocalAuthorizationClient;
+    get chargerFaults(): ChargerFaultsClient;
+    get locationChargerCommands(): LocationChargerCommandsClient;
+    get locationChargerFaults(): LocationChargerFaultsClient;
+    get locationChargerProvisioning(): LocationChargerProvisioningClient;
+    get health(): HealthClient;
+    /**
+     * Render a simple HTML landing page with API documentation links.
+     *
+     * Returns:
+     *     A static HTML page linking to the docs, schema, and health route.
+     *
+     * @param {OcpplabClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Ocpplab.UnauthorizedError}
+     * @throws {@link Ocpplab.ForbiddenError}
+     *
+     * @example
+     *     await client.defaultLandingPage()
+     */
+    defaultLandingPage(requestOptions?: OcpplabClient.RequestOptions): core.HttpResponsePromise<string>;
+    private __defaultLandingPage;
+    /**
+     * Make a passthrough request using the SDK's configured auth, retry, logging, etc.
+     * This is useful for making requests to endpoints not yet supported in the SDK.
+     * The input can be a URL string, URL object, or Request object. Relative paths are resolved against the configured base URL.
+     *
+     * @param {Request | string | URL} input - The URL, path, or Request object.
+     * @param {RequestInit} init - Standard fetch RequestInit options.
+     * @param {core.PassthroughRequest.RequestOptions} requestOptions - Per-request overrides (timeout, retries, headers, abort signal).
+     * @returns {Promise<Response>} A standard Response object.
+     */
+    fetch(input: Request | string | URL, init?: RequestInit, requestOptions?: core.PassthroughRequest.RequestOptions): Promise<Response>;
+}