@mcesystems/mdm-client-g4 1.0.64

package/README.md

@@ -0,0 +1,83 @@
+# @mcesystems/mdm-client
+
+MDM client for device management.
+
+## Install
+
+This package is published as part of the monorepo. Use it through your workspace
+package manager.
+
+## Usage
+
+### Create client from environment
+
+`createMDMClient()` reads `MDM_ENDPOINT` and `CREDENTIALS_PATH` from the
+environment, uses `@mcesystems/auth` to obtain a token, then returns a client.
+Make sure `AUTH_API_URL` is set for the auth flow.
+
+```ts
+import { createMDMClient } from "@mcesystems/mdm-client";
+
+async function main() {
+  const mdmClient = await createMDMClient();
+  if (!mdmClient) {
+    throw new Error("Missing MDM_ENDPOINT or CREDENTIALS_PATH");
+  }
+
+  const enrollmentProfile = await mdmClient.generateEnrollmentProfile("device-id");
+  if (enrollmentProfile.status === "OK") {
+    console.log(enrollmentProfile.profile);
+  }
+}
+
+main().catch((error) => {
+  console.error(error);
+  process.exit(1);
+});
+```
+
+### Create client directly
+
+```ts
+import { MdmClient } from "@mcesystems/mdm-client";
+
+const mdmClient = new MdmClient({
+  endpoint: "https://mdm.example.com/graphql",
+  authToken: "<access-token>",
+  timeout: 60000,
+});
+```
+
+## API
+
+### `MdmClient`
+
+- `generateEnrollmentProfile(deviceId: string)`
+- `waitForDeviceToEnroll(deviceId: string, previousOpRef?: string)`
+- `installApp(deviceId: string, options: { appId?: string; url?: string; waitForInstalled?: boolean })`
+
+### Types
+
+Exported types from `src/types/mdm.ts`:
+
+- `GenerateEnrollmentProfileResponse`
+- `WaitForDeviceToEnrollResponse`
+- `InstallAppResponse`
+- `MdmClientConfig`
+- `InstallAppOptions`
+- `InstallAppMdmOptions`
+- `DeviceType`
+- `MdmApiCallStatus`
+
+## Environment variables
+
+When using `createMDMClient()`:
+
+- `MDM_ENDPOINT`: MDM GraphQL endpoint URL
+- `CREDENTIALS_PATH`: path to credentials file used by `@mcesystems/auth`
+- `AUTH_API_URL`: auth API base URL for token retrieval
+
+## Logging
+
+This package uses `@mcesystems/tool-debug` for logging. Configure logging in your
+app as needed.