@twin.org/api-service 0.0.3-next.9 → 0.9.0

package/dist/types/platformService.d.ts

@@ -0,0 +1,39 @@
+import { type IPlatformComponent } from "@twin.org/api-models";
+import { type IContextIds } from "@twin.org/context";
+import type { IPlatformServiceConstructorOptions } from "./models/IPlatformServiceConstructorOptions.js";
+/**
+ * Service for performing platform operations.
+ */
+export declare class PlatformService implements IPlatformComponent {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of PlatformService.
+     * @param options The options for the connector.
+     */
+    constructor(options?: IPlatformServiceConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * Indicates whether the component is running in a multi-tenant environment.
+     * @returns True if the component is running in a multi-tenant environment, false otherwise.
+     */
+    isMultiTenant(): boolean;
+    /**
+     * Execute a method, if single tenant will run once, if multi-tenant will run for each tenant.
+     * @param method The method to run for each tenant.
+     * @returns A promise that resolves when the method has been executed for all applicable tenants.
+     */
+    execute(method: () => Promise<void>): Promise<void>;
+    /**
+     * Get the local origin context IDs for the given URL.
+     * @param url The URL to check.
+     * @returns A promise that resolves to the context IDs if the URL is a local origin, undefined otherwise.
+     */
+    getLocalOriginContext(url: string): Promise<IContextIds | undefined>;
+}

package/dist/types/restEntryPoints.d.ts

@@ -1,2 +1,5 @@
 import type { IRestRouteEntryPoint } from "@twin.org/api-models";
+/**
+ * REST entry points for the information and health services.
+ */
 export declare const restEntryPoints: IRestRouteEntryPoint[];