@native-engagement/sdk 0.9.1 → 0.11.0

package/README.md

@@ -0,0 +1,54 @@
+# Native Engagement SDK
+
+JavaScript and TypeScript access to Native Engagement. Requires Node.js 24.22.1 or later in the Node.js 24 line.
+
+```sh
+npm install @native-engagement/sdk@0.11.0
+```
+
+## Connect and sign in
+
+Use the trusted service URL supplied by your administrator. Browser sign-in handles account credentials and any MFA challenge.
+
+```js
+import {
+  createNativePublicLogin, openNativeLoginPage, RemoteNativeEngagementSdk
+} from '@native-engagement/sdk';
+
+const origin = 'https://engagement.example';
+const login = await createNativePublicLogin(origin);
+const grant = await login.authorize(AbortSignal.timeout(180_000), openNativeLoginPage);
+const sdk = new RemoteNativeEngagementSdk({
+  baseUrl: origin,
+  accessToken: () => grant.accessToken
+});
+
+const discovery = await sdk.discoverContracts({ query: 'execution.device', limit: 10 });
+console.log(discovery);
+// At the end of the session:
+await login.revoke(grant);
+```
+
+Your administrator provisions account and tenant permissions. Each operation checks current authorization. Keep grants in memory or an approved protected credential store. For an existing automation identity, supply its authorized token provider through `accessToken`; never put credentials in command arguments or source code.
+
+## Discover and call capabilities
+
+Use `sdk.discoverContracts({query, kind, limit, cursor})` to find relevant capabilities and `sdk.schema(name, 'input')` for their current input constraints. Call `sdk.query({name, payload})` or `sdk.command({name, payload})` with those inputs. Commands require a stable `idempotencyKey`.
+
+The SDK also exports typed helpers for supported business operations and `NativeMcpToolCatalog` for a host that already owns an authenticated MCP client. Capability discovery grants no additional permissions.
+
+Keep original request keys and receipts. After a lost response or an unknown external result, inspect the original operation before retrying. Request acceptance, operation completion and external delivery are separate outcomes.
+
+## Prepare an execution environment
+
+This package is a remote client. It does not contain another Agent Runtime, an execution node, channel applications or models. Your Agent Runtime remains managed by its existing host.
+
+`installationRuntimeSkill()` returns offline execution prerequisites and dependency reuse guidance. Discover `execution.device.list` and `execution.device.inspect` to reuse an existing authorized environment. When another environment is needed, follow `execution.environment.request` and its original authenticated installation handoff.
+
+The host Agent can prepare selected authorized dependencies and install a trusted execution artifact. Reuse compatible installed programs and caches. An execution artifact supplies the local Node/Worker programs; an existing installation can continue to use its original programs. A Desktop application is optional.
+
+Installation, account pairing, channel authorization and updates retain their own checks. Preserve installation identity, credentials, task journals and recovery state across upgrades. Missing trusted artifacts or unsupported platforms must remain explicit.
+
+## License
+
+Apache-2.0. Bundled third-party notices are included in `THIRD_PARTY_LICENSES.txt`.

package/THIRD_PARTY_LICENSES.txt

@@ -1,3 +1,120 @@
+ajv@8.20.0
+
+The MIT License (MIT)
+
+Copyright (c) 2015-2021 Evgeny Poberezkin
+
+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.
+
+
+
+---
+
+fast-deep-equal@3.1.3
+
+MIT License
+
+Copyright (c) 2017 Evgeny Poberezkin
+
+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.
+
+
+---
+
+json-schema-traverse@1.0.0
+
+MIT License
+
+Copyright (c) 2017 Evgeny Poberezkin
+
+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.
+
+
+---
+
+fast-uri@3.1.9
+
+Copyright (c) 2011-2021, Gary Court until https://github.com/garycourt/uri-js/commit/a1acf730b4bba3f1097c9f52e7d9d3aba8cdcaae
+Copyright (c) 2021-present The Fastify team <https://github.com/fastify/fastify#team>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * The names of any contributors may not be used to endorse or promote
+      products derived from this software without specific prior written
+      permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+                                  *   *   *
+
+The complete list of contributors can be found at:
+- https://github.com/garycourt/uri-js/graphs/contributors
+
+---
+
 oauth4webapi@3.8.8
 
 The MIT License (MIT)