@betorigami/game-ui-shared 4.0.0 → 4.1.1

package/README.md

@@ -34,6 +34,27 @@ declare module '@betorigami/game-ui-shared' {
 
 The package does not read environment variables. A host that wants a different provably-fair verifier calls `setVerifierBaseUrl` with that URL at startup; a host that does not leaves the built-in default in place.
 
+## Provider API client
+
+`ProviderApi` is a client for provider-api, generated with [hey-api](https://heyapi.dev) from provider-api's OpenAPI spec. Every response is checked against the spec with zod/mini before the caller sees it.
+
+```ts
+import { ProviderApi } from '@betorigami/game-ui-shared';
+
+const client = ProviderApi.createProviderApiClient({ baseUrl, authToken });
+const { data, error } = await ProviderApi.postGamesDicePlay({ client, body });
+```
+
+`createProviderApiClient` adds the auth token, a fresh `X-Origami-Trace` id and a `REQUEST_TIMEOUT_MS` timeout to every request. `data` is set when the request succeeds and the response matches the spec. Otherwise `error` holds the error body, which `resolveApiErrorCode` turns into an `ErrorCode`. A response that doesn't match the spec throws. Inside this package, import from `src/shared/provider-api/provider-api-client` instead.
+
+To regenerate it after provider-api's endpoints change:
+
+1. Start provider-api locally from the backend repo with `ENABLE_OPENAPI_DOCS=true`, the default in its `.env.template`. It serves the spec at `http://localhost:3000/openapi.json`.
+2. Run `pnpm run generate:provider-api` in this package.
+3. Commit the changes under `src/shared/provider-api/generated/`.
+
+The settings, including the excluded `/internal/*` routes, are in `openapi-ts.config.ts`. Don't edit the generated files by hand.
+
 ## Pinning
 
 `@betorigami/game-calculations` supplies the enums of the games that have not yet been extracted. A host must pin the same version of it as this package, or two copies of the engine end up in one bundle and enum identity breaks.

package/dist/components/shared/BetDetailsComponent/BetDetailsComponent.d.ts

@@ -2,7 +2,7 @@ import { default as OrigamiElement } from '../../../shared/origami-element';
 import { Language } from '../../../translations/language.context';
 import { TemplateResult } from 'lit';
 export declare class BetDetailsComponent extends OrigamiElement {
-    static styles: import('lit').CSSResult;
+    static styles: import('lit').CSSResult[];
     baseUrl: string;
     betId: string;
     language: Language;

package/dist/components/shared/GameProviderWrapper.d.ts

@@ -76,6 +76,7 @@ export declare class GameProviderWrapper extends OrigamiElement {
     private scale;
     language: Language;
     private _soundEffects;
+    private _providerApi;
     private _historyController;
     private _haptics;
     private _resizeObserver;
@@ -90,6 +91,7 @@ export declare class GameProviderWrapper extends OrigamiElement {
     firstUpdated(_changed: PropertyValues): Promise<void>;
     disconnectedCallback(): void;
     updated(changedProperties: PropertyValues): void;
+    private get providerApi();
     private get isDemoMode();
     private get isDesktop();
     private createLocale;

package/dist/components/shared/context/slices/services.context.d.ts

@@ -1,10 +1,12 @@
 import { HapticsController } from '../../../../controllers/haptics.controller';
 import { HistoryController } from '../../../../controllers/history.controller';
 import { SoundEffectsController } from '../../../../controllers/sound/sound-effects.controller';
+import { Client } from '../../../../shared/provider-api/generated/client';
 export type ServicesContextType = {
     soundEffects: SoundEffectsController;
     haptics: HapticsController;
     historyController: HistoryController;
+    providerApi: Client;
 };
 export declare const servicesContext: {
     __context__: ServicesContextType;

package/dist/controllers/history.controller.d.ts

@@ -1,5 +1,5 @@
 import { Currency } from '../shared/constants';
-import { ApiSession } from '../shared/create-api-factory';
+import { Client } from '../shared/provider-api/provider-api-client';
 export interface HistoryItem {
     id: string;
     fullId: string;
@@ -21,7 +21,7 @@ export declare class NonceChangedEvent extends Event {
     constructor(nonce: number | null);
 }
 export declare class HistoryController extends EventTarget {
-    private readonly getSession;
+    private readonly getClient;
     private _historyData;
     private _hasData;
     private _isInitialized;
@@ -33,7 +33,7 @@ export declare class HistoryController extends EventTarget {
     private _activeBetNonce;
     private _hasLoadedClientSeed;
     private _provablyFairInfoAbortController;
-    constructor(getSession: () => ApiSession | null);
+    constructor(getClient: () => Client | null);
     get historyData(): HistoryItem[];
     get hasData(): boolean | null;
     get isInitialized(): boolean;

package/dist/index.d.ts

@@ -175,6 +175,7 @@ export * from './shared/provably-fair-verifier';
 export * from './shared/provider-api/bet-result';
 export * from './shared/provider-api/error-codes';
 export * from './shared/provider-api/request-timeout';
+export * as ProviderApi from './shared/provider-api/provider-api-client';
 export * from './shared/retry-once';
 export * from './shared/sleep';
 export * from './shared/utils/format-autobet-settings';